Documentation ¶
Index ¶
- Constants
- type AutheliaHasher
- type CommonDiscoveryOptions
- type ConsentGetResponseBody
- type InternalClient
- func (c InternalClient) GetAudience() fosite.Arguments
- func (c InternalClient) GetConsentResponseBody(session *session.OIDCWorkflowSession) ConsentGetResponseBody
- func (c InternalClient) GetGrantTypes() fosite.Arguments
- func (c InternalClient) GetHashedSecret() []byte
- func (c InternalClient) GetID() string
- func (c InternalClient) GetRedirectURIs() []string
- func (c InternalClient) GetResponseModes() []fosite.ResponseModeType
- func (c InternalClient) GetResponseTypes() fosite.Arguments
- func (c InternalClient) GetScopes() fosite.Arguments
- func (c InternalClient) IsAuthenticationLevelSufficient(level authentication.Level) bool
- func (c InternalClient) IsPublic() bool
- 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) 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) Authenticate(ctx context.Context, name string, secret string) error
- func (s *OpenIDConnectStore) ClientAssertionJWTValid(ctx context.Context, jti string) error
- func (s *OpenIDConnectStore) CreateAccessTokenSession(ctx context.Context, signature string, req fosite.Requester) error
- func (s *OpenIDConnectStore) CreateAuthorizeCodeSession(ctx context.Context, code string, req fosite.Requester) error
- func (s *OpenIDConnectStore) CreateOpenIDConnectSession(ctx context.Context, authorizeCode string, requester fosite.Requester) error
- func (s *OpenIDConnectStore) CreatePKCERequestSession(ctx context.Context, code string, req fosite.Requester) error
- func (s *OpenIDConnectStore) CreateRefreshTokenSession(ctx context.Context, signature string, req fosite.Requester) error
- func (s *OpenIDConnectStore) DeleteAccessTokenSession(ctx context.Context, signature string) error
- func (s *OpenIDConnectStore) DeleteOpenIDConnectSession(ctx context.Context, authorizeCode string) error
- func (s *OpenIDConnectStore) DeletePKCERequestSession(ctx context.Context, code string) error
- func (s *OpenIDConnectStore) DeleteRefreshTokenSession(ctx context.Context, signature string) error
- func (s *OpenIDConnectStore) GetAccessTokenSession(ctx context.Context, signature string, session fosite.Session) (fosite.Requester, error)
- func (s *OpenIDConnectStore) GetAuthorizeCodeSession(ctx context.Context, code string, session fosite.Session) (fosite.Requester, error)
- func (s *OpenIDConnectStore) GetClient(_ context.Context, id string) (fosite.Client, error)
- func (s OpenIDConnectStore) GetClientPolicy(id string) (level authorization.Level)
- func (s OpenIDConnectStore) GetInternalClient(id string) (client *InternalClient, err error)
- func (s *OpenIDConnectStore) GetOpenIDConnectSession(ctx context.Context, authorizeCode string, requester fosite.Requester) (fosite.Requester, error)
- func (s *OpenIDConnectStore) GetPKCERequestSession(ctx context.Context, code string, session fosite.Session) (fosite.Requester, error)
- func (s *OpenIDConnectStore) GetPublicKey(ctx context.Context, issuer string, subject string, keyID string) (*jose.JSONWebKey, error)
- func (s *OpenIDConnectStore) GetPublicKeyScopes(ctx context.Context, issuer string, subject string, keyID string) ([]string, error)
- func (s *OpenIDConnectStore) GetPublicKeys(ctx context.Context, issuer string, subject string) (*jose.JSONWebKeySet, error)
- func (s *OpenIDConnectStore) GetRefreshTokenSession(ctx context.Context, signature string, session fosite.Session) (fosite.Requester, error)
- func (s *OpenIDConnectStore) InvalidateAuthorizeCodeSession(ctx context.Context, code string) error
- func (s *OpenIDConnectStore) IsJWTUsed(ctx context.Context, jti string) (bool, error)
- func (s OpenIDConnectStore) IsValidClientID(id string) (valid bool)
- func (s *OpenIDConnectStore) MarkJWTUsedForTime(ctx context.Context, jti string, exp time.Time) error
- func (s *OpenIDConnectStore) RevokeAccessToken(ctx context.Context, requestID string) error
- func (s *OpenIDConnectStore) RevokeRefreshToken(ctx context.Context, requestID string) error
- func (s OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) error
- func (s *OpenIDConnectStore) SetClientAssertionJWT(ctx context.Context, jti string, exp time.Time) error
- type OpenIDConnectWellKnownConfiguration
- type OpenIDSession
- 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 ( WellKnownOpenIDConfigurationPath = "/.well-known/openid-configuration" WellKnownOAuthAuthorizationServerPath = "/.well-known/oauth-authorization-server" JWKsPath = "/api/oidc/jwks" AuthorizationPath = "/api/oidc/authorization" TokenPath = "/api/oidc/token" //nolint:gosec // This is not a hard coded credential, it's a path. IntrospectionPath = "/api/oidc/introspection" RevocationPath = "/api/oidc/revocation" UserinfoPath = "/api/oidc/userinfo" )
Paths.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AutheliaHasher ¶
type AutheliaHasher struct{}
AutheliaHasher implements the fosite.Hasher interface without an actual hashing algo.
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"` }
ConsentGetResponseBody schema of the response body of the consent GET endpoint.
type InternalClient ¶
type InternalClient struct { ID string `json:"id"` Description string `json:"-"` Secret []byte `json:"client_secret,omitempty"` Public bool `json:"public"` Policy authorization.Level `json:"-"` Audience []string `json:"audience"` Scopes []string `json:"scopes"` RedirectURIs []string `json:"redirect_uris"` GrantTypes []string `json:"grant_types"` ResponseTypes []string `json:"response_types"` ResponseModes []fosite.ResponseModeType `json:"response_modes"` UserinfoSigningAlgorithm string `json:"userinfo_signed_response_alg,omitempty"` }
InternalClient represents the client internally.
func NewClient ¶
func NewClient(config schema.OpenIDConnectClientConfiguration) (client *InternalClient)
NewClient creates a new InternalClient.
func (InternalClient) GetAudience ¶
func (c InternalClient) GetAudience() fosite.Arguments
GetAudience returns the Audience.
func (InternalClient) GetConsentResponseBody ¶
func (c InternalClient) GetConsentResponseBody(session *session.OIDCWorkflowSession) ConsentGetResponseBody
GetConsentResponseBody returns the proper consent response body for this session.OIDCWorkflowSession.
func (InternalClient) GetGrantTypes ¶
func (c InternalClient) GetGrantTypes() fosite.Arguments
GetGrantTypes returns the GrantTypes.
func (InternalClient) GetHashedSecret ¶
func (c InternalClient) GetHashedSecret() []byte
GetHashedSecret returns the Secret.
func (InternalClient) GetRedirectURIs ¶
func (c InternalClient) GetRedirectURIs() []string
GetRedirectURIs returns the RedirectURIs.
func (InternalClient) GetResponseModes ¶
func (c InternalClient) GetResponseModes() []fosite.ResponseModeType
GetResponseModes returns the valid response modes for this client.
Implements the fosite.ResponseModeClient.
func (InternalClient) GetResponseTypes ¶
func (c InternalClient) GetResponseTypes() fosite.Arguments
GetResponseTypes returns the ResponseTypes.
func (InternalClient) GetScopes ¶
func (c InternalClient) GetScopes() fosite.Arguments
GetScopes returns the Scopes.
func (InternalClient) IsAuthenticationLevelSufficient ¶
func (c InternalClient) IsAuthenticationLevelSufficient(level authentication.Level) bool
IsAuthenticationLevelSufficient returns if the provided authentication.Level is sufficient for the client of the AutheliaClient.
func (InternalClient) IsPublic ¶
func (c InternalClient) IsPublic() bool
IsPublic returns the value of the Public property.
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(configuration *schema.OpenIDConnectConfiguration) (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) 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.
Currently it is mostly just implementing a decorator pattern other then GetInternalClient. The long term plan is to have these methods interact with the Authelia storage and session providers where applicable.
func NewOpenIDConnectStore ¶
func NewOpenIDConnectStore(configuration *schema.OpenIDConnectConfiguration) (store *OpenIDConnectStore)
NewOpenIDConnectStore returns a new OpenIDConnectStore using the provided schema.OpenIDConnectConfiguration.
func (*OpenIDConnectStore) Authenticate ¶
Authenticate decorates fosite's storage.MemoryStore Authenticate method.
func (*OpenIDConnectStore) ClientAssertionJWTValid ¶
func (s *OpenIDConnectStore) ClientAssertionJWTValid(ctx context.Context, jti string) error
ClientAssertionJWTValid decorates fosite's storage.MemoryStore ClientAssertionJWTValid method.
func (*OpenIDConnectStore) CreateAccessTokenSession ¶
func (s *OpenIDConnectStore) CreateAccessTokenSession(ctx context.Context, signature string, req fosite.Requester) error
CreateAccessTokenSession decorates fosite's storage.MemoryStore CreateAccessTokenSession method.
func (*OpenIDConnectStore) CreateAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) CreateAuthorizeCodeSession(ctx context.Context, code string, req fosite.Requester) error
CreateAuthorizeCodeSession decorates fosite's storage.MemoryStore CreateAuthorizeCodeSession method.
func (*OpenIDConnectStore) CreateOpenIDConnectSession ¶
func (s *OpenIDConnectStore) CreateOpenIDConnectSession(ctx context.Context, authorizeCode string, requester fosite.Requester) error
CreateOpenIDConnectSession decorates fosite's storage.MemoryStore CreateOpenIDConnectSession method.
func (*OpenIDConnectStore) CreatePKCERequestSession ¶
func (s *OpenIDConnectStore) CreatePKCERequestSession(ctx context.Context, code string, req fosite.Requester) error
CreatePKCERequestSession decorates fosite's storage.MemoryStore CreatePKCERequestSession method.
func (*OpenIDConnectStore) CreateRefreshTokenSession ¶
func (s *OpenIDConnectStore) CreateRefreshTokenSession(ctx context.Context, signature string, req fosite.Requester) error
CreateRefreshTokenSession decorates fosite's storage.MemoryStore CreateRefreshTokenSession method.
func (*OpenIDConnectStore) DeleteAccessTokenSession ¶
func (s *OpenIDConnectStore) DeleteAccessTokenSession(ctx context.Context, signature string) error
DeleteAccessTokenSession decorates fosite's storage.MemoryStore DeleteAccessTokenSession method.
func (*OpenIDConnectStore) DeleteOpenIDConnectSession ¶
func (s *OpenIDConnectStore) DeleteOpenIDConnectSession(ctx context.Context, authorizeCode string) error
DeleteOpenIDConnectSession decorates fosite's storage.MemoryStore DeleteOpenIDConnectSession method.
func (*OpenIDConnectStore) DeletePKCERequestSession ¶
func (s *OpenIDConnectStore) DeletePKCERequestSession(ctx context.Context, code string) error
DeletePKCERequestSession decorates fosite's storage.MemoryStore DeletePKCERequestSession method.
func (*OpenIDConnectStore) DeleteRefreshTokenSession ¶
func (s *OpenIDConnectStore) DeleteRefreshTokenSession(ctx context.Context, signature string) error
DeleteRefreshTokenSession decorates fosite's storage.MemoryStore DeleteRefreshTokenSession method.
func (*OpenIDConnectStore) GetAccessTokenSession ¶
func (s *OpenIDConnectStore) GetAccessTokenSession(ctx context.Context, signature string, session fosite.Session) (fosite.Requester, error)
GetAccessTokenSession decorates fosite's storage.MemoryStore GetAccessTokenSession method.
func (*OpenIDConnectStore) GetAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) GetAuthorizeCodeSession(ctx context.Context, code string, session fosite.Session) (fosite.Requester, error)
GetAuthorizeCodeSession decorates fosite's storage.MemoryStore GetAuthorizeCodeSession method.
func (*OpenIDConnectStore) GetClient ¶
GetClient decorates fosite's storage.MemoryStore GetClient method.
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) GetInternalClient ¶
func (s OpenIDConnectStore) GetInternalClient(id string) (client *InternalClient, err error)
GetInternalClient returns a fosite.Client asserted as an InternalClient matching the provided id.
func (*OpenIDConnectStore) GetOpenIDConnectSession ¶
func (s *OpenIDConnectStore) GetOpenIDConnectSession(ctx context.Context, authorizeCode string, requester fosite.Requester) (fosite.Requester, error)
GetOpenIDConnectSession decorates fosite's storage.MemoryStore GetOpenIDConnectSession method.
func (*OpenIDConnectStore) GetPKCERequestSession ¶
func (s *OpenIDConnectStore) GetPKCERequestSession(ctx context.Context, code string, session fosite.Session) (fosite.Requester, error)
GetPKCERequestSession decorates fosite's storage.MemoryStore GetPKCERequestSession method.
func (*OpenIDConnectStore) GetPublicKey ¶
func (s *OpenIDConnectStore) GetPublicKey(ctx context.Context, issuer string, subject string, keyID string) (*jose.JSONWebKey, error)
GetPublicKey decorates fosite's storage.MemoryStore GetPublicKey method.
func (*OpenIDConnectStore) GetPublicKeyScopes ¶
func (s *OpenIDConnectStore) GetPublicKeyScopes(ctx context.Context, issuer string, subject string, keyID string) ([]string, error)
GetPublicKeyScopes decorates fosite's storage.MemoryStore GetPublicKeyScopes method.
func (*OpenIDConnectStore) GetPublicKeys ¶
func (s *OpenIDConnectStore) GetPublicKeys(ctx context.Context, issuer string, subject string) (*jose.JSONWebKeySet, error)
GetPublicKeys decorates fosite's storage.MemoryStore GetPublicKeys method.
func (*OpenIDConnectStore) GetRefreshTokenSession ¶
func (s *OpenIDConnectStore) GetRefreshTokenSession(ctx context.Context, signature string, session fosite.Session) (fosite.Requester, error)
GetRefreshTokenSession decorates fosite's storage.MemoryStore GetRefreshTokenSession method.
func (*OpenIDConnectStore) InvalidateAuthorizeCodeSession ¶
func (s *OpenIDConnectStore) InvalidateAuthorizeCodeSession(ctx context.Context, code string) error
InvalidateAuthorizeCodeSession decorates fosite's storage.MemoryStore InvalidateAuthorizeCodeSession method.
func (*OpenIDConnectStore) IsJWTUsed ¶
IsJWTUsed decorates fosite's storage.MemoryStore IsJWTUsed method.
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) error
MarkJWTUsedForTime decorates fosite's storage.MemoryStore MarkJWTUsedForTime method.
func (*OpenIDConnectStore) RevokeAccessToken ¶
func (s *OpenIDConnectStore) RevokeAccessToken(ctx context.Context, requestID string) error
RevokeAccessToken decorates fosite's storage.MemoryStore RevokeAccessToken method.
func (*OpenIDConnectStore) RevokeRefreshToken ¶
func (s *OpenIDConnectStore) RevokeRefreshToken(ctx context.Context, requestID string) error
RevokeRefreshToken decorates fosite's storage.MemoryStore RevokeRefreshToken method.
func (OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod ¶ added in v4.33.2
func (s OpenIDConnectStore) RevokeRefreshTokenMaybeGracePeriod(ctx context.Context, requestID string, signature string) error
RevokeRefreshTokenMaybeGracePeriod decorates fosite's storage.MemoryStore RevokeRefreshTokenMaybeGracePeriod method.
func (*OpenIDConnectStore) SetClientAssertionJWT ¶
func (s *OpenIDConnectStore) SetClientAssertionJWT(ctx context.Context, jti string, exp time.Time) error
SetClientAssertionJWT decorates fosite's storage.MemoryStore SetClientAssertionJWT method.
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.
type OpenIDSession ¶
type OpenIDSession struct { *openid.DefaultSession `json:"idToken"` Extra map[string]interface{} `json:"extra"` ClientID string }
OpenIDSession holds OIDC Session information.
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).