This repository has been archived on 2023-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
dex/storage/storage.go

337 lines
12 KiB
Go
Raw Normal View History

2016-07-25 20:00:28 +00:00
package storage
import (
"crypto/rand"
"encoding/base32"
"errors"
"io"
"strings"
"time"
jose "gopkg.in/square/go-jose.v2"
)
var (
2016-10-05 23:03:29 +00:00
// ErrNotFound is the error returned by storages if a resource cannot be found.
ErrNotFound = errors.New("not found")
2016-07-25 20:00:28 +00:00
2016-10-05 23:03:29 +00:00
// ErrAlreadyExists is the error returned by storages if a resource ID is taken during a create.
ErrAlreadyExists = errors.New("ID already exists")
)
2016-07-25 20:00:28 +00:00
// Kubernetes only allows lower case letters for names.
//
// TODO(ericchiang): refactor ID creation onto the storage.
var encoding = base32.NewEncoding("abcdefghijklmnopqrstuvwxyz234567")
2016-08-03 04:57:36 +00:00
// NewID returns a random string which can be used as an ID for objects.
func NewID() string {
buff := make([]byte, 16) // 128 bit random ID.
2016-07-25 20:00:28 +00:00
if _, err := io.ReadFull(rand.Reader, buff); err != nil {
panic(err)
}
// Avoid the identifier to begin with number and trim padding
return string(buff[0]%26+'a') + strings.TrimRight(encoding.EncodeToString(buff[1:]), "=")
2016-07-25 20:00:28 +00:00
}
// GCResult returns the number of objects deleted by garbage collection.
type GCResult struct {
AuthRequests int64
AuthCodes int64
}
// Storage is the storage interface used by the server. Implementations are
// required to be able to perform atomic compare-and-swap updates and either
// support timezones or standardize on UTC.
2016-07-25 20:00:28 +00:00
type Storage interface {
Close() error
// TODO(ericchiang): Let the storages set the IDs of these objects.
2016-07-25 20:00:28 +00:00
CreateAuthRequest(a AuthRequest) error
CreateClient(c Client) error
CreateAuthCode(c AuthCode) error
2016-08-03 04:57:36 +00:00
CreateRefresh(r RefreshToken) error
2016-10-05 23:03:29 +00:00
CreatePassword(p Password) error
CreateOfflineSessions(s OfflineSessions) error
CreateConnector(c Connector) error
2016-07-25 20:00:28 +00:00
// TODO(ericchiang): return (T, bool, error) so we can indicate not found
// requests that way instead of using ErrNotFound.
2016-07-25 20:00:28 +00:00
GetAuthRequest(id string) (AuthRequest, error)
GetAuthCode(id string) (AuthCode, error)
GetClient(id string) (Client, error)
GetKeys() (Keys, error)
2016-08-03 04:57:36 +00:00
GetRefresh(id string) (RefreshToken, error)
2016-10-05 23:03:29 +00:00
GetPassword(email string) (Password, error)
GetOfflineSessions(userID string, connID string) (OfflineSessions, error)
GetConnector(id string) (Connector, error)
2016-07-25 20:00:28 +00:00
ListClients() ([]Client, error)
2016-08-03 04:57:36 +00:00
ListRefreshTokens() ([]RefreshToken, error)
ListPasswords() ([]Password, error)
ListConnectors() ([]Connector, error)
2016-07-25 20:00:28 +00:00
// Delete methods MUST be atomic.
DeleteAuthRequest(id string) error
DeleteAuthCode(code string) error
DeleteClient(id string) error
DeleteRefresh(id string) error
2016-10-05 23:03:29 +00:00
DeletePassword(email string) error
DeleteOfflineSessions(userID string, connID string) error
DeleteConnector(id string) error
2016-07-25 20:00:28 +00:00
2016-10-28 20:00:13 +00:00
// Update methods take a function for updating an object then performs that update within
// a transaction. "updater" functions may be called multiple times by a single update call.
//
// Because new fields may be added to resources, updaters should only modify existing
// fields on the old object rather then creating new structs. For example:
//
// updater := func(old storage.Client) (storage.Client, error) {
// old.Secret = newSecret
// return old, nil
// }
// if err := s.UpdateClient(clientID, updater); err != nil {
// // update failed, handle error
// }
//
2016-07-25 20:00:28 +00:00
UpdateClient(id string, updater func(old Client) (Client, error)) error
UpdateKeys(updater func(old Keys) (Keys, error)) error
UpdateAuthRequest(id string, updater func(a AuthRequest) (AuthRequest, error)) error
UpdateRefreshToken(id string, updater func(r RefreshToken) (RefreshToken, error)) error
2016-10-05 23:03:29 +00:00
UpdatePassword(email string, updater func(p Password) (Password, error)) error
UpdateOfflineSessions(userID string, connID string, updater func(s OfflineSessions) (OfflineSessions, error)) error
UpdateConnector(id string, updater func(c Connector) (Connector, error)) error
// GarbageCollect deletes all expired AuthCodes and AuthRequests.
GarbageCollect(now time.Time) (GCResult, error)
2016-07-25 20:00:28 +00:00
}
// Client represents an OAuth2 client.
2016-07-25 20:00:28 +00:00
//
// For further reading see:
// * Trusted peers: https://developers.google.com/identity/protocols/CrossClientAuth
// * Public clients: https://developers.google.com/api-client-library/python/auth/installed-app
type Client struct {
// Client ID and secret used to identify the client.
ID string `json:"id" yaml:"id"`
Secret string `json:"secret" yaml:"secret"`
// A registered set of redirect URIs. When redirecting from dex to the client, the URI
// requested to redirect to MUST match one of these values, unless the client is "public".
RedirectURIs []string `json:"redirectURIs" yaml:"redirectURIs"`
2016-07-25 20:00:28 +00:00
// TrustedPeers are a list of peers which can issue tokens on this client's behalf using
// the dynamic "oauth2:server:client_id:(client_id)" scope. If a peer makes such a request,
// this client's ID will appear as the ID Token's audience.
//
2016-07-25 20:00:28 +00:00
// Clients inherently trust themselves.
TrustedPeers []string `json:"trustedPeers" yaml:"trustedPeers"`
2016-07-25 20:00:28 +00:00
// Public clients must use either use a redirectURL 127.0.0.1:X or "urn:ietf:wg:oauth:2.0:oob"
Public bool `json:"public" yaml:"public"`
2016-07-25 20:00:28 +00:00
// Name and LogoURL used when displaying this client to the end user.
Name string `json:"name" yaml:"name"`
LogoURL string `json:"logoURL" yaml:"logoURL"`
2016-07-25 20:00:28 +00:00
}
2016-08-03 04:57:36 +00:00
// Claims represents the ID Token claims supported by the server.
type Claims struct {
UserID string
Username string
PreferredUsername string
Email string
EmailVerified bool
2016-07-25 20:00:28 +00:00
Groups []string
}
// AuthRequest represents a OAuth2 client authorization request. It holds the state
// of a single auth flow up to the point that the user authorizes the client.
type AuthRequest struct {
// ID used to identify the authorization request.
ID string
// ID of the client requesting authorization from a user.
2016-07-25 20:00:28 +00:00
ClientID string
// Values parsed from the initial request. These describe the resources the client is
// requesting as well as values describing the form of the response.
2016-07-25 20:00:28 +00:00
ResponseTypes []string
Scopes []string
RedirectURI string
Nonce string
State string
2016-07-25 20:00:28 +00:00
// The client has indicated that the end user must be shown an approval prompt
// on all requests. The server cannot cache their initial action for subsequent
// attempts.
ForceApprovalPrompt bool
Expiry time.Time
// Has the user proved their identity through a backing identity provider?
//
// If false, the following fields are invalid.
LoggedIn bool
2016-07-25 20:00:28 +00:00
// The identity of the end user. Generally nil until the user authenticates
// with a backend.
Claims Claims
// The connector used to login the user and any data the connector wishes to persists.
// Set when the user authenticates.
ConnectorID string
ConnectorData []byte
2016-07-25 20:00:28 +00:00
}
// AuthCode represents a code which can be exchanged for an OAuth2 token response.
//
// This value is created once an end user has authorized a client, the server has
// redirect the end user back to the client, but the client hasn't exchanged the
// code for an access_token and id_token.
2016-07-25 20:00:28 +00:00
type AuthCode struct {
// Actual string returned as the "code" value.
2016-07-25 20:00:28 +00:00
ID string
// The client this code value is valid for. When exchanging the code for a
// token response, the client must use its client_secret to authenticate.
ClientID string
// As part of the OAuth2 spec when a client makes a token request it MUST
// present the same redirect_uri as the initial redirect. This values is saved
// to make this check.
//
// https://tools.ietf.org/html/rfc6749#section-4.1.3
RedirectURI string
2016-07-25 20:00:28 +00:00
// If provided by the client in the initial request, the provider MUST create
// a ID Token with this nonce in the JWT payload.
2016-07-25 20:00:28 +00:00
Nonce string
// Scopes authorized by the end user for the client.
2016-07-25 20:00:28 +00:00
Scopes []string
// Authentication data provided by an upstream source.
ConnectorID string
ConnectorData []byte
Claims Claims
2016-07-25 20:00:28 +00:00
Expiry time.Time
}
// RefreshToken is an OAuth2 refresh token which allows a client to request new
// tokens on the end user's behalf.
2016-08-03 04:57:36 +00:00
type RefreshToken struct {
ID string
// A single token that's rotated every time the refresh token is refreshed.
//
// May be empty.
Token string
CreatedAt time.Time
LastUsed time.Time
2016-07-25 20:00:28 +00:00
// Client this refresh token is valid for.
ClientID string
// Authentication data provided by an upstream source.
ConnectorID string
ConnectorData []byte
Claims Claims
2016-07-25 20:00:28 +00:00
// Scopes present in the initial request. Refresh requests may specify a set
// of scopes different from the initial request when refreshing a token,
// however those scopes must be encompassed by this set.
Scopes []string
// Nonce value supplied during the initial redirect. This is required to be part
// of the claims of any future id_token generated by the client.
2016-07-25 20:00:28 +00:00
Nonce string
}
// RefreshTokenRef is a reference object that contains metadata about refresh tokens.
type RefreshTokenRef struct {
ID string
// Client the refresh token is valid for.
ClientID string
CreatedAt time.Time
LastUsed time.Time
}
// OfflineSessions objects are sessions pertaining to users with refresh tokens.
type OfflineSessions struct {
// UserID of an end user who has logged in to the server.
UserID string
// The ID of the connector used to login the user.
ConnID string
// Refresh is a hash table of refresh token reference objects
// indexed by the ClientID of the refresh token.
Refresh map[string]*RefreshTokenRef
}
2016-10-05 23:03:29 +00:00
// Password is an email to password mapping managed by the storage.
type Password struct {
// Email and identifying name of the password. Emails are assumed to be valid and
// determining that an end-user controls the address is left to an outside application.
//
// Emails are case insensitive and should be standardized by the storage.
//
// Storages that don't support an extended character set for IDs, such as '.' and '@'
// (cough cough, kubernetes), must map this value appropriately.
Email string `json:"email"`
2016-10-05 23:03:29 +00:00
// Bcrypt encoded hash of the password. This package enforces a min cost value of 10
Hash []byte `json:"hash"`
2016-10-05 23:03:29 +00:00
// Optional username to display. NOT used during login.
Username string `json:"username"`
2016-10-05 23:03:29 +00:00
// Randomly generated user ID. This is NOT the primary ID of the Password object.
UserID string `json:"userID"`
2016-10-05 23:03:29 +00:00
}
// Connector is an object that contains the metadata about connectors used to login to Dex.
type Connector struct {
// ID that will uniquely identify the connector object.
ID string `json:"id"`
// The Type of the connector. E.g. 'oidc' or 'ldap'
Type string `json:"type"`
// The Name of the connector that is used when displaying it to the end user.
Name string `json:"name"`
// ResourceVersion is the static versioning used to keep track of dynamic configuration
// changes to the connector object made by the API calls.
ResourceVersion string `json:"resourceVersion"`
// Config holds all the configuration information specific to the connector type. Since there
// no generic struct we can use for this purpose, it is stored as a byte stream.
Config []byte `json:"email"`
}
2016-07-25 20:00:28 +00:00
// VerificationKey is a rotated signing key which can still be used to verify
// signatures.
type VerificationKey struct {
PublicKey *jose.JSONWebKey `json:"publicKey"`
Expiry time.Time `json:"expiry"`
}
// Keys hold encryption and signing keys.
type Keys struct {
// Key for creating and verifying signatures. These may be nil.
SigningKey *jose.JSONWebKey
SigningKeyPub *jose.JSONWebKey
2016-07-25 20:00:28 +00:00
// Old signing keys which have been rotated but can still be used to validate
// existing signatures.
VerificationKeys []VerificationKey
// The next time the signing key will rotate.
//
// For caching purposes, implementations MUST NOT update keys before this time.
NextRotation time.Time
}