Documentation
¶
Index ¶
- Constants
- func AccessTokenJWTToRequest(token *jwt.Token) fosite.Requester
- type AccessTokenStorage
- type AccessTokenStorageProvider
- type AccessTokenStrategy
- type AccessTokenStrategyProvider
- type AuthorizeCodeStorage
- type AuthorizeCodeStorageProvider
- type AuthorizeCodeStrategy
- type AuthorizeCodeStrategyProvider
- type AuthorizeExplicitGrantHandler
- func (c *AuthorizeExplicitGrantHandler) CanHandleTokenEndpointRequest(_ context.Context, requester fosite.AccessRequester) bool
- func (c *AuthorizeExplicitGrantHandler) CanSkipClientAuth(_ context.Context, _ fosite.AccessRequester) bool
- func (c *AuthorizeExplicitGrantHandler) GetSanitationWhiteList(ctx context.Context) []string
- func (c *AuthorizeExplicitGrantHandler) HandleAuthorizeEndpointRequest(ctx context.Context, ar fosite.AuthorizeRequester, ...) error
- func (c *AuthorizeExplicitGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
- func (c *AuthorizeExplicitGrantHandler) IssueAuthorizeCode(ctx context.Context, ar fosite.AuthorizeRequester, ...) error
- func (c *AuthorizeExplicitGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, ...) (err error)
- type AuthorizeImplicitGrantHandler
- type ClientCredentialsGrantHandler
- func (c *ClientCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
- func (c *ClientCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, requester fosite.AccessRequester) bool
- func (c *ClientCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
- func (c *ClientCredentialsGrantHandler) IssueAccessToken(ctx context.Context, atLifespan time.Duration, ...) (signature string, err error)
- func (c *ClientCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, request fosite.AccessRequester, ...) error
- type CoreStrategy
- type CoreStrategyProvider
- type CoreValidator
- type DefaultJWTStrategy
- func (h *DefaultJWTStrategy) AccessTokenSignature(_ context.Context, token string) string
- func (h *DefaultJWTStrategy) GenerateAccessToken(ctx context.Context, requester fosite.Requester) (token string, signature string, err error)
- func (h *DefaultJWTStrategy) ValidateAccessToken(ctx context.Context, _ fosite.Requester, token string) error
- type HMACSHAStrategy
- func (h *HMACSHAStrategy) GenerateAccessToken(ctx context.Context, r fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategy) GenerateAuthorizeCode(ctx context.Context, r fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategy) GenerateRefreshToken(ctx context.Context, r fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategy) ValidateAccessToken(ctx context.Context, r fosite.Requester, token string) (err error)
- func (h *HMACSHAStrategy) ValidateAuthorizeCode(ctx context.Context, r fosite.Requester, token string) (err error)
- func (h *HMACSHAStrategy) ValidateRefreshToken(ctx context.Context, r fosite.Requester, token string) (err error)
- type HMACSHAStrategyUnPrefixed
- func (h *HMACSHAStrategyUnPrefixed) AccessTokenSignature(ctx context.Context, token string) string
- func (h *HMACSHAStrategyUnPrefixed) AuthorizeCodeSignature(ctx context.Context, token string) string
- func (h *HMACSHAStrategyUnPrefixed) GenerateAccessToken(ctx context.Context, _ fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategyUnPrefixed) GenerateAuthorizeCode(ctx context.Context, _ fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategyUnPrefixed) GenerateRefreshToken(ctx context.Context, _ fosite.Requester) (token string, signature string, err error)
- func (h *HMACSHAStrategyUnPrefixed) RefreshTokenSignature(ctx context.Context, token string) string
- func (h *HMACSHAStrategyUnPrefixed) ValidateAccessToken(ctx context.Context, r fosite.Requester, token string) (err error)
- func (h *HMACSHAStrategyUnPrefixed) ValidateAuthorizeCode(ctx context.Context, r fosite.Requester, token string) (err error)
- func (h *HMACSHAStrategyUnPrefixed) ValidateRefreshToken(ctx context.Context, r fosite.Requester, token string) (err error)
- type HandleHelper
- type HandleHelperConfigProvider
- type JWTSession
- func (j *JWTSession) Clone() fosite.Session
- func (j *JWTSession) GetExpiresAt(key fosite.TokenType) time.Time
- func (s *JWTSession) GetExtraClaims() map[string]interface{}
- func (j *JWTSession) GetJWTClaims() jwt.JWTClaimsContainer
- func (j *JWTSession) GetJWTHeader() *jwt.Headers
- func (j *JWTSession) GetSubject() string
- func (j *JWTSession) GetUsername() string
- func (j *JWTSession) SetExpiresAt(key fosite.TokenType, exp time.Time)
- func (j *JWTSession) SetSubject(subject string)
- type JWTSessionContainer
- type LifespanConfigProvider
- type RFC9068JWTStrategy
- type RefreshTokenGrantHandler
- func (c *RefreshTokenGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
- func (c *RefreshTokenGrantHandler) CanSkipClientAuth(ctx context.Context, requester fosite.AccessRequester) bool
- func (c *RefreshTokenGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
- func (c *RefreshTokenGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, ...) (err error)
- type RefreshTokenStorage
- type RefreshTokenStorageProvider
- type RefreshTokenStrategy
- type RefreshTokenStrategyProvider
- type ResourceOwnerPasswordCredentialsGrantHandlerdeprecated
- func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
- func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, _ fosite.AccessRequester) bool
- func (c *ResourceOwnerPasswordCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
- func (c *ResourceOwnerPasswordCredentialsGrantHandler) IssueAccessToken(ctx context.Context, atLifespan time.Duration, ...) (signature string, err error)
- func (c *ResourceOwnerPasswordCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, ...) error
- type ResourceOwnerPasswordCredentialsGrantStorage
- type ResourceOwnerPasswordCredentialsGrantStorageProvider
- type Session
- type StatelessJWTValidator
- type TokenRevocationHandler
- type TokenRevocationStorage
- type TokenRevocationStorageProvider
Constants ¶
const RFC9068JWTType = "at+jwt"
RFC9068JWTType is the media type used to identify RFC 9068 access tokens in the JWT typ header
Variables ¶
This section is empty.
Functions ¶
Types ¶
type AccessTokenStorage ¶
type AccessTokenStorage interface {
CreateAccessTokenSession(ctx context.Context, signature string, request fosite.Requester) (err error)
GetAccessTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
DeleteAccessTokenSession(ctx context.Context, signature string) (err error)
}
type AccessTokenStorageProvider ¶
type AccessTokenStorageProvider interface {
AccessTokenStorage() AccessTokenStorage
}
type AccessTokenStrategy ¶
type AccessTokenStrategy interface {
AccessTokenSignature(ctx context.Context, token string) string
GenerateAccessToken(ctx context.Context, requester fosite.Requester) (token string, signature string, err error)
ValidateAccessToken(ctx context.Context, requester fosite.Requester, token string) (err error)
}
type AccessTokenStrategyProvider ¶
type AccessTokenStrategyProvider interface {
AccessTokenStrategy() AccessTokenStrategy
}
type AuthorizeCodeStorage ¶
type AuthorizeCodeStorage interface {
// CreateAuthorizeCodeSession stores the authorization request keyed by signature.
CreateAuthorizeCodeSession(ctx context.Context, signature string, request fosite.Requester) (err error)
// GetAuthorizeCodeSession hydrates the session for an authorization code and returns
// the authorization request. code is the original opaque code string from the client;
// signature is the strategy-derived lookup key. Implementations that key sessions in a
// database use signature; implementations that decode session state from the code
// itself (e.g., AEAD-encoded codes) use code.
//
// If the authorization code has been invalidated with `InvalidateAuthorizeCodeSession`, this
// method should return the ErrInvalidatedAuthorizeCode error.
//
// Make sure to also return the fosite.Requester value when returning the fosite.ErrInvalidatedAuthorizeCode error!
GetAuthorizeCodeSession(ctx context.Context, code, signature string, session fosite.Session) (request fosite.Requester, err error)
// InvalidateAuthorizeCodeSession is called when an authorize code is being used. The state of the authorization
// code should be set to invalid and consecutive requests to GetAuthorizeCodeSession should return the
// ErrInvalidatedAuthorizeCode error.
//
// code is the original opaque code; signature is the lookup key. Implementations that
// record redemption state derived from the code's contents (e.g., a replay-marker row
// whose fields come from the AEAD payload) use code; implementations that mutate a row
// by PK use signature.
InvalidateAuthorizeCodeSession(ctx context.Context, code, signature string) (err error)
}
AuthorizeCodeStorage handles storage requests related to authorization codes.
The /token-side methods receive both the original opaque authorization code and its strategy-derived signature. The default SQL persister keys rows by signature.
type AuthorizeCodeStorageProvider ¶
type AuthorizeCodeStorageProvider interface {
AuthorizeCodeStorage() AuthorizeCodeStorage
}
type AuthorizeCodeStrategy ¶
type AuthorizeCodeStrategy interface {
AuthorizeCodeSignature(ctx context.Context, token string) string
GenerateAuthorizeCode(ctx context.Context, requester fosite.Requester) (token string, signature string, err error)
ValidateAuthorizeCode(ctx context.Context, requester fosite.Requester, token string) (err error)
}
type AuthorizeCodeStrategyProvider ¶
type AuthorizeCodeStrategyProvider interface {
AuthorizeCodeStrategy() AuthorizeCodeStrategy
}
type AuthorizeExplicitGrantHandler ¶
type AuthorizeExplicitGrantHandler struct {
Storage interface {
fosite.Transactional
AuthorizeCodeStorageProvider
AccessTokenStorageProvider
RefreshTokenStorageProvider
TokenRevocationStorageProvider
}
Strategy CoreStrategyProvider
Config interface {
fosite.AuthorizeCodeLifespanProvider
fosite.AccessTokenLifespanProvider
fosite.RefreshTokenLifespanProvider
fosite.ScopeStrategyProvider
fosite.AudienceStrategyProvider
fosite.RedirectSecureCheckerProvider
fosite.RefreshTokenScopesProvider
fosite.OmitRedirectScopeParamProvider
fosite.SanitationAllowedProvider
}
}
AuthorizeExplicitGrantHandler is a response handler for the Authorize Code grant using the explicit grant type as defined in https://tools.ietf.org/html/rfc6749#section-4.1
func (*AuthorizeExplicitGrantHandler) CanHandleTokenEndpointRequest ¶
func (c *AuthorizeExplicitGrantHandler) CanHandleTokenEndpointRequest(_ context.Context, requester fosite.AccessRequester) bool
func (*AuthorizeExplicitGrantHandler) CanSkipClientAuth ¶
func (c *AuthorizeExplicitGrantHandler) CanSkipClientAuth(_ context.Context, _ fosite.AccessRequester) bool
func (*AuthorizeExplicitGrantHandler) GetSanitationWhiteList ¶
func (c *AuthorizeExplicitGrantHandler) GetSanitationWhiteList(ctx context.Context) []string
func (*AuthorizeExplicitGrantHandler) HandleAuthorizeEndpointRequest ¶
func (c *AuthorizeExplicitGrantHandler) HandleAuthorizeEndpointRequest(ctx context.Context, ar fosite.AuthorizeRequester, resp fosite.AuthorizeResponder) error
func (*AuthorizeExplicitGrantHandler) HandleTokenEndpointRequest ¶
func (c *AuthorizeExplicitGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
HandleTokenEndpointRequest implements * https://tools.ietf.org/html/rfc6749#section-4.1.3 (everything)
func (*AuthorizeExplicitGrantHandler) IssueAuthorizeCode ¶
func (c *AuthorizeExplicitGrantHandler) IssueAuthorizeCode(ctx context.Context, ar fosite.AuthorizeRequester, resp fosite.AuthorizeResponder) error
func (*AuthorizeExplicitGrantHandler) PopulateTokenEndpointResponse ¶
func (c *AuthorizeExplicitGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, responder fosite.AccessResponder) (err error)
type AuthorizeImplicitGrantHandler ¶
type AuthorizeImplicitGrantHandler struct {
Strategy AccessTokenStrategyProvider
Storage AccessTokenStorageProvider
Config interface {
fosite.AccessTokenLifespanProvider
fosite.ScopeStrategyProvider
fosite.AudienceStrategyProvider
}
}
AuthorizeImplicitGrantHandler is a response handler for the Authorize Code grant using the implicit grant type as defined in https://tools.ietf.org/html/rfc6749#section-4.2
func (*AuthorizeImplicitGrantHandler) HandleAuthorizeEndpointRequest ¶
func (c *AuthorizeImplicitGrantHandler) HandleAuthorizeEndpointRequest(ctx context.Context, ar fosite.AuthorizeRequester, resp fosite.AuthorizeResponder) error
func (*AuthorizeImplicitGrantHandler) IssueImplicitAccessToken ¶
func (c *AuthorizeImplicitGrantHandler) IssueImplicitAccessToken(ctx context.Context, ar fosite.AuthorizeRequester, resp fosite.AuthorizeResponder) error
type ClientCredentialsGrantHandler ¶
type ClientCredentialsGrantHandler struct {
Storage AccessTokenStorageProvider
Strategy AccessTokenStrategyProvider
Config interface {
fosite.ScopeStrategyProvider
fosite.AudienceStrategyProvider
fosite.AccessTokenLifespanProvider
fosite.RefreshTokenLifespanProvider
}
}
func (*ClientCredentialsGrantHandler) CanHandleTokenEndpointRequest ¶
func (c *ClientCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
func (*ClientCredentialsGrantHandler) CanSkipClientAuth ¶
func (c *ClientCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, requester fosite.AccessRequester) bool
func (*ClientCredentialsGrantHandler) HandleTokenEndpointRequest ¶
func (c *ClientCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
IntrospectTokenEndpointRequest implements https://tools.ietf.org/html/rfc6749#section-4.4.2
func (*ClientCredentialsGrantHandler) IssueAccessToken ¶
func (c *ClientCredentialsGrantHandler) IssueAccessToken(ctx context.Context, atLifespan time.Duration, requester fosite.AccessRequester, responder fosite.AccessResponder) (signature string, err error)
func (*ClientCredentialsGrantHandler) PopulateTokenEndpointResponse ¶
func (c *ClientCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, request fosite.AccessRequester, response fosite.AccessResponder) error
PopulateTokenEndpointResponse implements https://tools.ietf.org/html/rfc6749#section-4.4.3
type CoreStrategy ¶
type CoreStrategy interface {
AuthorizeCodeStrategy
AccessTokenStrategy
RefreshTokenStrategy
}
type CoreStrategyProvider ¶
type CoreStrategyProvider interface {
AuthorizeCodeStrategyProvider
AccessTokenStrategyProvider
RefreshTokenStrategyProvider
}
type CoreValidator ¶
type CoreValidator struct {
Storage interface {
AccessTokenStorageProvider
RefreshTokenStorageProvider
}
Strategy interface {
AccessTokenStrategyProvider
RefreshTokenStrategyProvider
}
Config interface {
fosite.ScopeStrategyProvider
fosite.DisableRefreshTokenValidationProvider
}
}
func (*CoreValidator) IntrospectToken ¶
type DefaultJWTStrategy ¶
type DefaultJWTStrategy struct {
Signer jwt.Signer
Config interface {
fosite.AccessTokenIssuerProvider
fosite.JWTScopeFieldProvider
}
}
DefaultJWTStrategy is a JWT RS256 strategy.
func (*DefaultJWTStrategy) AccessTokenSignature ¶
func (h *DefaultJWTStrategy) AccessTokenSignature(_ context.Context, token string) string
func (*DefaultJWTStrategy) GenerateAccessToken ¶
func (*DefaultJWTStrategy) ValidateAccessToken ¶
type HMACSHAStrategy ¶
type HMACSHAStrategy struct {
*HMACSHAStrategyUnPrefixed
}
func NewHMACSHAStrategy ¶
func NewHMACSHAStrategy( enigma *enigma.HMACStrategy, config LifespanConfigProvider, ) *HMACSHAStrategy
func (*HMACSHAStrategy) GenerateAccessToken ¶
func (*HMACSHAStrategy) GenerateAuthorizeCode ¶
func (*HMACSHAStrategy) GenerateRefreshToken ¶
func (*HMACSHAStrategy) ValidateAccessToken ¶
func (*HMACSHAStrategy) ValidateAuthorizeCode ¶
func (*HMACSHAStrategy) ValidateRefreshToken ¶
type HMACSHAStrategyUnPrefixed ¶
type HMACSHAStrategyUnPrefixed struct {
Enigma *enigma.HMACStrategy
Config LifespanConfigProvider
}
func NewHMACSHAStrategyUnPrefixed ¶
func NewHMACSHAStrategyUnPrefixed( enigma *enigma.HMACStrategy, config LifespanConfigProvider, ) *HMACSHAStrategyUnPrefixed
func (*HMACSHAStrategyUnPrefixed) AccessTokenSignature ¶
func (h *HMACSHAStrategyUnPrefixed) AccessTokenSignature(ctx context.Context, token string) string
func (*HMACSHAStrategyUnPrefixed) AuthorizeCodeSignature ¶
func (h *HMACSHAStrategyUnPrefixed) AuthorizeCodeSignature(ctx context.Context, token string) string
func (*HMACSHAStrategyUnPrefixed) GenerateAccessToken ¶
func (*HMACSHAStrategyUnPrefixed) GenerateAuthorizeCode ¶
func (*HMACSHAStrategyUnPrefixed) GenerateRefreshToken ¶
func (*HMACSHAStrategyUnPrefixed) RefreshTokenSignature ¶
func (h *HMACSHAStrategyUnPrefixed) RefreshTokenSignature(ctx context.Context, token string) string
func (*HMACSHAStrategyUnPrefixed) ValidateAccessToken ¶
func (*HMACSHAStrategyUnPrefixed) ValidateAuthorizeCode ¶
func (*HMACSHAStrategyUnPrefixed) ValidateRefreshToken ¶
type HandleHelper ¶
type HandleHelper struct {
AccessTokenStrategy AccessTokenStrategy
Storage AccessTokenStorageProvider
Config HandleHelperConfigProvider
}
func (*HandleHelper) IssueAccessToken ¶
func (h *HandleHelper) IssueAccessToken(ctx context.Context, defaultLifespan time.Duration, requester fosite.AccessRequester, responder fosite.AccessResponder) (signature string, err error)
type HandleHelperConfigProvider ¶
type HandleHelperConfigProvider interface {
fosite.AccessTokenLifespanProvider
fosite.RefreshTokenLifespanProvider
}
type JWTSession ¶
type JWTSession struct {
JWTClaims *jwt.JWTClaims
JWTHeader *jwt.Headers
ExpiresAt map[fosite.TokenType]time.Time
Username string
Subject string
}
JWTSession Container for the JWT session.
func (*JWTSession) Clone ¶
func (j *JWTSession) Clone() fosite.Session
func (*JWTSession) GetExpiresAt ¶
func (j *JWTSession) GetExpiresAt(key fosite.TokenType) time.Time
func (*JWTSession) GetExtraClaims ¶
func (s *JWTSession) GetExtraClaims() map[string]interface{}
GetExtraClaims implements ExtraClaimsSession for JWTSession. The returned value is a copy of JWTSession claims.
func (*JWTSession) GetJWTClaims ¶
func (j *JWTSession) GetJWTClaims() jwt.JWTClaimsContainer
func (*JWTSession) GetJWTHeader ¶
func (j *JWTSession) GetJWTHeader() *jwt.Headers
func (*JWTSession) GetSubject ¶
func (j *JWTSession) GetSubject() string
func (*JWTSession) GetUsername ¶
func (j *JWTSession) GetUsername() string
func (*JWTSession) SetExpiresAt ¶
func (j *JWTSession) SetExpiresAt(key fosite.TokenType, exp time.Time)
func (*JWTSession) SetSubject ¶
func (j *JWTSession) SetSubject(subject string)
type JWTSessionContainer ¶
type LifespanConfigProvider ¶
type LifespanConfigProvider interface {
fosite.AccessTokenLifespanProvider
fosite.RefreshTokenLifespanProvider
fosite.AuthorizeCodeLifespanProvider
}
type RFC9068JWTStrategy ¶
type RFC9068JWTStrategy struct {
*DefaultJWTStrategy
}
RFC9068JWTStrategy issues JWT access tokens conforming to RFC 9068
func (*RFC9068JWTStrategy) GenerateAccessToken ¶
type RefreshTokenGrantHandler ¶
type RefreshTokenGrantHandler struct {
Strategy interface {
AccessTokenStrategyProvider
RefreshTokenStrategyProvider
}
Storage interface {
fosite.Transactional
TokenRevocationStorageProvider
AccessTokenStorageProvider
RefreshTokenStorageProvider
}
Config interface {
fosite.AccessTokenLifespanProvider
fosite.RefreshTokenLifespanProvider
fosite.ScopeStrategyProvider
fosite.AudienceStrategyProvider
fosite.RefreshTokenScopesProvider
fosite.IgnoreUnknownScopesProvider
}
}
func (*RefreshTokenGrantHandler) CanHandleTokenEndpointRequest ¶
func (c *RefreshTokenGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
func (*RefreshTokenGrantHandler) CanSkipClientAuth ¶
func (c *RefreshTokenGrantHandler) CanSkipClientAuth(ctx context.Context, requester fosite.AccessRequester) bool
func (*RefreshTokenGrantHandler) HandleTokenEndpointRequest ¶
func (c *RefreshTokenGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
HandleTokenEndpointRequest implements https://tools.ietf.org/html/rfc6749#section-6
func (*RefreshTokenGrantHandler) PopulateTokenEndpointResponse ¶
func (c *RefreshTokenGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, responder fosite.AccessResponder) (err error)
PopulateTokenEndpointResponse implements https://tools.ietf.org/html/rfc6749#section-6
type RefreshTokenStorage ¶
type RefreshTokenStorage interface {
CreateRefreshTokenSession(ctx context.Context, signature string, accessSignature string, request fosite.Requester) (err error)
GetRefreshTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
DeleteRefreshTokenSession(ctx context.Context, signature string) (err error)
RotateRefreshToken(ctx context.Context, requestID string, refreshTokenSignature string) (err error)
}
type RefreshTokenStorageProvider ¶
type RefreshTokenStorageProvider interface {
RefreshTokenStorage() RefreshTokenStorage
}
type RefreshTokenStrategy ¶
type RefreshTokenStrategy interface {
RefreshTokenSignature(ctx context.Context, token string) string
GenerateRefreshToken(ctx context.Context, requester fosite.Requester) (token string, signature string, err error)
ValidateRefreshToken(ctx context.Context, requester fosite.Requester, token string) (err error)
}
type RefreshTokenStrategyProvider ¶
type RefreshTokenStrategyProvider interface {
RefreshTokenStrategy() RefreshTokenStrategy
}
type ResourceOwnerPasswordCredentialsGrantHandler
deprecated
type ResourceOwnerPasswordCredentialsGrantHandler struct {
Storage interface {
ResourceOwnerPasswordCredentialsGrantStorageProvider
AccessTokenStorageProvider
RefreshTokenStorageProvider
}
Strategy interface {
AccessTokenStrategyProvider
RefreshTokenStrategyProvider
}
Config interface {
fosite.ScopeStrategyProvider
fosite.AudienceStrategyProvider
fosite.RefreshTokenScopesProvider
fosite.RefreshTokenLifespanProvider
fosite.AccessTokenLifespanProvider
}
}
Deprecated: This handler is deprecated as a means to communicate that the ROPC grant type is widely discouraged and is at the time of this writing going to be omitted in the OAuth 2.1 spec. For more information on why this grant type is discouraged see: https://www.scottbrady91.com/oauth/why-the-resource-owner-password-credentials-grant-type-is-not-authentication-nor-suitable-for-modern-applications
func (*ResourceOwnerPasswordCredentialsGrantHandler) CanHandleTokenEndpointRequest ¶
func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester fosite.AccessRequester) bool
func (*ResourceOwnerPasswordCredentialsGrantHandler) CanSkipClientAuth ¶
func (c *ResourceOwnerPasswordCredentialsGrantHandler) CanSkipClientAuth(ctx context.Context, _ fosite.AccessRequester) bool
func (*ResourceOwnerPasswordCredentialsGrantHandler) HandleTokenEndpointRequest ¶
func (c *ResourceOwnerPasswordCredentialsGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request fosite.AccessRequester) error
HandleTokenEndpointRequest implements https://tools.ietf.org/html/rfc6749#section-4.3.2
func (*ResourceOwnerPasswordCredentialsGrantHandler) IssueAccessToken ¶
func (c *ResourceOwnerPasswordCredentialsGrantHandler) IssueAccessToken(ctx context.Context, atLifespan time.Duration, requester fosite.AccessRequester, responder fosite.AccessResponder) (signature string, err error)
func (*ResourceOwnerPasswordCredentialsGrantHandler) PopulateTokenEndpointResponse ¶
func (c *ResourceOwnerPasswordCredentialsGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester fosite.AccessRequester, responder fosite.AccessResponder) error
PopulateTokenEndpointResponse implements https://tools.ietf.org/html/rfc6749#section-4.3.3
type ResourceOwnerPasswordCredentialsGrantStorage ¶
type ResourceOwnerPasswordCredentialsGrantStorage interface {
Authenticate(ctx context.Context, name string, secret string) (subject string, err error)
}
ResourceOwnerPasswordCredentialsGrantStorage provides storage for the resource owner password credentials grant.
type ResourceOwnerPasswordCredentialsGrantStorageProvider ¶
type ResourceOwnerPasswordCredentialsGrantStorageProvider interface {
ResourceOwnerPasswordCredentialsGrantStorage() ResourceOwnerPasswordCredentialsGrantStorage
}
ResourceOwnerPasswordCredentialsGrantStorageProvider provides the resource owner password credentials grant storage.
type Session ¶
type Session interface {
// SetSubject sets the session's subject.
SetSubject(subject string)
}
type StatelessJWTValidator ¶
type StatelessJWTValidator struct {
jwt.Signer
Config interface {
fosite.ScopeStrategyProvider
}
}
func (*StatelessJWTValidator) IntrospectToken ¶
type TokenRevocationHandler ¶
type TokenRevocationHandler struct {
Storage interface {
TokenRevocationStorageProvider
AccessTokenStorageProvider
RefreshTokenStorageProvider
}
Strategy interface {
AccessTokenStrategyProvider
RefreshTokenStrategyProvider
}
}
func (*TokenRevocationHandler) RevokeToken ¶
func (r *TokenRevocationHandler) RevokeToken(ctx context.Context, token string, tokenType fosite.TokenType, client fosite.Client) error
RevokeToken implements https://tools.ietf.org/html/rfc7009#section-2.1 The token type hint indicates which token type check should be performed first.
type TokenRevocationStorage ¶
type TokenRevocationStorage interface {
// RevokeRefreshToken revokes a refresh token as specified in:
// https://tools.ietf.org/html/rfc7009#section-2.1
// If the particular
// token is a refresh token and the authorization server supports the
// revocation of access tokens, then the authorization server SHOULD
// also invalidate all access tokens based on the same authorization
// grant (see Implementation Note).
RevokeRefreshToken(ctx context.Context, requestID string) error
// RevokeAccessToken revokes an access token as specified in:
// https://tools.ietf.org/html/rfc7009#section-2.1
// If the token passed to the request
// is an access token, the server MAY revoke the respective refresh
// token as well.
RevokeAccessToken(ctx context.Context, requestID string) error
}
TokenRevocationStorage provides the storage implementation as specified in: https://tools.ietf.org/html/rfc7009
type TokenRevocationStorageProvider ¶
type TokenRevocationStorageProvider interface {
TokenRevocationStorage() TokenRevocationStorage
}
Source Files
¶
- flow_authorize_code_auth.go
- flow_authorize_code_token.go
- flow_authorize_implicit.go
- flow_client_credentials.go
- flow_refresh.go
- flow_resource_owner.go
- flow_resource_owner_storage.go
- helper.go
- introspector.go
- introspector_jwt.go
- providers.go
- revocation.go
- revocation_storage.go
- storage.go
- strategy.go
- strategy_hmacsha_plain.go
- strategy_hmacsha_prefixed.go
- strategy_jwt.go
- strategy_jwt_rfc9068.go
- strategy_jwt_session.go