Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

storage

package

Go to main page

Versions in this module

v3

v3.5.0

Jan 12, 2024

v3.4.0

Jan 12, 2024

v3.3.0

Jan 12, 2024

Changes in this version

type UserStore

+ Users func() map[string]*T

v3.2.0

Jan 12, 2024

v3.1.0

Jun 13, 2023

Changes in this version

+ const CustomScopeImpersonatePrefix

+ var StorageErrors struct

+ func AppendClaim(claims map[string]interface{}, claim string, value interface{}) map[string]interface

+ func CodeChallengeToOIDC(challenge *OIDCCodeChallenge) *oidc.CodeChallenge

+ func MaxAgeToInternal(maxAge *uint) *time.Duration

+ func PromptToInternal(oidcPrompt oidc.SpaceDelimitedArray) []string

+ func RedirectGlobsClient(client *Client) op.Client

+ func RefreshTokenRequestFromBusiness(token *RefreshToken) op.RefreshTokenRequest

+ func RegisterClients(registerClients ...*Client)

+ type AuthRequest struct

+ ApplicationID string

+ CallbackURI string

+ CodeChallenge *OIDCCodeChallenge

+ CreationDate time.Time

+ ID string

+ LoginHint string

+ MaxAuthAge *time.Duration

+ Nonce string

+ Prompt []string

+ ResponseType oidc.ResponseType

+ Scopes []string

+ TransferState string

+ UiLocales []language.Tag

+ UserID string

+ func (a *AuthRequest) Done() bool

+ func (a *AuthRequest) GetACR() string

+ func (a *AuthRequest) GetAMR() []string

+ func (a *AuthRequest) GetAudience() []string

+ func (a *AuthRequest) GetAuthTime() time.Time

+ func (a *AuthRequest) GetClientID() string

+ func (a *AuthRequest) GetCodeChallenge() *oidc.CodeChallenge

+ func (a *AuthRequest) GetID() string

+ func (a *AuthRequest) GetNonce() string

+ func (a *AuthRequest) GetRedirectURI() string

+ func (a *AuthRequest) GetResponseMode() oidc.ResponseMode

+ func (a *AuthRequest) GetResponseType() oidc.ResponseType

+ func (a *AuthRequest) GetScopes() []string

+ func (a *AuthRequest) GetState() string

+ func (a *AuthRequest) GetSubject() string

+ type Client struct

+ func DeviceClient(id, secret, pathPrefix string) *Client

+ func NativeClient(id string, pathPrefix string, redirectURIs ...string) *Client

+ func WebClient(id, secret string, pathPrefix string, redirectURIs ...string) *Client

+ func (c *Client) AccessTokenType() op.AccessTokenType

+ func (c *Client) ApplicationType() op.ApplicationType

+ func (c *Client) AuthMethod() oidc.AuthMethod

+ func (c *Client) ClockSkew() time.Duration

+ func (c *Client) DevMode() bool

+ func (c *Client) GetID() string

+ func (c *Client) GrantTypes() []oidc.GrantType

+ func (c *Client) IDTokenLifetime() time.Duration

+ func (c *Client) IDTokenUserinfoClaimsAssertion() bool

+ func (c *Client) IsScopeAllowed(scope string) bool

+ func (c *Client) LoginURL(id string) string

+ func (c *Client) PostLogoutRedirectURIs() []string

+ func (c *Client) RedirectURIs() []string

+ func (c *Client) ResponseTypes() []oidc.ResponseType

+ func (c *Client) RestrictAdditionalAccessTokenScopes() func(scopes []string) []string

+ func (c *Client) RestrictAdditionalIdTokenScopes() func(scopes []string) []string

+ type GetPrivateClaimsFromScopesFunc func(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]interface{}, err error)

+ type OIDCCodeChallenge struct

+ Challenge string

+ Method string

+ type RefreshToken struct

+ AMR []string

+ ApplicationID string

+ Audience []string

+ AuthTime time.Time

+ Expiration time.Time

+ ID string

+ Scopes []string

+ Token string

+ UserID string

+ type RefreshTokenRequest struct

+ func (r *RefreshTokenRequest) GetAMR() []string

+ func (r *RefreshTokenRequest) GetAudience() []string

+ func (r *RefreshTokenRequest) GetAuthTime() time.Time

+ func (r *RefreshTokenRequest) GetClientID() string

+ func (r *RefreshTokenRequest) GetScopes() []string

+ func (r *RefreshTokenRequest) GetSubject() string

+ func (r *RefreshTokenRequest) SetCurrentScopes(scopes []string)

+ type Service struct

+ type SetUserInfoFunc func(user *T, userInfo *oidc.UserInfo, scope string, clientID string)

+ type Storage struct

+ func NewStorage(userStore UserStore[T], setUserInfoFunc SetUserInfoFunc[T], ...) *Storage[T]

+ func (s *Storage[T]) AuthRequestByCode(ctx context.Context, code string) (op.AuthRequest, error)

+ func (s *Storage[T]) AuthRequestByID(ctx context.Context, id string) (op.AuthRequest, error)

+ func (s *Storage[T]) AuthRequestDone(id string) error

+ func (s *Storage[T]) AuthorizeClientIDSecret(ctx context.Context, clientID, clientSecret string) error

+ func (s *Storage[T]) CheckUsernamePassword(username, password, id string) error

+ func (s *Storage[T]) CheckUsernamePasswordSimple(username, password string) error

+ func (s *Storage[T]) ClientCredentials(ctx context.Context, clientID, clientSecret string) (op.Client, error)

+ func (s *Storage[T]) ClientCredentialsTokenRequest(ctx context.Context, clientID string, scopes []string) (op.TokenRequest, error)

+ func (s *Storage[T]) CompleteDeviceAuthorization(ctx context.Context, userCode, subject string) error

+ func (s *Storage[T]) CreateAccessAndRefreshTokens(ctx context.Context, request op.TokenRequest, currentRefreshToken string) (accessTokenID string, newRefreshToken string, expiration time.Time, err error)

+ func (s *Storage[T]) CreateAccessToken(ctx context.Context, request op.TokenRequest) (string, time.Time, error)

+ func (s *Storage[T]) CreateAuthRequest(ctx context.Context, authReq *oidc.AuthRequest, userID string) (op.AuthRequest, error)

+ func (s *Storage[T]) CreateTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) error

+ func (s *Storage[T]) DeleteAuthRequest(ctx context.Context, id string) error

+ func (s *Storage[T]) DenyDeviceAuthorization(ctx context.Context, userCode string) error

+ func (s *Storage[T]) GetClientByClientID(ctx context.Context, clientID string) (op.Client, error)

+ func (s *Storage[T]) GetDeviceAuthorizationByUserCode(ctx context.Context, userCode string) (*op.DeviceAuthorizationState, error)

+ func (s *Storage[T]) GetDeviceAuthorizatonState(ctx context.Context, clientID, deviceCode string) (*op.DeviceAuthorizationState, error)

+ func (s *Storage[T]) GetKeyByIDAndClientID(ctx context.Context, keyID, clientID string) (*jose.JSONWebKey, error)

+ func (s *Storage[T]) GetPrivateClaimsFromScopes(ctx context.Context, userID, clientID string, scopes []string) (claims map[string]interface{}, err error)

+ func (s *Storage[T]) GetPrivateClaimsFromTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) (claims map[string]interface{}, err error)

+ func (s *Storage[T]) GetRefreshTokenInfo(ctx context.Context, clientID string, token string) (userID string, tokenID string, err error)

+ func (s *Storage[T]) Health(ctx context.Context) error

+ func (s *Storage[T]) KeySet(ctx context.Context) ([]op.Key, error)

+ func (s *Storage[T]) RevokeToken(ctx context.Context, tokenIDOrToken string, userID string, clientID string) *oidc.Error

+ func (s *Storage[T]) SaveAuthCode(ctx context.Context, id string, code string) error

+ func (s *Storage[T]) SetIntrospectionFromToken(ctx context.Context, introspection *oidc.IntrospectionResponse, ...) error

+ func (s *Storage[T]) SetUserinfoFromRequest(ctx context.Context, userinfo *oidc.UserInfo, token op.IDTokenRequest, ...) error

+ func (s *Storage[T]) SetUserinfoFromScopes(ctx context.Context, userinfo *oidc.UserInfo, userID, clientID string, ...) error

+ func (s *Storage[T]) SetUserinfoFromToken(ctx context.Context, userinfo *oidc.UserInfo, tokenID, subject, origin string) error

+ func (s *Storage[T]) SetUserinfoFromTokenExchangeRequest(ctx context.Context, userinfo *oidc.UserInfo, request op.TokenExchangeRequest) error

+ func (s *Storage[T]) SignatureAlgorithms(context.Context) ([]jose.SignatureAlgorithm, error)

+ func (s *Storage[T]) SigningKey(ctx context.Context) (op.SigningKey, error)

+ func (s *Storage[T]) StoreDeviceAuthorization(ctx context.Context, clientID, deviceCode, userCode string, expires time.Time, ...) error

+ func (s *Storage[T]) TerminateSession(ctx context.Context, userID string, clientID string) error

+ func (s *Storage[T]) TokenRequestByRefreshToken(ctx context.Context, refreshToken string) (op.RefreshTokenRequest, error)

+ func (s *Storage[T]) ValidateJWTProfileScopes(ctx context.Context, userID string, scopes []string) ([]string, error)

+ func (s *Storage[T]) ValidateTokenExchangeRequest(ctx context.Context, request op.TokenExchangeRequest) error

+ type Token struct

+ ApplicationID string

+ Audience []string

+ Expiration time.Time

+ ID string

+ RefreshTokenID string

+ Scopes []string

+ Subject string

+ type User interface

+ ID func() string

+ IsAdmin func() bool

+ Password func() string

+ Username func() string

+ type UserStore interface

+ ExampleClientID func() string

+ GetUserByID func(string) *T

+ GetUserByUsername func(string) *T

+ func NewUserStore(issuer string, dataDir string) (UserStore[T], error)

Other modules containing this package

github.com/danicc097/oidc-server