2021-05-04 22:06:05 +00:00
|
|
|
package schema
|
|
|
|
|
2022-04-07 00:58:51 +00:00
|
|
|
import (
|
2022-10-02 02:07:40 +00:00
|
|
|
"crypto/rsa"
|
2022-04-07 00:58:51 +00:00
|
|
|
"net/url"
|
|
|
|
"time"
|
|
|
|
)
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
|
2021-05-04 22:06:05 +00:00
|
|
|
// IdentityProvidersConfiguration represents the IdentityProviders 2.0 configuration for Authelia.
|
|
|
|
type IdentityProvidersConfiguration struct {
|
2021-08-03 09:55:21 +00:00
|
|
|
OIDC *OpenIDConnectConfiguration `koanf:"oidc"`
|
2021-05-04 22:06:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// OpenIDConnectConfiguration configuration for OpenID Connect.
|
|
|
|
type OpenIDConnectConfiguration struct {
|
2022-10-02 02:07:40 +00:00
|
|
|
HMACSecret string `koanf:"hmac_secret"`
|
|
|
|
IssuerCertificateChain X509CertificateChain `koanf:"issuer_certificate_chain"`
|
|
|
|
IssuerPrivateKey *rsa.PrivateKey `koanf:"issuer_private_key"`
|
2021-05-04 22:06:05 +00:00
|
|
|
|
2023-04-19 04:24:05 +00:00
|
|
|
IssuerJWKS []JWK `koanf:"issuer_jwks"`
|
|
|
|
|
2021-08-03 09:55:21 +00:00
|
|
|
AccessTokenLifespan time.Duration `koanf:"access_token_lifespan"`
|
|
|
|
AuthorizeCodeLifespan time.Duration `koanf:"authorize_code_lifespan"`
|
|
|
|
IDTokenLifespan time.Duration `koanf:"id_token_lifespan"`
|
|
|
|
RefreshTokenLifespan time.Duration `koanf:"refresh_token_lifespan"`
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
|
2021-08-03 09:55:21 +00:00
|
|
|
EnableClientDebugMessages bool `koanf:"enable_client_debug_messages"`
|
|
|
|
MinimumParameterEntropy int `koanf:"minimum_parameter_entropy"`
|
|
|
|
|
2022-03-02 04:44:05 +00:00
|
|
|
EnforcePKCE string `koanf:"enforce_pkce"`
|
|
|
|
EnablePKCEPlainChallenge bool `koanf:"enable_pkce_plain_challenge"`
|
|
|
|
|
2022-04-07 00:58:51 +00:00
|
|
|
CORS OpenIDConnectCORSConfiguration `koanf:"cors"`
|
2023-03-06 03:58:50 +00:00
|
|
|
PAR OpenIDConnectPARConfiguration `koanf:"pushed_authorizations"`
|
2022-04-07 00:58:51 +00:00
|
|
|
|
2021-08-03 09:55:21 +00:00
|
|
|
Clients []OpenIDConnectClientConfiguration `koanf:"clients"`
|
2023-04-19 04:24:05 +00:00
|
|
|
|
|
|
|
Discovery OpenIDConnectDiscovery // MetaData value. Not configurable by users.
|
|
|
|
}
|
|
|
|
|
|
|
|
type OpenIDConnectDiscovery struct {
|
|
|
|
DefaultKeyID string
|
|
|
|
RegisteredJWKSigningAlgs []string
|
2021-05-04 22:06:05 +00:00
|
|
|
}
|
|
|
|
|
2023-03-06 03:58:50 +00:00
|
|
|
// OpenIDConnectPARConfiguration represents an OpenID Connect PAR config.
|
|
|
|
type OpenIDConnectPARConfiguration struct {
|
|
|
|
Enforce bool `koanf:"enforce"`
|
|
|
|
ContextLifespan time.Duration `koanf:"context_lifespan"`
|
|
|
|
}
|
|
|
|
|
2022-04-07 00:58:51 +00:00
|
|
|
// OpenIDConnectCORSConfiguration represents an OpenID Connect CORS config.
|
|
|
|
type OpenIDConnectCORSConfiguration struct {
|
|
|
|
Endpoints []string `koanf:"endpoints"`
|
|
|
|
AllowedOrigins []url.URL `koanf:"allowed_origins"`
|
|
|
|
|
|
|
|
AllowedOriginsFromClientRedirectURIs bool `koanf:"allowed_origins_from_client_redirect_uris"`
|
|
|
|
}
|
|
|
|
|
2021-05-04 22:06:05 +00:00
|
|
|
// OpenIDConnectClientConfiguration configuration for an OpenID Connect client.
|
|
|
|
type OpenIDConnectClientConfiguration struct {
|
2022-10-20 03:21:45 +00:00
|
|
|
ID string `koanf:"id"`
|
|
|
|
Description string `koanf:"description"`
|
|
|
|
Secret *PasswordDigest `koanf:"secret"`
|
|
|
|
SectorIdentifier url.URL `koanf:"sector_identifier"`
|
|
|
|
Public bool `koanf:"public"`
|
2021-07-15 11:02:03 +00:00
|
|
|
|
2022-04-07 05:33:53 +00:00
|
|
|
RedirectURIs []string `koanf:"redirect_uris"`
|
|
|
|
|
2021-08-03 09:55:21 +00:00
|
|
|
Audience []string `koanf:"audience"`
|
|
|
|
Scopes []string `koanf:"scopes"`
|
|
|
|
GrantTypes []string `koanf:"grant_types"`
|
|
|
|
ResponseTypes []string `koanf:"response_types"`
|
|
|
|
ResponseModes []string `koanf:"response_modes"`
|
2021-07-10 04:56:33 +00:00
|
|
|
|
2023-04-15 10:55:38 +00:00
|
|
|
TokenEndpointAuthMethod string `koanf:"token_endpoint_auth_method"`
|
|
|
|
TokenEndpointAuthSigningAlg string `koanf:"token_endpoint_auth_signing_alg"`
|
2023-04-13 10:58:18 +00:00
|
|
|
|
2023-04-19 04:24:05 +00:00
|
|
|
IDTokenSigningAlg string `koanf:"id_token_signing_alg"`
|
|
|
|
|
2022-04-08 05:35:21 +00:00
|
|
|
Policy string `koanf:"authorization_policy"`
|
|
|
|
|
2023-03-06 03:58:50 +00:00
|
|
|
EnforcePAR bool `koanf:"enforce_par"`
|
2023-01-03 15:03:23 +00:00
|
|
|
EnforcePKCE bool `koanf:"enforce_pkce"`
|
|
|
|
|
2023-04-19 04:24:05 +00:00
|
|
|
PKCEChallengeMethod string `koanf:"pkce_challenge_method"`
|
|
|
|
UserinfoSigningAlg string `koanf:"userinfo_signing_algorithm"`
|
2023-01-03 15:03:23 +00:00
|
|
|
|
2022-10-20 02:16:36 +00:00
|
|
|
ConsentMode string `koanf:"consent_mode"`
|
|
|
|
ConsentPreConfiguredDuration *time.Duration `koanf:"pre_configured_consent_duration"`
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// DefaultOpenIDConnectConfiguration contains defaults for OIDC.
|
|
|
|
var DefaultOpenIDConnectConfiguration = OpenIDConnectConfiguration{
|
|
|
|
AccessTokenLifespan: time.Hour,
|
|
|
|
AuthorizeCodeLifespan: time.Minute,
|
|
|
|
IDTokenLifespan: time.Hour,
|
|
|
|
RefreshTokenLifespan: time.Minute * 90,
|
2022-03-02 04:44:05 +00:00
|
|
|
EnforcePKCE: "public_clients_only",
|
2021-05-04 22:06:05 +00:00
|
|
|
}
|
|
|
|
|
2022-10-20 02:16:36 +00:00
|
|
|
var defaultOIDCClientConsentPreConfiguredDuration = time.Hour * 24 * 7
|
|
|
|
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
// DefaultOpenIDConnectClientConfiguration contains defaults for OIDC Clients.
|
2021-05-04 22:06:05 +00:00
|
|
|
var DefaultOpenIDConnectClientConfiguration = OpenIDConnectClientConfiguration{
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
Policy: "two_factor",
|
2021-05-04 22:06:05 +00:00
|
|
|
Scopes: []string{"openid", "groups", "profile", "email"},
|
feat(oidc): add additional config options, accurate token times, and refactoring (#1991)
* This gives admins more control over their OIDC installation exposing options that had defaults before. Things like lifespans for authorize codes, access tokens, id tokens, refresh tokens, a option to enable the debug client messages, minimum parameter entropy. It also allows admins to configure the response modes.
* Additionally this records specific values about a users session indicating when they performed a specific authz factor so this is represented in the token accurately.
* Lastly we also implemented a OIDC key manager which calculates the kid for jwk's using the SHA1 digest instead of being static, or more specifically the first 7 chars. As per https://datatracker.ietf.org/doc/html/draft-ietf-jose-json-web-key#section-8.1.1 the kid should not exceed 8 chars. While it's allowed to exceed 8 chars, it must only be done so with a compelling reason, which we do not have.
2021-07-03 23:44:30 +00:00
|
|
|
ResponseTypes: []string{"code"},
|
2023-04-13 10:58:18 +00:00
|
|
|
ResponseModes: []string{"form_post"},
|
2021-07-10 04:56:33 +00:00
|
|
|
|
2023-04-19 04:24:05 +00:00
|
|
|
IDTokenSigningAlg: "RS256",
|
|
|
|
UserinfoSigningAlg: "none",
|
2022-10-20 02:16:36 +00:00
|
|
|
ConsentMode: "auto",
|
|
|
|
ConsentPreConfiguredDuration: &defaultOIDCClientConsentPreConfiguredDuration,
|
2021-05-04 22:06:05 +00:00
|
|
|
}
|