147 lines
4.9 KiB
Go
147 lines
4.9 KiB
Go
// Copyright 2020-2023 the Pinniped contributors. All Rights Reserved.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package refreshtoken
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/ory/fosite"
|
|
"github.com/ory/fosite/handler/oauth2"
|
|
v1 "k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/api/errors"
|
|
corev1client "k8s.io/client-go/kubernetes/typed/core/v1"
|
|
|
|
"go.pinniped.dev/internal/constable"
|
|
"go.pinniped.dev/internal/crud"
|
|
"go.pinniped.dev/internal/fositestorage"
|
|
"go.pinniped.dev/internal/oidc/clientregistry"
|
|
"go.pinniped.dev/internal/psession"
|
|
)
|
|
|
|
const (
|
|
TypeLabelValue = "refresh-token"
|
|
|
|
ErrInvalidRefreshTokenRequestVersion = constable.Error("refresh token request data has wrong version")
|
|
ErrInvalidRefreshTokenRequestData = constable.Error("refresh token request data must be present")
|
|
|
|
// Version 1 was the initial release of storage.
|
|
// Version 2 is when we switched to storing psession.PinnipedSession inside the fosite request.
|
|
// Version 3 is when we added the Username field to the psession.CustomSessionData.
|
|
// Version 4 is when fosite added json tags to their openid.DefaultSession struct.
|
|
// Version 5 is when we added the UpstreamUsername and UpstreamGroups fields to psession.CustomSessionData.
|
|
refreshTokenStorageVersion = "5"
|
|
)
|
|
|
|
type RevocationStorage interface {
|
|
oauth2.RefreshTokenStorage
|
|
RevokeRefreshToken(ctx context.Context, requestID string) error
|
|
RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) error
|
|
}
|
|
|
|
var _ RevocationStorage = &refreshTokenStorage{}
|
|
|
|
type refreshTokenStorage struct {
|
|
storage crud.Storage
|
|
}
|
|
|
|
type Session struct {
|
|
Request *fosite.Request `json:"request"`
|
|
Version string `json:"version"`
|
|
}
|
|
|
|
func New(secrets corev1client.SecretInterface, clock func() time.Time, sessionStorageLifetime time.Duration) RevocationStorage {
|
|
return &refreshTokenStorage{storage: crud.New(TypeLabelValue, secrets, clock, sessionStorageLifetime)}
|
|
}
|
|
|
|
// ReadFromSecret reads the contents of a Secret as a Session.
|
|
func ReadFromSecret(secret *v1.Secret) (*Session, error) {
|
|
session := newValidEmptyRefreshTokenSession()
|
|
err := crud.FromSecret(TypeLabelValue, secret, session)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if session.Version != refreshTokenStorageVersion {
|
|
return nil, fmt.Errorf("%w: refresh token session has version %s instead of %s",
|
|
ErrInvalidRefreshTokenRequestVersion, session.Version, refreshTokenStorageVersion)
|
|
}
|
|
if session.Request.ID == "" {
|
|
return nil, fmt.Errorf("malformed refresh token session: %w", ErrInvalidRefreshTokenRequestData)
|
|
}
|
|
return session, nil
|
|
}
|
|
|
|
func (a *refreshTokenStorage) RevokeRefreshToken(ctx context.Context, requestID string) error {
|
|
return a.storage.DeleteByLabel(ctx, fositestorage.StorageRequestIDLabelName, requestID)
|
|
}
|
|
|
|
func (a *refreshTokenStorage) RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) error {
|
|
// We don't support a grace period, so always call the regular RevokeRefreshToken().
|
|
return a.RevokeRefreshToken(ctx, requestID)
|
|
}
|
|
|
|
func (a *refreshTokenStorage) CreateRefreshTokenSession(ctx context.Context, signature string, requester fosite.Requester) error {
|
|
request, err := fositestorage.ValidateAndExtractAuthorizeRequest(requester)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = a.storage.Create(
|
|
ctx,
|
|
signature,
|
|
&Session{Request: request, Version: refreshTokenStorageVersion},
|
|
map[string]string{fositestorage.StorageRequestIDLabelName: requester.GetID()},
|
|
nil,
|
|
)
|
|
return err
|
|
}
|
|
|
|
func (a *refreshTokenStorage) GetRefreshTokenSession(ctx context.Context, signature string, _ fosite.Session) (fosite.Requester, error) {
|
|
session, _, err := a.getSession(ctx, signature)
|
|
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return session.Request, err
|
|
}
|
|
|
|
func (a *refreshTokenStorage) DeleteRefreshTokenSession(ctx context.Context, signature string) error {
|
|
return a.storage.Delete(ctx, signature)
|
|
}
|
|
|
|
func (a *refreshTokenStorage) getSession(ctx context.Context, signature string) (*Session, string, error) {
|
|
session := newValidEmptyRefreshTokenSession()
|
|
rv, err := a.storage.Get(ctx, signature, session)
|
|
|
|
if errors.IsNotFound(err) {
|
|
return nil, "", fosite.ErrNotFound.WithWrap(err).WithDebug(err.Error())
|
|
}
|
|
|
|
if err != nil {
|
|
return nil, "", fmt.Errorf("failed to get refresh token session for %s: %w", signature, err)
|
|
}
|
|
|
|
if version := session.Version; version != refreshTokenStorageVersion {
|
|
return nil, "", fmt.Errorf("%w: refresh token session for %s has version %s instead of %s",
|
|
ErrInvalidRefreshTokenRequestVersion, signature, version, refreshTokenStorageVersion)
|
|
}
|
|
|
|
if session.Request.ID == "" {
|
|
return nil, "", fmt.Errorf("malformed refresh token session for %s: %w", signature, ErrInvalidRefreshTokenRequestData)
|
|
}
|
|
|
|
return session, rv, nil
|
|
}
|
|
|
|
func newValidEmptyRefreshTokenSession() *Session {
|
|
return &Session{
|
|
Request: &fosite.Request{
|
|
Client: &clientregistry.Client{},
|
|
Session: &psession.PinnipedSession{},
|
|
},
|
|
}
|
|
}
|