2021-04-11 18:25:03 +07:00
|
|
|
# yamllint disable rule:comments-indentation
|
|
|
|
---
|
|
|
|
###############################################################################
|
|
|
|
# Authelia Configuration #
|
|
|
|
###############################################################################
|
2017-01-22 23:54:45 +07:00
|
|
|
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## Certificates directory specifies where Authelia will load trusted certificates (public portion) from in addition to
|
|
|
|
## the system certificates store.
|
|
|
|
## They should be in base64 format, and have one of the following extensions: *.cer, *.crt, *.pem.
|
2021-11-15 15:37:58 +07:00
|
|
|
# certificates_directory: /config/certificates/
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
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-04 06:44:30 +07:00
|
|
|
## The theme to display: light, dark, grey, auto.
|
2021-01-20 19:07:40 +07:00
|
|
|
theme: light
|
|
|
|
|
2021-08-02 18:55:30 +07:00
|
|
|
## The secret used to generate JWT tokens when validating user identity by email confirmation. JWT Secret can also be
|
|
|
|
## set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
|
|
|
jwt_secret: a_very_important_secret
|
|
|
|
|
|
|
|
## Default redirection URL
|
|
|
|
##
|
|
|
|
## If user tries to authenticate without any referer, Authelia does not know where to redirect the user to at the end
|
|
|
|
## of the authentication process. This parameter allows you to specify the default redirection URL Authelia will use
|
|
|
|
## in such a case.
|
|
|
|
##
|
|
|
|
## Note: this parameter is optional. If not provided, user won't be redirected upon successful authentication.
|
|
|
|
default_redirection_url: https://home.example.com/
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Server Configuration
|
|
|
|
##
|
2020-04-30 09:03:05 +07:00
|
|
|
server:
|
2021-08-03 16:55:21 +07:00
|
|
|
|
2021-08-02 18:55:30 +07:00
|
|
|
## The address to listen on.
|
|
|
|
host: 0.0.0.0
|
|
|
|
|
|
|
|
## The port to listen on.
|
|
|
|
port: 9091
|
|
|
|
|
2021-08-03 16:55:21 +07:00
|
|
|
## Set the single level path Authelia listens on.
|
|
|
|
## Must be alphanumeric chars and should not contain any slashes.
|
|
|
|
path: ""
|
2021-08-02 18:55:30 +07:00
|
|
|
|
2021-11-15 15:37:58 +07:00
|
|
|
## Set the path on disk to Authelia assets.
|
|
|
|
## Useful to allow overriding of specific static assets.
|
|
|
|
# asset_path: /config/assets/
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Buffers usually should be configured to be the same value.
|
|
|
|
## Explanation at https://www.authelia.com/docs/configuration/server.html
|
|
|
|
## Read buffer size adjusts the server's max incoming request size in bytes.
|
|
|
|
## Write buffer size does the same for outgoing responses.
|
2020-04-30 09:03:05 +07:00
|
|
|
read_buffer_size: 4096
|
|
|
|
write_buffer_size: 4096
|
2021-06-08 20:15:43 +07:00
|
|
|
|
2021-06-01 11:09:50 +07:00
|
|
|
## Enables the pprof endpoint.
|
|
|
|
enable_pprof: false
|
|
|
|
|
|
|
|
## Enables the expvars endpoint.
|
|
|
|
enable_expvars: false
|
|
|
|
|
2021-08-05 11:02:07 +07:00
|
|
|
## Disables writing the health check vars to /app/.healthcheck.env which makes healthcheck.sh return exit code 0.
|
|
|
|
## This is disabled by default if either /app/.healthcheck.env or /app/healthcheck.sh do not exist.
|
|
|
|
disable_healthcheck: false
|
|
|
|
|
2021-08-03 16:55:21 +07:00
|
|
|
## Authelia by default doesn't accept TLS communication on the server port. This section overrides this behaviour.
|
|
|
|
tls:
|
|
|
|
## The path to the DER base64/PEM format private key.
|
|
|
|
key: ""
|
|
|
|
|
|
|
|
## The path to the DER base64/PEM format public certificate.
|
|
|
|
certificate: ""
|
|
|
|
|
|
|
|
##
|
|
|
|
## Log Configuration
|
|
|
|
##
|
2021-06-08 20:15:43 +07:00
|
|
|
log:
|
|
|
|
## Level of verbosity for logs: info, debug, trace.
|
2021-06-01 11:09:50 +07:00
|
|
|
level: debug
|
2021-04-11 18:25:03 +07:00
|
|
|
|
2021-06-01 11:09:50 +07:00
|
|
|
## Format the logs are written as: json, text.
|
|
|
|
# format: json
|
2021-04-11 18:25:03 +07:00
|
|
|
|
2021-06-01 11:09:50 +07:00
|
|
|
## File path where the logs will be written. If not set logs are written to stdout.
|
|
|
|
# file_path: /config/authelia.log
|
2017-01-23 00:18:19 +07:00
|
|
|
|
2021-06-01 11:09:50 +07:00
|
|
|
## Whether to also log to stdout when a log_file_path is defined.
|
|
|
|
# keep_stdout: false
|
2021-05-31 11:02:54 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## TOTP Configuration
|
|
|
|
##
|
|
|
|
## Parameters used for TOTP generation.
|
2018-08-19 15:59:47 +07:00
|
|
|
totp:
|
2021-04-11 18:25:03 +07:00
|
|
|
## The issuer name displayed in the Authenticator application of your choice
|
|
|
|
## See: https://github.com/google/google-authenticator/wiki/Key-Uri-Format for more info on issuer names
|
2018-08-19 15:59:47 +07:00
|
|
|
issuer: authelia.com
|
2021-04-11 18:25:03 +07:00
|
|
|
## The period in seconds a one-time password is current for. Changing this will require all users to register
|
|
|
|
## their TOTP applications again. Warning: before changing period read the docs link below.
|
2020-03-25 08:48:20 +07:00
|
|
|
period: 30
|
2021-04-11 18:25:03 +07:00
|
|
|
## The skew controls number of one-time passwords either side of the current one that are valid.
|
|
|
|
## Warning: before changing skew read the docs link below.
|
2020-03-25 08:48:20 +07:00
|
|
|
skew: 1
|
2021-04-11 18:25:03 +07:00
|
|
|
## See: https://www.authelia.com/docs/configuration/one-time-password.html#period-and-skew to read the documentation.
|
2018-08-19 15:59:47 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Duo Push API Configuration
|
|
|
|
##
|
|
|
|
## Parameters used to contact the Duo API. Those are generated when you protect an application of type
|
|
|
|
## "Partner Auth API" in the management panel.
|
2019-03-24 21:15:49 +07:00
|
|
|
duo_api:
|
2019-03-25 00:45:32 +07:00
|
|
|
hostname: api-123456789.example.com
|
2019-03-24 21:15:49 +07:00
|
|
|
integration_key: ABCDEF
|
2021-04-11 18:25:03 +07:00
|
|
|
## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2019-03-24 21:15:49 +07:00
|
|
|
secret_key: 1234567890abcdefghifjkl
|
|
|
|
|
2021-09-17 11:44:35 +07:00
|
|
|
##
|
|
|
|
## NTP Configuration
|
|
|
|
##
|
|
|
|
## This is used to validate the servers time is accurate enough to validate TOTP.
|
|
|
|
ntp:
|
|
|
|
## NTP server address.
|
|
|
|
address: "time.cloudflare.com:123"
|
|
|
|
|
|
|
|
## NTP version.
|
|
|
|
version: 4
|
|
|
|
|
|
|
|
## Maximum allowed time offset between the host and the NTP server.
|
|
|
|
max_desync: 3s
|
|
|
|
|
|
|
|
## Disables the NTP check on startup entirely. This means Authelia will not contact a remote service at all if you
|
|
|
|
## set this to true, and can operate in a truly offline mode.
|
|
|
|
disable_startup_check: false
|
|
|
|
|
|
|
|
## The default of false will prevent startup only if we can contact the NTP server and the time is out of sync with
|
|
|
|
## the NTP server more than the configured max_desync. If you set this to true, an error will be logged but startup
|
|
|
|
## will continue regardless of results.
|
|
|
|
disable_failure: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Authentication Backend Provider Configuration
|
|
|
|
##
|
|
|
|
## Used for verifying user passwords and retrieve information such as email address and groups users belong to.
|
|
|
|
##
|
|
|
|
## The available providers are: `file`, `ldap`. You must use only one of these providers.
|
2018-08-26 15:30:43 +07:00
|
|
|
authentication_backend:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Disable both the HTML element and the API for reset password functionality.
|
2020-04-05 06:28:09 +07:00
|
|
|
disable_reset_password: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The amount of time to wait before we refresh data from the authentication backend. Uses duration notation.
|
|
|
|
## To disable this feature set it to 'disable', this will slightly reduce security because for Authelia, users will
|
|
|
|
## always belong to groups they belonged to at the time of login even if they have been removed from them in LDAP.
|
|
|
|
## To force update on every request you can set this to '0' or 'always', this will increase processor demand.
|
|
|
|
## See the below documentation for more information.
|
|
|
|
## Duration Notation docs: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
|
|
|
|
## Refresh Interval docs: https://www.authelia.com/docs/configuration/authentication/ldap.html#refresh-interval
|
2020-05-05 02:39:25 +07:00
|
|
|
refresh_interval: 5m
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## LDAP (Authentication Provider)
|
|
|
|
##
|
|
|
|
## This is the recommended Authentication Provider in production
|
|
|
|
## because it allows Authelia to offload the stateful operations
|
|
|
|
## onto the LDAP service.
|
2018-08-26 15:30:43 +07:00
|
|
|
ldap:
|
2021-04-11 18:25:03 +07:00
|
|
|
## The LDAP implementation, this affects elements like the attribute utilised for resetting a password.
|
|
|
|
## Acceptable options are as follows:
|
|
|
|
## - 'activedirectory' - For Microsoft Active Directory.
|
|
|
|
## - 'custom' - For custom specifications of attributes and filters.
|
|
|
|
## This currently defaults to 'custom' to maintain existing behaviour.
|
|
|
|
##
|
|
|
|
## Depending on the option here certain other values in this section have a default value, notably all of the
|
|
|
|
## attribute mappings have a default value that this config overrides, you can read more about these default values
|
|
|
|
## at https://www.authelia.com/docs/configuration/authentication/ldap.html#defaults
|
2020-11-27 16:59:22 +07:00
|
|
|
implementation: custom
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The url to the ldap server. Format: <scheme>://<address>[:<port>].
|
|
|
|
## Scheme can be ldap or ldaps in the format (port optional).
|
2019-01-30 22:47:03 +07:00
|
|
|
url: ldap://127.0.0.1
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
2021-08-05 11:30:00 +07:00
|
|
|
## The dial timeout for LDAP.
|
|
|
|
timeout: 5s
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Use StartTLS with the LDAP connection.
|
2020-12-03 12:23:52 +07:00
|
|
|
start_tls: false
|
|
|
|
|
2021-01-04 17:28:55 +07:00
|
|
|
tls:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Server Name for certificate validation (in case it's not set correctly in the URL).
|
2021-01-04 17:28:55 +07:00
|
|
|
# server_name: ldap.example.com
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Skip verifying the server certificate (to allow a self-signed certificate).
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## In preference to setting this we strongly recommend you add the public portion of the certificate to the
|
|
|
|
## certificates directory which is defined by the `certificates_directory` option at the top of the config.
|
2021-01-04 17:28:55 +07:00
|
|
|
skip_verify: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Minimum TLS version for either Secure LDAP or LDAP StartTLS.
|
2021-01-04 17:28:55 +07:00
|
|
|
minimum_version: TLS1.2
|
2020-12-03 12:23:52 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The distinguished name of the container searched for objects in the directory information tree.
|
|
|
|
## See also: additional_users_dn, additional_groups_dn.
|
2018-08-26 15:30:43 +07:00
|
|
|
base_dn: dc=example,dc=com
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The attribute holding the username of the user. This attribute is used to populate the username in the session
|
|
|
|
## information. It was introduced due to #561 to handle case insensitive search queries. For you information,
|
|
|
|
## Microsoft Active Directory usually uses 'sAMAccountName' and OpenLDAP usually uses 'uid'. Beware that this
|
|
|
|
## attribute holds the unique identifiers for the users binding the user and the configuration stored in database.
|
|
|
|
## Therefore only single value attributes are allowed and the value must never be changed once attributed to a user
|
|
|
|
## otherwise it would break the configuration for that user. Technically, non-unique attributes like 'mail' can also
|
|
|
|
## be used but we don't recommend using them, we instead advise to use the attributes mentioned above
|
|
|
|
## (sAMAccountName and uid) to follow https://www.ietf.org/rfc/rfc2307.txt.
|
2020-11-27 16:59:22 +07:00
|
|
|
# username_attribute: uid
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The additional_users_dn is prefixed to base_dn and delimited by a comma when searching for users.
|
|
|
|
## i.e. with this set to OU=Users and base_dn set to DC=a,DC=com; OU=Users,DC=a,DC=com is searched for users.
|
2018-08-26 15:30:43 +07:00
|
|
|
additional_users_dn: ou=users
|
2020-03-15 14:10:25 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The users filter used in search queries to find the user profile based on input filled in login form.
|
2021-08-05 11:17:07 +07:00
|
|
|
## Various placeholders are available in the user filter which you can read about in the documentation which can
|
|
|
|
## be found at: https://www.authelia.com/docs/configuration/authentication/ldap.html#users-filter-replacements
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Recommended settings are as follows:
|
|
|
|
## - Microsoft Active Directory: (&({username_attribute}={input})(objectCategory=person)(objectClass=user))
|
|
|
|
## - OpenLDAP:
|
|
|
|
## - (&({username_attribute}={input})(objectClass=person))
|
|
|
|
## - (&({username_attribute}={input})(objectClass=inetOrgPerson))
|
|
|
|
##
|
|
|
|
## To allow sign in both with username and email, one can use a filter like
|
|
|
|
## (&(|({username_attribute}={input})({mail_attribute}={input}))(objectClass=person))
|
2020-03-31 05:36:04 +07:00
|
|
|
users_filter: (&({username_attribute}={input})(objectClass=person))
|
2020-03-15 14:10:25 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The additional_groups_dn is prefixed to base_dn and delimited by a comma when searching for groups.
|
|
|
|
## i.e. with this set to OU=Groups and base_dn set to DC=a,DC=com; OU=Groups,DC=a,DC=com is searched for groups.
|
2018-08-26 15:30:43 +07:00
|
|
|
additional_groups_dn: ou=groups
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
2021-08-05 11:17:07 +07:00
|
|
|
## The groups filter used in search queries to find the groups based on relevant authenticated user.
|
|
|
|
## Various placeholders are available in the groups filter which you can read about in the documentation which can
|
|
|
|
## be found at: https://www.authelia.com/docs/configuration/authentication/ldap.html#groups-filter-replacements
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## If your groups use the `groupOfUniqueNames` structure use this instead:
|
2021-08-05 11:17:07 +07:00
|
|
|
## (&(uniqueMember={dn})(objectClass=groupOfUniqueNames))
|
|
|
|
groups_filter: (&(member={dn})(objectClass=groupOfNames))
|
2020-05-05 02:39:25 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The attribute holding the name of the group.
|
2020-11-27 16:59:22 +07:00
|
|
|
# group_name_attribute: cn
|
2020-05-05 02:39:25 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The attribute holding the mail address of the user. If multiple email addresses are defined for a user, only the
|
|
|
|
## first one returned by the LDAP server is used.
|
2020-11-27 16:59:22 +07:00
|
|
|
# mail_attribute: mail
|
2020-05-05 02:39:25 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The attribute holding the display name of the user. This will be used to greet an authenticated user.
|
2021-08-05 11:17:07 +07:00
|
|
|
# display_name_attribute: displayName
|
2020-06-19 17:50:21 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The username and password of the admin user.
|
2018-08-26 15:30:43 +07:00
|
|
|
user: cn=admin,dc=example,dc=com
|
2021-04-11 18:25:03 +07:00
|
|
|
## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2018-08-26 15:30:43 +07:00
|
|
|
password: password
|
2017-09-03 03:38:26 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## File (Authentication Provider)
|
|
|
|
##
|
|
|
|
## With this backend, the users database is stored in a file which is updated when users reset their passwords.
|
|
|
|
## Therefore, this backend is meant to be used in a dev environment and not in production since it prevents Authelia
|
|
|
|
## to be scaled to more than one instance. The options under 'password' have sane defaults, and as it has security
|
|
|
|
## implications it is highly recommended you leave the default values. Before considering changing these settings
|
|
|
|
## please read the docs page below:
|
|
|
|
## https://www.authelia.com/docs/configuration/authentication/file.html#password-hash-algorithm-tuning
|
|
|
|
##
|
|
|
|
## Important: Kubernetes (or HA) users must read https://www.authelia.com/docs/features/statelessness.html
|
|
|
|
##
|
|
|
|
# file:
|
|
|
|
# path: /config/users_database.yml
|
|
|
|
# password:
|
|
|
|
# algorithm: argon2id
|
|
|
|
# iterations: 1
|
|
|
|
# key_length: 32
|
|
|
|
# salt_length: 16
|
|
|
|
# memory: 1024
|
|
|
|
# parallelism: 8
|
|
|
|
|
|
|
|
##
|
|
|
|
## Access Control Configuration
|
|
|
|
##
|
|
|
|
## Access control is a list of rules defining the authorizations applied for one resource to users or group of users.
|
|
|
|
##
|
|
|
|
## If 'access_control' is not defined, ACL rules are disabled and the 'bypass' rule is applied, i.e., access is allowed
|
|
|
|
## to anyone. Otherwise restrictions follow the rules defined.
|
|
|
|
##
|
|
|
|
## Note: One can use the wildcard * to match any subdomain.
|
|
|
|
## It must stand at the beginning of the pattern. (example: *.mydomain.com)
|
|
|
|
##
|
|
|
|
## Note: You must put patterns containing wildcards between simple quotes for the YAML to be syntactically correct.
|
|
|
|
##
|
|
|
|
## Definition: A 'rule' is an object with the following keys: 'domain', 'subject', 'policy' and 'resources'.
|
|
|
|
##
|
|
|
|
## - 'domain' defines which domain or set of domains the rule applies to.
|
|
|
|
##
|
|
|
|
## - 'subject' defines the subject to apply authorizations to. This parameter is optional and matching any user if not
|
|
|
|
## provided. If provided, the parameter represents either a user or a group. It should be of the form
|
|
|
|
## 'user:<username>' or 'group:<groupname>'.
|
|
|
|
##
|
|
|
|
## - 'policy' is the policy to apply to resources. It must be either 'bypass', 'one_factor', 'two_factor' or 'deny'.
|
|
|
|
##
|
|
|
|
## - 'resources' is a list of regular expressions that matches a set of resources to apply the policy to. This parameter
|
|
|
|
## is optional and matches any resource if not provided.
|
|
|
|
##
|
|
|
|
## Note: the order of the rules is important. The first policy matching (domain, resource, subject) applies.
|
2017-03-25 21:17:21 +07:00
|
|
|
access_control:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Default policy can either be 'bypass', 'one_factor', 'two_factor' or 'deny'. It is the policy applied to any
|
|
|
|
## resource if there is no policy to be applied to the user.
|
2017-09-03 20:22:09 +07:00
|
|
|
default_policy: deny
|
|
|
|
|
2021-01-04 17:55:23 +07:00
|
|
|
networks:
|
|
|
|
- name: internal
|
|
|
|
networks:
|
|
|
|
- 10.10.0.0/16
|
|
|
|
- 192.168.2.0/24
|
|
|
|
- name: VPN
|
|
|
|
networks: 10.9.0.0/16
|
|
|
|
|
2018-10-24 05:29:09 +07:00
|
|
|
rules:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to everyone
|
2017-11-03 03:34:07 +07:00
|
|
|
- domain: public.example.com
|
2019-03-04 05:51:52 +07:00
|
|
|
policy: bypass
|
2019-03-28 05:09:01 +07:00
|
|
|
|
|
|
|
- domain: secure.example.com
|
|
|
|
policy: one_factor
|
2021-04-11 18:25:03 +07:00
|
|
|
## Network based rule, if not provided any network matches.
|
2019-03-28 05:09:01 +07:00
|
|
|
networks:
|
2021-01-04 17:55:23 +07:00
|
|
|
- internal
|
|
|
|
- VPN
|
2019-03-28 05:09:01 +07:00
|
|
|
- 192.168.1.0/24
|
2021-01-04 17:55:23 +07:00
|
|
|
- 10.0.0.1
|
2020-04-16 07:18:11 +07:00
|
|
|
|
|
|
|
- domain:
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
- secure.example.com
|
|
|
|
- private.example.com
|
2018-10-23 04:21:17 +07:00
|
|
|
policy: two_factor
|
2019-03-28 05:09:01 +07:00
|
|
|
|
2019-03-04 05:51:52 +07:00
|
|
|
- domain: singlefactor.example.com
|
2018-10-23 04:21:17 +07:00
|
|
|
policy: one_factor
|
2018-10-24 05:29:09 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to 'admins' group
|
2019-11-30 23:49:52 +07:00
|
|
|
- domain: "mx2.mail.example.com"
|
2019-12-04 14:46:49 +07:00
|
|
|
subject: "group:admins"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: deny
|
2020-04-16 07:18:11 +07:00
|
|
|
|
2019-11-30 23:49:52 +07:00
|
|
|
- domain: "*.example.com"
|
2020-04-16 07:18:11 +07:00
|
|
|
subject:
|
|
|
|
- "group:admins"
|
|
|
|
- "group:moderators"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to 'dev' group
|
2018-10-24 05:29:09 +07:00
|
|
|
- domain: dev.example.com
|
|
|
|
resources:
|
2019-11-30 23:49:52 +07:00
|
|
|
- "^/groups/dev/.*$"
|
|
|
|
subject: "group:dev"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to user 'john'
|
2018-10-24 05:29:09 +07:00
|
|
|
- domain: dev.example.com
|
|
|
|
resources:
|
2019-11-30 23:49:52 +07:00
|
|
|
- "^/users/john/.*$"
|
|
|
|
subject: "user:john"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to user 'harry'
|
2018-10-24 05:29:09 +07:00
|
|
|
- domain: dev.example.com
|
|
|
|
resources:
|
2019-11-30 23:49:52 +07:00
|
|
|
- "^/users/harry/.*$"
|
|
|
|
subject: "user:harry"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Rules applied to user 'bob'
|
2019-11-30 23:49:52 +07:00
|
|
|
- domain: "*.mail.example.com"
|
|
|
|
subject: "user:bob"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
2019-11-30 23:49:52 +07:00
|
|
|
- domain: "dev.example.com"
|
2018-10-24 05:29:09 +07:00
|
|
|
resources:
|
2019-11-30 23:49:52 +07:00
|
|
|
- "^/users/bob/.*$"
|
|
|
|
subject: "user:bob"
|
2018-10-24 05:29:09 +07:00
|
|
|
policy: two_factor
|
2017-03-25 21:17:21 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Session Provider Configuration
|
|
|
|
##
|
|
|
|
## The session cookies identify the user once logged in.
|
|
|
|
## The available providers are: `memory`, `redis`. Memory is the provider unless redis is defined.
|
2017-01-22 23:54:45 +07:00
|
|
|
session:
|
2021-04-11 18:25:03 +07:00
|
|
|
## The name of the session cookie.
|
2018-08-19 18:07:00 +07:00
|
|
|
name: authelia_session
|
|
|
|
|
2021-04-18 07:02:04 +07:00
|
|
|
## The domain to protect.
|
|
|
|
## Note: the authenticator must also be in that domain.
|
|
|
|
## If empty, the cookie is restricted to the subdomain of the issuer.
|
|
|
|
domain: example.com
|
|
|
|
|
|
|
|
## Sets the Cookie SameSite value. Possible options are none, lax, or strict.
|
2021-10-04 08:13:54 +07:00
|
|
|
## Please read https://www.authelia.com/docs/configuration/session/#same_site
|
2021-04-18 07:02:04 +07:00
|
|
|
same_site: lax
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The secret to encrypt the session data. This is only used with Redis / Redis Sentinel.
|
|
|
|
## Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2020-04-04 06:11:33 +07:00
|
|
|
secret: insecure_session_secret
|
2018-10-24 05:29:09 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The value for expiration, inactivity, and remember_me_duration are in seconds or the duration notation format.
|
|
|
|
## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
|
|
|
|
## All three of these values affect the cookie/session validity period. Longer periods are considered less secure
|
|
|
|
## because a stolen cookie will last longer giving attackers more time to spy or attack.
|
|
|
|
|
|
|
|
## The time before the cookie expires and the session is destroyed if remember me IS NOT selected.
|
2020-04-05 19:37:21 +07:00
|
|
|
expiration: 1h
|
2017-09-03 06:25:43 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The inactivity time before the session is reset. If expiration is set to 1h, and this is set to 5m, if the user
|
|
|
|
## does not select the remember me option their session will get destroyed after 1h, or after 5m since the last time
|
|
|
|
## Authelia detected user activity.
|
2020-04-05 19:37:21 +07:00
|
|
|
inactivity: 5m
|
2017-10-17 05:38:10 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The time before the cookie expires and the session is destroyed if remember me IS selected.
|
|
|
|
## Value of 0 disables remember me.
|
2020-04-04 06:11:33 +07:00
|
|
|
remember_me_duration: 1M
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Redis Provider
|
|
|
|
##
|
|
|
|
## Important: Kubernetes (or HA) users must read https://www.authelia.com/docs/features/statelessness.html
|
|
|
|
##
|
2017-06-30 00:41:05 +07:00
|
|
|
redis:
|
2019-01-30 22:47:03 +07:00
|
|
|
host: 127.0.0.1
|
2017-06-30 00:41:05 +07:00
|
|
|
port: 6379
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## Use a unix socket instead
|
2020-05-18 09:45:47 +07:00
|
|
|
# host: /var/run/redis/redis.sock
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Username used for redis authentication. This is optional and a new feature in redis 6.0.
|
|
|
|
# username: authelia
|
2020-05-18 09:45:47 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2018-08-26 18:10:23 +07:00
|
|
|
password: authelia
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
|
|
|
|
## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc).
|
2020-02-28 07:14:44 +07:00
|
|
|
database_index: 0
|
2017-01-22 23:54:45 +07:00
|
|
|
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## The maximum number of concurrent active connections to Redis.
|
|
|
|
maximum_active_connections: 8
|
|
|
|
|
|
|
|
## The target number of idle connections to have open ready for work. Useful when opening connections is slow.
|
|
|
|
minimum_idle_connections: 0
|
|
|
|
|
|
|
|
## The Redis TLS configuration. If defined will require a TLS connection to the Redis instance(s).
|
|
|
|
# tls:
|
|
|
|
## Server Name for certificate validation (in case you are using the IP or non-FQDN in the host option).
|
|
|
|
# server_name: myredis.example.com
|
|
|
|
|
|
|
|
## Skip verifying the server certificate (to allow a self-signed certificate).
|
|
|
|
## In preference to setting this we strongly recommend you add the public portion of the certificate to the
|
|
|
|
## certificates directory which is defined by the `certificates_directory` option at the top of the config.
|
|
|
|
# skip_verify: false
|
|
|
|
|
|
|
|
## Minimum TLS version for the connection.
|
|
|
|
# minimum_version: TLS1.2
|
|
|
|
|
|
|
|
## The Redis HA configuration options.
|
|
|
|
## This provides specific options to Redis Sentinel, sentinel_name must be defined (Master Name).
|
|
|
|
# high_availability:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Sentinel Name / Master Name.
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
# sentinel_name: mysentinel
|
|
|
|
|
2021-10-31 10:26:58 +07:00
|
|
|
## Specific username for Redis Sentinel. The node username and password is configured above.
|
|
|
|
# sentinel_username: sentinel_specific_user
|
|
|
|
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## Specific password for Redis Sentinel. The node username and password is configured above.
|
|
|
|
# sentinel_password: sentinel_specific_pass
|
|
|
|
|
|
|
|
## The additional nodes to pre-seed the redis provider with (for sentinel).
|
|
|
|
## If the host in the above section is defined, it will be combined with this list to connect to sentinel.
|
|
|
|
## For high availability to be used you must have either defined; the host above or at least one node below.
|
|
|
|
# nodes:
|
|
|
|
# - host: sentinel-node1
|
|
|
|
# port: 6379
|
|
|
|
# - host: sentinel-node2
|
|
|
|
# port: 6379
|
|
|
|
|
|
|
|
## Choose the host with the lowest latency.
|
|
|
|
# route_by_latency: false
|
|
|
|
|
|
|
|
## Choose the host randomly.
|
|
|
|
# route_randomly: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Regulation Configuration
|
|
|
|
##
|
|
|
|
## This mechanism prevents attackers from brute forcing the first factor. It bans the user if too many attempts are made
|
|
|
|
## in a short period of time.
|
2017-09-03 06:25:43 +07:00
|
|
|
regulation:
|
2021-04-11 18:25:03 +07:00
|
|
|
## The number of failed login attempts before user is banned. Set it to 0 to disable regulation.
|
2017-09-03 06:25:43 +07:00
|
|
|
max_retries: 3
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The time range during which the user can attempt login before being banned. The user is banned if the
|
|
|
|
## authentication failed 'max_retries' times in a 'find_time' seconds window. Find Time accepts duration notation.
|
|
|
|
## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
|
2020-04-05 19:37:21 +07:00
|
|
|
find_time: 2m
|
2017-09-03 06:25:43 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## The length of time before a banned user can login again. Ban Time accepts duration notation.
|
|
|
|
## See: https://www.authelia.com/docs/configuration/index.html#duration-notation-format
|
2020-04-05 19:37:21 +07:00
|
|
|
ban_time: 5m
|
2017-09-03 06:25:43 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Storage Provider Configuration
|
|
|
|
##
|
|
|
|
## The available providers are: `local`, `mysql`, `postgres`. You must use one and only one of these providers.
|
2017-07-20 02:06:12 +07:00
|
|
|
storage:
|
2021-11-25 08:56:58 +07:00
|
|
|
## The encryption key that is used to encrypt sensitive information in the database. Must be a string with a minimum
|
|
|
|
## length of 20. Please see the docs if you configure this with an undesirable key and need to change it.
|
|
|
|
# encryption_key: you_must_generate_a_random_string_of_more_than_twenty_chars_and_configure_this
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Local (Storage Provider)
|
|
|
|
##
|
|
|
|
## This stores the data in a SQLite3 Database.
|
|
|
|
## This is only recommended for lightweight non-stateful installations.
|
|
|
|
##
|
|
|
|
## Important: Kubernetes (or HA) users must read https://www.authelia.com/docs/features/statelessness.html
|
|
|
|
##
|
|
|
|
# local:
|
|
|
|
# path: /config/db.sqlite3
|
|
|
|
|
|
|
|
##
|
|
|
|
## MySQL / MariaDB (Storage Provider)
|
|
|
|
##
|
2019-11-17 02:50:58 +07:00
|
|
|
mysql:
|
2019-11-16 17:38:21 +07:00
|
|
|
host: 127.0.0.1
|
|
|
|
port: 3306
|
2018-03-29 05:04:59 +07:00
|
|
|
database: authelia
|
2019-11-16 17:38:21 +07:00
|
|
|
username: authelia
|
2021-04-11 18:25:03 +07:00
|
|
|
## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2019-11-16 17:38:21 +07:00
|
|
|
password: mypassword
|
2021-08-06 12:35:14 +07:00
|
|
|
timeout: 5s
|
2019-11-17 02:50:58 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## PostgreSQL (Storage Provider)
|
|
|
|
##
|
2019-11-17 02:50:58 +07:00
|
|
|
# postgres:
|
|
|
|
# host: 127.0.0.1
|
2020-04-11 09:38:57 +07:00
|
|
|
# port: 5432
|
2019-11-17 02:50:58 +07:00
|
|
|
# database: authelia
|
|
|
|
# username: authelia
|
2021-04-11 18:25:03 +07:00
|
|
|
# ## Password can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
2019-11-17 02:50:58 +07:00
|
|
|
# password: mypassword
|
2021-08-06 12:35:14 +07:00
|
|
|
# timeout: 5s
|
2020-04-23 08:11:32 +07:00
|
|
|
# sslmode: disable
|
2017-01-29 01:59:15 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## Notification Provider
|
|
|
|
##
|
|
|
|
## Notifications are sent to users when they require a password reset, a U2F registration or a TOTP registration.
|
|
|
|
## The available providers are: filesystem, smtp. You must use only one of these providers.
|
2017-01-22 23:54:45 +07:00
|
|
|
notifier:
|
2021-04-11 18:25:03 +07:00
|
|
|
## You can disable the notifier startup check by setting this to true.
|
[FEATURE] Notifier Startup Checks (#889)
* implement SMTP notifier startup check
* check dial, starttls, auth, mail from, rcpt to, reset, and quit
* log the error on failure
* implement mock
* misc optimizations, adjustments, and refactoring
* implement validate_skip config option
* fix comments to end with period
* fix suites that used smtp notifier without a smtp container
* add docs
* add file notifier startup check
* move file mode into const.go
* disable gosec linting on insecureskipverify since it's intended, warned, and discouraged
* minor PR commentary adjustment
* apply suggestions from code review
Co-Authored-By: Amir Zarrinkafsh <nightah@me.com>
2020-04-21 11:59:38 +07:00
|
|
|
disable_startup_check: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
##
|
|
|
|
## File System (Notification Provider)
|
|
|
|
##
|
|
|
|
## Important: Kubernetes (or HA) users must read https://www.authelia.com/docs/features/statelessness.html
|
|
|
|
##
|
|
|
|
# filesystem:
|
|
|
|
# filename: /config/notification.txt
|
|
|
|
|
|
|
|
##
|
|
|
|
## SMTP (Notification Provider)
|
|
|
|
##
|
|
|
|
## Use a SMTP server for sending notifications. Authelia uses the PLAIN or LOGIN methods to authenticate.
|
|
|
|
## [Security] By default Authelia will:
|
|
|
|
## - force all SMTP connections over TLS including unauthenticated connections
|
|
|
|
## - use the disable_require_tls boolean value to disable this requirement
|
|
|
|
## (only works for unauthenticated connections)
|
|
|
|
## - validate the SMTP server x509 certificate during the TLS handshake against the hosts trusted certificates
|
|
|
|
## (configure in tls section)
|
2017-09-24 19:49:03 +07:00
|
|
|
smtp:
|
2021-08-10 07:52:41 +07:00
|
|
|
## The SMTP host to connect to.
|
2019-01-30 22:47:03 +07:00
|
|
|
host: 127.0.0.1
|
2021-08-10 07:52:41 +07:00
|
|
|
|
|
|
|
## The port to connect to the SMTP host on.
|
2017-09-24 19:49:03 +07:00
|
|
|
port: 1025
|
2021-08-10 07:52:41 +07:00
|
|
|
|
|
|
|
## The connection timeout.
|
|
|
|
timeout: 5s
|
|
|
|
|
|
|
|
## The username used for SMTP authentication.
|
|
|
|
username: test
|
|
|
|
|
|
|
|
## The password used for SMTP authentication.
|
|
|
|
## Can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
|
|
|
password: password
|
|
|
|
|
2021-11-30 18:15:21 +07:00
|
|
|
## The sender is used to is used for the MAIL FROM command and the FROM header.
|
|
|
|
## If this is not defined and the username is an email, we use the username as this value. This can either be just
|
|
|
|
## an email address or the RFC5322 'Name <email address>' format.
|
|
|
|
sender: "Authelia <admin@example.com>"
|
2021-08-10 07:52:41 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost.
|
2020-11-05 06:22:10 +07:00
|
|
|
identifier: localhost
|
2021-08-10 07:52:41 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Subject configuration of the emails sent. {title} is replaced by the text from the notifier.
|
2020-04-09 07:21:28 +07:00
|
|
|
subject: "[Authelia] {title}"
|
2021-08-10 07:52:41 +07:00
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## This address is used during the startup check to verify the email configuration is correct.
|
|
|
|
## It's not important what it is except if your email server only allows local delivery.
|
2020-04-23 08:47:27 +07:00
|
|
|
startup_check_address: test@authelia.com
|
2021-08-10 07:52:41 +07:00
|
|
|
|
|
|
|
## By default we require some form of TLS. This disables this check though is not advised.
|
2020-04-23 08:47:27 +07:00
|
|
|
disable_require_tls: false
|
2021-08-10 07:52:41 +07:00
|
|
|
|
|
|
|
## Disables sending HTML formatted emails.
|
2020-08-21 09:16:23 +07:00
|
|
|
disable_html_emails: false
|
2020-02-01 20:17:39 +07:00
|
|
|
|
2021-01-04 17:28:55 +07:00
|
|
|
tls:
|
2021-04-11 18:25:03 +07:00
|
|
|
## Server Name for certificate validation (in case you are using the IP or non-FQDN in the host option).
|
2021-01-04 17:28:55 +07:00
|
|
|
# server_name: smtp.example.com
|
|
|
|
|
feat(session): add redis sentinel provider (#1768)
* feat(session): add redis sentinel provider
* refactor(session): use int for ports as per go standards
* refactor(configuration): adjust tests and validation
* refactor(configuration): add err format consts
* refactor(configuration): explicitly map redis structs
* refactor(session): merge redis/redis sentinel providers
* refactor(session): add additional checks to redis providers
* feat(session): add redis cluster provider
* fix: update config for new values
* fix: provide nil certpool to affected tests/mocks
* test: add additional tests to cover uncovered code
* docs: expand explanation of host and nodes relation for redis
* ci: add redis-sentinel to suite highavailability, add redis-sentinel quorum
* fix(session): sentinel password
* test: use redis alpine library image for redis sentinel, use expose instead of ports, use redis ip, adjust redis ip range, adjust redis config
* test: make entrypoint.sh executable, fix entrypoint.sh if/elif
* test: add redis failover tests
* test: defer docker start, adjust sleep, attempt logout before login, attempt visit before login and tune timeouts, add additional logging
* test: add sentinel integration test
* test: add secondary node failure to tests, fix password usage, bump test timeout, add sleep
* feat: use sentinel failover cluster
* fix: renamed addrs to sentineladdrs upstream
* test(session): sentinel failover
* test: add redis standard back into testing
* test: move redis standalone test to traefik2
* fix/docs: apply suggestions from code review
2021-03-10 06:03:05 +07:00
|
|
|
## Skip verifying the server certificate (to allow a self-signed certificate).
|
|
|
|
## In preference to setting this we strongly recommend you add the public portion of the certificate to the
|
|
|
|
## certificates directory which is defined by the `certificates_directory` option at the top of the config.
|
2021-01-04 17:28:55 +07:00
|
|
|
skip_verify: false
|
|
|
|
|
2021-04-11 18:25:03 +07:00
|
|
|
## Minimum TLS version for either StartTLS or SMTPS.
|
2021-01-04 17:28:55 +07:00
|
|
|
minimum_version: TLS1.2
|
|
|
|
|
2021-05-05 05:06:05 +07:00
|
|
|
##
|
|
|
|
## Identity Providers
|
|
|
|
##
|
|
|
|
# identity_providers:
|
|
|
|
|
|
|
|
##
|
|
|
|
## OpenID Connect (Identity Provider)
|
|
|
|
##
|
|
|
|
## It's recommended you read the documentation before configuration of this section:
|
|
|
|
## https://www.authelia.com/docs/configuration/identity-providers/oidc.html
|
|
|
|
# oidc:
|
|
|
|
## The hmac_secret is used to sign OAuth2 tokens (authorization code, access tokens and refresh tokens).
|
|
|
|
## HMAC Secret can also be set using a secret: https://www.authelia.com/docs/configuration/secrets.html
|
|
|
|
# hmac_secret: this_is_a_secret_abc123abc123abc
|
|
|
|
|
|
|
|
## The issuer_private_key is used to sign the JWT forged by OpenID Connect.
|
|
|
|
## Issuer Private Key can also be set using a secret: https://docs.authelia.com/configuration/secrets.html
|
|
|
|
# issuer_private_key: |
|
|
|
|
# --- KEY START
|
|
|
|
# --- KEY END
|
|
|
|
|
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-04 06:44:30 +07:00
|
|
|
## The lifespans configure the expiration for these token types.
|
|
|
|
# access_token_lifespan: 1h
|
|
|
|
# authorize_code_lifespan: 1m
|
|
|
|
# id_token_lifespan: 1h
|
|
|
|
# refresh_token_lifespan: 90m
|
|
|
|
|
|
|
|
## Enables additional debug messages.
|
|
|
|
# enable_client_debug_messages: false
|
|
|
|
|
2021-07-15 18:02:03 +07:00
|
|
|
## SECURITY NOTICE: It's not recommended changing this option, and highly discouraged to have it below 8 for
|
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-04 06:44:30 +07:00
|
|
|
## security reasons.
|
|
|
|
# minimum_parameter_entropy: 8
|
|
|
|
|
2021-05-05 05:06:05 +07:00
|
|
|
## Clients is a list of known clients and their configuration.
|
|
|
|
# clients:
|
|
|
|
# -
|
|
|
|
## The ID is the OpenID Connect ClientID which is used to link an application to a configuration.
|
|
|
|
# id: myapp
|
|
|
|
|
|
|
|
## The description to show to users when they end up on the consent screen. Defaults to the ID above.
|
|
|
|
# description: My Application
|
|
|
|
|
|
|
|
## The client secret is a shared secret between Authelia and the consumer of this client.
|
|
|
|
# secret: this_is_a_secret
|
|
|
|
|
2021-07-15 18:02:03 +07:00
|
|
|
## Sets the client to public. This should typically not be set, please see the documentation for usage.
|
|
|
|
# public: false
|
|
|
|
|
2021-05-05 05:06:05 +07:00
|
|
|
## The policy to require for this client; one_factor or two_factor.
|
|
|
|
# authorization_policy: two_factor
|
|
|
|
|
2021-07-15 18:02:03 +07:00
|
|
|
## Audience this client is allowed to request.
|
|
|
|
# audience: []
|
|
|
|
|
|
|
|
## Scopes this client is allowed to request.
|
|
|
|
# scopes:
|
|
|
|
# - openid
|
|
|
|
# - groups
|
|
|
|
# - email
|
|
|
|
# - profile
|
|
|
|
|
2021-05-05 05:06:05 +07:00
|
|
|
## Redirect URI's specifies a list of valid case-sensitive callbacks for this client.
|
|
|
|
# redirect_uris:
|
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-04 06:44:30 +07:00
|
|
|
# - https://oidc.example.com:8080/oauth2/callback
|
2021-05-05 05:06:05 +07:00
|
|
|
|
|
|
|
## Grant Types configures which grants this client can obtain.
|
|
|
|
## It's not recommended to define this unless you know what you're doing.
|
|
|
|
# grant_types:
|
2021-07-15 18:02:03 +07:00
|
|
|
# - refresh_token
|
|
|
|
# - authorization_code
|
2021-05-05 05:06:05 +07:00
|
|
|
|
|
|
|
## Response Types configures which responses this client can be sent.
|
|
|
|
## It's not recommended to define this unless you know what you're doing.
|
|
|
|
# response_types:
|
2021-07-15 18:02:03 +07:00
|
|
|
# - code
|
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-04 06:44:30 +07:00
|
|
|
|
|
|
|
## Response Modes configures which response modes this client supports.
|
|
|
|
# response_modes:
|
2021-07-15 18:02:03 +07:00
|
|
|
# - form_post
|
|
|
|
# - query
|
|
|
|
# - fragment
|
2021-07-10 11:56:33 +07:00
|
|
|
|
|
|
|
## The algorithm used to sign userinfo endpoint responses for this client, either none or RS256.
|
|
|
|
# userinfo_signing_algorithm: none
|
2021-04-11 18:25:03 +07:00
|
|
|
...
|