22fbced863
- For backwards compatibility with older Pinniped CLIs, the pinniped-cli
client does not need to request the username or groups scopes for them
to be granted. For dynamic clients, the usual OAuth2 rules apply:
the client must be allowed to request the scopes according to its
configuration, and the client must actually request the scopes in the
authorization request.
- If the username scope was not granted, then there will be no username
in the ID token, and the cluster-scoped token exchange will fail since
there would be no username in the resulting cluster-scoped ID token.
- The OIDC well-known discovery endpoint lists the username and groups
scopes in the scopes_supported list, and lists the username and groups
claims in the claims_supported list.
- Add username and groups scopes to the default list of scopes
put into kubeconfig files by "pinniped get kubeconfig" CLI command,
and the default list of scopes used by "pinniped login oidc" when
no list of scopes is specified in the kubeconfig file
- The warning header about group memberships changing during upstream
refresh will only be sent to the pinniped-cli client, since it is
only intended for kubectl and it could leak the username to the
client (which may not have the username scope granted) through the
warning message text.
- Add the user's username to the session storage as a new field, so that
during upstream refresh we can compare the original username from the
initial authorization to the refreshed username, even in the case when
the username scope was not granted (and therefore the username is not
stored in the ID token claims of the session storage)
- Bump the Supervisor session storage format version from 2 to 3
due to the username field being added to the session struct
- Extract commonly used string constants related to OIDC flows to api
package.
- Change some import names to make them consistent:
- Always import github.com/coreos/go-oidc/v3/oidc as "coreosoidc"
- Always import go.pinniped.dev/generated/latest/apis/supervisor/oidc
as "oidcapi"
- Always import go.pinniped.dev/internal/oidc as "oidc"
106 lines
3.1 KiB
Go
106 lines
3.1 KiB
Go
// Copyright 2020-2022 the Pinniped contributors. All Rights Reserved.
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package pkce
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"time"
|
|
|
|
"github.com/ory/fosite"
|
|
"github.com/ory/fosite/handler/pkce"
|
|
"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 = "pkce"
|
|
|
|
ErrInvalidPKCERequestVersion = constable.Error("pkce request data has wrong version")
|
|
ErrInvalidPKCERequestData = constable.Error("pkce 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.
|
|
pkceStorageVersion = "3"
|
|
)
|
|
|
|
var _ pkce.PKCERequestStorage = &pkceStorage{}
|
|
|
|
type pkceStorage 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) pkce.PKCERequestStorage {
|
|
return &pkceStorage{storage: crud.New(TypeLabelValue, secrets, clock, sessionStorageLifetime)}
|
|
}
|
|
|
|
func (a *pkceStorage) CreatePKCERequestSession(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: pkceStorageVersion}, nil)
|
|
return err
|
|
}
|
|
|
|
func (a *pkceStorage) GetPKCERequestSession(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 *pkceStorage) DeletePKCERequestSession(ctx context.Context, signature string) error {
|
|
return a.storage.Delete(ctx, signature)
|
|
}
|
|
|
|
func (a *pkceStorage) getSession(ctx context.Context, signature string) (*session, string, error) {
|
|
session := newValidEmptyPKCESession()
|
|
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 pkce session for %s: %w", signature, err)
|
|
}
|
|
|
|
if version := session.Version; version != pkceStorageVersion {
|
|
return nil, "", fmt.Errorf("%w: pkce session for %s has version %s instead of %s",
|
|
ErrInvalidPKCERequestVersion, signature, version, pkceStorageVersion)
|
|
}
|
|
|
|
if session.Request.ID == "" {
|
|
return nil, "", fmt.Errorf("malformed pkce session for %s: %w", signature, ErrInvalidPKCERequestData)
|
|
}
|
|
|
|
return session, rv, nil
|
|
}
|
|
|
|
func newValidEmptyPKCESession() *session {
|
|
return &session{
|
|
Request: &fosite.Request{
|
|
Client: &clientregistry.Client{},
|
|
Session: &psession.PinnipedSession{},
|
|
},
|
|
}
|
|
}
|