Documentation ¶
Index ¶
- Constants
- func NewSession() (session *model.OpenIDSession)
- func NewSessionWithAuthorizeRequest(issuer, kid, username string, amr []string, extra map[string]interface{}, ...) (session *model.OpenIDSession)
- type AuthenticationMethodsReferences
- func (r AuthenticationMethodsReferences) ChannelBrowser() bool
- func (r AuthenticationMethodsReferences) ChannelService() bool
- func (r AuthenticationMethodsReferences) FactorKnowledge() bool
- func (r AuthenticationMethodsReferences) FactorPossession() bool
- func (r AuthenticationMethodsReferences) MarshalRFC8176() []string
- func (r AuthenticationMethodsReferences) MultiChannelAuthentication() bool
- func (r AuthenticationMethodsReferences) MultiFactorAuthentication() bool
- type Client
- func (c Client) GetAudience() fosite.Arguments
- func (c Client) GetConsentResponseBody(consent *model.OAuth2ConsentSession) ConsentGetResponseBody
- func (c Client) GetGrantTypes() fosite.Arguments
- func (c Client) GetHashedSecret() []byte
- func (c Client) GetID() string
- func (c Client) GetRedirectURIs() []string
- func (c Client) GetResponseModes() []fosite.ResponseModeType
- func (c Client) GetResponseTypes() fosite.Arguments
- func (c Client) GetScopes() fosite.Arguments
- func (c Client) GetSectorIdentifier() string
- func (c Client) IsAuthenticationLevelSufficient(level authentication.Level) bool
- func (c Client) IsPublic() bool
- type CommonDiscoveryOptions
- type ConsentGetResponseBody
- type ConsentPostRequestBody
- type ConsentPostResponseBody
- type KeyManager
- func (m *KeyManager) AddActivePrivateKey(key *rsa.PrivateKey) (webKey *jose.JSONWebKey, err error)
- func (m *KeyManager) AddActivePrivateKeyData(data string) (key *rsa.PrivateKey, webKey *jose.JSONWebKey, err error)
- func (m KeyManager) GetActiveKey() (key *rsa.PublicKey, err error)
- func (m KeyManager) GetActiveKeyID() (keyID string)
- func (m KeyManager) GetActivePrivateKey() (key *rsa.PrivateKey, err error)
- func (m KeyManager) GetActiveWebKey() (webKey *jose.JSONWebKey, err error)
- func (m KeyManager) GetKeySet() (keySet *jose.JSONWebKeySet)
- func (m KeyManager) Strategy() (strategy *RS256JWTStrategy)
- type OAuth2DiscoveryOptions
- type OAuth2WellKnownConfiguration
- type OpenIDConnectBackChannelLogoutDiscoveryOptions
- type OpenIDConnectDiscoveryOptions
- type OpenIDConnectFrontChannelLogoutDiscoveryOptions
- type OpenIDConnectProvider
- func (p OpenIDConnectProvider) GetOAuth2WellKnownConfiguration(issuer string) OAuth2WellKnownConfiguration
- func (p OpenIDConnectProvider) GetOpenIDConnectWellKnownConfiguration(issuer string) OpenIDConnectWellKnownConfiguration
- func (p OpenIDConnectProvider) Pairwise() bool
- func (p OpenIDConnectProvider) Write(w http.ResponseWriter, r *http.Request, e interface{}, ...)
- func (p OpenIDConnectProvider) WriteError(w http.ResponseWriter, r *http.Request, err error, opts ...herodot.Option)
- func (p OpenIDConnectProvider) WriteErrorCode(w http.ResponseWriter, r *http.Request, code int, err error, ...)
- type OpenIDConnectStore
- func (s *OpenIDConnectStore) BeginTX(ctx context.Context) (c context.Context, err error)
- func (s *OpenIDConnectStore) ClientAssertionJWTValid(ctx context.Context, jti string) (err error)
- func (s *OpenIDConnectStore) Commit(ctx context.Context) (err error)
- func (s *OpenIDConnectStore) CreateAccessTokenSession(ctx context.Context, signature string, request fosite.Requester) (err error)
- func (s *OpenIDConnectStore) CreateAuthorizeCodeSession(ctx context.Context, code string, request fosite.Requester) (err error)
- func (s *OpenIDConnectStore) CreateOpenIDConnectSession(ctx context.Context, authorizeCode string, request fosite.Requester) (err error)
- func (s *OpenIDConnectStore) CreatePKCERequestSession(ctx context.Context, signature string, request fosite.Requester) (err error)
- func (s *OpenIDConnectStore) CreateRefreshTokenSession(ctx context.Context, signature string, request fosite.Requester) (err error)
- func (s *OpenIDConnectStore) DeleteAccessTokenSession(ctx context.Context, signature string) (err error)
- func (s *OpenIDConnectStore) DeleteOpenIDConnectSession(ctx context.Context, authorizeCode string) (err error)
- func (s *OpenIDConnectStore) DeletePKCERequestSession(ctx context.Context, signature string) (err error)
- func (s *OpenIDConnectStore) DeleteRefreshTokenSession(ctx context.Context, signature string) (err error)
- func (s OpenIDConnectStore) GenerateOpaqueUserID(ctx context.Context, sectorID, username string) (opaqueID *model.UserOpaqueIdentifier, err error)
- func (s *OpenIDConnectStore) GetAccessTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
- func (s *OpenIDConnectStore) GetAuthorizeCodeSession(ctx context.Context, code string, session fosite.Session) (request fosite.Requester, err error)
- func (s *OpenIDConnectStore) GetClient(_ context.Context, id string) (client fosite.Client, err error)
- func (s OpenIDConnectStore) GetClientPolicy(id string) (level authorization.Level)
- func (s OpenIDConnectStore) GetFullClient(id string) (client *Client, err error)
- func (s *OpenIDConnectStore) GetOpenIDConnectSession(ctx context.Context, authorizeCode string, request fosite.Requester) (r fosite.Requester, err error)
- func (s *OpenIDConnectStore) GetPKCERequestSession(ctx context.Context, signature string, session fosite.Session) (requester fosite.Requester, err error)
- func (s *OpenIDConnectStore) GetRefreshTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
- func (s OpenIDConnectStore) GetSubject(ctx context.Context, sectorID, username string) (subject uuid.UUID, err error)
- func (s *OpenIDConnectStore) InvalidateAuthorizeCodeSession(ctx context.Context, code string) (err error)
- func (s *OpenIDConnectStore) IsJWTUsed(ctx context.Context, jti string) (used bool, err error)
- func (s OpenIDConnectStore) IsValidClientID(id string) (valid bool)
- func (s *OpenIDConnectStore) MarkJWTUsedForTime(ctx context.Context, jti string, exp time.Time) (err error)
- func (s *OpenIDConnectStore) RevokeAccessToken(ctx context.Context, requestID string) (err error)
- func (s *OpenIDConnectStore) RevokeRefreshToken(ctx context.Context, requestID string) (err error)
- func (s *OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) (err error)
- func (s *OpenIDConnectStore) Rollback(ctx context.Context) (err error)
- func (s *OpenIDConnectStore) SetClientAssertionJWT(ctx context.Context, jti string, exp time.Time) (err error)
- type OpenIDConnectWellKnownConfiguration
- type PlainTextHasher
- type RS256JWTStrategy
- func (s *RS256JWTStrategy) Decode(ctx context.Context, token string) (*jwt.Token, error)
- func (s *RS256JWTStrategy) Generate(ctx context.Context, claims jwt.MapClaims, header jwt.Mapper) (string, string, error)
- func (s *RS256JWTStrategy) GetPublicKeyID(_ context.Context) (string, error)
- func (s *RS256JWTStrategy) GetSignature(ctx context.Context, token string) (string, error)
- func (s *RS256JWTStrategy) GetSigningMethodLength() int
- func (s *RS256JWTStrategy) Hash(ctx context.Context, in []byte) ([]byte, error)
- func (s RS256JWTStrategy) KeyID() (id string)
- func (s *RS256JWTStrategy) SetKey(id string, key *rsa.PrivateKey)
- func (s *RS256JWTStrategy) Validate(ctx context.Context, token string) (string, error)
Constants ¶
const ( ScopeOfflineAccess = "offline_access" ScopeOpenID = "openid" ScopeProfile = "profile" ScopeEmail = "email" ScopeGroups = "groups" )
Scope strings.
const ( ClaimGroups = "groups" ClaimDisplayName = "name" ClaimPreferredUsername = "preferred_username" ClaimEmail = "email" ClaimEmailVerified = "email_verified" ClaimEmailAlts = "alt_emails" )
Claim strings.
const ( AuthorizationEndpoint = "authorization" TokenEndpoint = "token" UserinfoEndpoint = "userinfo" IntrospectionEndpoint = "introspection" RevocationEndpoint = "revocation" )
Endpoints.
const ( WellKnownOpenIDConfigurationPath = "/.well-known/openid-configuration" WellKnownOAuthAuthorizationServerPath = "/.well-known/oauth-authorization-server" JWKsPath = "/jwks.json" RootPath = "/api/oidc" AuthorizationPath = RootPath + "/" + AuthorizationEndpoint TokenPath = RootPath + "/" + TokenEndpoint UserinfoPath = RootPath + "/" + UserinfoEndpoint IntrospectionPath = RootPath + "/" + IntrospectionEndpoint RevocationPath = RootPath + "/" + RevocationEndpoint )
Paths.
const ( // AMRMultiFactorAuthentication is an RFC8176 Authentication Method Reference Value that represents multiple-factor // authentication as per NIST.800-63-2 and ISO29115. When this is present, specific authentication methods used may // also be included. // // Authelia utilizes this when a user has performed any 2 AMR's with different factor values (excluding meta). // Factor: Meta, Channel: Meta. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 // // NIST.800-63-2: http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-63-2.pdf // // ISO29115: https://www.iso.org/standard/45138.html AMRMultiFactorAuthentication = "mfa" // AMRMultiChannelAuthentication is an RFC8176 Authentication Method Reference Value that represents // multiple-channel authentication. The authentication involves communication over more than one distinct // communication channel. For instance, a multiple-channel authentication might involve both entering information // into a workstation's browser and providing information on a telephone call to a pre-registered number. // // Authelia utilizes this when a user has performed any 2 AMR's with different channel values (excluding meta). // Factor: Meta, Channel: Meta. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 AMRMultiChannelAuthentication = "mca" // AMRUserPresence is an RFC8176 Authentication Method Reference Value that represents authentication that included // a user presence test. Evidence that the end user is present and interacting with the device. This is sometimes // also referred to as "test of user presence" as per W3C.WD-webauthn-20170216. // // Authelia utilizes this when a user has used Webauthn to authenticate and the user presence flag was set. // Factor: Meta, Channel: Meta. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 // // W3C.WD-webauthn-20170216: https://datatracker.ietf.org/doc/html/rfc8176#ref-W3C.WD-webauthn-20170216 AMRUserPresence = "user" // AMRPersonalIdentificationNumber is an RFC8176 Authentication Method Reference Value that represents // authentication that included a personal Identification Number (PIN) as per RFC4949 or pattern (not restricted to // containing only numbers) that a user enters to unlock a key on the device. This mechanism should have a way to // deter an attacker from obtaining the PIN by trying repeated guesses. // // Authelia utilizes this when a user has used Webauthn to authenticate and the user verified flag was set. // Factor: Meta, Channel: Meta. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 // // RFC4949: https://datatracker.ietf.org/doc/html/rfc4949 AMRPersonalIdentificationNumber = "pin" // AMRPasswordBasedAuthentication is an RFC8176 Authentication Method Reference Value that represents password-based // authentication as per RFC4949. // // Authelia utilizes this when a user has performed 1FA. Factor: Know, Channel: Browser. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 // // RFC4949: https://datatracker.ietf.org/doc/html/rfc4949 AMRPasswordBasedAuthentication = "pwd" // AMROneTimePassword is an RFC8176 Authentication Method Reference Value that represents authentication via a // one-time password as per RFC4949. One-time password specifications that this authentication method applies to // include RFC4226 and RFC6238. // // Authelia utilizes this when a user has used TOTP to authenticate. Factor: Have, Channel: Browser. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 // // RFC4949: https://datatracker.ietf.org/doc/html/rfc4949 // // RFC4226: https://datatracker.ietf.org/doc/html/rfc4226 // // RFC6238: https://datatracker.ietf.org/doc/html/rfc6238 AMROneTimePassword = "otp" // AMRHardwareSecuredKey is an RFC8176 Authentication Method Reference Value that // represents authentication via a proof-of-Possession (PoP) of a hardware-secured key. // // Authelia utilizes this when a user has used Webauthn to authenticate. Factor: Have, Channel: Browser. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 AMRHardwareSecuredKey = "hwk" // AMRShortMessageService is an RFC8176 Authentication Method Reference Value that // represents authentication via confirmation using SMS text message to the user at a registered number. // // Authelia utilizes this when a user has used Duo to authenticate. Factor: Have, Channel: Browser. // // RFC8176: https://datatracker.ietf.org/doc/html/rfc8176 AMRShortMessageService = "sms" )
Authentication Method Reference Values https://datatracker.ietf.org/doc/html/rfc8176
Variables ¶
This section is empty.
Functions ¶
func NewSession ¶ added in v4.34.5
func NewSession() (session *model.OpenIDSession)
NewSession creates a new empty OpenIDSession struct.
func NewSessionWithAuthorizeRequest ¶ added in v4.34.5
func NewSessionWithAuthorizeRequest(issuer, kid, username string, amr []string, extra map[string]interface{}, authTime time.Time, consent *model.OAuth2ConsentSession, requester fosite.AuthorizeRequester) (session *model.OpenIDSession)
NewSessionWithAuthorizeRequest uses details from an AuthorizeRequester to generate an OpenIDSession.
Types ¶
type AuthenticationMethodsReferences ¶ added in v4.35.0
type AuthenticationMethodsReferences struct { UsernameAndPassword bool TOTP bool Duo bool Webauthn bool WebauthnUserPresence bool WebauthnUserVerified bool }
AuthenticationMethodsReferences holds AMR information.
func (AuthenticationMethodsReferences) ChannelBrowser ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) ChannelBrowser() bool
ChannelBrowser returns true if a browser was used to authenticate.
func (AuthenticationMethodsReferences) ChannelService ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) ChannelService() bool
ChannelService returns true if a non-browser service was used to authenticate.
func (AuthenticationMethodsReferences) FactorKnowledge ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) FactorKnowledge() bool
FactorKnowledge returns true if a "something you know" factor of authentication was used.
func (AuthenticationMethodsReferences) FactorPossession ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) FactorPossession() bool
FactorPossession returns true if a "something you have" factor of authentication was used.
func (AuthenticationMethodsReferences) MarshalRFC8176 ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) MarshalRFC8176() []string
MarshalRFC8176 returns the AMR claim slice of strings in the RFC8176 format. https://datatracker.ietf.org/doc/html/rfc8176
func (AuthenticationMethodsReferences) MultiChannelAuthentication ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) MultiChannelAuthentication() bool
MultiChannelAuthentication returns true if the user used more than one channel to authenticate.
func (AuthenticationMethodsReferences) MultiFactorAuthentication ¶ added in v4.35.0
func (r AuthenticationMethodsReferences) MultiFactorAuthentication() bool
MultiFactorAuthentication returns true if multiple factors were used.
type Client ¶ added in v4.35.0
type Client struct { ID string Description string Secret []byte SectorIdentifier string Public bool Audience []string Scopes []string RedirectURIs []string GrantTypes []string ResponseTypes []string ResponseModes []fosite.ResponseModeType UserinfoSigningAlgorithm string Policy authorization.Level PreConfiguredConsentDuration *time.Duration }
Client represents the client internally.
func NewClient ¶
func NewClient(config schema.OpenIDConnectClientConfiguration) (client *Client)
NewClient creates a new Client.
func (Client) GetAudience ¶ added in v4.35.0
GetAudience returns the Audience.
func (Client) GetConsentResponseBody ¶ added in v4.35.0
func (c Client) GetConsentResponseBody(consent *model.OAuth2ConsentSession) ConsentGetResponseBody
GetConsentResponseBody returns the proper consent response body for this session.OIDCWorkflowSession.
func (Client) GetGrantTypes ¶ added in v4.35.0
GetGrantTypes returns the GrantTypes.
func (Client) GetHashedSecret ¶ added in v4.35.0
GetHashedSecret returns the Secret.
func (Client) GetRedirectURIs ¶ added in v4.35.0
GetRedirectURIs returns the RedirectURIs.
func (Client) GetResponseModes ¶ added in v4.35.0
func (c Client) GetResponseModes() []fosite.ResponseModeType
GetResponseModes returns the valid response modes for this client.
Implements the fosite.ResponseModeClient.
func (Client) GetResponseTypes ¶ added in v4.35.0
GetResponseTypes returns the ResponseTypes.
func (Client) GetSectorIdentifier ¶ added in v4.35.0
GetSectorIdentifier returns the SectorIdentifier for this client.
func (Client) IsAuthenticationLevelSufficient ¶ added in v4.35.0
func (c Client) IsAuthenticationLevelSufficient(level authentication.Level) bool
IsAuthenticationLevelSufficient returns if the provided authentication.Level is sufficient for the client of the AutheliaClient.
type CommonDiscoveryOptions ¶ added in v4.34.0
type CommonDiscoveryOptions struct { /* REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier. If Issuer discovery is supported (see Section 2), this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer. */ Issuer string `json:"issuer"` /* REQUIRED. URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. */ JWKSURI string `json:"jwks_uri,omitempty"` /* REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint [OpenID.Core]. See Also: OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html */ AuthorizationEndpoint string `json:"authorization_endpoint"` /* URL of the OP's OAuth 2.0 Token Endpoint [OpenID.Core]. This is REQUIRED unless only the Implicit Flow is used. See Also: OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html */ TokenEndpoint string `json:"token_endpoint,omitempty"` /* REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public. */ SubjectTypesSupported []string `json:"subject_types_supported"` /* REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values. */ ResponseTypesSupported []string `json:"response_types_supported"` /* OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"]. */ GrantTypesSupported []string `json:"grant_types_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports, as specified in OAuth 2.0 Multiple Response Type Encoding Practices [OAuth.Responses]. If omitted, the default for Dynamic OpenID Providers is ["query", "fragment"]. */ ResponseModesSupported []string `json:"response_modes_supported,omitempty"` /* RECOMMENDED. JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in [OpenID.Core] SHOULD be listed, if supported. See Also: OAuth 2.0: https://datatracker.ietf.org/doc/html/rfc6749 OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html */ ScopesSupported []string `json:"scopes_supported,omitempty"` /* RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list. */ ClaimsSupported []string `json:"claims_supported,omitempty"` /* OPTIONAL. Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values. See Also: BCP47: https://datatracker.ietf.org/doc/html/rfc5646 */ UILocalesSupported []string `json:"ui_locales_supported,omitempty"` /* OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0 [OpenID.Core]. Other authentication methods MAY be defined by extensions. If omitted, the default is client_secret_basic -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749]. See Also: OAuth 2.0: https://datatracker.ietf.org/doc/html/rfc6749 OpenID.Core Section 9: https://openid.net/specs/openid-connect-core-1_0.html#ClientAuthentication */ TokenEndpointAuthMethodsSupported []string `json:"token_endpoint_auth_methods_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods. Servers SHOULD support RS256. The value none MUST NOT be used. See Also: JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ TokenEndpointAuthSigningAlgValuesSupported []string `json:"token_endpoint_auth_signing_alg_values_supported,omitempty"` /* OPTIONAL. URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider. In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs to be provided in this documentation. */ ServiceDocumentation string `json:"service_documentation,omitempty"` /* OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering the Client if it is given. */ OPPolicyURI string `json:"op_policy_uri,omitempty"` /* OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service. The registration process SHOULD display this URL to the person registering the Client if it is given. */ OPTOSURI string `json:"op_tos_uri,omitempty"` }
CommonDiscoveryOptions represents the discovery options used in both OAuth 2.0 and OpenID Connect. See Also:
OpenID Connect Discovery: https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata OAuth 2.0 Discovery: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-discovery-10#section-2
type ConsentGetResponseBody ¶
type ConsentGetResponseBody struct { ClientID string `json:"client_id"` ClientDescription string `json:"client_description"` Scopes []string `json:"scopes"` Audience []string `json:"audience"` PreConfiguration bool `json:"pre_configuration"` }
ConsentGetResponseBody schema of the response body of the consent GET endpoint.
type ConsentPostRequestBody ¶ added in v4.35.0
type ConsentPostRequestBody struct { ClientID string `json:"client_id"` AcceptOrReject string `json:"accept_or_reject"` PreConfigure bool `json:"pre_configure"` }
ConsentPostRequestBody schema of the request body of the consent POST endpoint.
type ConsentPostResponseBody ¶ added in v4.35.0
type ConsentPostResponseBody struct {
RedirectURI string `json:"redirect_uri"`
}
ConsentPostResponseBody schema of the response body of the consent POST endpoint.
type KeyManager ¶
type KeyManager struct {
// contains filtered or unexported fields
}
KeyManager keeps track of all of the active/inactive rsa keys and provides them to services requiring them. It additionally allows us to add keys for the purpose of key rotation in the future.
func NewKeyManager ¶
func NewKeyManager() (manager *KeyManager)
NewKeyManager creates a new empty KeyManager.
func NewKeyManagerWithConfiguration ¶
func NewKeyManagerWithConfiguration(configuration *schema.OpenIDConnectConfiguration) (manager *KeyManager, err error)
NewKeyManagerWithConfiguration when provided a schema.OpenIDConnectConfiguration creates a new KeyManager and adds an initial key to the manager.
func (*KeyManager) AddActivePrivateKey ¶
func (m *KeyManager) AddActivePrivateKey(key *rsa.PrivateKey) (webKey *jose.JSONWebKey, err error)
AddActivePrivateKey adds a rsa.PublicKey, then sets it to the active key.
func (*KeyManager) AddActivePrivateKeyData ¶
func (m *KeyManager) AddActivePrivateKeyData(data string) (key *rsa.PrivateKey, webKey *jose.JSONWebKey, err error)
AddActivePrivateKeyData adds a rsa.PublicKey given the key in the PEM string format, then sets it to the active key.
func (KeyManager) GetActiveKey ¶
func (m KeyManager) GetActiveKey() (key *rsa.PublicKey, err error)
GetActiveKey returns the rsa.PublicKey of the currently active key.
func (KeyManager) GetActiveKeyID ¶
func (m KeyManager) GetActiveKeyID() (keyID string)
GetActiveKeyID returns the key id of the currently active key.
func (KeyManager) GetActivePrivateKey ¶
func (m KeyManager) GetActivePrivateKey() (key *rsa.PrivateKey, err error)
GetActivePrivateKey returns the rsa.PrivateKey of the currently active key.
func (KeyManager) GetActiveWebKey ¶
func (m KeyManager) GetActiveWebKey() (webKey *jose.JSONWebKey, err error)
GetActiveWebKey obtains the currently active jose.JSONWebKey.
func (KeyManager) GetKeySet ¶
func (m KeyManager) GetKeySet() (keySet *jose.JSONWebKeySet)
GetKeySet returns the joseJSONWebKeySet containing the rsa.PublicKey types.
func (KeyManager) Strategy ¶
func (m KeyManager) Strategy() (strategy *RS256JWTStrategy)
Strategy returns the RS256JWTStrategy.
type OAuth2DiscoveryOptions ¶ added in v4.34.0
type OAuth2DiscoveryOptions struct { /* OPTIONAL. URL of the authorization server's OAuth 2.0 introspection endpoint [RFC7662]. See Also: OAuth 2.0 Token Introspection: https://datatracker.ietf.org/doc/html/rfc7662 */ IntrospectionEndpoint string `json:"introspection_endpoint,omitempty"` /* OPTIONAL. URL of the authorization server's OAuth 2.0 revocation endpoint [RFC7009]. See Also: OAuth 2.0 Token Revocation: https://datatracker.ietf.org/doc/html/rfc7009 */ RevocationEndpoint string `json:"revocation_endpoint,omitempty"` /* OPTIONAL. URL of the authorization server's OAuth 2.0 Dynamic Client Registration endpoint [RFC7591]. See Also: OAuth 2.0 Dynamic Client Registration Protocol: https://datatracker.ietf.org/doc/html/rfc7591 */ RegistrationEndpoint string `json:"registration_endpoint,omitempty"` /* OPTIONAL. JSON array containing a list of client authentication methods supported by this introspection endpoint. The valid client authentication method values are those registered in the IANA "OAuth Token Endpoint Authentication Methods" registry [IANA.OAuth.Parameters] or those registered in the IANA "OAuth Access Token Types" registry [IANA.OAuth.Parameters]. (These values are and will remain distinct, due to Section 7.2.) If omitted, the set of supported authentication methods MUST be determined by other means. See Also: IANA.OAuth.Parameters: https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml OAuth 2.0 Authorization Server Metadata - Updated Registration Instructions: https://datatracker.ietf.org/doc/html/draft-ietf-oauth-discovery-10#section-7.2 */ IntrospectionEndpointAuthMethodsSupported []string `json:"introspection_endpoint_auth_methods_supported,omitempty"` /* OPTIONAL. JSON array containing a list of client authentication methods supported by this revocation endpoint. The valid client authentication method values are those registered in the IANA "OAuth Token Endpoint Authentication Methods" registry [IANA.OAuth.Parameters]. If omitted, the default is "client_secret_basic" -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749]. See Also: IANA.OAuth.Parameters: https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml OAuth 2.0 - Client Password: https://datatracker.ietf.org/doc/html/rfc6749#section-2.3.1 */ RevocationEndpointAuthMethodsSupported []string `json:"revocation_endpoint_auth_methods_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWS signing algorithms ("alg" values) supported by the revocation endpoint for the signature on the JWT [JWT] used to authenticate the client at the revocation endpoint for the "private_key_jwt" and "client_secret_jwt" authentication methods. This metadata entry MUST be present if either of these authentication methods are specified in the "revocation_endpoint_auth_methods_supported" entry. No default algorithms are implied if this entry is omitted. The value "none" MUST NOT be used. See Also: JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ RevocationEndpointAuthSigningAlgValuesSupported []string `json:"revocation_endpoint_auth_signing_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWS signing algorithms ("alg" values) supported by the introspection endpoint for the signature on the JWT [JWT] used to authenticate the client at the introspection endpoint for the "private_key_jwt" and "client_secret_jwt" authentication methods. This metadata entry MUST be present if either of these authentication methods are specified in the "introspection_endpoint_auth_methods_supported" entry. No default algorithms are implied if this entry is omitted. The value "none" MUST NOT be used. See Also: JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ IntrospectionEndpointAuthSigningAlgValuesSupported []string `json:"introspection_endpoint_auth_signing_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of PKCE [RFC7636] code challenge methods supported by this authorization server. Code challenge method values are used in the "code_challenge_method" parameter defined in Section 4.3 of [RFC7636]. The valid code challenge method values are those registered in the IANA "PKCE Code Challenge Methods" registry [IANA.OAuth.Parameters]. If omitted, the authorization server does not support PKCE. See Also: PKCE: https://datatracker.ietf.org/doc/html/rfc7636 IANA.OAuth.Parameters: https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml */ CodeChallengeMethodsSupported []string `json:"code_challenge_methods_supported,omitempty"` }
OAuth2DiscoveryOptions represents the discovery options specific to OAuth 2.0.
type OAuth2WellKnownConfiguration ¶ added in v4.34.0
type OAuth2WellKnownConfiguration struct { CommonDiscoveryOptions OAuth2DiscoveryOptions }
OAuth2WellKnownConfiguration represents the well known discovery document specific to OAuth 2.0.
type OpenIDConnectBackChannelLogoutDiscoveryOptions ¶ added in v4.34.0
type OpenIDConnectBackChannelLogoutDiscoveryOptions struct { /* OPTIONAL. Boolean value specifying whether the OP supports back-channel logout, with true indicating support. If omitted, the default value is false. */ BackChannelLogoutSupported bool `json:"backchannel_logout_supported"` /* OPTIONAL. Boolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP. If omitted, the default value is false. */ BackChannelLogoutSessionSupported bool `json:"backchannel_logout_session_supported"` }
OpenIDConnectBackChannelLogoutDiscoveryOptions represents the discovery options specific to OpenID Connect Back-Channel Logout functionality. See Also:
OpenID Connect Back-Channel Logout: https://openid.net/specs/openid-connect-backchannel-1_0.html#BCSupport
type OpenIDConnectDiscoveryOptions ¶ added in v4.34.0
type OpenIDConnectDiscoveryOptions struct { /* RECOMMENDED. URL of the OP's UserInfo Endpoint [OpenID.Core]. This URL MUST use the https scheme and MAY contain port, path, and query parameter components. See Also: OpenID.Core: https://openid.net/specs/openid-connect-core-1_0.html */ UserinfoEndpoint string `json:"userinfo_endpoint,omitempty"` /* REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT]. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow). See Also: JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ IDTokenSigningAlgValuesSupported []string `json:"id_token_signing_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. The value none MAY be included. See Also: JWS: https://datatracker.ietf.org/doc/html/rfc7515 JWA: https://datatracker.ietf.org/doc/html/rfc7518 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ UserinfoSigningAlgValuesSupported []string `json:"userinfo_signing_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). Servers SHOULD support none and RS256. */ RequestObjectSigningAlgValuesSupported []string `json:"request_object_signing_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT]. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ IDTokenEncryptionAlgValuesSupported []string `json:"id_token_encryption_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 JWA: https://datatracker.ietf.org/doc/html/rfc7518 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ UserinfoEncryptionAlgValuesSupported []string `json:"userinfo_encryption_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 */ RequestObjectEncryptionAlgValuesSupported []string `json:"request_object_encryption_alg_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT]. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ IDTokenEncryptionEncValuesSupported []string `json:"id_token_encryption_enc_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT]. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 JWA: https://datatracker.ietf.org/doc/html/rfc7518 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ UserinfoEncryptionEncValuesSupported []string `json:"userinfo_encryption_enc_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference. See Also: JWE: https://datatracker.ietf.org/doc/html/rfc7516 JWT: https://datatracker.ietf.org/doc/html/rfc7519 */ RequestObjectEncryptionEncValuesSupported []string `json:"request_object_encryption_enc_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the Authentication Context Class References that this OP supports. */ ACRValuesSupported []string `json:"acr_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the display parameter values that the OpenID Provider supports. These values are described in Section 3.1.2.1 of OpenID Connect Core 1.0 [OpenID.Core]. See Also: OpenID.Core Section 3.1.2.1: https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest */ DisplayValuesSupported []string `json:"display_values_supported,omitempty"` /* OPTIONAL. JSON array containing a list of the Claim Types that the OpenID Provider supports. These Claim Types are described in Section 5.6 of OpenID Connect Core 1.0 [OpenID.Core]. Values defined by this specification are normal, aggregated, and distributed. If omitted, the implementation supports only normal Claims. See Also: OpenID.Core Section 5.6: https://openid.net/specs/openid-connect-core-1_0.html#ClaimTypes */ ClaimTypesSupported []string `json:"claim_types_supported,omitempty"` /* OPTIONAL. Languages and scripts supported for values in Claims being returned, represented as a JSON array of BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily supported for all Claim values. See Also: BCP47: https://datatracker.ietf.org/doc/html/rfc5646 */ ClaimLocalesSupported []string `json:"claims_locales_supported,omitempty"` /* OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true. */ RequestURIParameterSupported bool `json:"request_uri_parameter_supported"` /* OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. Pre-registration is REQUIRED when the value is true. If omitted, the default value is false. */ RequireRequestURIRegistration bool `json:"require_request_uri_registration"` /* OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false. */ ClaimsParameterSupported bool `json:"claims_parameter_supported"` }
OpenIDConnectDiscoveryOptions represents the discovery options specific to OpenID Connect.
type OpenIDConnectFrontChannelLogoutDiscoveryOptions ¶ added in v4.34.0
type OpenIDConnectFrontChannelLogoutDiscoveryOptions struct { /* OPTIONAL. Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support. If omitted, the default value is false. */ FrontChannelLogoutSupported bool `json:"frontchannel_logout_supported"` /* OPTIONAL. Boolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP. If omitted, the default value is false. */ FrontChannelLogoutSessionSupported bool `json:"frontchannel_logout_session_supported"` }
OpenIDConnectFrontChannelLogoutDiscoveryOptions represents the discovery options specific to OpenID Connect Front-Channel Logout functionality. See Also:
OpenID Connect Front-Channel Logout: https://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout
type OpenIDConnectProvider ¶
type OpenIDConnectProvider struct { Fosite fosite.OAuth2Provider Store *OpenIDConnectStore KeyManager *KeyManager // contains filtered or unexported fields }
OpenIDConnectProvider for OpenID Connect.
func NewOpenIDConnectProvider ¶
func NewOpenIDConnectProvider(config *schema.OpenIDConnectConfiguration, storageProvider storage.Provider) (provider OpenIDConnectProvider, err error)
NewOpenIDConnectProvider new-ups a OpenIDConnectProvider.
func (OpenIDConnectProvider) GetOAuth2WellKnownConfiguration ¶ added in v4.34.0
func (p OpenIDConnectProvider) GetOAuth2WellKnownConfiguration(issuer string) OAuth2WellKnownConfiguration
GetOAuth2WellKnownConfiguration returns the discovery document for the OAuth Configuration.
func (OpenIDConnectProvider) GetOpenIDConnectWellKnownConfiguration ¶ added in v4.34.0
func (p OpenIDConnectProvider) GetOpenIDConnectWellKnownConfiguration(issuer string) OpenIDConnectWellKnownConfiguration
GetOpenIDConnectWellKnownConfiguration returns the discovery document for the OpenID Configuration.
func (OpenIDConnectProvider) Pairwise ¶ added in v4.35.0
func (p OpenIDConnectProvider) Pairwise() bool
Pairwise returns true if this provider is configured with clients that require pairwise.
func (OpenIDConnectProvider) Write ¶
func (p OpenIDConnectProvider) Write(w http.ResponseWriter, r *http.Request, e interface{}, opts ...herodot.EncoderOptions)
Write writes data with herodot.JSONWriter.
func (OpenIDConnectProvider) WriteError ¶
func (p OpenIDConnectProvider) WriteError(w http.ResponseWriter, r *http.Request, err error, opts ...herodot.Option)
WriteError writes an error with herodot.JSONWriter.
func (OpenIDConnectProvider) WriteErrorCode ¶
func (p OpenIDConnectProvider) WriteErrorCode(w http.ResponseWriter, r *http.Request, code int, err error, opts ...herodot.Option)
WriteErrorCode writes an error with an error code with herodot.JSONWriter.
type OpenIDConnectStore ¶
type OpenIDConnectStore struct {
// contains filtered or unexported fields
}
OpenIDConnectStore is Authelia's internal representation of the fosite.Storage interface. It maps the following interfaces to the storage.Provider interface: fosite.Storage, fosite.ClientManager, storage.Transactional, oauth2.AuthorizeCodeStorage, oauth2.AccessTokenStorage, oauth2.RefreshTokenStorage, oauth2.TokenRevocationStorage, pkce.PKCERequestStorage, openid.OpenIDConnectRequestStorage, and partially implements rfc7523.RFC7523KeyStorage.
func NewOpenIDConnectStore ¶
func NewOpenIDConnectStore(config *schema.OpenIDConnectConfiguration, provider storage.Provider) (store *OpenIDConnectStore)
NewOpenIDConnectStore returns a OpenIDConnectStore when provided with a schema.OpenIDConnectConfiguration and storage.Provider.
func (*OpenIDConnectStore) BeginTX ¶ added in v4.35.0
BeginTX starts a transaction. This implements a portion of fosite storage.Transactional interface.
func (*OpenIDConnectStore) ClientAssertionJWTValid ¶
func (s *OpenIDConnectStore) ClientAssertionJWTValid(ctx context.Context, jti string) (err error)
ClientAssertionJWTValid returns an error if the JTI is known or the DB check failed and nil if the JTI is not known. This implements a portion of fosite.ClientManager.
func (*OpenIDConnectStore) Commit ¶ added in v4.35.0
func (s *OpenIDConnectStore) Commit(ctx context.Context) (err error)
Commit completes a transaction. This implements a portion of fosite storage.Transactional interface.
func (*OpenIDConnectStore) CreateAccessTokenSession ¶
func (s *OpenIDConnectStore) CreateAccessTokenSession(ctx context.Context, signature string, request fosite.Requester) (err error)
CreateAccessTokenSession stores the authorization request for a given access token. This implements a portion of oauth2.AccessTokenStorage.
func (*OpenIDConnectStore) CreateAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) CreateAuthorizeCodeSession(ctx context.Context, code string, request fosite.Requester) (err error)
CreateAuthorizeCodeSession stores the authorization request for a given authorization code. This implements a portion of oauth2.AuthorizeCodeStorage.
func (*OpenIDConnectStore) CreateOpenIDConnectSession ¶
func (s *OpenIDConnectStore) CreateOpenIDConnectSession(ctx context.Context, authorizeCode string, request fosite.Requester) (err error)
CreateOpenIDConnectSession creates an open id connect session for a given authorize code. This is relevant for explicit open id connect flow. This implements a portion of openid.OpenIDConnectRequestStorage.
func (*OpenIDConnectStore) CreatePKCERequestSession ¶
func (s *OpenIDConnectStore) CreatePKCERequestSession(ctx context.Context, signature string, request fosite.Requester) (err error)
CreatePKCERequestSession stores the authorization request for a given PKCE request. This implements a portion of pkce.PKCERequestStorage.
func (*OpenIDConnectStore) CreateRefreshTokenSession ¶
func (s *OpenIDConnectStore) CreateRefreshTokenSession(ctx context.Context, signature string, request fosite.Requester) (err error)
CreateRefreshTokenSession stores the authorization request for a given refresh token. This implements a portion of oauth2.RefreshTokenStorage.
func (*OpenIDConnectStore) DeleteAccessTokenSession ¶
func (s *OpenIDConnectStore) DeleteAccessTokenSession(ctx context.Context, signature string) (err error)
DeleteAccessTokenSession marks an access token session as deleted. This implements a portion of oauth2.AccessTokenStorage.
func (*OpenIDConnectStore) DeleteOpenIDConnectSession ¶
func (s *OpenIDConnectStore) DeleteOpenIDConnectSession(ctx context.Context, authorizeCode string) (err error)
DeleteOpenIDConnectSession just implements the method required by fosite even though it's unused. This implements a portion of openid.OpenIDConnectRequestStorage.
func (*OpenIDConnectStore) DeletePKCERequestSession ¶
func (s *OpenIDConnectStore) DeletePKCERequestSession(ctx context.Context, signature string) (err error)
DeletePKCERequestSession marks the authorization request for a given PKCE request as deleted. This implements a portion of pkce.PKCERequestStorage.
func (*OpenIDConnectStore) DeleteRefreshTokenSession ¶
func (s *OpenIDConnectStore) DeleteRefreshTokenSession(ctx context.Context, signature string) (err error)
DeleteRefreshTokenSession marks the authorization request for a given refresh token as deleted. This implements a portion of oauth2.RefreshTokenStorage.
func (OpenIDConnectStore) GenerateOpaqueUserID ¶ added in v4.35.0
func (s OpenIDConnectStore) GenerateOpaqueUserID(ctx context.Context, sectorID, username string) (opaqueID *model.UserOpaqueIdentifier, err error)
GenerateOpaqueUserID either retrieves or creates an opaque user id from a sectorID and username.
func (*OpenIDConnectStore) GetAccessTokenSession ¶
func (s *OpenIDConnectStore) GetAccessTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
GetAccessTokenSession gets the authorization request for a given access token. This implements a portion of oauth2.AccessTokenStorage.
func (*OpenIDConnectStore) GetAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) GetAuthorizeCodeSession(ctx context.Context, code string, session fosite.Session) (request fosite.Requester, err error)
GetAuthorizeCodeSession hydrates the session based on the given code and returns the authorization request. 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! This implements a portion of oauth2.AuthorizeCodeStorage.
func (*OpenIDConnectStore) GetClient ¶
func (s *OpenIDConnectStore) GetClient(_ context.Context, id string) (client fosite.Client, err error)
GetClient loads the client by its ID or returns an error if the client does not exist or another error occurred. This implements a portion of fosite.ClientManager.
func (OpenIDConnectStore) GetClientPolicy ¶
func (s OpenIDConnectStore) GetClientPolicy(id string) (level authorization.Level)
GetClientPolicy retrieves the policy from the client with the matching provided id.
func (OpenIDConnectStore) GetFullClient ¶ added in v4.35.0
func (s OpenIDConnectStore) GetFullClient(id string) (client *Client, err error)
GetFullClient returns a fosite.Client asserted as an Client matching the provided id.
func (*OpenIDConnectStore) GetOpenIDConnectSession ¶
func (s *OpenIDConnectStore) GetOpenIDConnectSession(ctx context.Context, authorizeCode string, request fosite.Requester) (r fosite.Requester, err error)
GetOpenIDConnectSession returns error: - nil if a session was found, - ErrNoSessionFound if no session was found - or an arbitrary error if an error occurred. This implements a portion of openid.OpenIDConnectRequestStorage.
func (*OpenIDConnectStore) GetPKCERequestSession ¶
func (s *OpenIDConnectStore) GetPKCERequestSession(ctx context.Context, signature string, session fosite.Session) (requester fosite.Requester, err error)
GetPKCERequestSession gets the authorization request for a given PKCE request. This implements a portion of pkce.PKCERequestStorage.
func (*OpenIDConnectStore) GetRefreshTokenSession ¶
func (s *OpenIDConnectStore) GetRefreshTokenSession(ctx context.Context, signature string, session fosite.Session) (request fosite.Requester, err error)
GetRefreshTokenSession gets the authorization request for a given refresh token. This implements a portion of oauth2.RefreshTokenStorage.
func (OpenIDConnectStore) GetSubject ¶ added in v4.35.0
func (s OpenIDConnectStore) GetSubject(ctx context.Context, sectorID, username string) (subject uuid.UUID, err error)
GetSubject returns a subject UUID for a username. If it exists, it returns the existing one, otherwise it creates and saves it.
func (*OpenIDConnectStore) InvalidateAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) InvalidateAuthorizeCodeSession(ctx context.Context, code string) (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. This implements a portion of oauth2.AuthorizeCodeStorage.
func (OpenIDConnectStore) IsValidClientID ¶
func (s OpenIDConnectStore) IsValidClientID(id string) (valid bool)
IsValidClientID returns true if the provided id exists in the OpenIDConnectProvider.Clients map.
func (*OpenIDConnectStore) MarkJWTUsedForTime ¶
func (s *OpenIDConnectStore) MarkJWTUsedForTime(ctx context.Context, jti string, exp time.Time) (err error)
MarkJWTUsedForTime implements an interface required for rfc7523.RFC7523KeyStorage.
func (*OpenIDConnectStore) RevokeAccessToken ¶
func (s *OpenIDConnectStore) RevokeAccessToken(ctx context.Context, requestID string) (err 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. This implements a portion of oauth2.TokenRevocationStorage.
func (*OpenIDConnectStore) RevokeRefreshToken ¶
func (s *OpenIDConnectStore) RevokeRefreshToken(ctx context.Context, requestID string) (err error)
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). This implements a portion of oauth2.TokenRevocationStorage.
func (*OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod ¶ added in v4.33.2
func (s *OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) (err error)
RevokeRefreshTokenMaybeGracePeriod 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. This implements a portion of oauth2.TokenRevocationStorage.
func (*OpenIDConnectStore) Rollback ¶ added in v4.35.0
func (s *OpenIDConnectStore) Rollback(ctx context.Context) (err error)
Rollback rolls a transaction back. This implements a portion of fosite storage.Transactional interface.
func (*OpenIDConnectStore) SetClientAssertionJWT ¶
func (s *OpenIDConnectStore) SetClientAssertionJWT(ctx context.Context, jti string, exp time.Time) (err error)
SetClientAssertionJWT marks a JTI as known for the given expiry time. Before inserting the new JTI, it will clean up any existing JTIs that have expired as those tokens can not be replayed due to the expiry. This implements a portion of fosite.ClientManager.
type OpenIDConnectWellKnownConfiguration ¶ added in v4.34.0
type OpenIDConnectWellKnownConfiguration struct { CommonDiscoveryOptions OAuth2DiscoveryOptions OpenIDConnectDiscoveryOptions OpenIDConnectFrontChannelLogoutDiscoveryOptions OpenIDConnectBackChannelLogoutDiscoveryOptions }
OpenIDConnectWellKnownConfiguration represents the well known discovery document specific to OpenID Connect.
func NewOpenIDConnectWellKnownConfiguration ¶ added in v4.35.0
func NewOpenIDConnectWellKnownConfiguration(enablePKCEPlainChallenge, pairwise bool) (config OpenIDConnectWellKnownConfiguration)
NewOpenIDConnectWellKnownConfiguration generates a new OpenIDConnectWellKnownConfiguration.
type PlainTextHasher ¶ added in v4.35.0
type PlainTextHasher struct{}
PlainTextHasher implements the fosite.Hasher interface without an actual hashing algo.
type RS256JWTStrategy ¶
type RS256JWTStrategy struct { JWTStrategy *jwt.RS256JWTStrategy // contains filtered or unexported fields }
RS256JWTStrategy is a decorator struct for the fosite RS256JWTStrategy.
func NewRS256JWTStrategy ¶
func NewRS256JWTStrategy(id string, key *rsa.PrivateKey) (strategy *RS256JWTStrategy, err error)
NewRS256JWTStrategy returns a new RS256JWTStrategy.
func (*RS256JWTStrategy) Decode ¶
Decode is a decorator func for the underlying fosite RS256JWTStrategy.
func (*RS256JWTStrategy) Generate ¶
func (s *RS256JWTStrategy) Generate(ctx context.Context, claims jwt.MapClaims, header jwt.Mapper) (string, string, error)
Generate is a decorator func for the underlying fosite RS256JWTStrategy.
func (*RS256JWTStrategy) GetPublicKeyID ¶
func (s *RS256JWTStrategy) GetPublicKeyID(_ context.Context) (string, error)
GetPublicKeyID is a decorator func for the underlying fosite RS256JWTStrategy.
func (*RS256JWTStrategy) GetSignature ¶
GetSignature is a decorator func for the underlying fosite RS256JWTStrategy.
func (*RS256JWTStrategy) GetSigningMethodLength ¶
func (s *RS256JWTStrategy) GetSigningMethodLength() int
GetSigningMethodLength is a decorator func for the underlying fosite RS256JWTStrategy.
func (*RS256JWTStrategy) Hash ¶
Hash is a decorator func for the underlying fosite RS256JWTStrategy.
func (RS256JWTStrategy) KeyID ¶
func (s RS256JWTStrategy) KeyID() (id string)
KeyID returns the key id.
func (*RS256JWTStrategy) SetKey ¶
func (s *RS256JWTStrategy) SetKey(id string, key *rsa.PrivateKey)
SetKey sets the provided key id and key as the active key (this is what triggers fosite to use it).