diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index e94cb1b1b..9571705f6 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -3,7 +3,7 @@ # github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] # patreon: # Replace with a single Patreon username -open_collective: authelia-sponsors +open_collective: 'authelia-sponsors' # ko_fi: # Replace with a single Ko-fi username # tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel # community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 2a89a14ac..1bf5a3b93 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,22 +1,22 @@ --- blank_issues_enabled: false contact_links: - - name: Idea - url: https://github.com/authelia/authelia/discussions/new?category=ideas - about: Submit an Idea for Voting - - name: Question - url: https://github.com/authelia/authelia/discussions/new?category=q-a - about: Ask a Question - - name: Discussion - url: https://github.com/authelia/authelia/discussions/new - about: Start a Discussion related to Ideas, Polls, Show and Tell, or General Topics - - name: Documentation - url: https://www.authelia.com/ - about: Read the Documentation - - name: Matrix - url: https://matrix.to/#/#community:authelia.com - about: Discuss Authelia with the Developers on Matrix which is the preferred method of contact - - name: Discord - url: https://discord.authelia.com - about: Discuss Authelia with the Developers on Discord which is bridged to Matrix + - name: 'Idea' + url: 'https://github.com/authelia/authelia/discussions/new?category=ideas' + about: 'Submit an Idea for Voting' + - name: 'Question' + url: 'https://github.com/authelia/authelia/discussions/new?category=q-a' + about: 'Ask a Question' + - name: 'Discussion' + url: 'https://github.com/authelia/authelia/discussions/new' + about: 'Start a Discussion related to Ideas, Polls, Show and Tell, or General Topics' + - name: 'Documentation' + url: 'https://www.authelia.com/' + about: 'Read the Documentation' + - name: 'Matrix' + url: 'https://matrix.to/#/#community:authelia.com' + about: 'Discuss Authelia with the Developers on Matrix which is the preferred method of contact' + - name: 'Discord' + url: 'https://discord.authelia.com' + about: 'Discuss Authelia with the Developers on Discord which is bridged to Matrix' ... diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 607f832ff..4cd251a9a 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,12 +1,12 @@ --- -name: Feature Request -description: Submit a Feature Request +name: 'Feature Request' +description: 'Submit a Feature Request' labels: - - type/feature - - status/needs-design - - priority/4/normal + - 'type/feature' + - 'status/needs-design' + - 'priority/4/normal' body: - - type: markdown + - type: 'markdown' attributes: value: | Thanks for taking the time to fill out this feature request. A feature request is created as issue for the purpose of tracking the design and implementation of a feature. @@ -16,42 +16,54 @@ body: 1. Ensure there are no other similar feature requests. 2. Make sure you've checked the [Documentation](https://www.authelia.com) doesn't clearly document the features existence already. 3. Consider creating an [Idea Discussion](https://github.com/authelia/authelia/discussions/new?category=ideas) which can be voted on instead if one doesn't exist. - - type: textarea - id: description + - type: 'textarea' + id: 'description' attributes: - label: Description - description: Describe the feature + label: | + Description + description: | + Describe the feature validations: required: true - - type: textarea - id: use-case + - type: 'textarea' + id: 'use-case' attributes: - label: Use Case - description: Provide a use case + label: | + Use Case + description: | + Provide a use case validations: required: true - - type: textarea - id: details + - type: 'textarea' + id: 'details' attributes: - label: Details - description: Describe the feature in detail + label: | + Details + description: | + Describe the feature in detail validations: required: false - - type: textarea - id: documentation + - type: 'textarea' + id: 'documentation' attributes: - label: Documentation - description: Provide any relevant specification or other documentation if applicable + label: | + Documentation + description: | + Provide any relevant specification or other documentation if applicable validations: required: false - - type: checkboxes - id: checklist + - type: 'checkboxes' + id: 'checklist' attributes: - label: Pre-Submission Checklist - description: By submitting this issue confirm all of the following + label: | + Pre-Submission Checklist + description: | + By submitting this issue confirm all of the following options: - - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) + - label: | + I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) required: true - - label: I have checked for related issues and checked the documentation + - label: | + I have checked for related issues and checked the documentation required: true ... diff --git a/.yamllint.yml b/.yamllint.yml index 66bafeb8f..c5cb4ee41 100644 --- a/.yamllint.yml +++ b/.yamllint.yml @@ -11,6 +11,7 @@ yaml-files: ignore: | api/openapi.yml docs/pnpm-lock.yaml + docs/node_modules/ internal/configuration/test_resources/config_bad_quoting.yml web/pnpm-lock.yaml web/node_modules/ diff --git a/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl b/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl index 7fe279929..7280b9f9d 100644 --- a/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl +++ b/cmd/authelia-gen/templates/github_issue_template_bug_report.yml.tmpl @@ -1,12 +1,12 @@ --- -name: Bug Report -description: Report a bug +name: 'Bug Report' +description: 'Report a bug' labels: {{- range .Labels }} - - {{ . }} + - '{{ . }}' {{- end }} body: - - type: markdown + - type: 'markdown' attributes: value: | Thanks for taking the time to fill out this bug report. If you are unsure if this is actually a bug and you still need some form of support we generally recommend creating a [Question and Answer Discussion](https://github.com/authelia/authelia/discussions/new?category=q-a) first. @@ -25,122 +25,152 @@ body: - Do not truncate any logs unless you are complying with the specific instructions in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section. - If you plan on sanitizing, removing, or adjusting any values for the logs or configuration files please read the [Sanitization](https://www.authelia.com/r/troubleshooting#sanitization) section. 7. Please consider including a [HTTP Archive File](https://www.authelia.com/r/har) if you're having redirection issues. - - type: dropdown - id: version + - type: 'dropdown' + id: 'version' attributes: - label: Version - description: What version(s) of Authelia can you reproduce this bug on? + label: | + Version + description: | + What version(s) of Authelia can you reproduce this bug on? multiple: true options: {{- range .Versions }} - - {{ . }} + - '{{ . }}' {{- end }} validations: required: true - - type: dropdown - id: deployment + - type: 'dropdown' + id: 'deployment' attributes: - label: Deployment Method - description: How are you deploying Authelia? + label: | + Deployment Method + description: | + How are you deploying Authelia? options: - - Docker - - Kubernetes - - Bare-metal - - Other + - 'Docker' + - 'Kubernetes' + - 'Bare-metal' + - 'Other' validations: required: true - - type: dropdown - id: proxy + - type: 'dropdown' + id: 'proxy' attributes: - label: Reverse Proxy - description: What reverse proxy are you using? + label: | + Reverse Proxy + description: | + What reverse proxy are you using? options: {{- range .Proxies }} - - {{ . }} + - '{{ . }}' {{- end }} validations: required: true - - type: input - id: proxy-version + - type: 'input' + id: 'proxy-version' attributes: - label: Reverse Proxy Version - description: What is the version of your reverse proxy? - placeholder: x.x.x + label: | + Reverse Proxy Version + description: | + What is the version of your reverse proxy? + placeholder: 'x.x.x' validations: required: false - - type: textarea - id: description + - type: 'textarea' + id: 'description' attributes: - label: Description - description: Describe the bug. + label: | + Description + description: | + Describe the bug. validations: required: true - - type: textarea - id: reproduction + - type: 'textarea' + id: 'reproduction' attributes: - label: Reproduction - description: Describe how we can reproduce this issue. This should be step by step and should include detailed and specific information. Abstract or generic information should be avoided. For example this should include specific application names and versions if relevant. Reproducing the issue is important so we can verify it exists, add relevant tests, and verify it is solved. + label: | + Reproduction + description: | + Describe how we can reproduce this issue. This should be step by step and should include detailed and specific information. Abstract or generic information should be avoided. For example this should include specific application names and versions if relevant. Reproducing the issue is important so we can verify it exists, add relevant tests, and verify it is solved. validations: required: true - - type: textarea - id: expectations + - type: 'textarea' + id: 'expectations' attributes: - label: Expectations - description: Describe the desired or expected results. + label: | + Expectations + description: | + Describe the desired or expected results. validations: required: false - - type: textarea - id: configuration + - type: 'textarea' + id: 'configuration' attributes: - label: Configuration (Authelia) - description: Provide a complete configuration file (the template will automatically put this content in a code block). - render: yaml + label: | + Configuration (Authelia) + description: | + Provide a complete configuration file (the template will automatically put this content in a code block). + render: 'yaml' validations: required: false - - type: textarea - id: logs + - type: 'textarea' + id: 'logs' attributes: - label: Logs (Authelia) + label: | + Logs (Authelia) description: | Provide complete logs with the log level set to debug or trace. Complete means from application start until the issue occurring. This is clearly explained in the [Logs](https://www.authelia.com/r/troubleshooting#logs) section of the troubleshooting guide. The template will automatically put this content in a code block so you can just paste it. - render: shell + render: 'shell' validations: required: true - - type: textarea - id: logs-other + - type: 'textarea' + id: 'logs-other' attributes: - label: Logs (Proxy / Application) - description: Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block). - render: shell + label: | + Logs (Proxy / Application) + description: | + Provide complete debug logs for the affected proxy and/or application if available and relevant (the template will automatically put this content in a code block). + render: 'shell' validations: required: false - - type: textarea - id: documentation + - type: 'textarea' + id: 'documentation' attributes: - label: Documentation - description: Provide any relevant specification or other documentation if applicable. + label: | + Documentation + description: | + Provide any relevant specification or other documentation if applicable. validations: required: false - - type: checkboxes - id: checklist + - type: 'checkboxes' + id: 'checklist' attributes: - label: Pre-Submission Checklist - description: By submitting this issue confirm all of the following. + label: | + Pre-Submission Checklist + description: | + By submitting this issue confirm all of the following. options: - - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) + - label: | + I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) required: true - - label: This is a bug report and not a support request + - label: | + This is a bug report and not a support request required: true - - label: I have read the security policy and this bug report is not a security issue or security related issue + - label: | + I have read the security policy and this bug report is not a security issue or security related issue required: true - - label: I have either included the complete configuration file or I am sure it's unrelated to the configuration + - label: | + I have either included the complete configuration file or I am sure it's unrelated to the configuration required: true - - label: I have provided all of the required information in full with the only alteration being reasonable sanitization in accordance with the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide + - label: | + I have provided all of the required information in full with the only alteration being reasonable sanitization in accordance with the [Troubleshooting Sanitization](https://www.authelia.com/r/sanitize) reference guide required: true - - label: I have checked for related proxy or application logs and included them if available + - label: | + I have checked for related proxy or application logs and included them if available required: true - - label: I have checked for related issues and checked the documentation + - label: | + I have checked for related issues and checked the documentation required: true ... diff --git a/cmd/authelia-gen/templates/github_issue_template_feature.yml.tmpl b/cmd/authelia-gen/templates/github_issue_template_feature.yml.tmpl index c9d7ed245..04d733f8d 100644 --- a/cmd/authelia-gen/templates/github_issue_template_feature.yml.tmpl +++ b/cmd/authelia-gen/templates/github_issue_template_feature.yml.tmpl @@ -1,12 +1,12 @@ --- -name: Feature Request -description: Submit a Feature Request +name: 'Feature Request' +description: 'Submit a Feature Request' labels: {{- range .Labels }} - - {{ . }} + - '{{ . }}' {{- end }} body: - - type: markdown + - type: 'markdown' attributes: value: | Thanks for taking the time to fill out this feature request. A feature request is created as issue for the purpose of tracking the design and implementation of a feature. @@ -16,42 +16,54 @@ body: 1. Ensure there are no other similar feature requests. 2. Make sure you've checked the [Documentation](https://www.authelia.com) doesn't clearly document the features existence already. 3. Consider creating an [Idea Discussion](https://github.com/authelia/authelia/discussions/new?category=ideas) which can be voted on instead if one doesn't exist. - - type: textarea - id: description + - type: 'textarea' + id: 'description' attributes: - label: Description - description: Describe the feature + label: | + Description + description: | + Describe the feature validations: required: true - - type: textarea - id: use-case + - type: 'textarea' + id: 'use-case' attributes: - label: Use Case - description: Provide a use case + label: | + Use Case + description: | + Provide a use case validations: required: true - - type: textarea - id: details + - type: 'textarea' + id: 'details' attributes: - label: Details - description: Describe the feature in detail + label: | + Details + description: | + Describe the feature in detail validations: required: false - - type: textarea - id: documentation + - type: 'textarea' + id: 'documentation' attributes: - label: Documentation - description: Provide any relevant specification or other documentation if applicable + label: | + Documentation + description: | + Provide any relevant specification or other documentation if applicable validations: required: false - - type: checkboxes - id: checklist + - type: 'checkboxes' + id: 'checklist' attributes: - label: Pre-Submission Checklist - description: By submitting this issue confirm all of the following + label: | + Pre-Submission Checklist + description: | + By submitting this issue confirm all of the following options: - - label: I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) + - label: | + I agree to follow the [Code of Conduct](http://www.authelia.com/code-of-conduct) required: true - - label: I have checked for related issues and checked the documentation + - label: | + I have checked for related issues and checked the documentation required: true ... diff --git a/config.template.yml b/config.template.yml index d5b0852ac..5b7f82ad0 100644 --- a/config.template.yml +++ b/config.template.yml @@ -9,14 +9,14 @@ ## 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. -# certificates_directory: /config/certificates/ +# certificates_directory: '/config/certificates/' ## The theme to display: light, dark, grey, auto. -theme: light +theme: 'light' ## 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/c/secrets -jwt_secret: a_very_important_secret +jwt_secret: 'a_very_important_secret' ## Default redirection URL ## @@ -25,28 +25,32 @@ jwt_secret: a_very_important_secret ## 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/ +default_redirection_url: 'https://home.example.com/' ## Set the default 2FA method for new users and for when a user has a preferred method configured that has been ## disabled. This setting must be a method that is enabled. ## Options are totp, webauthn, mobile_push. -default_2fa_method: "" +default_2fa_method: '' ## ## Server Configuration ## server: - - ## The address to listen on. This must be a TCP or unix socket. - address: "tcp://:9091" + ## The address for the Main server to listen on in the address common syntax. + ## Formats: + ## - [://][:] + ## - [://][hostname]: + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix'. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '9091'. + address: 'tcp://:9091' ## Set the single level path Authelia listens on. ## Must be alphanumeric chars and should not contain any slashes. - path: "" + path: '' ## Set the path on disk to Authelia assets. ## Useful to allow overriding of specific static assets. - # asset_path: /config/assets/ + # asset_path: '/config/assets/' ## 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. @@ -55,10 +59,10 @@ server: ## 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: "" + key: '' ## The path to the DER base64/PEM format public certificate. - certificate: "" + certificate: '' ## The list of certificates for client authentication. client_certificates: [] @@ -67,7 +71,7 @@ server: headers: ## The CSP Template. Read the docs. - csp_template: "" + csp_template: '' ## Server Buffers configuration. # buffers: @@ -87,13 +91,13 @@ server: # timeouts: ## Read timeout. - # read: 6s + # read: '6s' ## Write timeout. - # write: 6s + # write: '6s' ## Idle timeout. - # idle: 30s + # idle: '30s' ## Server Endpoints configuration. ## This section is considered advanced and it SHOULD NOT be configured unless you've read the relevant documentation. @@ -107,16 +111,16 @@ server: ## Configure the authz endpoints. # authz: # forward-auth: - # implementation: ForwardAuth + # implementation: 'ForwardAuth' # authn_strategies: [] # ext-authz: - # implementation: ExtAuthz + # implementation: 'ExtAuthz' # authn_strategies: [] # auth-request: - # implementation: AuthRequest + # implementation: 'AuthRequest' # authn_strategies: [] # legacy: - # implementation: Legacy + # implementation: 'Legacy' # authn_strategies: [] ## @@ -124,13 +128,13 @@ server: ## log: ## Level of verbosity for logs: info, debug, trace. - level: debug + level: 'debug' ## Format the logs are written as: json, text. - # format: json + # format: 'json' ## File path where the logs will be written. If not set logs are written to stdout. - # file_path: /config/authelia.log + # file_path: '/config/authelia.log' ## Whether to also log to stdout when a log_file_path is defined. # keep_stdout: false @@ -147,8 +151,13 @@ telemetry: ## Enable Metrics. enabled: false - ## The address to listen on for metrics. This should be on a different port to the main server.port value. - address: tcp://0.0.0.0:9959 + ## The address for the Metrics server to listen on in the address common syntax. + ## Formats: + ## - [://][:] + ## - [://][hostname]: + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix'. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '9959'. + address: 'tcp://:9959' ## Metrics Server Buffers configuration. # buffers: @@ -163,13 +172,13 @@ telemetry: # timeouts: ## Read timeout. - # read: 6s + # read: '6s' ## Write timeout. - # write: 6s + # write: '6s' ## Idle timeout. - # idle: 30s + # idle: '30s' ## ## TOTP Configuration @@ -180,12 +189,12 @@ totp: disable: false ## The issuer name displayed in the Authenticator application of your choice. - issuer: authelia.com + issuer: 'authelia.com' ## The TOTP algorithm to use. ## It is CRITICAL you read the documentation before changing this option: ## https://www.authelia.com/c/totp#algorithm - algorithm: sha1 + algorithm: 'sha1' ## The number of digits a user has to input. Must either be 6 or 8. ## Changing this option only affects newly generated TOTP configurations. @@ -215,18 +224,18 @@ webauthn: disable: false ## Adjust the interaction timeout for WebAuthn dialogues. - timeout: 60s + timeout: '60s' ## The display name the browser should show the user for when using WebAuthn to login/register. - display_name: Authelia + display_name: 'Authelia' ## Conveyance preference controls if we collect the attestation statement including the AAGUID from the device. ## Options are none, indirect, direct. - attestation_conveyance_preference: indirect + attestation_conveyance_preference: 'indirect' ## User verification controls if the user must make a gesture or action to confirm they are present. ## Options are required, preferred, discouraged. - user_verification: preferred + user_verification: 'preferred' ## ## Duo Push API Configuration @@ -235,10 +244,10 @@ webauthn: ## "Partner Auth API" in the management panel. # duo_api: # disable: false - # hostname: api-123456789.example.com - # integration_key: ABCDEF + # hostname: 'api-123456789.example.com' + # integration_key: 'ABCDEF' ## Secret can also be set using a secret: https://www.authelia.com/c/secrets - # secret_key: 1234567890abcdefghifjkl + # secret_key: '1234567890abcdefghifjkl' # enable_self_enrollment: false ## @@ -246,14 +255,17 @@ webauthn: ## ## This is used to validate the servers time is accurate enough to validate TOTP. ntp: - ## NTP server address. - address: "time.cloudflare.com:123" + ## The address of the NTP server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'udp', 'udp4', or 'udp6'. + ## The default scheme is 'udp'. The default port is '123'. + address: 'udp://time.cloudflare.com:123' ## NTP version. version: 4 - ## Maximum allowed time offset between the host and the NTP server. - max_desync: 3s + ## Maximum allowed time offset between the host and the NTP server in duration common syntax. + 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. @@ -279,14 +291,14 @@ authentication_backend: ## External reset password url that redirects the user to an external reset portal. This disables the internal reset ## functionality. - custom_url: "" + custom_url: '' ## 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/c/common#duration-notation-format + ## Duration Notation docs: https://www.authelia.com/c/common#duration ## Refresh Interval docs: https://www.authelia.com/c/1fa#refresh-interval refresh_interval: 5m @@ -297,6 +309,13 @@ authentication_backend: ## because it allows Authelia to offload the stateful operations ## onto the LDAP service. # ldap: + ## The address of the LDAP server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'ldap', 'ldaps', or 'ldapi`. + ## The default scheme is 'ldapi' if the address is an absolute path otherwise it's 'ldaps'. + ## The default port is '636', unless the scheme is 'ldap' in which case it's '389'. + # address: 'ldaps://127.0.0.1:636' + ## The LDAP implementation, this affects elements like the attribute utilised for resetting a password. ## Acceptable options are as follows: ## - 'activedirectory' - for Microsoft Active Directory. @@ -308,22 +327,18 @@ authentication_backend: ## 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/c/ldap#defaults - # implementation: custom + # implementation: 'custom' - ## The url to the ldap server. Format: ://
[:]. - ## Scheme can be ldap or ldaps in the format (port optional). - # url: ldap://127.0.0.1 - - ## The dial timeout for LDAP. - # timeout: 5s + ## The dial timeout for LDAP in the duration common syntax. + # timeout: '5s' ## Use StartTLS with the LDAP connection. # start_tls: false # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host portion of the url option. - # server_name: ldap.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'ldap.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -334,10 +349,10 @@ authentication_backend: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -414,7 +429,7 @@ authentication_backend: ## The distinguished name of the container searched for objects in the directory information tree. ## See also: additional_users_dn, additional_groups_dn. - # base_dn: dc=example,dc=com + # base_dn: 'dc=example,dc=com' ## The attribute holding the username of the user. This attribute is used to populate the username in the session ## information. For your information, Microsoft Active Directory usually uses 'sAMAccountName' and OpenLDAP usually @@ -424,11 +439,11 @@ authentication_backend: ## non-unique attributes like 'mail' can also be used but we don't recommend using them, we instead advise to use ## a filter to perform alternative lookups and the attributes mentioned above (sAMAccountName and uid) to ## follow https://datatracker.ietf.org/doc/html/rfc2307. - # username_attribute: uid + # username_attribute: 'uid' ## 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. - # additional_users_dn: ou=users + # additional_users_dn: 'ou=users' ## The users filter used in search queries to find the user profile based on input filled in login form. ## Various placeholders are available in the user filter which you can read about in the documentation which can @@ -442,11 +457,11 @@ authentication_backend: ## ## To allow sign in both with username and email, one can use a filter like ## (&(|({username_attribute}={input})({mail_attribute}={input}))(objectClass=person)) - # users_filter: (&({username_attribute}={input})(objectClass=person)) + # users_filter: '(&({username_attribute}={input})(objectClass=person))' ## 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. - # additional_groups_dn: ou=groups + # additional_groups_dn: 'ou=groups' ## 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 @@ -454,17 +469,17 @@ authentication_backend: ## ## If your groups use the `groupOfUniqueNames` structure use this instead: ## (&(uniqueMember={dn})(objectClass=groupOfUniqueNames)) - # groups_filter: (&(member={dn})(objectClass=groupOfNames)) + # groups_filter: '(&(member={dn})(objectClass=groupOfNames))' ## The attribute holding the name of the group. - # group_name_attribute: cn + # group_name_attribute: 'cn' ## 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. - # mail_attribute: mail + # mail_attribute: 'mail' ## The attribute holding the display name of the user. This will be used to greet an authenticated user. - # display_name_attribute: displayName + # display_name_attribute: 'displayName' ## Follow referrals returned by the server. ## This is especially useful for environments where read-only servers exist. Only implemented for write operations. @@ -473,7 +488,7 @@ authentication_backend: ## The username and password of the admin user. # user: cn=admin,dc=example,dc=com ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: password + # password: 'password' ## ## File (Authentication Provider) @@ -488,15 +503,15 @@ authentication_backend: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # file: - # path: /config/users_database.yml + # path: '/config/users_database.yml' # watch: false # search: # email: false # case_insensitive: false # password: - # algorithm: argon2 + # algorithm: 'argon2' # argon2: - # variant: argon2id + # variant: 'argon2id' # iterations: 3 # memory: 65536 # parallelism: 4 @@ -509,15 +524,15 @@ authentication_backend: # key_length: 32 # salt_length: 16 # pbkdf2: - # variant: sha512 + # variant: 'sha512' # iterations: 310000 # salt_length: 16 # sha2crypt: - # variant: sha512 + # variant: 'sha512' # iterations: 50000 # salt_length: 16 # bcrypt: - # variant: standard + # variant: 'standard' # cost: 12 ## @@ -601,91 +616,91 @@ privacy_policy: access_control: ## 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. - default_policy: deny + default_policy: 'deny' # networks: - # - name: internal + # - name: 'internal' # networks: - # - 10.10.0.0/16 - # - 192.168.2.0/24 + # - '10.10.0.0/16' + # - '192.168.2.0/24' # - name: VPN - # networks: 10.9.0.0/16 + # networks: '10.9.0.0/16' # rules: ## Rules applied to everyone # - domain: 'public.example.com' - # policy: bypass + # policy: 'bypass' ## Domain Regex examples. Generally we recommend just using a standard domain. # - domain_regex: '^(?P\w+)\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: '^(?P\w+)\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: # - '^appgroup-.*\.example\.com$' # - '^appgroup2-.*\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: '^.*\.example\.com$' - # policy: two_factor + # policy: 'two_factor' # - domain: 'secure.example.com' - # policy: one_factor + # policy: 'one_factor' ## Network based rule, if not provided any network matches. # networks: - # - internal - # - VPN - # - 192.168.1.0/24 - # - 10.0.0.1 + # - 'internal' + # - 'VPN' + # - '192.168.1.0/24' + # - '10.0.0.1' # - domain: # - 'secure.example.com' # - 'private.example.com' - # policy: two_factor + # policy: 'two_factor' # - domain: 'singlefactor.example.com' - # policy: one_factor + # policy: 'one_factor' ## Rules applied to 'admins' group # - domain: 'mx2.mail.example.com' # subject: 'group:admins' - # policy: deny + # policy: 'deny' # - domain: '*.example.com' # subject: # - 'group:admins' # - 'group:moderators' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to 'dev' group # - domain: 'dev.example.com' # resources: # - '^/groups/dev/.*$' # subject: 'group:dev' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'john' # - domain: 'dev.example.com' # resources: # - '^/users/john/.*$' # subject: 'user:john' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'harry' # - domain: 'dev.example.com' # resources: # - '^/users/harry/.*$' # subject: 'user:harry' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'bob' # - domain: '*.mail.example.com' # subject: 'user:bob' - # policy: two_factor + # policy: 'two_factor' # - domain: 'dev.example.com' # resources: # - '^/users/bob/.*$' # subject: 'user:bob' - # policy: two_factor + # policy: 'two_factor' ## ## Session Provider Configuration @@ -720,8 +735,8 @@ session: ## Please read https://www.authelia.com/c/session#same_site # same_site: 'lax' - ## The value for inactivity, expiration, and remember_me are in seconds or the duration notation format. - ## See: https://www.authelia.com/c/common#duration-notation-format + ## The value for inactivity, expiration, and remember_me are in seconds or the duration common syntax. + ## See: https://www.authelia.com/c/common#duration ## 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. @@ -745,8 +760,8 @@ session: ## or strict. Please read https://www.authelia.com/c/session#same_site same_site: 'lax' - ## The value for inactivity, expiration, and remember_me are in seconds or the duration notation format. - ## See: https://www.authelia.com/c/common#duration-notation-format + ## The value for inactivity, expiration, and remember_me are in seconds or the duration common syntax. + ## See: https://www.authelia.com/c/common#duration ## 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. @@ -755,7 +770,7 @@ session: ## destroyed after 1h, or after 5m since the last time Authelia detected user activity. inactivity: '5m' - ## Cookie Session Domain default 'expiration' value. The time before the session cookie expires and the session is + ## Cookie Session Domain default 'expiration' value. The time before the session cookie expires and the session is ## destroyed if remember me IS NOT selected by the user. expiration: '1h' @@ -770,16 +785,16 @@ session: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # redis: - # host: 127.0.0.1 + # host: '127.0.0.1' # port: 6379 ## Use a unix socket instead - # host: /var/run/redis/redis.sock + # host: '/var/run/redis/redis.sock' ## Username used for redis authentication. This is optional and a new feature in redis 6.0. - # username: authelia + # username: 'authelia' ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: authelia + # password: 'authelia' ## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc). # database_index: 0 @@ -794,7 +809,7 @@ session: # tls: ## The server subject name to check the servers certificate against during the validation process. ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: myredis.example.com + # server_name: 'myredis.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -805,10 +820,10 @@ session: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -887,21 +902,21 @@ session: ## This provides specific options to Redis Sentinel, sentinel_name must be defined (Master Name). # high_availability: ## Sentinel Name / Master Name. - # sentinel_name: mysentinel + # sentinel_name: 'mysentinel' ## Specific username for Redis Sentinel. The node username and password is configured above. - # sentinel_username: sentinel_specific_user + # sentinel_username: 'sentinel_specific_user' ## Specific password for Redis Sentinel. The node username and password is configured above. - # sentinel_password: sentinel_specific_pass + # 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 + # - host: 'sentinel-node1' # port: 6379 - # - host: sentinel-node2 + # - host: 'sentinel-node2' # port: 6379 ## Choose the host with the lowest latency. @@ -919,14 +934,12 @@ regulation: ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation. max_retries: 3 - ## 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/c/common#duration-notation-format - find_time: 2m + ## The time range in duration common syntax 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: '2m' - ## The length of time before a banned user can login again. Ban Time accepts duration notation. - ## See: https://www.authelia.com/c/common#duration-notation-format - ban_time: 5m + ## The length of time in duration common syntax before a banned user can login again. + ban_time: '5m' ## ## Storage Provider Configuration @@ -936,7 +949,7 @@ regulation: ## 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, you MUST use ## the CLI to change this in the database if you want to change it from a previously configured value. - # encryption_key: you_must_generate_a_random_string_of_more_than_twenty_chars_and_configure_this + # encryption_key: 'you_must_generate_a_random_string_of_more_than_twenty_chars_and_configure_this' ## ## Local (Storage Provider) @@ -948,25 +961,36 @@ regulation: ## # local: ## Path to the SQLite3 Database. - # path: /config/db.sqlite3 + # path: '/config/db.sqlite3' ## ## MySQL / MariaDB (Storage Provider) ## # mysql: - # host: 127.0.0.1 - # port: 3306 - # database: authelia - # username: authelia - ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: mypassword - # timeout: 5s + ## The address of the MySQL server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix`. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '3306'. + # address: 'tcp://127.0.0.1:3306' + + ## The database name to use. + # database: 'authelia' + + ## The username used for SQL authentication. + # username: 'authelia' + + ## The password used for SQL authentication. + ## Can also be set using a secret: https://www.authelia.com/c/secrets + # password: 'mypassword' + + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## MySQL TLS settings. Configuring this requires TLS. # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: mysql.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'mysql.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -977,10 +1001,10 @@ regulation: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1059,20 +1083,33 @@ regulation: ## PostgreSQL (Storage Provider) ## # postgres: - # host: 127.0.0.1 - # port: 5432 - # database: authelia - # schema: public - # username: authelia - ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: mypassword - # timeout: 5s + ## The address of the PostgreSQL server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix`. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '5432'. + # address: 'tcp://127.0.0.1:5432' + + ## The database name to use. + # database: 'authelia' + + ## The schema name to use. + # schema: 'public' + + ## The username used for SQL authentication. + # username: 'authelia' + + ## The password used for SQL authentication. + ## Can also be set using a secret: https://www.authelia.com/c/secrets + # password: 'mypassword' + + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## PostgreSQL TLS settings. Configuring this requires TLS. # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: postgres.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'postgres.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -1083,10 +1120,10 @@ regulation: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1176,7 +1213,7 @@ notifier: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # filesystem: - # filename: /config/notification.txt + # filename: '/config/notification.txt' ## ## SMTP (Notification Provider) @@ -1189,36 +1226,33 @@ notifier: ## - validate the SMTP server x509 certificate during the TLS handshake against the hosts trusted certificates ## (configure in tls section) # smtp: - ## The SMTP host to connect to. - # host: 127.0.0.1 + ## The address of the SMTP server to connect to in the address common syntax. + # address: 'smtp://127.0.0.1:25' - ## The port to connect to the SMTP host on. - # port: 1025 - - ## The connection timeout. - # timeout: 5s + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## The username used for SMTP authentication. - # username: test + # username: 'test' ## The password used for SMTP authentication. ## Can also be set using a secret: https://www.authelia.com/c/secrets - # password: password + # password: 'password' ## 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 ' format. - # sender: "Authelia " + # sender: 'Authelia ' ## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost. - # identifier: localhost + # identifier: 'localhost' ## Subject configuration of the emails sent. {title} is replaced by the text from the notifier. - # subject: "[Authelia] {title}" + # subject: '[Authelia] {title}' ## 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. - # startup_check_address: test@authelia.com + # startup_check_address: 'test@authelia.com' ## By default we require some form of TLS. This disables this check though is not advised. # disable_require_tls: false @@ -1228,8 +1262,8 @@ notifier: # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: smtp.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'smtp.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -1240,10 +1274,10 @@ notifier: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1331,7 +1365,7 @@ notifier: # 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/c/secrets - # hmac_secret: this_is_a_secret_abc123abc123abc + # hmac_secret: 'this_is_a_secret_abc123abc123abc' ## The issuer_certificate_chain is an optional PEM encoded certificate chain. It's used in conjunction with the ## issuer_private_key to sign JWT's. All certificates in the chain must be within the validity period, and every @@ -1408,10 +1442,10 @@ notifier: # -----END RSA PRIVATE KEY----- ## 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 + # 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 @@ -1421,23 +1455,23 @@ notifier: ## SECURITY NOTICE: It's not recommended changing this option, and highly discouraged to have it set to 'never' ## for security reasons. - # enforce_pkce: public_clients_only + # enforce_pkce: 'public_clients_only' ## Cross-Origin Resource Sharing (CORS) settings. # cors: ## List of endpoints in addition to the metadata endpoints to permit cross-origin requests on. # endpoints: - # - authorization - # - token - # - revocation - # - introspection - # - userinfo + # - 'authorization' + # - 'token' + # - 'revocation' + # - 'introspection' + # - 'userinfo' ## List of allowed origins. ## Any origin with https is permitted unless this option is configured or the ## allowed_origins_from_client_redirect_uris option is enabled. # allowed_origins: - # - https://example.com + # - 'https://example.com' ## Automatically adds the origin portion of all redirect URI's on all clients to the list of allowed_origins, ## provided they have the scheme http or https and do not have the hostname of localhost. @@ -1447,71 +1481,72 @@ notifier: # clients: # - ## The ID is the OpenID Connect ClientID which is used to link an application to a configuration. - # id: myapp + # id: 'myapp' ## The description to show to users when they end up on the consent screen. Defaults to the ID above. - # description: My Application + # description: 'My Application' ## The client secret is a shared secret between Authelia and the consumer of this client. - # secret: this_is_a_secret + # yamllint disable-line rule:line-length + # secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. ## Sector Identifiers are occasionally used to generate pairwise subject identifiers. In most cases this is not ## necessary. Read the documentation for more information. ## The subject identifier must be the host component of a URL, which is a domain name with an optional port. - # sector_identifier: example.com + # sector_identifier: 'example.com' ## Sets the client to public. This should typically not be set, please see the documentation for usage. # public: false ## Redirect URI's specifies a list of valid case-sensitive callbacks for this client. # redirect_uris: - # - https://oidc.example.com:8080/oauth2/callback + # - 'https://oidc.example.com:8080/oauth2/callback' ## Audience this client is allowed to request. # audience: [] ## Scopes this client is allowed to request. # scopes: - # - openid - # - groups - # - email - # - profile + # - 'openid' + # - 'groups' + # - 'email' + # - 'profile' ## 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: - # - code + # - 'code' ## Response Modes configures which response modes this client supports. # response_modes: - # - form_post - # - query + # - 'form_post' + # - 'query' ## 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: - # - authorization_code + # - 'authorization_code' ## The permitted client authentication method for the Token Endpoint for this client. - # token_endpoint_auth_method: client_secret_basic + # token_endpoint_auth_method: 'client_secret_basic' ## The policy to require for this client; one_factor or two_factor. - # authorization_policy: two_factor + # authorization_policy: 'two_factor' ## Enforces the use of PKCE for this client when set to true. # enforce_pkce: false ## Enforces the use of PKCE for this client when configured, and enforces the specified challenge method. ## Options are 'plain' and 'S256'. - # pkce_challenge_method: S256 + # pkce_challenge_method: 'S256' ## The algorithm used to sign userinfo endpoint responses for this client, either none or RS256. - # userinfo_signing_algorithm: none + # userinfo_signing_algorithm: 'none' ## The consent mode controls how consent is obtained. - # consent_mode: auto + # consent_mode: 'auto' ## This value controls the duration a consent on this client remains remembered when the consent mode is ## configured as 'auto' or 'pre-configured'. - # pre_configured_consent_duration: 1w + # pre_configured_consent_duration: '1w' ... diff --git a/crowdin.yml b/crowdin.yml index 88613ec99..da43544d1 100644 --- a/crowdin.yml +++ b/crowdin.yml @@ -1,9 +1,9 @@ --- -pull_request_title: "i18n: update translations" -commit_message: "i18n: update translation for %original_file_name% (%language%)" +pull_request_title: 'i18n: update translations' +commit_message: 'i18n: update translation for %original_file_name% (%language%)' append_commit_message: false files: - - source: /internal/server/locales/en/* - translation: /internal/server/locales/%locale%/%original_file_name% + - source: '/internal/server/locales/en/*' + translation: '/internal/server/locales/%locale%/%original_file_name%' skip_untranslated_files: true ... diff --git a/docs/content/en/configuration/first-factor/file.md b/docs/content/en/configuration/first-factor/file.md index 896ec8aa2..97ec3e23a 100644 --- a/docs/content/en/configuration/first-factor/file.md +++ b/docs/content/en/configuration/first-factor/file.md @@ -21,15 +21,15 @@ aliases: ```yaml authentication_backend: file: - path: /config/users.yml + path: '/config/users.yml' watch: false search: email: false case_insensitive: false password: - algorithm: argon2 + algorithm: 'argon2' argon2: - variant: argon2id + variant: 'argon2id' iterations: 3 memory: 65536 parallelism: 4 @@ -42,15 +42,15 @@ authentication_backend: key_length: 32 salt_length: 16 pbkdf2: - variant: sha512 + variant: 'sha512' iterations: 310000 salt_length: 16 sha2crypt: - variant: sha512 + variant: 'sha512' iterations: 50000 salt_length: 16 bcrypt: - variant: standard + variant: 'standard' cost: 12 ``` diff --git a/docs/content/en/configuration/first-factor/ldap.md b/docs/content/en/configuration/first-factor/ldap.md index 598a1683d..aebd73f46 100644 --- a/docs/content/en/configuration/first-factor/ldap.md +++ b/docs/content/en/configuration/first-factor/ldap.md @@ -22,15 +22,15 @@ aliases: ```yaml authentication_backend: ldap: - implementation: custom - url: ldap://127.0.0.1 - timeout: 5s + address: 'ldap://127.0.0.1' + implementation: 'custom' + timeout: '5s' start_tls: false tls: - server_name: ldap.example.com + server_name: 'ldap.example.com' skip_verify: false - minimum_version: TLS1.2 - maximum_version: TLS1.3 + minimum_version: 'TLS1.2' + maximum_version: 'TLS1.3' certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -98,25 +98,54 @@ authentication_backend: 27GoE2i5mh6Yez6VAYbUuns3FcwIsMyWLq043Tu2DNkx9ijOOAuQzw^invalid.. DO NOT USE== -----END RSA PRIVATE KEY----- - base_dn: DC=example,DC=com - additional_users_dn: OU=users - users_filter: (&({username_attribute}={input})(objectClass=person)) - username_attribute: uid - mail_attribute: mail - display_name_attribute: displayName - additional_groups_dn: OU=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn + base_dn: 'DC=example,DC=com' + additional_users_dn: 'OU=users' + users_filter: '(&({username_attribute}={input})(objectClass=person))' + username_attribute: 'uid' + mail_attribute: 'mail' + display_name_attribute: 'displayName' + additional_groups_dn: 'OU=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' permit_referrals: false permit_unauthenticated_bind: false - user: CN=admin,DC=example,DC=com - password: password + user: 'CN=admin,DC=example,DC=com' + password: 'password' ``` ## Options This section describes the individual configuration options. +### address + +{{< confkey type="string" required="yes" >}} + +*__Reference Note:__ This configuration option uses the [Address](../prologue/common.md#address) format. Please see the +[documentation](../prologue/common.md#address) on this format for more information.* + +The LDAP URL which consists of a scheme, hostname, and port. Format is `[://][:]`. The default +scheme is `ldapi` if the path is absolute otherwise it's `ldaps`, and the permitted schemes are `ldap`, `ldaps`, or +`ldapi` (a unix domain socket). + +If the scheme is `ldapi` it must be followed by an absolute path to an existing unix domain socket that the +user/group the Authelia process is running as has the appropriate permissions to access. For example if the socket is +located at `/var/run/slapd.sock` the address should be `ldapi:///var/run/slapd.sock`. + +__Examples:__ + +```yaml +authentication_backend: + ldap: + address: 'ldaps://dc1.example.com' +``` + +```yaml +authentication_backend: + ldap: + address: 'ldap://[fd00:1111:2222:3333::1]' +``` + ### implementation {{< confkey type="string" default="custom" required="no" >}} @@ -125,27 +154,6 @@ Configures the LDAP implementation used by Authelia. See the [Implementation Guide](../../reference/guides/ldap.md#implementation-guide) for information. -### url - -{{< confkey type="string" required="yes" >}} - -The LDAP URL which consists of a scheme, address, and port. Format is `://
:` or -`://
` where scheme is either `ldap` or `ldaps`. - -```yaml -authentication_backend: - ldap: - url: ldaps://dc1.example.com -``` - -If utilising an IPv6 literal address it must be enclosed by square brackets: - -```yaml -authentication_backend: - ldap: - url: ldap://[fd00:1111:2222:3333::1] -``` - ### timeout {{< confkey type="duration" default="5s" required="no" >}} diff --git a/docs/content/en/configuration/identity-providers/open-id-connect.md b/docs/content/en/configuration/identity-providers/open-id-connect.md index e01cc1e53..0b1afe399 100644 --- a/docs/content/en/configuration/identity-providers/open-id-connect.md +++ b/docs/content/en/configuration/identity-providers/open-id-connect.md @@ -33,7 +33,7 @@ More information about the beta can be found in the [roadmap](../../roadmap/acti ```yaml identity_providers: oidc: - hmac_secret: this_is_a_secret_abc123abc123abc + hmac_secret: 'this_is_a_secret_abc123abc123abc' issuer_certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -101,48 +101,48 @@ identity_providers: 27GoE2i5mh6Yez6VAYbUuns3FcwIsMyWLq043Tu2DNkx9ijOOAuQzw^invalid.. DO NOT USE== -----END RSA PRIVATE KEY----- - access_token_lifespan: 1h - authorize_code_lifespan: 1m - id_token_lifespan: 1h - refresh_token_lifespan: 90m + access_token_lifespan: '1h' + authorize_code_lifespan: '1m' + id_token_lifespan: '1h' + refresh_token_lifespan: '90m' enable_client_debug_messages: false - enforce_pkce: public_clients_only + enforce_pkce: 'public_clients_only' cors: endpoints: - - authorization - - token - - revocation - - introspection + - 'authorization' + - 'token' + - 'revocation' + - 'introspection' allowed_origins: - - https://example.com + - 'https://example.com' allowed_origins_from_client_redirect_uris: false clients: - - id: myapp - description: My Application + - id: 'myapp' + description: 'My Application' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. sector_identifier: '' public: false - authorization_policy: two_factor - consent_mode: explicit - pre_configured_consent_duration: 1w + authorization_policy: 'two_factor' + consent_mode: 'explicit' + pre_configured_consent_duration: '1w' audience: [] scopes: - - openid - - groups - - email - - profile + - 'openid' + - 'groups' + - 'email' + - 'profile' redirect_uris: - - https://oidc.example.com:8080/oauth2/callback + - 'https://oidc.example.com:8080/oauth2/callback' grant_types: - - refresh_token - - authorization_code + - 'refresh_token' + - 'authorization_code' response_types: - - code + - 'code' response_modes: - - form_post - - query - - fragment - userinfo_signing_algorithm: none + - 'form_post' + - 'query' + - 'fragment' + userinfo_signing_algorithm: 'none' ``` ## Options diff --git a/docs/content/en/configuration/methods/environment.md b/docs/content/en/configuration/methods/environment.md index 0aec76276..0019382fc 100644 --- a/docs/content/en/configuration/methods/environment.md +++ b/docs/content/en/configuration/methods/environment.md @@ -39,7 +39,7 @@ For example this YAML configuration: ```yaml log: - level: info + level: 'info' server: buffers: read: 4096 diff --git a/docs/content/en/configuration/miscellaneous/introduction.md b/docs/content/en/configuration/miscellaneous/introduction.md index 907d0e4a5..549542bdb 100644 --- a/docs/content/en/configuration/miscellaneous/introduction.md +++ b/docs/content/en/configuration/miscellaneous/introduction.md @@ -20,14 +20,16 @@ aliases: {{< config-alert-example >}} ```yaml -certificates_directory: /config/certs/ -default_redirection_url: https://home.example.com:8080/ -jwt_secret: v3ry_important_s3cr3t -theme: light +certificates_directory: '/config/certs/' +default_redirection_url: 'https://home.example.com:8080/' +jwt_secret: 'v3ry_important_s3cr3t' +theme: 'light' ``` ## Options +This section describes the individual configuration options. + ### certificates_directory This option defines the location of additional certificates to load into the trust chain specifically for Authelia. diff --git a/docs/content/en/configuration/miscellaneous/logging.md b/docs/content/en/configuration/miscellaneous/logging.md index 31efd03b8..2320168bb 100644 --- a/docs/content/en/configuration/miscellaneous/logging.md +++ b/docs/content/en/configuration/miscellaneous/logging.md @@ -22,14 +22,16 @@ The logging section tunes the logging settings. ```yaml log: - level: info - format: text - file_path: "" + level: 'info' + format: 'text' + file_path: '' keep_stdout: false ``` ## Options +This section describes the individual configuration options. + ### level {{< confkey type="string" default="info" required="no" >}} diff --git a/docs/content/en/configuration/miscellaneous/ntp.md b/docs/content/en/configuration/miscellaneous/ntp.md index 1542b6b20..048d31692 100644 --- a/docs/content/en/configuration/miscellaneous/ntp.md +++ b/docs/content/en/configuration/miscellaneous/ntp.md @@ -27,15 +27,17 @@ unless configured otherwise. ```yaml ntp: - address: "time.cloudflare.com:123" + address: 'udp://time.cloudflare.com:123' version: 3 - max_desync: 3s + max_desync: '3s' disable_startup_check: false disable_failure: false ``` ## Options +This section describes the individual configuration options. + ### address {{< confkey type="string" default="time.cloudflare.com:123" required="no" >}} @@ -43,6 +45,28 @@ ntp: Determines the address of the NTP server to retrieve the time from. The format is `:`, and both of these are required. +### address + +{{< confkey type="address" default="udp://time.cloudflare.com:123" required="no" >}} + +*__Reference Note:__ This configuration option uses the [address common syntax](../prologue/common.md#address). Please +see the [documentation](../prologue/common.md#address) on this format for more information.* + +Configures the address for the NTP Server. The address itself is a connector and the scheme must be `udp`, +`udp4`, or `udp6`. + +__Examples:__ + +```yaml +ntp: + address: 'udp://127.0.0.1:123' +``` + +```yaml +ntp: + address: 'udp6://[fd00:1111:2222:3333::1]:123' +``` + ### version {{< confkey type="integer" default="4" required="no" >}} diff --git a/docs/content/en/configuration/miscellaneous/privacy-policy.md b/docs/content/en/configuration/miscellaneous/privacy-policy.md index a8a3b4ee1..327b7e821 100644 --- a/docs/content/en/configuration/miscellaneous/privacy-policy.md +++ b/docs/content/en/configuration/miscellaneous/privacy-policy.md @@ -25,6 +25,8 @@ privacy_policy: ## Options +This section describes the individual configuration options. + ### enabled {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md b/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md index 1381f04c3..f62bebd93 100644 --- a/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md +++ b/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md @@ -23,16 +23,16 @@ server: endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' authn_strategies: [] ext-authz: - implementation: ExtAuthz + implementation: 'ExtAuthz' authn_strategies: [] auth-request: - implementation: AuthRequest + implementation: 'AuthRequest' authn_strategies: [] legacy: - implementation: Legacy + implementation: 'Legacy' authn_strategies: [] ``` diff --git a/docs/content/en/configuration/miscellaneous/server.md b/docs/content/en/configuration/miscellaneous/server.md index 0021c4f25..de1bfb205 100644 --- a/docs/content/en/configuration/miscellaneous/server.md +++ b/docs/content/en/configuration/miscellaneous/server.md @@ -21,37 +21,37 @@ aliases: ```yaml server: - address: "tcp://:9091" - path: "" + address: 'tcp://:9091' + path: '' disable_healthcheck: false tls: - key: "" - certificate: "" + key: '' + certificate: '' client_certificates: [] headers: - csp_template: "" + csp_template: '' buffers: read: 4096 write: 4096 timeouts: - read: 6s - write: 6s - idle: 30s + read: '6s' + write: '6s' + idle: '30s' endpoints: enable_pprof: false enable_expvars: false authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' authn_strategies: [] ext-authz: - implementation: ExtAuthz + implementation: 'ExtAuthz' authn_strategies: [] auth-request: - implementation: AuthRequest + implementation: 'AuthRequest' authn_strategies: [] legacy: - implementation: Legacy + implementation: 'Legacy' authn_strategies: [] ``` diff --git a/docs/content/en/configuration/notifications/file.md b/docs/content/en/configuration/notifications/file.md index 15f55314c..1bc73dac8 100644 --- a/docs/content/en/configuration/notifications/file.md +++ b/docs/content/en/configuration/notifications/file.md @@ -27,7 +27,7 @@ This method will use the plain text email template for readability purposes. notifier: disable_startup_check: false filesystem: - filename: /config/notification.txt + filename: '/config/notification.txt' ``` ## Options diff --git a/docs/content/en/configuration/notifications/smtp.md b/docs/content/en/configuration/notifications/smtp.md index 07fb3d82b..bd879e0e5 100644 --- a/docs/content/en/configuration/notifications/smtp.md +++ b/docs/content/en/configuration/notifications/smtp.md @@ -23,23 +23,22 @@ aliases: notifier: disable_startup_check: false smtp: - host: 127.0.0.1 - port: 1025 - timeout: 5s - username: test - password: password + address: 'smtp://127.0.0.1:25' + timeout: '5s' + username: 'test' + password: 'password' sender: "Authelia " - identifier: localhost + identifier: 'localhost' subject: "[Authelia] {title}" - startup_check_address: test@authelia.com + startup_check_address: 'test@authelia.com' disable_require_tls: false disable_starttls: false disable_html_emails: false tls: - server_name: smtp.example.com + server_name: 'smtp.example.com' skip_verify: false - minimum_version: TLS1.2 - maximum_version: TLS1.3 + minimum_version: 'TLS1.2' + maximum_version: 'TLS1.3' certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -113,31 +112,34 @@ notifier: This section describes the individual configuration options. -### host +### address -{{< confkey type="integer" required="yes" >}} +{{< confkey type="address" required="yes" >}} -The hostname of the SMTP server. +*__Reference Note:__ This configuration option uses the [address common syntax](../prologue/common.md#address). Please +see the [documentation](../prologue/common.md#address) on this format for more information.* -If utilising an IPv6 literal address it must be enclosed by square brackets and quoted: - -```yaml -host: "[fd00:1111:2222:3333::1]" -``` - -### port - -{{< confkey type="integer" required="yes" >}} - -The port the SMTP service is listening on. - -A connection is securely established with TLS after a succesful STARTTLS negotiation. - -[Port 465 is an exception][docs-security-smtp-port] when supported by the mail server as a `submissions` service port. -STARTTLS negotiation is not required for this port, the connection is implicitly established with TLS. +Configures the address for the SMTP Server. The address itself is a connector and the scheme must be `smtp`, +`submission`, or `submissions`. The only difference between these schemes are the default ports and `submissions` +requires a TLS transport per [SMTP Ports Security Measures][docs-security-smtp-port], whereas `submission` and `smtp` +use a standard TCP transport and typically enforce StartTLS. [docs-security-smtp-port]: ../../overview/security/measures.md#smtp-ports +__Examples:__ + +```yaml +notifier: + smtp: + address: 'smtp://127.0.0.1:25' +``` + +```yaml +notifier: + smtp: + address: 'submissions://[fd00:1111:2222:3333::1]:465' +``` + ### timeout {{< confkey type="duration" default="5s" required="no" >}} @@ -241,10 +243,10 @@ You need to generate an app password in order to use Gmail SMTP servers. The pro ```yaml notifier: smtp: - username: myaccount@gmail.com + username: 'myaccount@gmail.com' # Password can also be set using a secret: https://www.authelia.com/configuration/methods/secrets/ - password: yourapppassword - sender: admin@example.com - host: smtp.gmail.com + password: 'yourapppassword' + sender: 'admin@example.com' + host: 'smtp.gmail.com' port: 587 ``` diff --git a/docs/content/en/configuration/prologue/common.md b/docs/content/en/configuration/prologue/common.md index 8aa6a2d3e..4e8f54a95 100644 --- a/docs/content/en/configuration/prologue/common.md +++ b/docs/content/en/configuration/prologue/common.md @@ -92,17 +92,31 @@ These values are more human readable but have only been available since v4.38.0. The base type for this syntax is a string. -The address type is a string that indicates how to configure a listener or connector, which are the two primary -categories of addresses. +The address type is a string that indicates how to configure a listener (i.e. listening for connections) or connector +(i.e. opening remote connections), which are the two primary categories of addresses. -The address values take the following formats: + +#### Format + +This section outlines the format for these strings. The formats use a conventional POSIX format to indicate optional and +required elements. The square brackets `[]` surround optional portions, and the angled brackets `<>` surround required +portions. Required portions may exist within optional portions, in which case they are often accompanied with other +format specific text which indicates if the accompanying text exists then it is actually required, otherwise it's +entirely optional. + +The connector address values take the following formats: ```text [://][:] -[://]: unix:// ``` +The listener address values take the following additional formats: + +```text +[://]: +``` + Examples: ```text @@ -121,7 +135,7 @@ The square brackets indicate optional sections, and the angled brackets indicate sections elaborate on this. Sections may only be optional for the purposes of parsing, there may be a configuration requirement that one of these is provided. -### scheme +#### scheme The entire scheme is optional, but if the scheme host delimiter `://` is in the string, the scheme must be present. The scheme must be one of the following (the listeners and connectors columns indicate support for the scheme on the @@ -147,7 +161,7 @@ If the scheme is absent, the default scheme is assumed. If the address has a `/` otherwise it's assumed to be`tcp`. If the scheme is `unix` it must be suffixed with an absolute path i.e. `/var/local/authelia.sock` would be represented as `unix:///var/run/authelia.sock`. -### hostname +#### hostname The hostname is required if the scheme is one of the `tcp` or `udp` schemes and there is no [port](#port) specified. It can be any IP that is locally addressable or a hostname which resolves to a locally addressable IP. @@ -155,7 +169,7 @@ can be any IP that is locally addressable or a hostname which resolves to a loca If specifying an IPv6 it should be wrapped in square brackets. For example for the IPv6 address `::1` with the `tcp` scheme and port `80` the correct address would be `tcp://[::1]:80`. -### port +#### port The hostname is required if the scheme is one of the `tcp` or `udp` schemes and there is no [hostname](#hostname) specified. diff --git a/docs/content/en/configuration/second-factor/duo.md b/docs/content/en/configuration/second-factor/duo.md index 6b3bebbfc..6ac7b0cd7 100644 --- a/docs/content/en/configuration/second-factor/duo.md +++ b/docs/content/en/configuration/second-factor/duo.md @@ -30,9 +30,9 @@ section of the configuration. ```yaml duo_api: disable: false - hostname: api-123456789.example.com - integration_key: ABCDEF - secret_key: 1234567890abcdefghifjkl + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' + secret_key: '1234567890abcdefghifjkl' enable_self_enrollment: false ``` diff --git a/docs/content/en/configuration/second-factor/time-based-one-time-password.md b/docs/content/en/configuration/second-factor/time-based-one-time-password.md index 9b2279389..1ca1c216a 100644 --- a/docs/content/en/configuration/second-factor/time-based-one-time-password.md +++ b/docs/content/en/configuration/second-factor/time-based-one-time-password.md @@ -31,8 +31,8 @@ and many only support SHA1. ```yaml totp: disable: false - issuer: authelia.com - algorithm: sha1 + issuer: 'authelia.com' + algorithm: 'sha1' digits: 6 period: 30 skew: 1 diff --git a/docs/content/en/configuration/second-factor/webauthn.md b/docs/content/en/configuration/second-factor/webauthn.md index 17f295559..fd8966a71 100644 --- a/docs/content/en/configuration/second-factor/webauthn.md +++ b/docs/content/en/configuration/second-factor/webauthn.md @@ -21,10 +21,10 @@ aliases: ```yaml webauthn: disable: false - display_name: Authelia - attestation_conveyance_preference: indirect - user_verification: preferred - timeout: 60s + display_name: 'Authelia' + attestation_conveyance_preference: 'indirect' + user_verification: 'preferred' + timeout: '60s' ``` ## Options diff --git a/docs/content/en/configuration/security/access-control.md b/docs/content/en/configuration/security/access-control.md index 5edc77b46..b4d43a15d 100644 --- a/docs/content/en/configuration/security/access-control.md +++ b/docs/content/en/configuration/security/access-control.md @@ -21,9 +21,9 @@ aliases: ```yaml access_control: - default_policy: deny + default_policy: 'deny' networks: - - name: internal + - name: 'internal' networks: - '10.0.0.0/8' - '172.16.0.0/12' @@ -31,7 +31,7 @@ access_control: rules: - domain: 'private.example.com' domain_regex: '^(\d+\-)?priv-img.example.com$' - policy: one_factor + policy: 'one_factor' networks: - 'internal' - '1.1.1.1' @@ -40,8 +40,8 @@ access_control: - ['user:fred'] - ['group:admins'] methods: - - GET - - HEAD + - 'GET' + - 'HEAD' resources: - '^/api.*' query: @@ -154,10 +154,10 @@ different ways.* access_control: rules: - domain: '*.example.com' - policy: bypass + policy: 'bypass' - domain: - '*.example.com' - policy: bypass + policy: 'bypass' ``` *Multiple domains matched. These rules will match either `apple.example.com` or `orange.example.com`. All rules in this @@ -167,11 +167,11 @@ list are effectively the same rule just expressed in different ways.* access_control: rules: - domain: ['apple.example.com', 'banana.example.com'] - policy: bypass + policy: 'bypass' - domain: - - apple.example.com - - banana.example.com - policy: bypass + - 'apple.example.com' + - 'banana.example.com' + policy: 'bypass' ``` *Multiple domains matched either via a static domain or via a [domain_regex]. This rule will match @@ -217,7 +217,7 @@ access_control: - domain_regex: - '^user-(?P\w+)\.example\.com$' - '^group-(?P\w+)\.example\.com$' - policy: one_factor + policy: 'one_factor' ``` *Multiple domains example, one with a static domain and one with a regex domain. This will match requests to @@ -228,7 +228,7 @@ access_control: rules: - domain: 'protected.example.com' - domain_regex: '^(img|data)-private\.example\.com' - policy: one_factor + policy: 'one_factor' ``` #### policy @@ -267,14 +267,14 @@ ways.* ```yaml access_control: rules: - - domain: example.com - policy: two_factor + - domain: 'example.com' + policy: 'two_factor' subject: - 'user:john' - ['group:admin', 'group:app-name'] - 'group:super-admin' - - domain: example.com - policy: two_factor + - domain: 'example.com' + policy: 'two_factor' subject: - ['user:john'] - ['group:admin', 'group:app-name'] @@ -287,15 +287,15 @@ expressed in different ways.* ```yaml access_control: rules: - - domain: example.com - policy: one_factor + - domain: 'example.com' + policy: 'one_factor' subject: 'group:super-admin' - - domain: example.com - policy: one_factor + - domain: 'example.com' + policy: 'one_factor' subject: - 'group:super-admin' - - domain: example.com - policy: one_factor + - domain: 'example.com' + policy: 'one_factor' subject: - ['group:super-admin'] ``` @@ -332,10 +332,10 @@ relevant methods are listed in this table: ```yaml access_control: rules: - - domain: example.com - policy: bypass + - domain: 'example.com' + policy: 'bypass' methods: - - OPTIONS + - 'OPTIONS' ``` #### networks @@ -369,28 +369,28 @@ rules in this list are effectively the same rule just expressed in different way ```yaml access_control: - default_policy: two_factor + default_policy: 'two_factor' networks: - - name: internal + - name: 'internal' networks: - '10.0.0.0/8' - '172.16.0.0/12' - '192.168.0.0/18' rules: - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' networks: - '10.0.0.0/8' - '172.16.0.0/12' - '192.168.0.0/18' - '112.134.145.167/32' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' networks: - 'internal' - '112.134.145.167/32' - - domain: secure.example.com - policy: two_factor + - domain: 'secure.example.com' + policy: 'two_factor' ``` #### resources @@ -425,8 +425,8 @@ likely save you a lot of time if you do it for all resource rules. ```yaml access_control: rules: - - domain: app.example.com - policy: bypass + - domain: 'app.example.com' + policy: 'bypass' resources: - '^/api([/?].*)?$' ``` @@ -471,8 +471,8 @@ defaults to `present`. ```yaml access_control: rules: - - domain: app.example.com - policy: bypass + - domain: 'app.example.com' + policy: 'bypass' query: - - operator: 'present' key: 'secure' @@ -549,13 +549,13 @@ a match for that request. - domain: - 'example.com' - '*.example.com' - policy: bypass + policy: 'bypass' resources: - '^/api$' - '^/api/' - domain: - 'app.example.com' - policy: two_factor + policy: 'two_factor' ``` [Rule Matching Concept 1]: #rule-matching-concept-1-sequential-order @@ -607,25 +607,25 @@ Here is a detailed example of an example access control section: ```yaml access_control: - default_policy: deny + default_policy: 'deny' networks: - - name: internal + - name: 'internal' networks: - '10.10.0.0/16' - '192.168.2.0/24' - - name: VPN - networks: 10.9.0.0/16 + - name: 'VPN' + networks: '10.9.0.0/16' rules: - domain: 'public.example.com' - policy: bypass + policy: 'bypass' - domain: '*.example.com' - policy: bypass + policy: 'bypass' methods: - - OPTIONS + - 'OPTIONS' - domain: 'secure.example.com' - policy: one_factor + policy: 'one_factor' networks: - 'internal' - 'VPN' @@ -635,37 +635,37 @@ access_control: - domain: - 'secure.example.com' - 'private.example.com' - policy: two_factor + policy: 'two_factor' - domain: 'singlefactor.example.com' - policy: one_factor + policy: 'one_factor' - domain: 'mx2.mail.example.com' subject: 'group:admins' - policy: deny + policy: 'deny' - domain: '*.example.com' subject: - 'group:admins' - 'group:moderators' - policy: two_factor + policy: 'two_factor' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - '^/groups/dev/.*$' subject: 'group:dev' - policy: two_factor + policy: 'two_factor' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - '^/users/john/.*$' subject: - ['group:dev', 'user:john'] - 'group:admins' - policy: two_factor + policy: 'two_factor' - domain: '{user}.example.com' - policy: bypass + policy: 'bypass' ``` [RFC7231]: https://datatracker.ietf.org/doc/html/rfc7231 diff --git a/docs/content/en/configuration/security/regulation.md b/docs/content/en/configuration/security/regulation.md index b3e4a58e6..3c818095d 100644 --- a/docs/content/en/configuration/security/regulation.md +++ b/docs/content/en/configuration/security/regulation.md @@ -25,8 +25,8 @@ authentication attempts. This helps prevent brute-force attacks. ```yaml regulation: max_retries: 3 - find_time: 2m - ban_time: 5m + find_time: '2m' + ban_time: '5m' ``` ## Options diff --git a/docs/content/en/configuration/session/introduction.md b/docs/content/en/configuration/session/introduction.md index 53c337396..323cd505d 100644 --- a/docs/content/en/configuration/session/introduction.md +++ b/docs/content/en/configuration/session/introduction.md @@ -24,22 +24,20 @@ the session cookie behaviour and the domains which Authelia can service authoriz ```yaml session: - secret: insecure_session_secret - - name: authelia_session - same_site: lax - inactivity: 5m - expiration: 1h - remember_me: 1M - + secret: 'insecure_session_secret' + name: 'authelia_session' + same_site: 'lax' + inactivity: '5m' + expiration: '1h' + remember_me: '1M' cookies: - - domain: example.com - authelia_url: https://auth.example.com - name: authelia_session - same_site: lax - inactivity: 5m - expiration: 1h - remember_me: 1d + - domain: 'example.com' + authelia_url: 'https://auth.example.com' + name: 'authelia_session' + same_site: 'lax' + inactivity: '5m' + expiration: '1h' + remember_me: '1d' ``` ## Providers diff --git a/docs/content/en/configuration/session/redis.md b/docs/content/en/configuration/session/redis.md index b36d51d08..fe8a8de01 100644 --- a/docs/content/en/configuration/session/redis.md +++ b/docs/content/en/configuration/session/redis.md @@ -25,18 +25,18 @@ this option and we highly recommend it in production environments. It requires y ```yaml session: redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 - username: authelia - password: authelia + username: 'authelia' + password: 'authelia' database_index: 0 maximum_active_connections: 8 minimum_idle_connections: 0 tls: - server_name: myredis.example.com + server_name: 'myredis.example.com' skip_verify: false - minimum_version: TLS1.2 - maximum_version: TLS1.3 + minimum_version: 'TLS1.2' + maximum_version: 'TLS1.3' certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -105,15 +105,15 @@ session: DO NOT USE== -----END RSA PRIVATE KEY----- high_availability: - sentinel_name: mysentinel + sentinel_name: 'mysentinel' # If `sentinel_username` is supplied, Authelia will connect using ACL-based # authentication. Otherwise, it will use traditional `requirepass` auth. - sentinel_username: sentinel_user - sentinel_password: sentinel_specific_pass + sentinel_username: 'sentinel_user' + sentinel_password: 'sentinel_specific_pass' nodes: - - host: sentinel-node1 + - host: 'sentinel-node1' port: 26379 - - host: sentinel-node2 + - host: 'sentinel-node2' port: 26379 route_by_latency: false route_randomly: false diff --git a/docs/content/en/configuration/storage/introduction.md b/docs/content/en/configuration/storage/introduction.md index 97fcf08bf..8f7a44efc 100644 --- a/docs/content/en/configuration/storage/introduction.md +++ b/docs/content/en/configuration/storage/introduction.md @@ -25,7 +25,7 @@ The available storage backends are listed in the table of contents below. ```yaml storage: - encryption_key: a_very_important_secret + encryption_key: 'a_very_important_secret' local: {} mysql: {} postgres: {} diff --git a/docs/content/en/configuration/storage/mysql.md b/docs/content/en/configuration/storage/mysql.md index d5a9f0181..bbe02ff0a 100644 --- a/docs/content/en/configuration/storage/mysql.md +++ b/docs/content/en/configuration/storage/mysql.md @@ -26,19 +26,18 @@ guide for supported version information. ```yaml storage: - encryption_key: a_very_important_secret + encryption_key: 'a_very_important_secret' mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia - password: mypassword - timeout: 5s + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' + password: 'mypassword' + timeout: '5s' tls: - server_name: mysql.example.com + server_name: 'mysql.example.com' skip_verify: false - minimum_version: TLS1.2 - maximum_version: TLS1.3 + minimum_version: 'TLS1.2' + maximum_version: 'TLS1.3' certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -116,33 +115,35 @@ This section describes the individual configuration options. See the [encryption_key docs](introduction.md#encryption_key). -### host +### address -{{< confkey type="string" default="localhost" required="no" >}} +{{< confkey type="address" required="yes" >}} -The database server host. This can also be a unix socket. +*__Reference Note:__ This configuration option uses the [address common syntax](../prologue/common.md#address). Please +see the [documentation](../prologue/common.md#address) on this format for more information.* -If utilising an IPv6 literal address it must be enclosed by square brackets and quoted: +Configures the address for the MySQL/MariaDB Server. The address itself is a connector and the scheme must either be +the `unix` scheme or one of the `tcp` schemes. + +__Examples:__ ```yaml storage: mysql: - host: "[fd00:1111:2222:3333::1]" + address: 'tcp://127.0.0.1:3306' ``` -If utilizing a unix socket it must have the `/` prefix: - ```yaml storage: mysql: - host: /var/run/mysqld.sock + address: 'tcp://[fd00:1111:2222:3333::1]:3306' ``` -### port - -{{< confkey type="integer" default="3306" required="no" >}} - -The port the database server is listening on. +```yaml +storage: + mysql: + address: 'unix:///var/run/mysqld.sock' +``` ### database diff --git a/docs/content/en/configuration/storage/postgres.md b/docs/content/en/configuration/storage/postgres.md index 2deab5050..f7ca07238 100644 --- a/docs/content/en/configuration/storage/postgres.md +++ b/docs/content/en/configuration/storage/postgres.md @@ -25,19 +25,18 @@ guide for supported version information. ```yaml storage: - encryption_key: a_very_important_secret + encryption_key: 'a_very_important_secret' postgres: - host: 127.0.0.1 - port: 5432 - database: authelia - schema: public - username: authelia - password: mypassword + address: 'tcp://127.0.0.1:5432' + database: 'authelia' + schema: 'public' + username: 'authelia' + password: 'mypassword' tls: - server_name: postgres.example.com + server_name: 'postgres.example.com' skip_verify: false - minimum_version: TLS1.2 - maximum_version: TLS1.3 + minimum_version: 'TLS1.2' + maximum_version: 'TLS1.3' certificate_chain: | -----BEGIN CERTIFICATE----- MIIC5jCCAc6gAwIBAgIRAK4Sj7FiN6PXo/urPfO4E7owDQYJKoZIhvcNAQELBQAw @@ -113,35 +112,37 @@ This section describes the individual configuration options. ### encryption_key -See the [encryption_key docs](introduction.md#encryption_key). +See the [encryption_key docs](introduction.md#encryptionkey). -### host +### address -{{< confkey type="string" required="yes" >}} +{{< confkey type="address" required="yes" >}} -The database server host. This can also be a unix socket. +*__Reference Note:__ This configuration option uses the [address common syntax](../prologue/common.md#address). Please +see the [documentation](../prologue/common.md#address) on this format for more information.* -If utilising an IPv6 literal address it must be enclosed by square brackets and quoted: +Configures the address for the PostgreSQL Server. The address itself is a connector and the scheme must either be +the `unix` scheme or one of the `tcp` schemes. + +__Examples:__ ```yaml storage: postgres: - host: "[fd00:1111:2222:3333::1]" + address: 'tcp://127.0.0.1:5432' ``` -If utilizing a unix socket it must have the `/` prefix: - ```yaml storage: postgres: - host: /var/run/postgres.sock + address: 'tcp://[fd00:1111:2222:3333::1]:5432' ``` -### port - -{{< confkey type="integer" default="5432" required="no" >}} - -The port the database server is listening on. +```yaml +storage: + postgres: + address: 'unix:///var/run/postgres.sock' +``` ### database diff --git a/docs/content/en/configuration/storage/sqlite.md b/docs/content/en/configuration/storage/sqlite.md index 631003a7e..417388a4d 100644 --- a/docs/content/en/configuration/storage/sqlite.md +++ b/docs/content/en/configuration/storage/sqlite.md @@ -28,9 +28,9 @@ but this requires you setup an external database such as [PostgreSQL](postgres.m ```yaml storage: - encryption_key: a_very_important_secret + encryption_key: 'a_very_important_secret' local: - path: /config/db.sqlite3 + path: '/config/db.sqlite3' ``` ## Options diff --git a/docs/content/en/configuration/telemetry/metrics.md b/docs/content/en/configuration/telemetry/metrics.md index 2f213c732..4e277752d 100644 --- a/docs/content/en/configuration/telemetry/metrics.md +++ b/docs/content/en/configuration/telemetry/metrics.md @@ -22,14 +22,14 @@ toc: true telemetry: metrics: enabled: false - address: "tcp://:9959" + address: 'tcp://:9959' buffers: read: 4096 write: 4096 timeouts: - read: 6s - write: 6s - idle: 30s + read: '6s' + write: '6s' + idle: '30s' ``` ## Options diff --git a/docs/content/en/integration/kubernetes/istio.md b/docs/content/en/integration/kubernetes/istio.md index 60360c6b0..9201d50c5 100644 --- a/docs/content/en/integration/kubernetes/istio.md +++ b/docs/content/en/integration/kubernetes/istio.md @@ -30,8 +30,8 @@ This is an example IstioOperator manifest adjusted to authenticate with Authelia portions of the resource that you add as well as context. You will need to adapt it to your needs. ```yaml -apiVersion: install.istio.io/v1alpha1 -kind: IstioOperator +apiVersion: 'install.istio.io/v1alpha1' +kind: 'IstioOperator' spec: meshConfig: extensionProviders: @@ -63,13 +63,13 @@ spec: The following [Authorization Policy] applies the above filter extension provider to the `nextcloud.example.com` domain: ```yaml -apiVersion: security.istio.io/v1beta1 -kind: AuthorizationPolicy +apiVersion: 'security.istio.io/v1beta1' +kind: 'AuthorizationPolicy' metadata: - name: nextcloud - namespace: apps + name: 'nextcloud' + namespace: 'apps' spec: - action: CUSTOM + action: 'CUSTOM' provider: name: 'authelia' rules: diff --git a/docs/content/en/integration/kubernetes/traefik-ingress.md b/docs/content/en/integration/kubernetes/traefik-ingress.md index 3a50d8e9e..d2ffd2d38 100644 --- a/docs/content/en/integration/kubernetes/traefik-ingress.md +++ b/docs/content/en/integration/kubernetes/traefik-ingress.md @@ -51,14 +51,14 @@ __SHOULD NOT__ be applied to the Authelia [Ingress] / [IngressRoute] itself.* {{< details "middleware.yml" >}} ```yaml --- -apiVersion: traefik.containo.us/v1alpha1 -kind: Middleware +apiVersion: 'traefik.containo.us/v1alpha1' +kind: 'Middleware' metadata: - name: forwardauth-authelia - namespace: default + name: 'forwardauth-authelia' + namespace: 'default' labels: - app.kubernetes.io/instance: authelia - app.kubernetes.io/name: authelia + app.kubernetes.io/instance: 'authelia' + app.kubernetes.io/name: 'authelia' spec: forwardAuth: address: 'http://authelia.default.svc.cluster.local/api/authz/forward-auth' @@ -85,25 +85,25 @@ the `default` [Namespace] with TCP port `80` configured to route to the applicat {{< details "ingress.yml" >}} ```yaml --- -apiVersion: networking.k8s.io/v1 -kind: Ingress +apiVersion: 'networking.k8s.io/v1' +kind: 'Ingress' metadata: - name: app - namespace: default + name: 'app' + namespace: 'default' annotations: - traefik.ingress.kubernetes.io/router.entryPoints: websecure - traefik.ingress.kubernetes.io/router.middlewares: default-forwardauth-authelia@kubernetescrd - traefik.ingress.kubernetes.io/router.tls: "true" + traefik.ingress.kubernetes.io/router.entryPoints: 'websecure' + traefik.ingress.kubernetes.io/router.middlewares: 'default-forwardauth-authelia@kubernetescrd' + traefik.ingress.kubernetes.io/router.tls: 'true' spec: rules: - - host: app.example.com + - host: 'app.example.com' http: paths: - - path: /bar - pathType: Prefix + - path: '/bar' + pathType: 'Prefix' backend: service: - name: app + name: 'app' port: number: 80 ... @@ -119,27 +119,27 @@ the `default` [Namespace] with TCP port `80` configured to route to the applicat {{< details "ingressRoute.yml" >}} ```yaml --- -apiVersion: traefik.containo.us/v1alpha1 -kind: IngressRoute +apiVersion: 'traefik.containo.us/v1alpha1' +kind: 'IngressRoute' metadata: - name: app - namespace: default + name: 'app' + namespace: 'default' spec: entryPoints: - - websecure + - 'websecure' routes: - - kind: Rule - match: Host(`app.example.com`) + - kind: 'Rule' + match: 'Host(`app.example.com`)' middlewares: - - name: forwardauth-authelia - namespace: default + - name: 'forwardauth-authelia' + namespace: 'default' services: - - kind: Service - name: app - namespace: default + - kind: 'Service' + name: 'app' + namespace: 'default' port: 80 - scheme: http - strategy: RoundRobin + scheme: 'http' + strategy: 'RoundRobin' weight: 10 ... ``` diff --git a/docs/content/en/integration/ldap/introduction.md b/docs/content/en/integration/ldap/introduction.md index 596caa125..6988ee9e7 100644 --- a/docs/content/en/integration/ldap/introduction.md +++ b/docs/content/en/integration/ldap/introduction.md @@ -44,8 +44,8 @@ In your Authelia configuration you will need to enter and update the following v ```yaml ldap: + address: 'ldap://OpenLDAP:1389' implementation: custom - url: ldap://OpenLDAP:1389 timeout: 5s start_tls: false tls: @@ -91,8 +91,8 @@ In your Authelia configuration you will need to enter and update the following v ```yaml ldap: + address: 'ldaps://ldap.example.com' implementation: custom - url: ldaps://ldap.example.com timeout: 5s start_tls: false tls: @@ -134,8 +134,8 @@ In your Authelia configuration you will need to enter and update the following v ```yaml ldap: + address: 'ldap://lldap:3890' implementation: custom - url: ldap://lldap:3890 timeout: 5s start_tls: false base_dn: dc=example,DC=com diff --git a/docs/content/en/integration/openid-connect/apache-guacamole/index.md b/docs/content/en/integration/openid-connect/apache-guacamole/index.md index 856ed202f..ac21220f2 100644 --- a/docs/content/en/integration/openid-connect/apache-guacamole/index.md +++ b/docs/content/en/integration/openid-connect/apache-guacamole/index.md @@ -62,23 +62,23 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: guacamole - description: Apache Guacamole + - id: 'guacamole' + description: 'Apache Guacamole' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://guacamole.example.com + - 'https://guacamole.example.com' scopes: - - openid - - profile - - groups - - email + - 'openid' + - 'profile' + - 'groups' + - 'email' response_types: - - id_token + - 'id_token' grant_types: - - implicit - userinfo_signing_algorithm: none + - 'implicit' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/argocd/index.md b/docs/content/en/integration/openid-connect/argocd/index.md index b37fd2e1d..43071cced 100644 --- a/docs/content/en/integration/openid-connect/argocd/index.md +++ b/docs/content/en/integration/openid-connect/argocd/index.md @@ -65,32 +65,32 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: argocd - description: Argo CD + - id: 'argocd' + description: 'Argo CD' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://argocd.example.com/auth/callback + - 'https://argocd.example.com/auth/callback' scopes: - - openid - - groups - - email - - profile - userinfo_signing_algorithm: none - - id: argocd-cli - description: Argo CD (CLI) + - 'openid' + - 'groups' + - 'email' + - 'profile' + userinfo_signing_algorithm: 'none' + - id: 'argocd-cli' + description: 'Argo CD (CLI)' public: true - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - http://localhost:8085/auth/callback + - 'http://localhost:8085/auth/callback' scopes: - - openid - - groups - - email - - profile - - offline_access - userinfo_signing_algorithm: none + - 'openid' + - 'groups' + - 'email' + - 'profile' + - 'offline_access' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/bookstack/index.md b/docs/content/en/integration/openid-connect/bookstack/index.md index 73e8214a2..3d8ef133c 100644 --- a/docs/content/en/integration/openid-connect/bookstack/index.md +++ b/docs/content/en/integration/openid-connect/bookstack/index.md @@ -67,18 +67,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: bookstack - description: BookStack + - id: 'bookstack' + description: 'BookStack' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://bookstack.example.com/oidc/callback + - 'https://bookstack.example.com/oidc/callback' scopes: - - openid - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/cloudflare-zerotrust/index.md b/docs/content/en/integration/openid-connect/cloudflare-zerotrust/index.md index eecf2c9fc..2259f473a 100644 --- a/docs/content/en/integration/openid-connect/cloudflare-zerotrust/index.md +++ b/docs/content/en/integration/openid-connect/cloudflare-zerotrust/index.md @@ -75,18 +75,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: cloudflare - description: Cloudflare ZeroTrust + - id: 'cloudflare' + description: 'Cloudflare ZeroTrust' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://example-team.cloudflareaccess.com/cdn-cgi/access/callback + - 'https://example-team.cloudflareaccess.com/cdn-cgi/access/callback' scopes: - - openid - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/firezone/index.md b/docs/content/en/integration/openid-connect/firezone/index.md index 39728c5a1..121c49cc3 100644 --- a/docs/content/en/integration/openid-connect/firezone/index.md +++ b/docs/content/en/integration/openid-connect/firezone/index.md @@ -76,20 +76,20 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: firezone - description: Firezone + - id: 'firezone' + description: 'Firezone' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' enforce_pkce: true - pkce_challenge_method: S256 + pkce_challenge_method: 'S256' redirect_uris: - - https://firezone.example.com/auth/oidc/authelia/callback + - 'https://firezone.example.com/auth/oidc/authelia/callback' scopes: - - openid - - email - - profile - userinfo_signing_algorithm: none + - 'openid' + - 'email' + - 'profile' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/frequently-asked-questions.md b/docs/content/en/integration/openid-connect/frequently-asked-questions.md index 0862e1f1a..e7557003c 100644 --- a/docs/content/en/integration/openid-connect/frequently-asked-questions.md +++ b/docs/content/en/integration/openid-connect/frequently-asked-questions.md @@ -132,7 +132,7 @@ services: ## Mandatory that the proxy is on the same network as the application, and that it has this alias. proxy: aliases: - - auth.example.com + - 'auth.example.com' authelia: networks: proxy: {} @@ -140,7 +140,7 @@ networks: proxy: ## An external network can be created manually and shared between multiple compose files. This is NOT mandatory. external: true - name: proxy-net + name: 'proxy-net' ``` ```console diff --git a/docs/content/en/integration/openid-connect/gitea/index.md b/docs/content/en/integration/openid-connect/gitea/index.md index c51fdc238..ed4c691c9 100644 --- a/docs/content/en/integration/openid-connect/gitea/index.md +++ b/docs/content/en/integration/openid-connect/gitea/index.md @@ -86,18 +86,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: gitea - description: Gitea + - id: 'gitea' + description: 'Gitea' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://gitea.example.com/user/oauth2/authelia/callback + - 'https://gitea.example.com/user/oauth2/authelia/callback' scopes: - - openid - - email - - profile - userinfo_signing_algorithm: none + - 'openid' + - 'email' + - 'profile' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/gitlab/index.md b/docs/content/en/integration/openid-connect/gitlab/index.md index 72bc826bd..71ba8d01c 100644 --- a/docs/content/en/integration/openid-connect/gitlab/index.md +++ b/docs/content/en/integration/openid-connect/gitlab/index.md @@ -78,19 +78,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: gitlab - description: GitLab + - id: 'gitlab' + description: 'GitLab' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://gitlab.example.com/users/auth/openid_connect/callback + - 'https://gitlab.example.com/users/auth/openid_connect/callback' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/grafana/index.md b/docs/content/en/integration/openid-connect/grafana/index.md index 45fc15f79..245b588c6 100644 --- a/docs/content/en/integration/openid-connect/grafana/index.md +++ b/docs/content/en/integration/openid-connect/grafana/index.md @@ -96,19 +96,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: grafana - description: Grafana + - id: 'grafana' + description: 'Grafana' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://grafana.example.com/login/generic_oauth + - 'https://grafana.example.com/login/generic_oauth' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/harbor/index.md b/docs/content/en/integration/openid-connect/harbor/index.md index 42d42909b..2c8223657 100644 --- a/docs/content/en/integration/openid-connect/harbor/index.md +++ b/docs/content/en/integration/openid-connect/harbor/index.md @@ -69,19 +69,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: harbor - description: Harbor + - id: 'harbor' + description: 'Harbor' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://harbor.example.com/c/oidc/callback + - 'https://harbor.example.com/c/oidc/callback' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/hashicorp-vault/index.md b/docs/content/en/integration/openid-connect/hashicorp-vault/index.md index 2f14beb74..8c5a9713c 100644 --- a/docs/content/en/integration/openid-connect/hashicorp-vault/index.md +++ b/docs/content/en/integration/openid-connect/hashicorp-vault/index.md @@ -52,20 +52,20 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: vault - description: HashiCorp Vault + - id: 'vault' + description: 'HashiCorp Vault' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://vault.example.com/oidc/callback - - https://vault.example.com/ui/vault/auth/oidc/oidc/callback + - 'https://vault.example.com/oidc/callback' + - 'https://vault.example.com/ui/vault/auth/oidc/oidc/callback' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/kasm-workspaces/index.md b/docs/content/en/integration/openid-connect/kasm-workspaces/index.md index 2860bcbf1..873c04098 100644 --- a/docs/content/en/integration/openid-connect/kasm-workspaces/index.md +++ b/docs/content/en/integration/openid-connect/kasm-workspaces/index.md @@ -67,20 +67,20 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: kasm - description: Kasm Workspaces + - id: 'kasm' + description: 'Kasm Workspaces' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://kasm.example.com/api/oidc_callback + - 'https://kasm.example.com/api/oidc_callback' scopes: - - openid - - profile - - groups - - email - consent_mode: implicit - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + consent_mode: 'implicit' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/komga/index.md b/docs/content/en/integration/openid-connect/komga/index.md index d07272e71..2299af893 100644 --- a/docs/content/en/integration/openid-connect/komga/index.md +++ b/docs/content/en/integration/openid-connect/komga/index.md @@ -50,16 +50,16 @@ spring: client: registration: authelia: - client-id: `komga` - client-secret: `insecure_secret` - client-name: Authelia - scope: openid,profile,email - authorization-grant-type: authorization_code + client-id: 'komga' + client-secret: 'insecure_secret' + client-name: 'Authelia' + scope: 'openid,profile,email' + authorization-grant-type: 'authorization_code' redirect-uri: "{baseScheme}://{baseHost}{basePort}{basePath}/login/oauth2/code/authelia" provider: authelia: - issuer-uri: https://auth.example.com - user-name-attribute: preferred_username + issuer-uri: 'https://auth.example.com' + user-name-attribute: 'preferred_username' ```` ### Authelia @@ -74,20 +74,20 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: komga - description: Komga + - id: 'komga' + description: 'Komga' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://komga.example.com/login/oauth2/code/authelia + - 'https://komga.example.com/login/oauth2/code/authelia' scopes: - - openid - - profile - - email + - 'openid' + - 'profile' + - 'email' grant_types: - - authorization_code - userinfo_signing_algorithm: none + - 'authorization_code' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/minio/index.md b/docs/content/en/integration/openid-connect/minio/index.md index 6a0b2c801..8b3067002 100644 --- a/docs/content/en/integration/openid-connect/minio/index.md +++ b/docs/content/en/integration/openid-connect/minio/index.md @@ -72,19 +72,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: minio - description: MinIO + - id: 'minio' + description: 'MinIO' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://minio.example.com/apps/oidc_login/oidc + - 'https://minio.example.com/apps/oidc_login/oidc' scopes: - - openid - - profile - - email - - groups - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + - 'groups' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/misago/index.md b/docs/content/en/integration/openid-connect/misago/index.md index d462c25e5..dc11c8efc 100644 --- a/docs/content/en/integration/openid-connect/misago/index.md +++ b/docs/content/en/integration/openid-connect/misago/index.md @@ -87,23 +87,24 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: misago + - id: 'misago' + description: 'Misago' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' scopes: - - openid - - profile - - email + - 'openid' + - 'profile' + - 'email' redirect_uris: - - https://misago.example.com/oauth2/complete/ + - 'https://misago.example.com/oauth2/complete/' grant_types: - - authorization_code + - 'authorization_code' response_types: - - code + - 'code' response_modes: - - query - userinfo_signing_algorithm: none + - 'query' + userinfo_signing_algorithm: 'none' ``` --- diff --git a/docs/content/en/integration/openid-connect/nextcloud/index.md b/docs/content/en/integration/openid-connect/nextcloud/index.md index 83249dc46..540e2069e 100644 --- a/docs/content/en/integration/openid-connect/nextcloud/index.md +++ b/docs/content/en/integration/openid-connect/nextcloud/index.md @@ -95,19 +95,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: nextcloud - description: NextCloud + - id: 'nextcloud' + description: 'NextCloud' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://nextcloud.example.com/apps/oidc_login/oidc + - 'https://nextcloud.example.com/apps/oidc_login/oidc' scopes: - - openid - - profile - - email - - groups - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + - 'groups' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/outline/index.md b/docs/content/en/integration/openid-connect/outline/index.md index c01c7720a..1a330e0f8 100644 --- a/docs/content/en/integration/openid-connect/outline/index.md +++ b/docs/content/en/integration/openid-connect/outline/index.md @@ -69,19 +69,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: outline - description: Outline + - id: 'outline' + description: 'Outline' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://outline.example.com/auth/oidc.callback + - 'https://outline.example.com/auth/oidc.callback' scopes: - - openid - - offline_access - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'offline_access' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/portainer/index.md b/docs/content/en/integration/openid-connect/portainer/index.md index 511461cdc..e50a282da 100644 --- a/docs/content/en/integration/openid-connect/portainer/index.md +++ b/docs/content/en/integration/openid-connect/portainer/index.md @@ -70,19 +70,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: portainer - description: Portainer + - id: 'portainer' + description: 'Portainer' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://portainer.example.com + - 'https://portainer.example.com' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/proxmox/index.md b/docs/content/en/integration/openid-connect/proxmox/index.md index f7ba35255..17eefafc9 100644 --- a/docs/content/en/integration/openid-connect/proxmox/index.md +++ b/docs/content/en/integration/openid-connect/proxmox/index.md @@ -74,18 +74,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: proxmox - description: Proxmox + - id: 'proxmox' + description: 'Proxmox' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://proxmox.example.com + - 'https://proxmox.example.com' scopes: - - openid - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/seafile/index.md b/docs/content/en/integration/openid-connect/seafile/index.md index 0a1d5d021..41b4e1482 100644 --- a/docs/content/en/integration/openid-connect/seafile/index.md +++ b/docs/content/en/integration/openid-connect/seafile/index.md @@ -78,18 +78,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: seafile - description: Seafile + - id: 'seafile' + description: 'Seafile' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://seafile.example.com/oauth/callback/ + - 'https://seafile.example.com/oauth/callback/' scopes: - - openid - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/synapse/index.md b/docs/content/en/integration/openid-connect/synapse/index.md index 13428e28f..1927f306e 100644 --- a/docs/content/en/integration/openid-connect/synapse/index.md +++ b/docs/content/en/integration/openid-connect/synapse/index.md @@ -72,18 +72,18 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: synapse - description: Synapse + - id: 'synapse' + description: 'Synapse' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://synapse.example.com/_synapse/client/oidc/callback + - 'https://synapse.example.com/_synapse/client/oidc/callback' scopes: - - openid - - profile - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/synology-dsm/index.md b/docs/content/en/integration/openid-connect/synology-dsm/index.md index e6de3acec..a5dcd075e 100644 --- a/docs/content/en/integration/openid-connect/synology-dsm/index.md +++ b/docs/content/en/integration/openid-connect/synology-dsm/index.md @@ -74,19 +74,19 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: synology-dsm - description: Synology DSM + - id: 'synology-dsm' + description: 'Synology DSM' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. public: false - authorization_policy: two_factor + authorization_policy: 'two_factor' redirect_uris: - - https://dsm.example.com + - 'https://dsm.example.com' scopes: - - openid - - profile - - groups - - email - userinfo_signing_algorithm: none + - 'openid' + - 'profile' + - 'groups' + - 'email' + userinfo_signing_algorithm: 'none' ``` ## See Also diff --git a/docs/content/en/integration/openid-connect/tailscale/index.md b/docs/content/en/integration/openid-connect/tailscale/index.md index 2129f4155..3a3f927dd 100644 --- a/docs/content/en/integration/openid-connect/tailscale/index.md +++ b/docs/content/en/integration/openid-connect/tailscale/index.md @@ -84,15 +84,15 @@ identity_providers: ## The other portions of the mandatory OpenID Connect 1.0 configuration go here. ## See: https://www.authelia.com/c/oidc clients: - - id: tailscale - description: Tailscale SSO + - id: 'tailscale' + description: 'Tailscale' secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. redirect_uris: - - https://login.tailscale.com/a/oauth_response + - 'https://login.tailscale.com/a/oauth_response' scopes: - - openid - - email - - profile + - 'openid' + - 'email' + - 'profile' ``` ## See Also diff --git a/docs/content/en/integration/proxies/caddy.md b/docs/content/en/integration/proxies/caddy.md index 850538aaa..7e2496ce7 100644 --- a/docs/content/en/integration/proxies/caddy.md +++ b/docs/content/en/integration/proxies/caddy.md @@ -101,7 +101,7 @@ server: endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' ``` ## Configuration diff --git a/docs/content/en/integration/proxies/envoy.md b/docs/content/en/integration/proxies/envoy.md index af37d3cc8..8a50de23f 100644 --- a/docs/content/en/integration/proxies/envoy.md +++ b/docs/content/en/integration/proxies/envoy.md @@ -75,7 +75,7 @@ server: endpoints: authz: ext-authz: - implementation: ExtAuthz + implementation: 'ExtAuthz' ``` ## Configuration @@ -97,47 +97,47 @@ Support for [Envoy] is possible with Authelia v4.37.0 and higher via the [Envoy] version: "3.8" networks: net: - driver: bridge + driver: 'bridge' services: envoy: - container_name: envoy - image: envoyproxy/envoy:v1.24 - restart: unless-stopped + container_name: 'envoy' + image: 'envoyproxy/envoy:v1.24' + restart: 'unless-stopped' networks: net: {} ports: - '80:8080' - '443:8443' volumes: - - ${PWD}/data/envoy/envoy.yaml:/etc/envoy/envoy.yaml:ro - - ${PWD}/data/certificates:/certificates:ro + - '${PWD}/data/envoy/envoy.yaml:/etc/envoy/envoy.yaml:ro' + - '${PWD}/data/certificates:/certificates:ro' authelia: - container_name: authelia - image: authelia/authelia - restart: unless-stopped + container_name: 'authelia' + image: 'authelia/authelia' + restart: 'unless-stopped' networks: net: {} expose: - 9091 volumes: - - ${PWD}/data/authelia/config:/config + - '${PWD}/data/authelia/config:/config' environment: - TZ: "Australia/Melbourne" + TZ: 'Australia/Melbourne' nextcloud: - container_name: nextcloud - image: linuxserver/nextcloud - restart: unless-stopped + container_name: 'nextcloud' + image: 'linuxserver/nextcloud' + restart: 'unless-stopped' networks: net: {} expose: - 443 volumes: - - ${PWD}/data/nextcloud/config:/config - - ${PWD}/data/nextcloud/data:/data + - '${PWD}/data/nextcloud/config:/config' + - '${PWD}/data/nextcloud/data:/data' environment: - PUID: "1000" - PGID: "1000" - TZ: "Australia/Melbourne" + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' ``` {{< /details >}} @@ -145,92 +145,92 @@ services: ```yaml static_resources: listeners: - - name: listener_http + - name: 'listener_http' address: socket_address: - address: 0.0.0.0 + address: '0.0.0.0' port_value: 8080 filter_chains: - filters: - - name: envoy.filters.network.http_connection_manager + - name: 'envoy.filters.network.http_connection_manager' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager - codec_type: auto - stat_prefix: ingress_http + "@type": 'type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager' + codec_type: 'auto' + stat_prefix: 'ingress_http' route_config: - name: local_route + name: 'local_route' virtual_hosts: - - name: backend - domains: ["*"] + - name: 'backend' + domains: ['*'] routes: - match: - prefix: "/" + prefix: '/' redirect: https_redirect: true http_filters: - - name: envoy.filters.http.router + - name: 'envoy.filters.http.router' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router - - name: listener_https + "@type": 'type.googleapis.com/envoy.extensions.filters.http.router.v3.Router' + - name: 'listener_https' address: socket_address: - address: 0.0.0.0 + address: '0.0.0.0' port_value: 8443 filter_chains: - filters: - - name: envoy.filters.network.http_connection_manager + - name: 'envoy.filters.network.http_connection_manager' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager - stat_prefix: ingress_http + "@type": 'type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager' + stat_prefix: 'ingress_http' use_remote_address: true skip_xff_append: false route_config: - name: local_route + name: 'local_route' virtual_hosts: - - name: whoami_service + - name: 'whoami_service' domains: ["nextcloud.example.com"] routes: - match: prefix: "/" route: - cluster: nextcloud - - name: authelia_service - domains: ["auth.example.com"] + cluster: 'nextcloud' + - name: 'authelia_service' + domains: ['auth.example.com'] typed_per_filter_config: envoy.filters.http.ext_authz: - "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute + "@type": 'type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute' disabled: true routes: - match: - prefix: "/" + prefix: '/' route: - cluster: authelia + cluster: 'authelia' http_filters: - - name: envoy.filters.http.ext_authz + - name: 'envoy.filters.http.ext_authz' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz - transport_api_version: v3 + "@type": 'type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz' + transport_api_version: 'v3' allowed_headers: patterns: - - exact: authorization - - exact: proxy-authorization - - exact: accept - - exact: cookie + - exact: 'authorization' + - exact: 'proxy-authorization' + - exact: 'accept' + - exact: 'cookie' http_service: - path_prefix: /api/authz/ext-authz/ + path_prefix: '/api/authz/ext-authz/' server_uri: - uri: authelia:9091 - cluster: authelia - timeout: 0.25s + uri: 'authelia:9091' + cluster: 'authelia' + timeout: '0.25s' authorization_request: allowed_headers: patterns: - - exact: authorization - - exact: proxy-authorization - - exact: accept - - exact: cookie + - exact: 'authorization' + - exact: 'proxy-authorization' + - exact: 'accept' + - exact: 'cookie' headers_to_add: - - key: X-Forwarded-Proto + - key: 'X-Forwarded-Proto' value: '%REQ(:SCHEME)%' ## The following commented lines are for configuring the Authelia URL in the proxy. We ## strongly suggest this is configured in the Session Cookies section of the Authelia configuration. @@ -239,52 +239,52 @@ static_resources: authorization_response: allowed_upstream_headers: patterns: - - exact: authorization - - exact: proxy-authorization - - prefix: remote- - - prefix: authelia- + - exact: 'authorization' + - exact: 'proxy-authorization' + - prefix: 'remote-' + - prefix: 'authelia-' allowed_client_headers: patterns: - - exact: set-cookie + - exact: 'set-cookie' allowed_client_headers_on_success: patterns: - - exact: set-cookie + - exact: 'set-cookie' failure_mode_allow: false - - name: envoy.filters.http.router + - name: 'envoy.filters.http.router' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router + "@type": 'type.googleapis.com/envoy.extensions.filters.http.router.v3.Router' clusters: - - name: nextcloud - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'nextcloud' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: nextcloud + cluster_name: 'nextcloud' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: nextcloud + address: 'nextcloud' port_value: 80 - - name: authelia - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'authelia' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: authelia + cluster_name: 'authelia' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: authelia + address: 'authelia' port_value: 9091 layered_runtime: layers: - - name: static_layer_0 + - name: 'static_layer_0' static_layer: envoy: resource_limits: diff --git a/docs/content/en/integration/proxies/haproxy.md b/docs/content/en/integration/proxies/haproxy.md index 12b9f98a1..d7f5efd66 100644 --- a/docs/content/en/integration/proxies/haproxy.md +++ b/docs/content/en/integration/proxies/haproxy.md @@ -104,7 +104,7 @@ server: endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' ``` ## Configuration diff --git a/docs/content/en/integration/proxies/nginx-proxy-manager/index.md b/docs/content/en/integration/proxies/nginx-proxy-manager/index.md index b260455dd..c57968712 100644 --- a/docs/content/en/integration/proxies/nginx-proxy-manager/index.md +++ b/docs/content/en/integration/proxies/nginx-proxy-manager/index.md @@ -75,13 +75,13 @@ version: "3.8" networks: net: - driver: bridge + driver: 'bridge' services: nginx: - container_name: nginx - image: jc21/nginx-proxy-manager - restart: unless-stopped + container_name: 'nginx' + image: 'jc21/nginx-proxy-manager' + restart: 'unless-stopped' networks: net: aliases: [] @@ -90,44 +90,44 @@ services: - '81:81' - '443:443' volumes: - - ${PWD}/data/nginx-proxy-manager/data:/data - - ${PWD}/data/nginx-proxy-manager/letsencrypt:/etc/letsencrypt - - ${PWD}/data/nginx/snippets:/snippets:ro + - '${PWD}/data/nginx-proxy-manager/data:/data' + - '${PWD}/data/nginx-proxy-manager/letsencrypt:/etc/letsencrypt' + - '${PWD}/data/nginx/snippets:/snippets:ro' environment: TZ: 'Australia/Melbourne' authelia: - container_name: authelia - image: authelia/authelia - restart: unless-stopped + container_name: 'authelia' + image: 'authelia/authelia' + restart: 'unless-stopped' networks: net: aliases: [] expose: - 9091 volumes: - - ${PWD}/data/authelia/config:/config + - '${PWD}/data/authelia/config:/config' environment: TZ: 'Australia/Melbourne' nextcloud: - container_name: nextcloud - image: lscr.io/linuxserver/nextcloud - restart: unless-stopped + container_name: 'nextcloud' + image: 'lscr.io/linuxserver/nextcloud' + restart: 'unless-stopped' networks: net: aliases: [] expose: - 443 volumes: - - ${PWD}/data/nextcloud/config:/config - - ${PWD}/data/nextcloud/data:/data + - '${PWD}/data/nextcloud/config:/config' + - '${PWD}/data/nextcloud/data:/data' environment: PUID: '1000' PGID: '1000' TZ: 'Australia/Melbourne' whoami: - container_name: whoami - image: docker.io/traefik/whoami - restart: unless-stopped + container_name: 'whoami' + image: 'docker.io/traefik/whoami' + restart: 'unless-stopped' networks: net: aliases: [] diff --git a/docs/content/en/integration/proxies/nginx.md b/docs/content/en/integration/proxies/nginx.md index 8d185e697..c8419f909 100644 --- a/docs/content/en/integration/proxies/nginx.md +++ b/docs/content/en/integration/proxies/nginx.md @@ -90,7 +90,7 @@ server: endpoints: authz: auth-request: - implementation: AuthRequest + implementation: 'AuthRequest' ``` ## Docker Compose diff --git a/docs/content/en/integration/proxies/swag.md b/docs/content/en/integration/proxies/swag.md index 8f39865d5..f936ac7fa 100644 --- a/docs/content/en/integration/proxies/swag.md +++ b/docs/content/en/integration/proxies/swag.md @@ -156,13 +156,13 @@ version: "3.8" networks: net: - driver: bridge + driver: 'bridge' services: swag: - container_name: swag - image: lscr.io/linuxserver/swag - restart: unless-stopped + container_name: 'swag' + image: 'lscr.io/linuxserver/swag' + restart: 'unless-stopped' networks: net: aliases: [] @@ -170,7 +170,7 @@ services: - '80:80' - '443:443' volumes: - - ${PWD}/data/swag:/config + - '${PWD}/data/swag:/config' ## Uncomment the line below if you want to use the Authelia configuration snippets. #- ${PWD}/data/nginx/snippets:/snippets:ro environment: @@ -184,40 +184,40 @@ services: ONLY_SUBDOMAINS: 'false' STAGING: 'true' cap_add: - - NET_ADMIN + - 'NET_ADMIN' authelia: - container_name: authelia - image: authelia/authelia - restart: unless-stopped + container_name: 'authelia' + image: 'authelia/authelia' + restart: 'unless-stopped' networks: net: aliases: [] expose: - 9091 volumes: - - ${PWD}/data/authelia/config:/config + - '${PWD}/data/authelia/config:/config' environment: TZ: 'Australia/Melbourne' nextcloud: - container_name: nextcloud - image: lscr.io/linuxserver/nextcloud - restart: unless-stopped + container_name: 'nextcloud' + image: 'lscr.io/linuxserver/nextcloud' + restart: 'unless-stopped' networks: net: aliases: [] expose: - 443 volumes: - - ${PWD}/data/nextcloud/config:/config - - ${PWD}/data/nextcloud/data:/data + - '${PWD}/data/nextcloud/config:/config' + - '${PWD}/data/nextcloud/data:/data' environment: PUID: '1000' PGID: '1000' TZ: 'Australia/Melbourne' whoami: - container_name: whoami - image: docker.io/traefik/whoami - restart: unless-stopped + container_name: 'whoami' + image: 'docker.io/traefik/whoami' + restart: 'unless-stopped' networks: net: aliases: [] diff --git a/docs/content/en/integration/proxies/traefik.md b/docs/content/en/integration/proxies/traefik.md index d5553e95d..8d6b084aa 100644 --- a/docs/content/en/integration/proxies/traefik.md +++ b/docs/content/en/integration/proxies/traefik.md @@ -75,7 +75,7 @@ server: endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' ``` ## Configuration @@ -130,9 +130,9 @@ networks: driver: bridge services: traefik: - container_name: traefik - image: traefik:v2.9 - restart: unless-stopped + container_name: 'traefik' + image: 'traefik:v2.9' + restart: 'unless-stopped' command: - '--api=true' - '--api.dashboard=true' @@ -164,11 +164,11 @@ services: networks: net: {} ports: - - "80:8080" - - "443:8443" + - '80:8080' + - '443:8443' volumes: - - /var/run/docker.sock:/var/run/docker.sock - - ${PWD}/data/traefik:/config + - '/var/run/docker.sock:/var/run/docker.sock' + - '${PWD}/data/traefik:/config' labels: - 'traefik.enable=true' - 'traefik.http.routers.api.rule=Host(`traefik.example.com`)' @@ -177,15 +177,15 @@ services: - 'traefik.http.routers.api.service=api@internal' - 'traefik.http.routers.api.middlewares=authelia@docker' authelia: - container_name: authelia - image: authelia/authelia - restart: unless-stopped + container_name: 'authelia' + image: 'authelia/authelia' + restart: 'unless-stopped' networks: net: {} expose: - 9091 volumes: - - ${PWD}/data/authelia/config:/config + - '${PWD}/data/authelia/config:/config' environment: TZ: "Australia/Melbourne" labels: @@ -200,20 +200,20 @@ services: - 'traefik.http.middlewares.authelia.forwardAuth.trustForwardHeader=true' - 'traefik.http.middlewares.authelia.forwardAuth.authResponseHeaders=Authorization,Proxy-Authorization,Remote-User,Remote-Groups,Remote-Email,Remote-Name' nextcloud: - container_name: nextcloud - image: linuxserver/nextcloud - restart: unless-stopped + container_name: 'nextcloud' + image: 'linuxserver/nextcloud' + restart: 'unless-stopped' networks: net: {} expose: - 443 volumes: - - ${PWD}/data/nextcloud/config:/config - - ${PWD}/data/nextcloud/data:/data + - '${PWD}/data/nextcloud/config:/config' + - '${PWD}/data/nextcloud/data:/data' environment: - PUID: "1000" - PGID: "1000" - TZ: "Australia/Melbourne" + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' labels: - 'traefik.enable=true' - 'traefik.http.routers.nextcloud.rule=Host(`nextcloud.example.com`)' @@ -221,19 +221,19 @@ services: - 'traefik.http.routers.nextcloud.tls=true' - 'traefik.http.routers.nextcloud.middlewares=authelia@docker' heimdall: - container_name: heimdall - image: linuxserver/heimdall - restart: unless-stopped + container_name: 'heimdall' + image: 'linuxserver/heimdall' + restart: 'unless-stopped' networks: net: {} expose: - 443 volumes: - - ${PWD}/data/heimdall/config:/config + - '${PWD}/data/heimdall/config:/config' environment: - PUID: "1000" - PGID: "1000" - TZ: "Australia/Melbourne" + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' labels: - 'traefik.enable=true' - 'traefik.http.routers.heimdall.rule=Host(`heimdall.example.com`)' @@ -264,12 +264,12 @@ This example uses a `docker-compose.yml` similar to the one above however it has version: "3.8" networks: net: - driver: bridge + driver: 'bridge' services: traefik: - container_name: traefik - image: traefik:v2.9 - restart: unless-stopped + container_name: 'traefik' + image: 'traefik:v2.9' + restart: 'unless-stopped' command: - '--api=true' - '--api.dashboard=true' @@ -294,74 +294,74 @@ services: networks: net: {} ports: - - "80:8080" - - "443:8443" + - '80:8080' + - '443:8443' volumes: - - /var/run/docker.sock:/var/run/docker.sock - - ${PWD}/data/traefik/config:/config - - ${PWD}/data/traefik/certificates:/certificates + - '/var/run/docker.sock:/var/run/docker.sock' + - '${PWD}/data/traefik/config:/config' + - '${PWD}/data/traefik/certificates:/certificates' labels: - 'traefik.enable=true' authelia: - container_name: authelia - image: authelia/authelia - restart: unless-stopped + container_name: 'authelia' + image: 'authelia/authelia' + restart: 'unless-stopped' networks: net: {} expose: - 9091 volumes: - - ${PWD}/data/authelia/config:/config - - ${PWD}/data/authelia/certificates:/certificates + - '${PWD}/data/authelia/config:/config' + - '${PWD}/data/authelia/certificates:/certificates' environment: - TZ: "Australia/Melbourne" + TZ: 'Australia/Melbourne' labels: - 'traefik.enable=true' nextcloud: - container_name: nextcloud - image: linuxserver/nextcloud - restart: unless-stopped + container_name: 'nextcloud' + image: 'linuxserver/nextcloud' + restart: 'unless-stopped' networks: net: {} expose: - 443 volumes: - - ${PWD}/data/nextcloud/config:/config - - ${PWD}/data/nextcloud/data:/data + - '${PWD}/data/nextcloud/config:/config' + - '${PWD}/data/nextcloud/data:/data' environment: - PUID: "1000" - PGID: "1000" - TZ: "Australia/Melbourne" + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' labels: - 'traefik.enable=true' heimdall: - container_name: heimdall - image: linuxserver/heimdall - restart: unless-stopped + container_name: 'heimdall' + image: 'linuxserver/heimdall' + restart: 'unless-stopped' networks: net: {} expose: - 443 volumes: - - ${PWD}/data/heimdall/config:/config + - '${PWD}/data/heimdall/config:/config' environment: - PUID: "1000" - PGID: "1000" - TZ: "Australia/Melbourne" + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' labels: - 'traefik.enable=true' whoami: - container_name: whoami - image: traefik/whoami:latest - restart: unless-stopped + container_name: 'whoami' + image: 'traefik/whoami:latest' + restart: 'unless-stopped' networks: net: {} expose: - 80 environment: - TZ: "Australia/Melbourne" + TZ: 'Australia/Melbourne' labels: - - "traefik.enable=true" + - 'traefik.enable=true' ... ``` {{< /details >}} @@ -391,16 +391,16 @@ entryPoints: tls: options: modern: - minVersion: "VersionTLS13" + minVersion: 'VersionTLS13' intermediate: - minVersion: "VersionTLS12" + minVersion: 'VersionTLS12' cipherSuites: - - "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256" - - "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256" - - "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384" - - "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" - - "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305" - - "TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305" + - 'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256' + - 'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256' + - 'TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384' + - 'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384' + - 'TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305' + - 'TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305' http: middlewares: authelia: @@ -418,9 +418,9 @@ http: - 'Remote-Email' - 'Remote-Name' tls: - ca: /certificates/ca.public.crt - cert: /certificates/traefik.public.crt - key: /certificates/traefik.private.pem + ca: '/certificates/ca.public.crt' + cert: '/certificates/traefik.public.crt' + key: '/certificates/traefik.private.pem' authelia-basic: forwardAuth: address: 'https://authelia:9091/api/verify?auth=basic' @@ -433,86 +433,86 @@ http: - 'Remote-Email' - 'Remote-Name' tls: - ca: /certificates/ca.public.crt - cert: /certificates/traefik.public.crt - key: /certificates/traefik.private.pem + ca: '/certificates/ca.public.crt' + cert: '/certificates/traefik.public.crt' + key: '/certificates/traefik.private.pem' routers: traefik: - rule: Host(`traefik.example.com`) - entryPoints: websecure - service: api@internal + rule: 'Host(`traefik.example.com`)' + entryPoints: 'websecure' + service: 'api@internal' middlewares: - - authelia@file + - 'authelia@file' tls: - options: modern@file - certResolver: default + options: 'modern@file' + certResolver: 'default' domains: - - main: "example.com" + - main: 'example.com' sans: - - "*.example.com" + - '*.example.com' whoami: - rule: Host(`whoami.example.com`) - entryPoints: websecure - service: whoami-net@docker + rule: 'Host(`whoami.example.com`)' + entryPoints: 'websecure' + service: 'whoami-net@docker' middlewares: - - authelia@file + - 'authelia@file' tls: - options: modern@file - certResolver: default + options: 'modern@file' + certResolver: 'default' domains: - - main: "example.com" + - main: 'example.com' sans: - - "*.example.com" + - '*.example.com' nextcloud: - rule: Host(`nextcloud.example.com`) - entryPoints: websecure - service: nextcloud-net@docker + rule: 'Host(`nextcloud.example.com`)' + entryPoints: 'websecure' + service: 'nextcloud-net@docker' middlewares: - - authelia@file + - 'authelia@file' tls: - options: modern@file - certResolver: default + options: 'modern@file' + certResolver: 'default' domains: - - main: "example.com" + - main: 'example.com' sans: - - "*.example.com" + - '*.example.com' heimdall: - rule: Host(`heimdall.example.com`) - entryPoints: websecure - service: heimdall-net@docker + rule: 'Host(`heimdall.example.com`)' + entryPoints: 'websecure' + service: 'heimdall-net@docker' middlewares: - - authelia-basic@file + - 'authelia-basic@file' tls: - options: modern@file - certResolver: default + options: 'modern@file' + certResolver: 'default' domains: - - main: "example.com" + - main: 'example.com' sans: - - "*.example.com" + - '*.example.com' authelia: - rule: Host(`auth.example.com`) - entryPoints: websecure - service: authelia@file + rule: 'Host(`auth.example.com`)' + entryPoints: 'websecure' + service: 'authelia@file' tls: - options: modern@file - certResolver: default + options: 'modern@file' + certResolver: 'default' domains: - - main: "example.com" + - main: 'example.com' sans: - - "*.example.com" + - '*.example.com' services: authelia: loadBalancer: servers: - - url: https://authelia:9091/ - serversTransport: autheliaMutualTLS + - url: 'https://authelia:9091/' + serversTransport: 'autheliaMutualTLS' serversTransports: autheliaMutualTLS: certificates: - - certFile: /certificates/traefik.public.crt - keyFile: /certificates/traefik.private.pem + - certFile: '/certificates/traefik.public.crt' + keyFile: '/certificates/traefik.private.pem' rootCAs: - - /certificates/ca.public.crt + - '/certificates/ca.public.crt' ... ``` {{< /details >}} diff --git a/docs/content/en/integration/proxies/traefikv1.md b/docs/content/en/integration/proxies/traefikv1.md index 0519782ca..3aa1195d0 100644 --- a/docs/content/en/integration/proxies/traefikv1.md +++ b/docs/content/en/integration/proxies/traefikv1.md @@ -88,7 +88,7 @@ server: endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' ``` ## Configuration @@ -119,15 +119,15 @@ version: '3' networks: net: - driver: bridge + driver: 'bridge' services: traefik: - image: traefik:v1.7.34-alpine - container_name: traefik + image: 'traefik:v1.7.34-alpine' + container_name: 'traefik' volumes: - - /var/run/docker.sock:/var/run/docker.sock + - '/var/run/docker.sock:/var/run/docker.sock' networks: - - net + - 'net' labels: - 'traefik.frontend.rule=Host:traefik.example.com' - 'traefik.port=8081' @@ -135,7 +135,7 @@ services: - '80:80' - '443:443' - '8081:8081' - restart: unless-stopped + restart: 'unless-stopped' command: - '--api' - '--api.entrypoint=api' @@ -151,27 +151,27 @@ services: # - '--entryPoints=Name:https Address::443 TLS ForwardedHeaders.TrustedIPs:10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,fc00::/7 ProxyProtocol.TrustedIPs:10.0.0.0/8,172.16.0.0/12,192.168.0.0/16,fc00::/7' - '--entryPoints=Name:api Address::8081' authelia: - image: authelia/authelia - container_name: authelia + image: 'authelia/authelia' + container_name: 'authelia' volumes: - - /path/to/authelia:/config + - '/path/to/authelia:/config' networks: - - net + - 'net' labels: - 'traefik.frontend.rule=Host:auth.example.com' expose: - 9091 - restart: unless-stopped + restart: 'unless-stopped' environment: - - TZ=Australia/Melbourne + TZ: 'Australia/Melbourne' nextcloud: - image: linuxserver/nextcloud - container_name: nextcloud + image: 'linuxserver/nextcloud' + container_name: 'nextcloud' volumes: - - /path/to/nextcloud/config:/config - - /path/to/nextcloud/data:/data + - '/path/to/nextcloud/config:/config' + - '/path/to/nextcloud/data:/data' networks: - - net + - 'net' labels: - 'traefik.frontend.rule=Host:nextcloud.example.com' - 'traefik.frontend.auth.forward.address=http://authelia:9091/api/authz/forward-auth' @@ -182,18 +182,18 @@ services: - 'traefik.frontend.auth.forward.authResponseHeaders=Authorization,Proxy-Authorization,Remote-User,Remote-Groups,Remote-Email,Remote-Name' expose: - 443 - restart: unless-stopped + restart: 'unless-stopped' environment: - - PUID=1000 - - PGID=1000 - - TZ=Australia/Melbourne + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' heimdall: - image: linuxserver/heimdall - container_name: heimdall + image: 'linuxserver/heimdall' + container_name: 'heimdall' volumes: - - /path/to/heimdall/config:/config + - '/path/to/heimdall/config:/config' networks: - - net + - 'net' labels: - 'traefik.frontend.rule=Host:heimdall.example.com' - 'traefik.frontend.auth.forward.address=http://authelia:9091/api/authz/forward-auth/basic' @@ -201,11 +201,11 @@ services: - 'traefik.frontend.auth.forward.authResponseHeaders=Authorization,Proxy-Authorization,Remote-User,Remote-Groups,Remote-Email,Remote-Name' expose: - 443 - restart: unless-stopped + restart: 'unless-stopped' environment: - - PUID=1000 - - PGID=1000 - - TZ=Australia/Melbourne + PUID: '1000' + PGID: '1000' + TZ: 'Australia/Melbourne' ``` ## See Also diff --git a/docs/content/en/overview/security/measures.md b/docs/content/en/overview/security/measures.md index 88714dd16..41e91c60b 100644 --- a/docs/content/en/overview/security/measures.md +++ b/docs/content/en/overview/security/measures.md @@ -160,7 +160,7 @@ values. As such all SMTP connections require the following: -1. A TLS Connection (STARTTLS or implicit) has been negotiated before authentication or sending emails (_unauthenticated +1. A TLS Connection (StartTLS or implicit) has been negotiated before authentication or sending emails (_unauthenticated connections require it as well_) 2. Valid X509 Certificate presented to the client during the TLS handshake @@ -207,22 +207,22 @@ for SMTP servers that allow unauthenticated relaying (bad practice). ### SMTP Ports -All SMTP connections begin as [cleartext], and then negotiate to upgrade to a secure TLS connection via STARTTLS. +All SMTP connections begin as [cleartext], and then negotiate to upgrade to a secure TLS connection via StartTLS. The [`submissions` service][service-submissions] (_typically port 465_) is an exception to this rule, where the -connection begins immediately secured with TLS (_similar to HTTPS_). When the configured [port for -SMTP][docs-config-smtp-port] is set to `465`, Authelia will initiate TLS connections without requiring STARTTLS +connection begins immediately secured with TLS (_similar to HTTPS_). When the configured [scheme for +SMTP][docs-config-smtp-port] is set to `submissions`, Authelia will initiate TLS connections without requiring StartTLS negotiation. -When the `submissions` service port is available, it [should be preferred][port-465] over any STARTTLS port for +When the `submissions` service port is available, it [should be preferred][port-465] over any StartTLS port for submitting mail. **NOTE:** Prior to 2018, port 465 was previously assigned for a similar purpose known as [`smtps`][port-465] (_A TLS only equivalent of the `smtp` port 25_), which it had been deprecated for. Port 465 has since been re-assigned for only supporting mail submission (_which unlike SMTP transfers via port 25, [requires authentication][smtp-auth]_), similar -to port 587 (_the `submission` port, a common alternative that uses STARTTLS instead_). +to port 587 (_the `submission` port, a common alternative that uses StartTLS instead_). -[docs-config-smtp-port]: ../../configuration/notifications/smtp.md#port +[docs-config-smtp-port]: ../../configuration/notifications/smtp.md#address [cleartext]: https://cwe.mitre.org/data/definitions/312.html [service-submissions]: https://datatracker.ietf.org/doc/html/rfc8314#section-7.3 [port-465]: https://datatracker.ietf.org/doc/html/rfc8314#section-3.3 diff --git a/docs/content/en/reference/guides/passwords.md b/docs/content/en/reference/guides/passwords.md index a21fc3bf0..e90749354 100644 --- a/docs/content/en/reference/guides/passwords.md +++ b/docs/content/en/reference/guides/passwords.md @@ -26,30 +26,31 @@ The format of the [YAML] file is as follows: users: john: disabled: false - displayname: "John Doe" - password: "$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM" - email: john.doe@authelia.com + displayname: 'John Doe' + password: '$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM' + email: 'john.doe@authelia.com' groups: - - admins - - dev + - 'admins' + - 'dev' harry: disabled: false - displayname: "Harry Potter" - password: "$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM" - email: harry.potter@authelia.com + displayname: 'Harry Potter' + password: '$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM' + email: 'harry.potter@authelia.com' groups: [] bob: disabled: false - displayname: "Bob Dylan" - password: "$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM" - email: bob.dylan@authelia.com + displayname: 'Bob Dylan' + password: '$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM' + email: 'bob.dylan@authelia.com' groups: - - dev + - 'dev' james: disabled: false - displayname: "James Dean" - password: "$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM" - email: james.dean@authelia.com + displayname: 'James Dean' + password: '$argon2id$v=19$m=65536,t=3,p=2$BpLnfgDsc2WD8F2q$o/vzA4myCqZZ36bUGsDY//8mKUYNZZaR0t4MFFSs+iM' + email: 'james.dean@authelia.com' + groups: [] ``` ## Passwords diff --git a/docs/content/en/reference/guides/troubleshooting.md b/docs/content/en/reference/guides/troubleshooting.md index 6dd6a864a..d8811ecfa 100644 --- a/docs/content/en/reference/guides/troubleshooting.md +++ b/docs/content/en/reference/guides/troubleshooting.md @@ -2,7 +2,7 @@ title: "Troubleshooting" description: "This guide describes and helps users provide information during troubleshooting including sanitization etc" lead: "This guide describes and helps users provide troubleshooting information." -date: 2023-05-01T11:30:07+10:00 +date: 2023-05-01T12:36:02+10:00 draft: false images: [] menu: diff --git a/docs/data/configkeys.json b/docs/data/configkeys.json index c140a0b24..ecc9213cf 100644 --- a/docs/data/configkeys.json +++ b/docs/data/configkeys.json @@ -1 +1 @@ -[{"path":"theme","secret":false,"env":"AUTHELIA_THEME"},{"path":"certificates_directory","secret":false,"env":"AUTHELIA_CERTIFICATES_DIRECTORY"},{"path":"jwt_secret","secret":true,"env":"AUTHELIA_JWT_SECRET_FILE"},{"path":"default_redirection_url","secret":false,"env":"AUTHELIA_DEFAULT_REDIRECTION_URL"},{"path":"default_2fa_method","secret":false,"env":"AUTHELIA_DEFAULT_2FA_METHOD"},{"path":"log.level","secret":false,"env":"AUTHELIA_LOG_LEVEL"},{"path":"log.format","secret":false,"env":"AUTHELIA_LOG_FORMAT"},{"path":"log.file_path","secret":false,"env":"AUTHELIA_LOG_FILE_PATH"},{"path":"log.keep_stdout","secret":false,"env":"AUTHELIA_LOG_KEEP_STDOUT"},{"path":"identity_providers.oidc.hmac_secret","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_HMAC_SECRET_FILE"},{"path":"identity_providers.oidc.issuer_certificate_chain","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ISSUER_CERTIFICATE_CHAIN_FILE"},{"path":"identity_providers.oidc.issuer_private_key","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ISSUER_PRIVATE_KEY_FILE"},{"path":"identity_providers.oidc.access_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ACCESS_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.authorize_code_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_AUTHORIZE_CODE_LIFESPAN"},{"path":"identity_providers.oidc.id_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ID_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.refresh_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_REFRESH_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.enable_client_debug_messages","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENABLE_CLIENT_DEBUG_MESSAGES"},{"path":"identity_providers.oidc.minimum_parameter_entropy","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_MINIMUM_PARAMETER_ENTROPY"},{"path":"identity_providers.oidc.enforce_pkce","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENFORCE_PKCE"},{"path":"identity_providers.oidc.enable_pkce_plain_challenge","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENABLE_PKCE_PLAIN_CHALLENGE"},{"path":"identity_providers.oidc.cors.allowed_origins_from_client_redirect_uris","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_CORS_ALLOWED_ORIGINS_FROM_CLIENT_REDIRECT_URIS"},{"path":"identity_providers.oidc.pushed_authorizations.enforce","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_PUSHED_AUTHORIZATIONS_ENFORCE"},{"path":"identity_providers.oidc.pushed_authorizations.context_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_PUSHED_AUTHORIZATIONS_CONTEXT_LIFESPAN"},{"path":"authentication_backend.password_reset.disable","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_PASSWORD_RESET_DISABLE"},{"path":"authentication_backend.password_reset.custom_url","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_PASSWORD_RESET_CUSTOM_URL"},{"path":"authentication_backend.refresh_interval","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_REFRESH_INTERVAL"},{"path":"authentication_backend.file.path","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PATH"},{"path":"authentication_backend.file.watch","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_WATCH"},{"path":"authentication_backend.file.password.algorithm","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ALGORITHM"},{"path":"authentication_backend.file.password.argon2.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_VARIANT"},{"path":"authentication_backend.file.password.argon2.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_ITERATIONS"},{"path":"authentication_backend.file.password.argon2.memory","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_MEMORY"},{"path":"authentication_backend.file.password.argon2.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_PARALLELISM"},{"path":"authentication_backend.file.password.argon2.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_KEY_LENGTH"},{"path":"authentication_backend.file.password.argon2.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_SALT_LENGTH"},{"path":"authentication_backend.file.password.sha2crypt.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_VARIANT"},{"path":"authentication_backend.file.password.sha2crypt.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_ITERATIONS"},{"path":"authentication_backend.file.password.sha2crypt.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_SALT_LENGTH"},{"path":"authentication_backend.file.password.pbkdf2.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_VARIANT"},{"path":"authentication_backend.file.password.pbkdf2.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_ITERATIONS"},{"path":"authentication_backend.file.password.pbkdf2.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_SALT_LENGTH"},{"path":"authentication_backend.file.password.bcrypt.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_BCRYPT_VARIANT"},{"path":"authentication_backend.file.password.bcrypt.cost","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_BCRYPT_COST"},{"path":"authentication_backend.file.password.scrypt.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_ITERATIONS"},{"path":"authentication_backend.file.password.scrypt.block_size","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_BLOCK_SIZE"},{"path":"authentication_backend.file.password.scrypt.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_PARALLELISM"},{"path":"authentication_backend.file.password.scrypt.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_KEY_LENGTH"},{"path":"authentication_backend.file.password.scrypt.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_SALT_LENGTH"},{"path":"authentication_backend.file.password.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ITERATIONS"},{"path":"authentication_backend.file.password.memory","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_MEMORY"},{"path":"authentication_backend.file.password.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PARALLELISM"},{"path":"authentication_backend.file.password.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_KEY_LENGTH"},{"path":"authentication_backend.file.password.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SALT_LENGTH"},{"path":"authentication_backend.file.search.email","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_SEARCH_EMAIL"},{"path":"authentication_backend.file.search.case_insensitive","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_SEARCH_CASE_INSENSITIVE"},{"path":"authentication_backend.ldap.implementation","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_IMPLEMENTATION"},{"path":"authentication_backend.ldap.url","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_URL"},{"path":"authentication_backend.ldap.timeout","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TIMEOUT"},{"path":"authentication_backend.ldap.start_tls","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_START_TLS"},{"path":"authentication_backend.ldap.tls.minimum_version","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_MINIMUM_VERSION"},{"path":"authentication_backend.ldap.tls.maximum_version","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_MAXIMUM_VERSION"},{"path":"authentication_backend.ldap.tls.skip_verify","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_SKIP_VERIFY"},{"path":"authentication_backend.ldap.tls.server_name","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_SERVER_NAME"},{"path":"authentication_backend.ldap.tls.private_key","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_PRIVATE_KEY_FILE"},{"path":"authentication_backend.ldap.tls.certificate_chain","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"authentication_backend.ldap.base_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_BASE_DN"},{"path":"authentication_backend.ldap.additional_users_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_ADDITIONAL_USERS_DN"},{"path":"authentication_backend.ldap.users_filter","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USERS_FILTER"},{"path":"authentication_backend.ldap.additional_groups_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_ADDITIONAL_GROUPS_DN"},{"path":"authentication_backend.ldap.groups_filter","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_GROUPS_FILTER"},{"path":"authentication_backend.ldap.group_name_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_GROUP_NAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.username_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USERNAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.mail_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_MAIL_ATTRIBUTE"},{"path":"authentication_backend.ldap.display_name_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_DISPLAY_NAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.permit_referrals","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_REFERRALS"},{"path":"authentication_backend.ldap.permit_unauthenticated_bind","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_UNAUTHENTICATED_BIND"},{"path":"authentication_backend.ldap.permit_feature_detection_failure","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_FEATURE_DETECTION_FAILURE"},{"path":"authentication_backend.ldap.user","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USER"},{"path":"authentication_backend.ldap.password","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PASSWORD_FILE"},{"path":"session.secret","secret":true,"env":"AUTHELIA_SESSION_SECRET_FILE"},{"path":"session.name","secret":false,"env":"AUTHELIA_SESSION_NAME"},{"path":"session.domain","secret":false,"env":"AUTHELIA_SESSION_DOMAIN"},{"path":"session.same_site","secret":false,"env":"AUTHELIA_SESSION_SAME_SITE"},{"path":"session.expiration","secret":false,"env":"AUTHELIA_SESSION_EXPIRATION"},{"path":"session.inactivity","secret":false,"env":"AUTHELIA_SESSION_INACTIVITY"},{"path":"session.remember_me","secret":false,"env":"AUTHELIA_SESSION_REMEMBER_ME"},{"path":"session","secret":false,"env":"AUTHELIA_SESSION"},{"path":"session.redis.host","secret":false,"env":"AUTHELIA_SESSION_REDIS_HOST"},{"path":"session.redis.port","secret":false,"env":"AUTHELIA_SESSION_REDIS_PORT"},{"path":"session.redis.username","secret":false,"env":"AUTHELIA_SESSION_REDIS_USERNAME"},{"path":"session.redis.password","secret":true,"env":"AUTHELIA_SESSION_REDIS_PASSWORD_FILE"},{"path":"session.redis.database_index","secret":false,"env":"AUTHELIA_SESSION_REDIS_DATABASE_INDEX"},{"path":"session.redis.maximum_active_connections","secret":false,"env":"AUTHELIA_SESSION_REDIS_MAXIMUM_ACTIVE_CONNECTIONS"},{"path":"session.redis.minimum_idle_connections","secret":false,"env":"AUTHELIA_SESSION_REDIS_MINIMUM_IDLE_CONNECTIONS"},{"path":"session.redis.tls.minimum_version","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_MINIMUM_VERSION"},{"path":"session.redis.tls.maximum_version","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_MAXIMUM_VERSION"},{"path":"session.redis.tls.skip_verify","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_SKIP_VERIFY"},{"path":"session.redis.tls.server_name","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_SERVER_NAME"},{"path":"session.redis.tls.private_key","secret":true,"env":"AUTHELIA_SESSION_REDIS_TLS_PRIVATE_KEY_FILE"},{"path":"session.redis.tls.certificate_chain","secret":true,"env":"AUTHELIA_SESSION_REDIS_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"session.redis.high_availability.sentinel_name","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_NAME"},{"path":"session.redis.high_availability.sentinel_username","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_USERNAME"},{"path":"session.redis.high_availability.sentinel_password","secret":true,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_PASSWORD_FILE"},{"path":"session.redis.high_availability.route_by_latency","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_ROUTE_BY_LATENCY"},{"path":"session.redis.high_availability.route_randomly","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_ROUTE_RANDOMLY"},{"path":"totp.disable","secret":false,"env":"AUTHELIA_TOTP_DISABLE"},{"path":"totp.issuer","secret":false,"env":"AUTHELIA_TOTP_ISSUER"},{"path":"totp.algorithm","secret":false,"env":"AUTHELIA_TOTP_ALGORITHM"},{"path":"totp.digits","secret":false,"env":"AUTHELIA_TOTP_DIGITS"},{"path":"totp.period","secret":false,"env":"AUTHELIA_TOTP_PERIOD"},{"path":"totp.skew","secret":false,"env":"AUTHELIA_TOTP_SKEW"},{"path":"totp.secret_size","secret":false,"env":"AUTHELIA_TOTP_SECRET_SIZE"},{"path":"duo_api.disable","secret":false,"env":"AUTHELIA_DUO_API_DISABLE"},{"path":"duo_api.hostname","secret":false,"env":"AUTHELIA_DUO_API_HOSTNAME"},{"path":"duo_api.integration_key","secret":true,"env":"AUTHELIA_DUO_API_INTEGRATION_KEY_FILE"},{"path":"duo_api.secret_key","secret":true,"env":"AUTHELIA_DUO_API_SECRET_KEY_FILE"},{"path":"duo_api.enable_self_enrollment","secret":false,"env":"AUTHELIA_DUO_API_ENABLE_SELF_ENROLLMENT"},{"path":"access_control.default_policy","secret":false,"env":"AUTHELIA_ACCESS_CONTROL_DEFAULT_POLICY"},{"path":"ntp.address","secret":false,"env":"AUTHELIA_NTP_ADDRESS"},{"path":"ntp.version","secret":false,"env":"AUTHELIA_NTP_VERSION"},{"path":"ntp.max_desync","secret":false,"env":"AUTHELIA_NTP_MAX_DESYNC"},{"path":"ntp.disable_startup_check","secret":false,"env":"AUTHELIA_NTP_DISABLE_STARTUP_CHECK"},{"path":"ntp.disable_failure","secret":false,"env":"AUTHELIA_NTP_DISABLE_FAILURE"},{"path":"regulation.max_retries","secret":false,"env":"AUTHELIA_REGULATION_MAX_RETRIES"},{"path":"regulation.find_time","secret":false,"env":"AUTHELIA_REGULATION_FIND_TIME"},{"path":"regulation.ban_time","secret":false,"env":"AUTHELIA_REGULATION_BAN_TIME"},{"path":"storage.local.path","secret":false,"env":"AUTHELIA_STORAGE_LOCAL_PATH"},{"path":"storage.mysql.host","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_HOST"},{"path":"storage.mysql.port","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_PORT"},{"path":"storage.mysql.database","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_DATABASE"},{"path":"storage.mysql.username","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_USERNAME"},{"path":"storage.mysql.password","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_PASSWORD_FILE"},{"path":"storage.mysql.timeout","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TIMEOUT"},{"path":"storage.mysql.tls.minimum_version","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_MINIMUM_VERSION"},{"path":"storage.mysql.tls.maximum_version","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_MAXIMUM_VERSION"},{"path":"storage.mysql.tls.skip_verify","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_SKIP_VERIFY"},{"path":"storage.mysql.tls.server_name","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_SERVER_NAME"},{"path":"storage.mysql.tls.private_key","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_TLS_PRIVATE_KEY_FILE"},{"path":"storage.mysql.tls.certificate_chain","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"storage.postgres.host","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_HOST"},{"path":"storage.postgres.port","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_PORT"},{"path":"storage.postgres.database","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_DATABASE"},{"path":"storage.postgres.username","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_USERNAME"},{"path":"storage.postgres.password","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_PASSWORD_FILE"},{"path":"storage.postgres.timeout","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TIMEOUT"},{"path":"storage.postgres.schema","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SCHEMA"},{"path":"storage.postgres.tls.minimum_version","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_MINIMUM_VERSION"},{"path":"storage.postgres.tls.maximum_version","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_MAXIMUM_VERSION"},{"path":"storage.postgres.tls.skip_verify","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_SKIP_VERIFY"},{"path":"storage.postgres.tls.server_name","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_SERVER_NAME"},{"path":"storage.postgres.tls.private_key","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_PRIVATE_KEY_FILE"},{"path":"storage.postgres.tls.certificate_chain","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"storage.postgres.ssl.mode","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_MODE"},{"path":"storage.postgres.ssl.root_certificate","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_ROOT_CERTIFICATE"},{"path":"storage.postgres.ssl.certificate","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_CERTIFICATE"},{"path":"storage.postgres.ssl.key","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_KEY_FILE"},{"path":"storage.encryption_key","secret":true,"env":"AUTHELIA_STORAGE_ENCRYPTION_KEY_FILE"},{"path":"notifier.disable_startup_check","secret":false,"env":"AUTHELIA_NOTIFIER_DISABLE_STARTUP_CHECK"},{"path":"notifier.filesystem.filename","secret":false,"env":"AUTHELIA_NOTIFIER_FILESYSTEM_FILENAME"},{"path":"notifier.smtp.host","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_HOST"},{"path":"notifier.smtp.port","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_PORT"},{"path":"notifier.smtp.timeout","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TIMEOUT"},{"path":"notifier.smtp.username","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_USERNAME"},{"path":"notifier.smtp.password","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_PASSWORD_FILE"},{"path":"notifier.smtp.identifier","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_IDENTIFIER"},{"path":"notifier.smtp.sender","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_SENDER"},{"path":"notifier.smtp.subject","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_SUBJECT"},{"path":"notifier.smtp.startup_check_address","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_STARTUP_CHECK_ADDRESS"},{"path":"notifier.smtp.disable_require_tls","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_REQUIRE_TLS"},{"path":"notifier.smtp.disable_html_emails","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_HTML_EMAILS"},{"path":"notifier.smtp.disable_starttls","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_STARTTLS"},{"path":"notifier.smtp.tls.minimum_version","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_MINIMUM_VERSION"},{"path":"notifier.smtp.tls.maximum_version","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_MAXIMUM_VERSION"},{"path":"notifier.smtp.tls.skip_verify","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_SKIP_VERIFY"},{"path":"notifier.smtp.tls.server_name","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_SERVER_NAME"},{"path":"notifier.smtp.tls.private_key","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_PRIVATE_KEY_FILE"},{"path":"notifier.smtp.tls.certificate_chain","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"notifier.template_path","secret":false,"env":"AUTHELIA_NOTIFIER_TEMPLATE_PATH"},{"path":"server.host","secret":false,"env":"AUTHELIA_SERVER_HOST"},{"path":"server.port","secret":false,"env":"AUTHELIA_SERVER_PORT"},{"path":"server.address","secret":false,"env":"AUTHELIA_SERVER_ADDRESS"},{"path":"server.umask","secret":false,"env":"AUTHELIA_SERVER_UMASK"},{"path":"server.path","secret":false,"env":"AUTHELIA_SERVER_PATH"},{"path":"server.asset_path","secret":false,"env":"AUTHELIA_SERVER_ASSET_PATH"},{"path":"server.disable_healthcheck","secret":false,"env":"AUTHELIA_SERVER_DISABLE_HEALTHCHECK"},{"path":"server.tls.certificate","secret":false,"env":"AUTHELIA_SERVER_TLS_CERTIFICATE"},{"path":"server.tls.key","secret":true,"env":"AUTHELIA_SERVER_TLS_KEY_FILE"},{"path":"server.headers.csp_template","secret":false,"env":"AUTHELIA_SERVER_HEADERS_CSP_TEMPLATE"},{"path":"server.endpoints.enable_pprof","secret":false,"env":"AUTHELIA_SERVER_ENDPOINTS_ENABLE_PPROF"},{"path":"server.endpoints.enable_expvars","secret":false,"env":"AUTHELIA_SERVER_ENDPOINTS_ENABLE_EXPVARS"},{"path":"server.buffers.read","secret":false,"env":"AUTHELIA_SERVER_BUFFERS_READ"},{"path":"server.buffers.write","secret":false,"env":"AUTHELIA_SERVER_BUFFERS_WRITE"},{"path":"server.timeouts.read","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_READ"},{"path":"server.timeouts.write","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_WRITE"},{"path":"server.timeouts.idle","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_IDLE"},{"path":"telemetry.metrics.enabled","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_ENABLED"},{"path":"telemetry.metrics.address","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_ADDRESS"},{"path":"telemetry.metrics.umask","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_UMASK"},{"path":"telemetry.metrics.buffers.read","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_BUFFERS_READ"},{"path":"telemetry.metrics.buffers.write","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_BUFFERS_WRITE"},{"path":"telemetry.metrics.timeouts.read","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_READ"},{"path":"telemetry.metrics.timeouts.write","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_WRITE"},{"path":"telemetry.metrics.timeouts.idle","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_IDLE"},{"path":"webauthn.disable","secret":false,"env":"AUTHELIA_WEBAUTHN_DISABLE"},{"path":"webauthn.display_name","secret":false,"env":"AUTHELIA_WEBAUTHN_DISPLAY_NAME"},{"path":"webauthn.attestation_conveyance_preference","secret":false,"env":"AUTHELIA_WEBAUTHN_ATTESTATION_CONVEYANCE_PREFERENCE"},{"path":"webauthn.user_verification","secret":false,"env":"AUTHELIA_WEBAUTHN_USER_VERIFICATION"},{"path":"webauthn.timeout","secret":false,"env":"AUTHELIA_WEBAUTHN_TIMEOUT"},{"path":"password_policy.standard.enabled","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_ENABLED"},{"path":"password_policy.standard.min_length","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_MIN_LENGTH"},{"path":"password_policy.standard.max_length","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_MAX_LENGTH"},{"path":"password_policy.standard.require_uppercase","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_UPPERCASE"},{"path":"password_policy.standard.require_lowercase","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_LOWERCASE"},{"path":"password_policy.standard.require_number","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_NUMBER"},{"path":"password_policy.standard.require_special","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_SPECIAL"},{"path":"password_policy.zxcvbn.enabled","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_ZXCVBN_ENABLED"},{"path":"password_policy.zxcvbn.min_score","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_ZXCVBN_MIN_SCORE"},{"path":"privacy_policy.enabled","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_ENABLED"},{"path":"privacy_policy.require_user_acceptance","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_REQUIRE_USER_ACCEPTANCE"},{"path":"privacy_policy.policy_url","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_POLICY_URL"}] \ No newline at end of file +[{"path":"theme","secret":false,"env":"AUTHELIA_THEME"},{"path":"certificates_directory","secret":false,"env":"AUTHELIA_CERTIFICATES_DIRECTORY"},{"path":"jwt_secret","secret":true,"env":"AUTHELIA_JWT_SECRET_FILE"},{"path":"default_redirection_url","secret":false,"env":"AUTHELIA_DEFAULT_REDIRECTION_URL"},{"path":"default_2fa_method","secret":false,"env":"AUTHELIA_DEFAULT_2FA_METHOD"},{"path":"log.level","secret":false,"env":"AUTHELIA_LOG_LEVEL"},{"path":"log.format","secret":false,"env":"AUTHELIA_LOG_FORMAT"},{"path":"log.file_path","secret":false,"env":"AUTHELIA_LOG_FILE_PATH"},{"path":"log.keep_stdout","secret":false,"env":"AUTHELIA_LOG_KEEP_STDOUT"},{"path":"identity_providers.oidc.hmac_secret","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_HMAC_SECRET_FILE"},{"path":"identity_providers.oidc.issuer_certificate_chain","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ISSUER_CERTIFICATE_CHAIN_FILE"},{"path":"identity_providers.oidc.issuer_private_key","secret":true,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ISSUER_PRIVATE_KEY_FILE"},{"path":"identity_providers.oidc.access_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ACCESS_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.authorize_code_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_AUTHORIZE_CODE_LIFESPAN"},{"path":"identity_providers.oidc.id_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ID_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.refresh_token_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_REFRESH_TOKEN_LIFESPAN"},{"path":"identity_providers.oidc.enable_client_debug_messages","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENABLE_CLIENT_DEBUG_MESSAGES"},{"path":"identity_providers.oidc.minimum_parameter_entropy","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_MINIMUM_PARAMETER_ENTROPY"},{"path":"identity_providers.oidc.enforce_pkce","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENFORCE_PKCE"},{"path":"identity_providers.oidc.enable_pkce_plain_challenge","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_ENABLE_PKCE_PLAIN_CHALLENGE"},{"path":"identity_providers.oidc.cors.allowed_origins_from_client_redirect_uris","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_CORS_ALLOWED_ORIGINS_FROM_CLIENT_REDIRECT_URIS"},{"path":"identity_providers.oidc.pushed_authorizations.enforce","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_PUSHED_AUTHORIZATIONS_ENFORCE"},{"path":"identity_providers.oidc.pushed_authorizations.context_lifespan","secret":false,"env":"AUTHELIA_IDENTITY_PROVIDERS_OIDC_PUSHED_AUTHORIZATIONS_CONTEXT_LIFESPAN"},{"path":"authentication_backend.password_reset.disable","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_PASSWORD_RESET_DISABLE"},{"path":"authentication_backend.password_reset.custom_url","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_PASSWORD_RESET_CUSTOM_URL"},{"path":"authentication_backend.refresh_interval","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_REFRESH_INTERVAL"},{"path":"authentication_backend.file.path","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PATH"},{"path":"authentication_backend.file.watch","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_WATCH"},{"path":"authentication_backend.file.password.algorithm","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ALGORITHM"},{"path":"authentication_backend.file.password.argon2.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_VARIANT"},{"path":"authentication_backend.file.password.argon2.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_ITERATIONS"},{"path":"authentication_backend.file.password.argon2.memory","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_MEMORY"},{"path":"authentication_backend.file.password.argon2.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_PARALLELISM"},{"path":"authentication_backend.file.password.argon2.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_KEY_LENGTH"},{"path":"authentication_backend.file.password.argon2.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ARGON2_SALT_LENGTH"},{"path":"authentication_backend.file.password.sha2crypt.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_VARIANT"},{"path":"authentication_backend.file.password.sha2crypt.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_ITERATIONS"},{"path":"authentication_backend.file.password.sha2crypt.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SHA2CRYPT_SALT_LENGTH"},{"path":"authentication_backend.file.password.pbkdf2.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_VARIANT"},{"path":"authentication_backend.file.password.pbkdf2.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_ITERATIONS"},{"path":"authentication_backend.file.password.pbkdf2.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PBKDF2_SALT_LENGTH"},{"path":"authentication_backend.file.password.bcrypt.variant","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_BCRYPT_VARIANT"},{"path":"authentication_backend.file.password.bcrypt.cost","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_BCRYPT_COST"},{"path":"authentication_backend.file.password.scrypt.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_ITERATIONS"},{"path":"authentication_backend.file.password.scrypt.block_size","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_BLOCK_SIZE"},{"path":"authentication_backend.file.password.scrypt.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_PARALLELISM"},{"path":"authentication_backend.file.password.scrypt.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_KEY_LENGTH"},{"path":"authentication_backend.file.password.scrypt.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SCRYPT_SALT_LENGTH"},{"path":"authentication_backend.file.password.iterations","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_ITERATIONS"},{"path":"authentication_backend.file.password.memory","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_MEMORY"},{"path":"authentication_backend.file.password.parallelism","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_PARALLELISM"},{"path":"authentication_backend.file.password.key_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_KEY_LENGTH"},{"path":"authentication_backend.file.password.salt_length","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_PASSWORD_SALT_LENGTH"},{"path":"authentication_backend.file.search.email","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_SEARCH_EMAIL"},{"path":"authentication_backend.file.search.case_insensitive","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_FILE_SEARCH_CASE_INSENSITIVE"},{"path":"authentication_backend.ldap.address","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_ADDRESS"},{"path":"authentication_backend.ldap.implementation","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_IMPLEMENTATION"},{"path":"authentication_backend.ldap.timeout","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TIMEOUT"},{"path":"authentication_backend.ldap.start_tls","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_START_TLS"},{"path":"authentication_backend.ldap.tls.minimum_version","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_MINIMUM_VERSION"},{"path":"authentication_backend.ldap.tls.maximum_version","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_MAXIMUM_VERSION"},{"path":"authentication_backend.ldap.tls.skip_verify","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_SKIP_VERIFY"},{"path":"authentication_backend.ldap.tls.server_name","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_SERVER_NAME"},{"path":"authentication_backend.ldap.tls.private_key","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_PRIVATE_KEY_FILE"},{"path":"authentication_backend.ldap.tls.certificate_chain","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"authentication_backend.ldap.base_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_BASE_DN"},{"path":"authentication_backend.ldap.additional_users_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_ADDITIONAL_USERS_DN"},{"path":"authentication_backend.ldap.users_filter","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USERS_FILTER"},{"path":"authentication_backend.ldap.additional_groups_dn","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_ADDITIONAL_GROUPS_DN"},{"path":"authentication_backend.ldap.groups_filter","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_GROUPS_FILTER"},{"path":"authentication_backend.ldap.group_name_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_GROUP_NAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.username_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USERNAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.mail_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_MAIL_ATTRIBUTE"},{"path":"authentication_backend.ldap.display_name_attribute","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_DISPLAY_NAME_ATTRIBUTE"},{"path":"authentication_backend.ldap.permit_referrals","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_REFERRALS"},{"path":"authentication_backend.ldap.permit_unauthenticated_bind","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_UNAUTHENTICATED_BIND"},{"path":"authentication_backend.ldap.permit_feature_detection_failure","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PERMIT_FEATURE_DETECTION_FAILURE"},{"path":"authentication_backend.ldap.user","secret":false,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_USER"},{"path":"authentication_backend.ldap.password","secret":true,"env":"AUTHELIA_AUTHENTICATION_BACKEND_LDAP_PASSWORD_FILE"},{"path":"session.secret","secret":true,"env":"AUTHELIA_SESSION_SECRET_FILE"},{"path":"session.name","secret":false,"env":"AUTHELIA_SESSION_NAME"},{"path":"session.domain","secret":false,"env":"AUTHELIA_SESSION_DOMAIN"},{"path":"session.same_site","secret":false,"env":"AUTHELIA_SESSION_SAME_SITE"},{"path":"session.expiration","secret":false,"env":"AUTHELIA_SESSION_EXPIRATION"},{"path":"session.inactivity","secret":false,"env":"AUTHELIA_SESSION_INACTIVITY"},{"path":"session.remember_me","secret":false,"env":"AUTHELIA_SESSION_REMEMBER_ME"},{"path":"session","secret":false,"env":"AUTHELIA_SESSION"},{"path":"session.redis.host","secret":false,"env":"AUTHELIA_SESSION_REDIS_HOST"},{"path":"session.redis.port","secret":false,"env":"AUTHELIA_SESSION_REDIS_PORT"},{"path":"session.redis.username","secret":false,"env":"AUTHELIA_SESSION_REDIS_USERNAME"},{"path":"session.redis.password","secret":true,"env":"AUTHELIA_SESSION_REDIS_PASSWORD_FILE"},{"path":"session.redis.database_index","secret":false,"env":"AUTHELIA_SESSION_REDIS_DATABASE_INDEX"},{"path":"session.redis.maximum_active_connections","secret":false,"env":"AUTHELIA_SESSION_REDIS_MAXIMUM_ACTIVE_CONNECTIONS"},{"path":"session.redis.minimum_idle_connections","secret":false,"env":"AUTHELIA_SESSION_REDIS_MINIMUM_IDLE_CONNECTIONS"},{"path":"session.redis.tls.minimum_version","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_MINIMUM_VERSION"},{"path":"session.redis.tls.maximum_version","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_MAXIMUM_VERSION"},{"path":"session.redis.tls.skip_verify","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_SKIP_VERIFY"},{"path":"session.redis.tls.server_name","secret":false,"env":"AUTHELIA_SESSION_REDIS_TLS_SERVER_NAME"},{"path":"session.redis.tls.private_key","secret":true,"env":"AUTHELIA_SESSION_REDIS_TLS_PRIVATE_KEY_FILE"},{"path":"session.redis.tls.certificate_chain","secret":true,"env":"AUTHELIA_SESSION_REDIS_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"session.redis.high_availability.sentinel_name","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_NAME"},{"path":"session.redis.high_availability.sentinel_username","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_USERNAME"},{"path":"session.redis.high_availability.sentinel_password","secret":true,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_SENTINEL_PASSWORD_FILE"},{"path":"session.redis.high_availability.route_by_latency","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_ROUTE_BY_LATENCY"},{"path":"session.redis.high_availability.route_randomly","secret":false,"env":"AUTHELIA_SESSION_REDIS_HIGH_AVAILABILITY_ROUTE_RANDOMLY"},{"path":"totp.disable","secret":false,"env":"AUTHELIA_TOTP_DISABLE"},{"path":"totp.issuer","secret":false,"env":"AUTHELIA_TOTP_ISSUER"},{"path":"totp.algorithm","secret":false,"env":"AUTHELIA_TOTP_ALGORITHM"},{"path":"totp.digits","secret":false,"env":"AUTHELIA_TOTP_DIGITS"},{"path":"totp.period","secret":false,"env":"AUTHELIA_TOTP_PERIOD"},{"path":"totp.skew","secret":false,"env":"AUTHELIA_TOTP_SKEW"},{"path":"totp.secret_size","secret":false,"env":"AUTHELIA_TOTP_SECRET_SIZE"},{"path":"duo_api.disable","secret":false,"env":"AUTHELIA_DUO_API_DISABLE"},{"path":"duo_api.hostname","secret":false,"env":"AUTHELIA_DUO_API_HOSTNAME"},{"path":"duo_api.integration_key","secret":true,"env":"AUTHELIA_DUO_API_INTEGRATION_KEY_FILE"},{"path":"duo_api.secret_key","secret":true,"env":"AUTHELIA_DUO_API_SECRET_KEY_FILE"},{"path":"duo_api.enable_self_enrollment","secret":false,"env":"AUTHELIA_DUO_API_ENABLE_SELF_ENROLLMENT"},{"path":"access_control.default_policy","secret":false,"env":"AUTHELIA_ACCESS_CONTROL_DEFAULT_POLICY"},{"path":"ntp.address","secret":false,"env":"AUTHELIA_NTP_ADDRESS"},{"path":"ntp.version","secret":false,"env":"AUTHELIA_NTP_VERSION"},{"path":"ntp.max_desync","secret":false,"env":"AUTHELIA_NTP_MAX_DESYNC"},{"path":"ntp.disable_startup_check","secret":false,"env":"AUTHELIA_NTP_DISABLE_STARTUP_CHECK"},{"path":"ntp.disable_failure","secret":false,"env":"AUTHELIA_NTP_DISABLE_FAILURE"},{"path":"regulation.max_retries","secret":false,"env":"AUTHELIA_REGULATION_MAX_RETRIES"},{"path":"regulation.find_time","secret":false,"env":"AUTHELIA_REGULATION_FIND_TIME"},{"path":"regulation.ban_time","secret":false,"env":"AUTHELIA_REGULATION_BAN_TIME"},{"path":"storage.local.path","secret":false,"env":"AUTHELIA_STORAGE_LOCAL_PATH"},{"path":"storage.mysql.address","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_ADDRESS"},{"path":"storage.mysql.database","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_DATABASE"},{"path":"storage.mysql.username","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_USERNAME"},{"path":"storage.mysql.password","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_PASSWORD_FILE"},{"path":"storage.mysql.timeout","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TIMEOUT"},{"path":"storage.mysql.host","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_HOST"},{"path":"storage.mysql.port","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_PORT"},{"path":"storage.mysql.tls.minimum_version","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_MINIMUM_VERSION"},{"path":"storage.mysql.tls.maximum_version","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_MAXIMUM_VERSION"},{"path":"storage.mysql.tls.skip_verify","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_SKIP_VERIFY"},{"path":"storage.mysql.tls.server_name","secret":false,"env":"AUTHELIA_STORAGE_MYSQL_TLS_SERVER_NAME"},{"path":"storage.mysql.tls.private_key","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_TLS_PRIVATE_KEY_FILE"},{"path":"storage.mysql.tls.certificate_chain","secret":true,"env":"AUTHELIA_STORAGE_MYSQL_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"storage.postgres.address","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_ADDRESS"},{"path":"storage.postgres.database","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_DATABASE"},{"path":"storage.postgres.username","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_USERNAME"},{"path":"storage.postgres.password","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_PASSWORD_FILE"},{"path":"storage.postgres.timeout","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TIMEOUT"},{"path":"storage.postgres.host","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_HOST"},{"path":"storage.postgres.port","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_PORT"},{"path":"storage.postgres.schema","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SCHEMA"},{"path":"storage.postgres.tls.minimum_version","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_MINIMUM_VERSION"},{"path":"storage.postgres.tls.maximum_version","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_MAXIMUM_VERSION"},{"path":"storage.postgres.tls.skip_verify","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_SKIP_VERIFY"},{"path":"storage.postgres.tls.server_name","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_SERVER_NAME"},{"path":"storage.postgres.tls.private_key","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_PRIVATE_KEY_FILE"},{"path":"storage.postgres.tls.certificate_chain","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"storage.postgres.ssl.mode","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_MODE"},{"path":"storage.postgres.ssl.root_certificate","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_ROOT_CERTIFICATE"},{"path":"storage.postgres.ssl.certificate","secret":false,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_CERTIFICATE"},{"path":"storage.postgres.ssl.key","secret":true,"env":"AUTHELIA_STORAGE_POSTGRES_SSL_KEY_FILE"},{"path":"storage.encryption_key","secret":true,"env":"AUTHELIA_STORAGE_ENCRYPTION_KEY_FILE"},{"path":"notifier.disable_startup_check","secret":false,"env":"AUTHELIA_NOTIFIER_DISABLE_STARTUP_CHECK"},{"path":"notifier.filesystem.filename","secret":false,"env":"AUTHELIA_NOTIFIER_FILESYSTEM_FILENAME"},{"path":"notifier.smtp.address","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_ADDRESS"},{"path":"notifier.smtp.timeout","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TIMEOUT"},{"path":"notifier.smtp.username","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_USERNAME"},{"path":"notifier.smtp.password","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_PASSWORD_FILE"},{"path":"notifier.smtp.identifier","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_IDENTIFIER"},{"path":"notifier.smtp.sender","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_SENDER"},{"path":"notifier.smtp.subject","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_SUBJECT"},{"path":"notifier.smtp.startup_check_address","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_STARTUP_CHECK_ADDRESS"},{"path":"notifier.smtp.disable_require_tls","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_REQUIRE_TLS"},{"path":"notifier.smtp.disable_html_emails","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_HTML_EMAILS"},{"path":"notifier.smtp.disable_starttls","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_DISABLE_STARTTLS"},{"path":"notifier.smtp.tls.minimum_version","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_MINIMUM_VERSION"},{"path":"notifier.smtp.tls.maximum_version","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_MAXIMUM_VERSION"},{"path":"notifier.smtp.tls.skip_verify","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_SKIP_VERIFY"},{"path":"notifier.smtp.tls.server_name","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_SERVER_NAME"},{"path":"notifier.smtp.tls.private_key","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_PRIVATE_KEY_FILE"},{"path":"notifier.smtp.tls.certificate_chain","secret":true,"env":"AUTHELIA_NOTIFIER_SMTP_TLS_CERTIFICATE_CHAIN_FILE"},{"path":"notifier.smtp.host","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_HOST"},{"path":"notifier.smtp.port","secret":false,"env":"AUTHELIA_NOTIFIER_SMTP_PORT"},{"path":"notifier.template_path","secret":false,"env":"AUTHELIA_NOTIFIER_TEMPLATE_PATH"},{"path":"server.address","secret":false,"env":"AUTHELIA_SERVER_ADDRESS"},{"path":"server.umask","secret":false,"env":"AUTHELIA_SERVER_UMASK"},{"path":"server.path","secret":false,"env":"AUTHELIA_SERVER_PATH"},{"path":"server.asset_path","secret":false,"env":"AUTHELIA_SERVER_ASSET_PATH"},{"path":"server.disable_healthcheck","secret":false,"env":"AUTHELIA_SERVER_DISABLE_HEALTHCHECK"},{"path":"server.tls.certificate","secret":false,"env":"AUTHELIA_SERVER_TLS_CERTIFICATE"},{"path":"server.tls.key","secret":true,"env":"AUTHELIA_SERVER_TLS_KEY_FILE"},{"path":"server.headers.csp_template","secret":false,"env":"AUTHELIA_SERVER_HEADERS_CSP_TEMPLATE"},{"path":"server.endpoints.enable_pprof","secret":false,"env":"AUTHELIA_SERVER_ENDPOINTS_ENABLE_PPROF"},{"path":"server.endpoints.enable_expvars","secret":false,"env":"AUTHELIA_SERVER_ENDPOINTS_ENABLE_EXPVARS"},{"path":"server.buffers.read","secret":false,"env":"AUTHELIA_SERVER_BUFFERS_READ"},{"path":"server.buffers.write","secret":false,"env":"AUTHELIA_SERVER_BUFFERS_WRITE"},{"path":"server.timeouts.read","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_READ"},{"path":"server.timeouts.write","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_WRITE"},{"path":"server.timeouts.idle","secret":false,"env":"AUTHELIA_SERVER_TIMEOUTS_IDLE"},{"path":"server.host","secret":false,"env":"AUTHELIA_SERVER_HOST"},{"path":"server.port","secret":false,"env":"AUTHELIA_SERVER_PORT"},{"path":"telemetry.metrics.enabled","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_ENABLED"},{"path":"telemetry.metrics.address","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_ADDRESS"},{"path":"telemetry.metrics.umask","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_UMASK"},{"path":"telemetry.metrics.buffers.read","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_BUFFERS_READ"},{"path":"telemetry.metrics.buffers.write","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_BUFFERS_WRITE"},{"path":"telemetry.metrics.timeouts.read","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_READ"},{"path":"telemetry.metrics.timeouts.write","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_WRITE"},{"path":"telemetry.metrics.timeouts.idle","secret":false,"env":"AUTHELIA_TELEMETRY_METRICS_TIMEOUTS_IDLE"},{"path":"webauthn.disable","secret":false,"env":"AUTHELIA_WEBAUTHN_DISABLE"},{"path":"webauthn.display_name","secret":false,"env":"AUTHELIA_WEBAUTHN_DISPLAY_NAME"},{"path":"webauthn.attestation_conveyance_preference","secret":false,"env":"AUTHELIA_WEBAUTHN_ATTESTATION_CONVEYANCE_PREFERENCE"},{"path":"webauthn.user_verification","secret":false,"env":"AUTHELIA_WEBAUTHN_USER_VERIFICATION"},{"path":"webauthn.timeout","secret":false,"env":"AUTHELIA_WEBAUTHN_TIMEOUT"},{"path":"password_policy.standard.enabled","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_ENABLED"},{"path":"password_policy.standard.min_length","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_MIN_LENGTH"},{"path":"password_policy.standard.max_length","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_MAX_LENGTH"},{"path":"password_policy.standard.require_uppercase","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_UPPERCASE"},{"path":"password_policy.standard.require_lowercase","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_LOWERCASE"},{"path":"password_policy.standard.require_number","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_NUMBER"},{"path":"password_policy.standard.require_special","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_STANDARD_REQUIRE_SPECIAL"},{"path":"password_policy.zxcvbn.enabled","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_ZXCVBN_ENABLED"},{"path":"password_policy.zxcvbn.min_score","secret":false,"env":"AUTHELIA_PASSWORD_POLICY_ZXCVBN_MIN_SCORE"},{"path":"privacy_policy.enabled","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_ENABLED"},{"path":"privacy_policy.require_user_acceptance","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_REQUIRE_USER_ACCEPTANCE"},{"path":"privacy_policy.policy_url","secret":false,"env":"AUTHELIA_PRIVACY_POLICY_POLICY_URL"}] \ No newline at end of file diff --git a/docs/i18n/en.yaml b/docs/i18n/en.yaml index 4994b7e52..9d0a5ee56 100644 --- a/docs/i18n/en.yaml +++ b/docs/i18n/en.yaml @@ -1,19 +1,19 @@ --- -- id: get-started - translation: "Get Started" +- id: 'get-started' + translation: 'Get Started' -- id: on-this-page - translation: "On this page" +- id: 'on-this-page' + translation: 'On this page' -- id: search-text - translation: "Search..." +- id: 'search-text' + translation: 'Search...' -- id: 404-title - translation: "Page not found :(" +- id: '404-title' + translation: 'Page not found :(' -- id: 404-text +- id: '404-text' translation: "The page you are looking for doesn't exist or has been moved. If you followed a link to get to this page please report it if it was on this site, the official GitHub repository, or the logs on the latest version." # yamllint disable-line rule:line-length -- id: browse - translation: "Browse" +- id: 'browse' + translation: 'Browse' ... diff --git a/examples/compose/lite/authelia/configuration.yml b/examples/compose/lite/authelia/configuration.yml index d9841d310..bd06a5dd3 100644 --- a/examples/compose/lite/authelia/configuration.yml +++ b/examples/compose/lite/authelia/configuration.yml @@ -8,8 +8,7 @@ jwt_secret: a_very_important_secret default_redirection_url: https://public.example.com server: - host: 0.0.0.0 - port: 9091 + address: 'tcp://:9091' log: level: debug diff --git a/examples/compose/local/authelia/configuration.yml b/examples/compose/local/authelia/configuration.yml index 42b770e6c..c19b62167 100644 --- a/examples/compose/local/authelia/configuration.yml +++ b/examples/compose/local/authelia/configuration.yml @@ -7,8 +7,7 @@ jwt_secret: a_very_important_secret default_redirection_url: https://public.example.com server: - host: 0.0.0.0 - port: 9091 + address: 'tcp://:9091' log: level: debug diff --git a/internal/authentication/const_test.go b/internal/authentication/const_test.go new file mode 100644 index 000000000..3829c3eb5 --- /dev/null +++ b/internal/authentication/const_test.go @@ -0,0 +1,24 @@ +package authentication + +import ( + "github.com/authelia/authelia/v4/internal/configuration/schema" +) + +const ( + testLDAPURL = "ldap://127.0.0.1:389" + testLDAPSURL = "ldaps://127.0.0.1:389" +) + +var ( + testLDAPAddress = MustParseAddress(testLDAPURL) + testLDAPSAddress = MustParseAddress(testLDAPSURL) +) + +func MustParseAddress(input string) *schema.AddressLDAP { + address, err := schema.NewAddress(input) + if err != nil { + panic(err) + } + + return &schema.AddressLDAP{Address: *address} +} diff --git a/internal/authentication/ldap_user_provider.go b/internal/authentication/ldap_user_provider.go index 56ad08c6f..d2bb2603f 100644 --- a/internal/authentication/ldap_user_provider.go +++ b/internal/authentication/ldap_user_provider.go @@ -107,7 +107,7 @@ func (p *LDAPUserProvider) CheckUserPassword(username string, password string) ( return false, err } - if clientUser, err = p.connectCustom(p.config.URL, profile.DN, password, p.config.StartTLS, p.dialOpts...); err != nil { + if clientUser, err = p.connectCustom(p.config.Address.String(), profile.DN, password, p.config.StartTLS, p.dialOpts...); err != nil { return false, fmt.Errorf("authentication failed. Cause: %w", err) } @@ -234,7 +234,7 @@ func (p *LDAPUserProvider) UpdatePassword(username, password string) (err error) } func (p *LDAPUserProvider) connect() (client LDAPClient, err error) { - return p.connectCustom(p.config.URL, p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...) + return p.connectCustom(p.config.Address.String(), p.config.User, p.config.Password, p.config.StartTLS, p.dialOpts...) } func (p *LDAPUserProvider) connectCustom(url, username, password string, startTLS bool, opts ...ldap.DialOpt) (client LDAPClient, err error) { diff --git a/internal/authentication/ldap_user_provider_startup.go b/internal/authentication/ldap_user_provider_startup.go index edf668587..076b02fd4 100644 --- a/internal/authentication/ldap_user_provider_startup.go +++ b/internal/authentication/ldap_user_provider_startup.go @@ -31,7 +31,7 @@ func (p *LDAPUserProvider) StartupCheck() (err error) { "attribute when users reset their password via Authelia.") } - if p.features.Extensions.TLS && !p.config.StartTLS && !strings.HasPrefix(p.config.URL, "ldaps://") { + if p.features.Extensions.TLS && !p.config.StartTLS && !p.config.Address.IsExplicitlySecure() { p.log.Error("Your LDAP Server supports TLS but you don't appear to be utilizing it. We strongly " + "recommend using the scheme 'ldaps://' or enabling the StartTLS option to secure connections with your " + "LDAP Server.") diff --git a/internal/authentication/ldap_user_provider_test.go b/internal/authentication/ldap_user_provider_test.go index ebda277a6..97c9dc749 100644 --- a/internal/authentication/ldap_user_provider_test.go +++ b/internal/authentication/ldap_user_provider_test.go @@ -25,7 +25,7 @@ func TestShouldCreateRawConnectionWhenSchemeIsLDAP(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", }, @@ -57,7 +57,7 @@ func TestShouldCreateTLSConnectionWhenSchemeIsLDAPS(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldaps://127.0.0.1:389", + Address: testLDAPSAddress, User: "cn=admin,dc=example,dc=com", Password: "password", }, @@ -107,7 +107,7 @@ func TestEscapeSpecialCharsInGroupsFilter(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldaps://127.0.0.1:389", + Address: testLDAPSAddress, GroupsFilter: "(|(member={dn})(uid={username})(uid={input}))", }, false, @@ -165,7 +165,7 @@ func TestShouldCheckLDAPServerExtensions(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -230,7 +230,7 @@ func TestShouldNotCheckLDAPServerExtensionsWhenRootDSEReturnsMoreThanOneEntry(t provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -296,7 +296,7 @@ func TestShouldCheckLDAPServerControlTypes(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -361,7 +361,7 @@ func TestShouldNotEnablePasswdModifyExtensionOrControlTypes(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -426,7 +426,7 @@ func TestShouldReturnCheckServerConnectError(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -459,7 +459,7 @@ func TestShouldReturnCheckServerSearchError(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -521,7 +521,7 @@ func TestShouldEscapeUserInput(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsersFilter: "(|({username_attribute}={input})({mail_attribute}={input}))", UsernameAttribute: "uid", @@ -555,7 +555,7 @@ func TestShouldReturnEmailWhenAttributeSameAsUsername(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "mail", @@ -626,7 +626,7 @@ func TestShouldReturnUsernameAndBlankDisplayNameWhenAttributesTheSame(t *testing provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -697,7 +697,7 @@ func TestShouldReturnBlankEmailAndDisplayNameWhenAttrsLenZero(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -771,7 +771,7 @@ func TestShouldCombineUsernameFilterAndUsersFilter(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", UsernameAttribute: "uid", UsersFilter: "(&({username_attribute}={input})(&(objectCategory=person)(objectClass=user)))", @@ -822,7 +822,7 @@ func TestShouldNotCrashWhenGroupsAreNotRetrievedFromLDAP(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -895,7 +895,7 @@ func TestShouldNotCrashWhenEmailsAreNotRetrievedFromLDAP(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -956,7 +956,7 @@ func TestShouldReturnUsernameFromLDAP(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1029,7 +1029,7 @@ func TestShouldReturnUsernameFromLDAPWithReferrals(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1121,7 +1121,7 @@ func TestShouldReturnUsernameFromLDAPWithReferralsInErrorAndResult(t *testing.T) provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1246,7 +1246,7 @@ func TestShouldReturnUsernameFromLDAPWithReferralsErr(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1333,7 +1333,7 @@ func TestShouldNotUpdateUserPasswordConnect(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1400,7 +1400,7 @@ func TestShouldNotUpdateUserPasswordGetDetails(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1477,7 +1477,7 @@ func TestShouldUpdateUserPassword(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1585,7 +1585,7 @@ func TestShouldUpdateUserPasswordMSAD(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1695,7 +1695,7 @@ func TestShouldUpdateUserPasswordMSADWithReferrals(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1823,7 +1823,7 @@ func TestShouldUpdateUserPasswordMSADWithReferralsWithReferralConnectErr(t *test provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -1942,7 +1942,7 @@ func TestShouldUpdateUserPasswordMSADWithReferralsWithReferralModifyErr(t *testi provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2074,7 +2074,7 @@ func TestShouldUpdateUserPasswordMSADWithoutReferrals(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2187,7 +2187,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtension(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2294,7 +2294,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtensionWithReferrals(t *testing.T provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2421,7 +2421,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtensionWithoutReferrals(t *testin provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2534,7 +2534,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtensionWithReferralsReferralConne provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2652,7 +2652,7 @@ func TestShouldUpdateUserPasswordPasswdModifyExtensionWithReferralsReferralPassw provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -2784,7 +2784,7 @@ func TestShouldUpdateUserPasswordActiveDirectoryWithServerPolicyHints(t *testing provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "sAMAccountName", @@ -2895,7 +2895,7 @@ func TestShouldUpdateUserPasswordActiveDirectoryWithServerPolicyHintsDeprecated( provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "sAMAccountName", @@ -3006,7 +3006,7 @@ func TestShouldUpdateUserPasswordActiveDirectory(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "activedirectory", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "sAMAccountName", @@ -3117,7 +3117,7 @@ func TestShouldUpdateUserPasswordBasic(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ Implementation: "custom", - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "uid=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3224,7 +3224,7 @@ func TestShouldReturnErrorWhenMultipleUsernameAttributes(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3290,7 +3290,7 @@ func TestShouldReturnErrorWhenZeroUsernameAttributes(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3356,7 +3356,7 @@ func TestShouldReturnErrorWhenUsernameAttributeNotReturned(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3418,7 +3418,7 @@ func TestShouldReturnErrorWhenMultipleUsersFound(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3501,7 +3501,7 @@ func TestShouldReturnErrorWhenNoDN(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3567,7 +3567,7 @@ func TestShouldCheckValidUserPassword(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3635,7 +3635,7 @@ func TestShouldNotCheckValidUserPasswordWithConnectError(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3674,7 +3674,7 @@ func TestShouldCheckInvalidUserPassword(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3742,7 +3742,7 @@ func TestShouldCallStartTLSWhenEnabled(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3817,7 +3817,7 @@ func TestShouldParseDynamicConfiguration(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3866,7 +3866,7 @@ func TestShouldCallStartTLSWithInsecureSkipVerifyWhenSkipVerifyTrue(t *testing.T provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldap://127.0.0.1:389", + Address: testLDAPAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", @@ -3949,7 +3949,7 @@ func TestShouldReturnLDAPSAlreadySecuredWhenStartTLSAttempted(t *testing.T) { provider := NewLDAPUserProviderWithFactory( schema.LDAPAuthenticationBackend{ - URL: "ldaps://127.0.0.1:389", + Address: testLDAPSAddress, User: "cn=admin,dc=example,dc=com", Password: "password", UsernameAttribute: "uid", diff --git a/internal/configuration/config.template.yml b/internal/configuration/config.template.yml index d5b0852ac..5b7f82ad0 100644 --- a/internal/configuration/config.template.yml +++ b/internal/configuration/config.template.yml @@ -9,14 +9,14 @@ ## 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. -# certificates_directory: /config/certificates/ +# certificates_directory: '/config/certificates/' ## The theme to display: light, dark, grey, auto. -theme: light +theme: 'light' ## 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/c/secrets -jwt_secret: a_very_important_secret +jwt_secret: 'a_very_important_secret' ## Default redirection URL ## @@ -25,28 +25,32 @@ jwt_secret: a_very_important_secret ## 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/ +default_redirection_url: 'https://home.example.com/' ## Set the default 2FA method for new users and for when a user has a preferred method configured that has been ## disabled. This setting must be a method that is enabled. ## Options are totp, webauthn, mobile_push. -default_2fa_method: "" +default_2fa_method: '' ## ## Server Configuration ## server: - - ## The address to listen on. This must be a TCP or unix socket. - address: "tcp://:9091" + ## The address for the Main server to listen on in the address common syntax. + ## Formats: + ## - [://][:] + ## - [://][hostname]: + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix'. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '9091'. + address: 'tcp://:9091' ## Set the single level path Authelia listens on. ## Must be alphanumeric chars and should not contain any slashes. - path: "" + path: '' ## Set the path on disk to Authelia assets. ## Useful to allow overriding of specific static assets. - # asset_path: /config/assets/ + # asset_path: '/config/assets/' ## 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. @@ -55,10 +59,10 @@ server: ## 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: "" + key: '' ## The path to the DER base64/PEM format public certificate. - certificate: "" + certificate: '' ## The list of certificates for client authentication. client_certificates: [] @@ -67,7 +71,7 @@ server: headers: ## The CSP Template. Read the docs. - csp_template: "" + csp_template: '' ## Server Buffers configuration. # buffers: @@ -87,13 +91,13 @@ server: # timeouts: ## Read timeout. - # read: 6s + # read: '6s' ## Write timeout. - # write: 6s + # write: '6s' ## Idle timeout. - # idle: 30s + # idle: '30s' ## Server Endpoints configuration. ## This section is considered advanced and it SHOULD NOT be configured unless you've read the relevant documentation. @@ -107,16 +111,16 @@ server: ## Configure the authz endpoints. # authz: # forward-auth: - # implementation: ForwardAuth + # implementation: 'ForwardAuth' # authn_strategies: [] # ext-authz: - # implementation: ExtAuthz + # implementation: 'ExtAuthz' # authn_strategies: [] # auth-request: - # implementation: AuthRequest + # implementation: 'AuthRequest' # authn_strategies: [] # legacy: - # implementation: Legacy + # implementation: 'Legacy' # authn_strategies: [] ## @@ -124,13 +128,13 @@ server: ## log: ## Level of verbosity for logs: info, debug, trace. - level: debug + level: 'debug' ## Format the logs are written as: json, text. - # format: json + # format: 'json' ## File path where the logs will be written. If not set logs are written to stdout. - # file_path: /config/authelia.log + # file_path: '/config/authelia.log' ## Whether to also log to stdout when a log_file_path is defined. # keep_stdout: false @@ -147,8 +151,13 @@ telemetry: ## Enable Metrics. enabled: false - ## The address to listen on for metrics. This should be on a different port to the main server.port value. - address: tcp://0.0.0.0:9959 + ## The address for the Metrics server to listen on in the address common syntax. + ## Formats: + ## - [://][:] + ## - [://][hostname]: + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix'. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '9959'. + address: 'tcp://:9959' ## Metrics Server Buffers configuration. # buffers: @@ -163,13 +172,13 @@ telemetry: # timeouts: ## Read timeout. - # read: 6s + # read: '6s' ## Write timeout. - # write: 6s + # write: '6s' ## Idle timeout. - # idle: 30s + # idle: '30s' ## ## TOTP Configuration @@ -180,12 +189,12 @@ totp: disable: false ## The issuer name displayed in the Authenticator application of your choice. - issuer: authelia.com + issuer: 'authelia.com' ## The TOTP algorithm to use. ## It is CRITICAL you read the documentation before changing this option: ## https://www.authelia.com/c/totp#algorithm - algorithm: sha1 + algorithm: 'sha1' ## The number of digits a user has to input. Must either be 6 or 8. ## Changing this option only affects newly generated TOTP configurations. @@ -215,18 +224,18 @@ webauthn: disable: false ## Adjust the interaction timeout for WebAuthn dialogues. - timeout: 60s + timeout: '60s' ## The display name the browser should show the user for when using WebAuthn to login/register. - display_name: Authelia + display_name: 'Authelia' ## Conveyance preference controls if we collect the attestation statement including the AAGUID from the device. ## Options are none, indirect, direct. - attestation_conveyance_preference: indirect + attestation_conveyance_preference: 'indirect' ## User verification controls if the user must make a gesture or action to confirm they are present. ## Options are required, preferred, discouraged. - user_verification: preferred + user_verification: 'preferred' ## ## Duo Push API Configuration @@ -235,10 +244,10 @@ webauthn: ## "Partner Auth API" in the management panel. # duo_api: # disable: false - # hostname: api-123456789.example.com - # integration_key: ABCDEF + # hostname: 'api-123456789.example.com' + # integration_key: 'ABCDEF' ## Secret can also be set using a secret: https://www.authelia.com/c/secrets - # secret_key: 1234567890abcdefghifjkl + # secret_key: '1234567890abcdefghifjkl' # enable_self_enrollment: false ## @@ -246,14 +255,17 @@ webauthn: ## ## This is used to validate the servers time is accurate enough to validate TOTP. ntp: - ## NTP server address. - address: "time.cloudflare.com:123" + ## The address of the NTP server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'udp', 'udp4', or 'udp6'. + ## The default scheme is 'udp'. The default port is '123'. + address: 'udp://time.cloudflare.com:123' ## NTP version. version: 4 - ## Maximum allowed time offset between the host and the NTP server. - max_desync: 3s + ## Maximum allowed time offset between the host and the NTP server in duration common syntax. + 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. @@ -279,14 +291,14 @@ authentication_backend: ## External reset password url that redirects the user to an external reset portal. This disables the internal reset ## functionality. - custom_url: "" + custom_url: '' ## 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/c/common#duration-notation-format + ## Duration Notation docs: https://www.authelia.com/c/common#duration ## Refresh Interval docs: https://www.authelia.com/c/1fa#refresh-interval refresh_interval: 5m @@ -297,6 +309,13 @@ authentication_backend: ## because it allows Authelia to offload the stateful operations ## onto the LDAP service. # ldap: + ## The address of the LDAP server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'ldap', 'ldaps', or 'ldapi`. + ## The default scheme is 'ldapi' if the address is an absolute path otherwise it's 'ldaps'. + ## The default port is '636', unless the scheme is 'ldap' in which case it's '389'. + # address: 'ldaps://127.0.0.1:636' + ## The LDAP implementation, this affects elements like the attribute utilised for resetting a password. ## Acceptable options are as follows: ## - 'activedirectory' - for Microsoft Active Directory. @@ -308,22 +327,18 @@ authentication_backend: ## 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/c/ldap#defaults - # implementation: custom + # implementation: 'custom' - ## The url to the ldap server. Format: ://
[:]. - ## Scheme can be ldap or ldaps in the format (port optional). - # url: ldap://127.0.0.1 - - ## The dial timeout for LDAP. - # timeout: 5s + ## The dial timeout for LDAP in the duration common syntax. + # timeout: '5s' ## Use StartTLS with the LDAP connection. # start_tls: false # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host portion of the url option. - # server_name: ldap.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'ldap.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -334,10 +349,10 @@ authentication_backend: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -414,7 +429,7 @@ authentication_backend: ## The distinguished name of the container searched for objects in the directory information tree. ## See also: additional_users_dn, additional_groups_dn. - # base_dn: dc=example,dc=com + # base_dn: 'dc=example,dc=com' ## The attribute holding the username of the user. This attribute is used to populate the username in the session ## information. For your information, Microsoft Active Directory usually uses 'sAMAccountName' and OpenLDAP usually @@ -424,11 +439,11 @@ authentication_backend: ## non-unique attributes like 'mail' can also be used but we don't recommend using them, we instead advise to use ## a filter to perform alternative lookups and the attributes mentioned above (sAMAccountName and uid) to ## follow https://datatracker.ietf.org/doc/html/rfc2307. - # username_attribute: uid + # username_attribute: 'uid' ## 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. - # additional_users_dn: ou=users + # additional_users_dn: 'ou=users' ## The users filter used in search queries to find the user profile based on input filled in login form. ## Various placeholders are available in the user filter which you can read about in the documentation which can @@ -442,11 +457,11 @@ authentication_backend: ## ## To allow sign in both with username and email, one can use a filter like ## (&(|({username_attribute}={input})({mail_attribute}={input}))(objectClass=person)) - # users_filter: (&({username_attribute}={input})(objectClass=person)) + # users_filter: '(&({username_attribute}={input})(objectClass=person))' ## 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. - # additional_groups_dn: ou=groups + # additional_groups_dn: 'ou=groups' ## 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 @@ -454,17 +469,17 @@ authentication_backend: ## ## If your groups use the `groupOfUniqueNames` structure use this instead: ## (&(uniqueMember={dn})(objectClass=groupOfUniqueNames)) - # groups_filter: (&(member={dn})(objectClass=groupOfNames)) + # groups_filter: '(&(member={dn})(objectClass=groupOfNames))' ## The attribute holding the name of the group. - # group_name_attribute: cn + # group_name_attribute: 'cn' ## 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. - # mail_attribute: mail + # mail_attribute: 'mail' ## The attribute holding the display name of the user. This will be used to greet an authenticated user. - # display_name_attribute: displayName + # display_name_attribute: 'displayName' ## Follow referrals returned by the server. ## This is especially useful for environments where read-only servers exist. Only implemented for write operations. @@ -473,7 +488,7 @@ authentication_backend: ## The username and password of the admin user. # user: cn=admin,dc=example,dc=com ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: password + # password: 'password' ## ## File (Authentication Provider) @@ -488,15 +503,15 @@ authentication_backend: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # file: - # path: /config/users_database.yml + # path: '/config/users_database.yml' # watch: false # search: # email: false # case_insensitive: false # password: - # algorithm: argon2 + # algorithm: 'argon2' # argon2: - # variant: argon2id + # variant: 'argon2id' # iterations: 3 # memory: 65536 # parallelism: 4 @@ -509,15 +524,15 @@ authentication_backend: # key_length: 32 # salt_length: 16 # pbkdf2: - # variant: sha512 + # variant: 'sha512' # iterations: 310000 # salt_length: 16 # sha2crypt: - # variant: sha512 + # variant: 'sha512' # iterations: 50000 # salt_length: 16 # bcrypt: - # variant: standard + # variant: 'standard' # cost: 12 ## @@ -601,91 +616,91 @@ privacy_policy: access_control: ## 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. - default_policy: deny + default_policy: 'deny' # networks: - # - name: internal + # - name: 'internal' # networks: - # - 10.10.0.0/16 - # - 192.168.2.0/24 + # - '10.10.0.0/16' + # - '192.168.2.0/24' # - name: VPN - # networks: 10.9.0.0/16 + # networks: '10.9.0.0/16' # rules: ## Rules applied to everyone # - domain: 'public.example.com' - # policy: bypass + # policy: 'bypass' ## Domain Regex examples. Generally we recommend just using a standard domain. # - domain_regex: '^(?P\w+)\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: '^(?P\w+)\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: # - '^appgroup-.*\.example\.com$' # - '^appgroup2-.*\.example\.com$' - # policy: one_factor + # policy: 'one_factor' # - domain_regex: '^.*\.example\.com$' - # policy: two_factor + # policy: 'two_factor' # - domain: 'secure.example.com' - # policy: one_factor + # policy: 'one_factor' ## Network based rule, if not provided any network matches. # networks: - # - internal - # - VPN - # - 192.168.1.0/24 - # - 10.0.0.1 + # - 'internal' + # - 'VPN' + # - '192.168.1.0/24' + # - '10.0.0.1' # - domain: # - 'secure.example.com' # - 'private.example.com' - # policy: two_factor + # policy: 'two_factor' # - domain: 'singlefactor.example.com' - # policy: one_factor + # policy: 'one_factor' ## Rules applied to 'admins' group # - domain: 'mx2.mail.example.com' # subject: 'group:admins' - # policy: deny + # policy: 'deny' # - domain: '*.example.com' # subject: # - 'group:admins' # - 'group:moderators' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to 'dev' group # - domain: 'dev.example.com' # resources: # - '^/groups/dev/.*$' # subject: 'group:dev' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'john' # - domain: 'dev.example.com' # resources: # - '^/users/john/.*$' # subject: 'user:john' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'harry' # - domain: 'dev.example.com' # resources: # - '^/users/harry/.*$' # subject: 'user:harry' - # policy: two_factor + # policy: 'two_factor' ## Rules applied to user 'bob' # - domain: '*.mail.example.com' # subject: 'user:bob' - # policy: two_factor + # policy: 'two_factor' # - domain: 'dev.example.com' # resources: # - '^/users/bob/.*$' # subject: 'user:bob' - # policy: two_factor + # policy: 'two_factor' ## ## Session Provider Configuration @@ -720,8 +735,8 @@ session: ## Please read https://www.authelia.com/c/session#same_site # same_site: 'lax' - ## The value for inactivity, expiration, and remember_me are in seconds or the duration notation format. - ## See: https://www.authelia.com/c/common#duration-notation-format + ## The value for inactivity, expiration, and remember_me are in seconds or the duration common syntax. + ## See: https://www.authelia.com/c/common#duration ## 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. @@ -745,8 +760,8 @@ session: ## or strict. Please read https://www.authelia.com/c/session#same_site same_site: 'lax' - ## The value for inactivity, expiration, and remember_me are in seconds or the duration notation format. - ## See: https://www.authelia.com/c/common#duration-notation-format + ## The value for inactivity, expiration, and remember_me are in seconds or the duration common syntax. + ## See: https://www.authelia.com/c/common#duration ## 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. @@ -755,7 +770,7 @@ session: ## destroyed after 1h, or after 5m since the last time Authelia detected user activity. inactivity: '5m' - ## Cookie Session Domain default 'expiration' value. The time before the session cookie expires and the session is + ## Cookie Session Domain default 'expiration' value. The time before the session cookie expires and the session is ## destroyed if remember me IS NOT selected by the user. expiration: '1h' @@ -770,16 +785,16 @@ session: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # redis: - # host: 127.0.0.1 + # host: '127.0.0.1' # port: 6379 ## Use a unix socket instead - # host: /var/run/redis/redis.sock + # host: '/var/run/redis/redis.sock' ## Username used for redis authentication. This is optional and a new feature in redis 6.0. - # username: authelia + # username: 'authelia' ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: authelia + # password: 'authelia' ## This is the Redis DB Index https://redis.io/commands/select (sometimes referred to as database number, DB, etc). # database_index: 0 @@ -794,7 +809,7 @@ session: # tls: ## The server subject name to check the servers certificate against during the validation process. ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: myredis.example.com + # server_name: 'myredis.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -805,10 +820,10 @@ session: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -887,21 +902,21 @@ session: ## This provides specific options to Redis Sentinel, sentinel_name must be defined (Master Name). # high_availability: ## Sentinel Name / Master Name. - # sentinel_name: mysentinel + # sentinel_name: 'mysentinel' ## Specific username for Redis Sentinel. The node username and password is configured above. - # sentinel_username: sentinel_specific_user + # sentinel_username: 'sentinel_specific_user' ## Specific password for Redis Sentinel. The node username and password is configured above. - # sentinel_password: sentinel_specific_pass + # 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 + # - host: 'sentinel-node1' # port: 6379 - # - host: sentinel-node2 + # - host: 'sentinel-node2' # port: 6379 ## Choose the host with the lowest latency. @@ -919,14 +934,12 @@ regulation: ## The number of failed login attempts before user is banned. Set it to 0 to disable regulation. max_retries: 3 - ## 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/c/common#duration-notation-format - find_time: 2m + ## The time range in duration common syntax 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: '2m' - ## The length of time before a banned user can login again. Ban Time accepts duration notation. - ## See: https://www.authelia.com/c/common#duration-notation-format - ban_time: 5m + ## The length of time in duration common syntax before a banned user can login again. + ban_time: '5m' ## ## Storage Provider Configuration @@ -936,7 +949,7 @@ regulation: ## 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, you MUST use ## the CLI to change this in the database if you want to change it from a previously configured value. - # encryption_key: you_must_generate_a_random_string_of_more_than_twenty_chars_and_configure_this + # encryption_key: 'you_must_generate_a_random_string_of_more_than_twenty_chars_and_configure_this' ## ## Local (Storage Provider) @@ -948,25 +961,36 @@ regulation: ## # local: ## Path to the SQLite3 Database. - # path: /config/db.sqlite3 + # path: '/config/db.sqlite3' ## ## MySQL / MariaDB (Storage Provider) ## # mysql: - # host: 127.0.0.1 - # port: 3306 - # database: authelia - # username: authelia - ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: mypassword - # timeout: 5s + ## The address of the MySQL server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix`. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '3306'. + # address: 'tcp://127.0.0.1:3306' + + ## The database name to use. + # database: 'authelia' + + ## The username used for SQL authentication. + # username: 'authelia' + + ## The password used for SQL authentication. + ## Can also be set using a secret: https://www.authelia.com/c/secrets + # password: 'mypassword' + + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## MySQL TLS settings. Configuring this requires TLS. # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: mysql.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'mysql.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -977,10 +1001,10 @@ regulation: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1059,20 +1083,33 @@ regulation: ## PostgreSQL (Storage Provider) ## # postgres: - # host: 127.0.0.1 - # port: 5432 - # database: authelia - # schema: public - # username: authelia - ## Password can also be set using a secret: https://www.authelia.com/c/secrets - # password: mypassword - # timeout: 5s + ## The address of the PostgreSQL server to connect to in the address common syntax. + ## Format: [://][:]. + ## Square brackets indicate optional portions of the format. Scheme must be 'tcp', 'tcp4', 'tcp6', or 'unix`. + ## The default scheme is 'unix' if the address is an absolute path otherwise it's 'tcp'. The default port is '5432'. + # address: 'tcp://127.0.0.1:5432' + + ## The database name to use. + # database: 'authelia' + + ## The schema name to use. + # schema: 'public' + + ## The username used for SQL authentication. + # username: 'authelia' + + ## The password used for SQL authentication. + ## Can also be set using a secret: https://www.authelia.com/c/secrets + # password: 'mypassword' + + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## PostgreSQL TLS settings. Configuring this requires TLS. # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: postgres.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'postgres.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -1083,10 +1120,10 @@ regulation: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1176,7 +1213,7 @@ notifier: ## Important: Kubernetes (or HA) users must read https://www.authelia.com/t/statelessness ## # filesystem: - # filename: /config/notification.txt + # filename: '/config/notification.txt' ## ## SMTP (Notification Provider) @@ -1189,36 +1226,33 @@ notifier: ## - validate the SMTP server x509 certificate during the TLS handshake against the hosts trusted certificates ## (configure in tls section) # smtp: - ## The SMTP host to connect to. - # host: 127.0.0.1 + ## The address of the SMTP server to connect to in the address common syntax. + # address: 'smtp://127.0.0.1:25' - ## The port to connect to the SMTP host on. - # port: 1025 - - ## The connection timeout. - # timeout: 5s + ## The connection timeout in the duration common syntax. + # timeout: '5s' ## The username used for SMTP authentication. - # username: test + # username: 'test' ## The password used for SMTP authentication. ## Can also be set using a secret: https://www.authelia.com/c/secrets - # password: password + # password: 'password' ## 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 ' format. - # sender: "Authelia " + # sender: 'Authelia ' ## HELO/EHLO Identifier. Some SMTP Servers may reject the default of localhost. - # identifier: localhost + # identifier: 'localhost' ## Subject configuration of the emails sent. {title} is replaced by the text from the notifier. - # subject: "[Authelia] {title}" + # subject: '[Authelia] {title}' ## 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. - # startup_check_address: test@authelia.com + # startup_check_address: 'test@authelia.com' ## By default we require some form of TLS. This disables this check though is not advised. # disable_require_tls: false @@ -1228,8 +1262,8 @@ notifier: # tls: ## The server subject name to check the servers certificate against during the validation process. - ## This option is not required if the certificate has a SAN which matches the host option. - # server_name: smtp.example.com + ## This option is not required if the certificate has a SAN which matches the address options hostname. + # server_name: 'smtp.example.com' ## Skip verifying the server certificate entirely. In preference to setting this we strongly recommend you add the ## certificate or the certificate of the authority signing the certificate to the certificates directory which is @@ -1240,10 +1274,10 @@ notifier: # skip_verify: false ## Minimum TLS version for the connection. - # minimum_version: TLS1.2 + # minimum_version: 'TLS1.2' ## Maximum TLS version for the connection. - # maximum_version: TLS1.3 + # maximum_version: 'TLS1.3' ## The certificate chain used with the private_key if the server requests TLS Client Authentication ## i.e. Mutual TLS. @@ -1331,7 +1365,7 @@ notifier: # 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/c/secrets - # hmac_secret: this_is_a_secret_abc123abc123abc + # hmac_secret: 'this_is_a_secret_abc123abc123abc' ## The issuer_certificate_chain is an optional PEM encoded certificate chain. It's used in conjunction with the ## issuer_private_key to sign JWT's. All certificates in the chain must be within the validity period, and every @@ -1408,10 +1442,10 @@ notifier: # -----END RSA PRIVATE KEY----- ## 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 + # 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 @@ -1421,23 +1455,23 @@ notifier: ## SECURITY NOTICE: It's not recommended changing this option, and highly discouraged to have it set to 'never' ## for security reasons. - # enforce_pkce: public_clients_only + # enforce_pkce: 'public_clients_only' ## Cross-Origin Resource Sharing (CORS) settings. # cors: ## List of endpoints in addition to the metadata endpoints to permit cross-origin requests on. # endpoints: - # - authorization - # - token - # - revocation - # - introspection - # - userinfo + # - 'authorization' + # - 'token' + # - 'revocation' + # - 'introspection' + # - 'userinfo' ## List of allowed origins. ## Any origin with https is permitted unless this option is configured or the ## allowed_origins_from_client_redirect_uris option is enabled. # allowed_origins: - # - https://example.com + # - 'https://example.com' ## Automatically adds the origin portion of all redirect URI's on all clients to the list of allowed_origins, ## provided they have the scheme http or https and do not have the hostname of localhost. @@ -1447,71 +1481,72 @@ notifier: # clients: # - ## The ID is the OpenID Connect ClientID which is used to link an application to a configuration. - # id: myapp + # id: 'myapp' ## The description to show to users when they end up on the consent screen. Defaults to the ID above. - # description: My Application + # description: 'My Application' ## The client secret is a shared secret between Authelia and the consumer of this client. - # secret: this_is_a_secret + # yamllint disable-line rule:line-length + # secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'. ## Sector Identifiers are occasionally used to generate pairwise subject identifiers. In most cases this is not ## necessary. Read the documentation for more information. ## The subject identifier must be the host component of a URL, which is a domain name with an optional port. - # sector_identifier: example.com + # sector_identifier: 'example.com' ## Sets the client to public. This should typically not be set, please see the documentation for usage. # public: false ## Redirect URI's specifies a list of valid case-sensitive callbacks for this client. # redirect_uris: - # - https://oidc.example.com:8080/oauth2/callback + # - 'https://oidc.example.com:8080/oauth2/callback' ## Audience this client is allowed to request. # audience: [] ## Scopes this client is allowed to request. # scopes: - # - openid - # - groups - # - email - # - profile + # - 'openid' + # - 'groups' + # - 'email' + # - 'profile' ## 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: - # - code + # - 'code' ## Response Modes configures which response modes this client supports. # response_modes: - # - form_post - # - query + # - 'form_post' + # - 'query' ## 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: - # - authorization_code + # - 'authorization_code' ## The permitted client authentication method for the Token Endpoint for this client. - # token_endpoint_auth_method: client_secret_basic + # token_endpoint_auth_method: 'client_secret_basic' ## The policy to require for this client; one_factor or two_factor. - # authorization_policy: two_factor + # authorization_policy: 'two_factor' ## Enforces the use of PKCE for this client when set to true. # enforce_pkce: false ## Enforces the use of PKCE for this client when configured, and enforces the specified challenge method. ## Options are 'plain' and 'S256'. - # pkce_challenge_method: S256 + # pkce_challenge_method: 'S256' ## The algorithm used to sign userinfo endpoint responses for this client, either none or RS256. - # userinfo_signing_algorithm: none + # userinfo_signing_algorithm: 'none' ## The consent mode controls how consent is obtained. - # consent_mode: auto + # consent_mode: 'auto' ## This value controls the duration a consent on this client remains remembered when the consent mode is ## configured as 'auto' or 'pre-configured'. - # pre_configured_consent_duration: 1w + # pre_configured_consent_duration: '1w' ... diff --git a/internal/configuration/decode_hooks.go b/internal/configuration/decode_hooks.go index caca552c6..1eabcfa7d 100644 --- a/internal/configuration/decode_hooks.go +++ b/internal/configuration/decode_hooks.go @@ -300,7 +300,7 @@ func StringToAddressHookFunc() mapstructure.DecodeHookFuncType { return schema.AddressUDP{Address: *result}, nil case expectedTypeLDAP: - if result, err = schema.NewAddressDefault(dataStr, schema.AddressSchemeLDAP, schema.AddressSchemeLDAPI); err != nil { + if result, err = schema.NewAddressDefault(dataStr, schema.AddressSchemeLDAPS, schema.AddressSchemeLDAPI); err != nil { return nil, fmt.Errorf(errFmtDecodeHookCouldNotParse, dataStr, prefixType, expectedType, err) } diff --git a/internal/configuration/decode_hooks_test.go b/internal/configuration/decode_hooks_test.go index 4e2ad1c03..f9642c170 100644 --- a/internal/configuration/decode_hooks_test.go +++ b/internal/configuration/decode_hooks_test.go @@ -838,7 +838,7 @@ func TestStringToAddressHookFunc(t *testing.T) { name: "ShouldFailDecode", have: "tcp://&!@^#*&!@#&*@!:2020", expected: schema.Address{}, - err: "could not decode 'tcp://&!@^#*&!@#&*@!:2020' to a schema.Address: could not parse string 'tcp://&!@^#*&!@#&*@!:2020' as address: expected format is [://][:]: parse \"tcp://&!@^\": invalid character \"^\" in host name", + err: "could not decode 'tcp://&!@^#*&!@#&*@!:2020' to a schema.Address: could not parse string 'tcp://&!@^#*&!@#&*@!:2020' as address: expected format is [://][:]: parse \"tcp://&!@^\": invalid character \"^\" in host name", decode: false, }, } diff --git a/internal/configuration/deprecation.go b/internal/configuration/deprecation.go index 531074462..5fb997a42 100644 --- a/internal/configuration/deprecation.go +++ b/internal/configuration/deprecation.go @@ -13,6 +13,7 @@ type Deprecation struct { Key string NewKey string AutoMap bool + Keep bool MapFunc func(value any) any ErrFunc func(d Deprecation, keysFinal map[string]any, value any, val *schema.StructValidator) } @@ -183,9 +184,10 @@ var deprecations = map[string]Deprecation{ Key: "server.host", NewKey: "server.address", AutoMap: false, + Keep: true, MapFunc: nil, ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { - val.PushWarning(fmt.Errorf("configuration key 'server.host' is deprecated in %s and has been replaced by 'server.address' when combined with the 'server.port' in the format of 'tcp://:': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + val.PushWarning(fmt.Errorf("configuration key 'server.host' is deprecated in %s and has been replaced by 'server.address' when combined with the 'server.port' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) }, }, "server.port": { @@ -193,9 +195,62 @@ var deprecations = map[string]Deprecation{ Key: "server.port", NewKey: "server.address", AutoMap: false, + Keep: true, MapFunc: nil, ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { - val.PushWarning(fmt.Errorf("configuration key 'server.port' is deprecated in %s and has been replaced by 'server.address' when combined with the 'server.host' in the format of 'tcp://:': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + val.PushWarning(fmt.Errorf("configuration key 'server.port' is deprecated in %s and has been replaced by 'server.address' when combined with the 'server.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) }, }, + "storage.mysql.host": { + Version: model.SemanticVersion{Major: 4, Minor: 38}, + Key: "storage.mysql.host", + NewKey: "storage.mysql.address", + AutoMap: false, + Keep: true, + MapFunc: nil, + ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { + val.PushWarning(fmt.Errorf("configuration key 'storage.mysql.host' is deprecated in %s and has been replaced by 'storage.mysql.address' when combined with the 'storage.mysql.port' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + }, + }, + "storage.mysql.port": { + Version: model.SemanticVersion{Major: 4, Minor: 38}, + Key: "storage.mysql.port", + NewKey: "storage.mysql.address", + AutoMap: false, + Keep: true, + MapFunc: nil, + ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { + val.PushWarning(fmt.Errorf("configuration key 'storage.mysql.port' is deprecated in %s and has been replaced by 'storage.mysql.address' when combined with the 'storage.mysql.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + }, + }, + "storage.postgres.host": { + Version: model.SemanticVersion{Major: 4, Minor: 38}, + Key: "storage.postgres.host", + NewKey: "storage.postgres.address", + AutoMap: false, + Keep: true, + MapFunc: nil, + ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { + val.PushWarning(fmt.Errorf("configuration key 'storage.postgres.host' is deprecated in %s and has been replaced by 'storage.postgres.address' when combined with the 'storage.postgres.port' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + }, + }, + "storage.postgres.port": { + Version: model.SemanticVersion{Major: 4, Minor: 38}, + Key: "storage.postgres.port", + NewKey: "storage.postgres.address", + AutoMap: false, + Keep: true, + MapFunc: nil, + ErrFunc: func(d Deprecation, _ map[string]any, _ any, val *schema.StructValidator) { + val.PushWarning(fmt.Errorf("configuration key 'storage.postgres.port' is deprecated in %s and has been replaced by 'storage.postgres.address' when combined with the 'storage.postgres.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message", d.Version.String())) + }, + }, + "authentication_backend.ldap.url": { + Version: model.SemanticVersion{Major: 4, Minor: 38}, + Key: "authentication_backend.ldap.url", + NewKey: "authentication_backend.ldap.address", + AutoMap: true, + MapFunc: nil, + ErrFunc: nil, + }, } diff --git a/internal/configuration/provider_test.go b/internal/configuration/provider_test.go index 4208389ca..98915016b 100644 --- a/internal/configuration/provider_test.go +++ b/internal/configuration/provider_test.go @@ -120,7 +120,7 @@ func TestShouldValidateConfigurationWithFilters(t *testing.T) { require.Len(t, val.Warnings(), 0) assert.Equal(t, "api-123456789.example.org", config.DuoAPI.Hostname) - assert.Equal(t, "10.10.10.10", config.Notifier.SMTP.Host) + assert.Equal(t, "smtp://10.10.10.10:1025", config.Notifier.SMTP.Address.String()) assert.Equal(t, "10.10.10.10", config.Session.Redis.Host) require.Len(t, config.IdentityProviders.OIDC.Clients, 3) @@ -135,7 +135,7 @@ func TestShouldNotIgnoreInvalidEnvs(t *testing.T) { testSetEnv(t, "STORAGE_MYSQL", "a bad env") testSetEnv(t, "JWT_SECRET", "an env jwt secret") testSetEnv(t, "AUTHENTICATION_BACKEND_LDAP_PASSWORD", "an env authentication backend ldap password") - testSetEnv(t, "AUTHENTICATION_BACKEND_LDAP_URL", "an env authentication backend ldap password") + testSetEnv(t, "AUTHENTICATION_BACKEND_LDAP_ADDRESS", "an env authentication backend ldap password") val := schema.NewStructValidator() keys, _, err := Load(val, NewDefaultSources([]string{"./test_resources/config.yml"}, DefaultEnvPrefix, DefaultEnvDelimiter)...) @@ -145,9 +145,10 @@ func TestShouldNotIgnoreInvalidEnvs(t *testing.T) { validator.ValidateKeys(keys, DefaultEnvPrefix, val) require.Len(t, val.Warnings(), 1) - assert.Len(t, val.Errors(), 0) + assert.Len(t, val.Errors(), 1) assert.EqualError(t, val.Warnings()[0], fmt.Sprintf("configuration environment variable not expected: %sSTORAGE_MYSQL", DefaultEnvPrefix)) + assert.EqualError(t, val.Errors()[0], "error occurred during unmarshalling configuration: 1 error(s) decoding:\n\n* error decoding 'authentication_backend.ldap.address': could not decode 'an env authentication backend ldap password' to a *schema.AddressLDAP: could not parse string 'an env authentication backend ldap password' as address: expected format is [://][:]: parse \"ldaps://an env authentication backend ldap password\": invalid character \" \" in host name") } func TestShouldValidateAndRaiseErrorsOnNormalConfigurationAndSecret(t *testing.T) { @@ -268,6 +269,75 @@ func TestShouldValidateAndRaiseErrorsOnBadConfiguration(t *testing.T) { assert.Equal(t, "debug", c.Log.Level) } +func TestShouldValidateDeprecatedEnvNames(t *testing.T) { + testSetEnv(t, "AUTHENTICATION_BACKEND_LDAP_URL", "ldap://from-env") + + val := schema.NewStructValidator() + keys, c, err := Load(val, NewDefaultSources([]string{"./test_resources/config.yml"}, DefaultEnvPrefix, DefaultEnvDelimiter)...) + + assert.NoError(t, err) + + validator.ValidateKeys(keys, DefaultEnvPrefix, val) + + assert.Len(t, val.Errors(), 0) + require.Len(t, val.Warnings(), 1) + + assert.EqualError(t, val.Warnings()[0], "configuration key 'authentication_backend.ldap.url' is deprecated in 4.38.0 and has been replaced by 'authentication_backend.ldap.address': this has not been automatically mapped for you because the replacement key also exists and you will need to adjust your configuration to remove this message") + + assert.Equal(t, "ldap://127.0.0.1:389", c.AuthenticationBackend.LDAP.Address.String()) +} + +func TestShouldValidateDeprecatedEnvNamesWithDeprecatedKeys(t *testing.T) { + testSetEnv(t, "AUTHENTICATION_BACKEND_LDAP_URL", "ldap://from-env") + + val := schema.NewStructValidator() + keys, c, err := Load(val, NewDefaultSources([]string{"./test_resources/config.deprecated.yml"}, DefaultEnvPrefix, DefaultEnvDelimiter)...) + + assert.NoError(t, err) + + validator.ValidateKeys(keys, DefaultEnvPrefix, val) + + assert.Len(t, val.Errors(), 0) + + warnings := val.Warnings() + require.Len(t, warnings, 3) + + sort.Sort(utils.ErrSliceSortAlphabetical(warnings)) + + assert.EqualError(t, warnings[0], "configuration key 'authentication_backend.ldap.url' is deprecated in 4.38.0 and has been replaced by 'authentication_backend.ldap.address': this has been automatically mapped for you but you will need to adjust your configuration to remove this message") + assert.EqualError(t, warnings[1], "configuration key 'storage.mysql.host' is deprecated in 4.38.0 and has been replaced by 'storage.mysql.address' when combined with the 'storage.mysql.port' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") + assert.EqualError(t, warnings[2], "configuration key 'storage.mysql.port' is deprecated in 4.38.0 and has been replaced by 'storage.mysql.address' when combined with the 'storage.mysql.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") + + assert.Equal(t, "ldap://from-env:389", c.AuthenticationBackend.LDAP.Address.String()) +} + +func TestShouldValidateDeprecatedEnvNamesWithDeprecatedKeysAlt(t *testing.T) { + val := schema.NewStructValidator() + keys, c, err := Load(val, NewDefaultSources([]string{"./test_resources/config.deprecated.alt.yml"}, DefaultEnvPrefix, DefaultEnvDelimiter)...) + + assert.NoError(t, err) + + validator.ValidateKeys(keys, DefaultEnvPrefix, val) + + assert.Len(t, val.Errors(), 0) + + warnings := val.Warnings() + require.Len(t, warnings, 3) + + sort.Sort(utils.ErrSliceSortAlphabetical(warnings)) + + assert.EqualError(t, warnings[0], "configuration key 'authentication_backend.ldap.url' is deprecated in 4.38.0 and has been replaced by 'authentication_backend.ldap.address': this has been automatically mapped for you but you will need to adjust your configuration to remove this message") + assert.EqualError(t, warnings[1], "configuration key 'storage.postgres.host' is deprecated in 4.38.0 and has been replaced by 'storage.postgres.address' when combined with the 'storage.postgres.port' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") + assert.EqualError(t, warnings[2], "configuration key 'storage.postgres.port' is deprecated in 4.38.0 and has been replaced by 'storage.postgres.address' when combined with the 'storage.postgres.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") + + val.Clear() + + validator.ValidateConfiguration(c, val) + + require.NotNil(t, c.Storage.PostgreSQL.Address) + assert.Equal(t, "tcp://127.0.0.1:5432", c.Storage.PostgreSQL.Address.String()) +} + func TestShouldRaiseErrOnInvalidNotifierSMTPSender(t *testing.T) { val := schema.NewStructValidator() keys, _, err := Load(val, NewDefaultSources([]string{"./test_resources/config_smtp_sender_invalid.yml"}, DefaultEnvPrefix, DefaultEnvDelimiter)...) @@ -411,7 +481,7 @@ func TestShouldLoadDirectoryConfiguration(t *testing.T) { assert.Len(t, val.Errors(), 0) require.Len(t, val.Warnings(), 1) - assert.EqualError(t, val.Warnings()[0], "configuration key 'server.port' is deprecated in 4.38.0 and has been replaced by 'server.address' when combined with the 'server.host' in the format of 'tcp://:': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") + assert.EqualError(t, val.Warnings()[0], "configuration key 'server.port' is deprecated in 4.38.0 and has been replaced by 'server.address' when combined with the 'server.host' in the format of '[tcp://][:]': this should be automatically mapped for you but you will need to adjust your configuration to remove this message") } func testSetEnv(t *testing.T, key, value string) { diff --git a/internal/configuration/schema/authentication.go b/internal/configuration/schema/authentication.go index c44954c9d..876982498 100644 --- a/internal/configuration/schema/authentication.go +++ b/internal/configuration/schema/authentication.go @@ -95,8 +95,8 @@ type SCryptPassword struct { // LDAPAuthenticationBackend represents the configuration related to LDAP server. type LDAPAuthenticationBackend struct { + Address *AddressLDAP `koanf:"address"` Implementation string `koanf:"implementation"` - URL string `koanf:"url"` Timeout time.Duration `koanf:"timeout"` StartTLS bool `koanf:"start_tls"` TLS *TLSConfig `koanf:"tls"` diff --git a/internal/configuration/schema/keys.go b/internal/configuration/schema/keys.go index ba5aaa423..ac5dbca3e 100644 --- a/internal/configuration/schema/keys.go +++ b/internal/configuration/schema/keys.go @@ -85,8 +85,8 @@ var Keys = []string{ "authentication_backend.file.password.salt_length", "authentication_backend.file.search.email", "authentication_backend.file.search.case_insensitive", + "authentication_backend.ldap.address", "authentication_backend.ldap.implementation", - "authentication_backend.ldap.url", "authentication_backend.ldap.timeout", "authentication_backend.ldap.start_tls", "authentication_backend.ldap.tls.minimum_version", @@ -184,24 +184,26 @@ var Keys = []string{ "regulation.find_time", "regulation.ban_time", "storage.local.path", - "storage.mysql.host", - "storage.mysql.port", + "storage.mysql.address", "storage.mysql.database", "storage.mysql.username", "storage.mysql.password", "storage.mysql.timeout", + "storage.mysql.host", + "storage.mysql.port", "storage.mysql.tls.minimum_version", "storage.mysql.tls.maximum_version", "storage.mysql.tls.skip_verify", "storage.mysql.tls.server_name", "storage.mysql.tls.private_key", "storage.mysql.tls.certificate_chain", - "storage.postgres.host", - "storage.postgres.port", + "storage.postgres.address", "storage.postgres.database", "storage.postgres.username", "storage.postgres.password", "storage.postgres.timeout", + "storage.postgres.host", + "storage.postgres.port", "storage.postgres.schema", "storage.postgres.tls.minimum_version", "storage.postgres.tls.maximum_version", @@ -216,8 +218,7 @@ var Keys = []string{ "storage.encryption_key", "notifier.disable_startup_check", "notifier.filesystem.filename", - "notifier.smtp.host", - "notifier.smtp.port", + "notifier.smtp.address", "notifier.smtp.timeout", "notifier.smtp.username", "notifier.smtp.password", @@ -234,9 +235,9 @@ var Keys = []string{ "notifier.smtp.tls.server_name", "notifier.smtp.tls.private_key", "notifier.smtp.tls.certificate_chain", + "notifier.smtp.host", + "notifier.smtp.port", "notifier.template_path", - "server.host", - "server.port", "server.address", "server.umask", "server.path", @@ -257,6 +258,8 @@ var Keys = []string{ "server.timeouts.read", "server.timeouts.write", "server.timeouts.idle", + "server.host", + "server.port", "telemetry.metrics.enabled", "telemetry.metrics.address", "telemetry.metrics.umask", diff --git a/internal/configuration/schema/notifier.go b/internal/configuration/schema/notifier.go index a95b935f1..d554e6d64 100644 --- a/internal/configuration/schema/notifier.go +++ b/internal/configuration/schema/notifier.go @@ -3,6 +3,7 @@ package schema import ( "crypto/tls" "net/mail" + "net/url" "time" ) @@ -13,8 +14,7 @@ type FileSystemNotifierConfiguration struct { // SMTPNotifierConfiguration represents the configuration of the SMTP server to send emails with. type SMTPNotifierConfiguration struct { - Host string `koanf:"host"` - Port int `koanf:"port"` + Address *AddressSMTP `koanf:"address"` Timeout time.Duration `koanf:"timeout"` Username string `koanf:"username"` Password string `koanf:"password"` @@ -26,6 +26,12 @@ type SMTPNotifierConfiguration struct { DisableHTMLEmails bool `koanf:"disable_html_emails"` DisableStartTLS bool `koanf:"disable_starttls"` TLS *TLSConfig `koanf:"tls"` + + // Deprecated: use address instead. + Host string `koanf:"host"` + + // Deprecated: use address instead. + Port int `koanf:"port"` } // NotifierConfiguration represents the configuration of the notifier to use when sending notifications to users. @@ -38,6 +44,7 @@ type NotifierConfiguration struct { // DefaultSMTPNotifierConfiguration represents default configuration parameters for the SMTP notifier. var DefaultSMTPNotifierConfiguration = SMTPNotifierConfiguration{ + Address: &AddressSMTP{Address{true, false, 25, &url.URL{Scheme: AddressSchemeSMTP, Host: "localhost:25"}}}, Timeout: time.Second * 5, Subject: "[Authelia] {title}", Identifier: "localhost", diff --git a/internal/configuration/schema/ntp.go b/internal/configuration/schema/ntp.go index a9fdd3d2e..2cfce4b1d 100644 --- a/internal/configuration/schema/ntp.go +++ b/internal/configuration/schema/ntp.go @@ -1,12 +1,13 @@ package schema import ( + "net/url" "time" ) // NTPConfiguration represents the configuration related to ntp server. type NTPConfiguration struct { - Address string `koanf:"address"` + Address *AddressUDP `koanf:"address"` Version int `koanf:"version"` MaximumDesync time.Duration `koanf:"max_desync"` DisableStartupCheck bool `koanf:"disable_startup_check"` @@ -15,7 +16,7 @@ type NTPConfiguration struct { // DefaultNTPConfiguration represents default configuration parameters for the NTP server. var DefaultNTPConfiguration = NTPConfiguration{ - Address: "time.cloudflare.com:123", + Address: &AddressUDP{Address{valid: true, socket: false, port: 123, url: &url.URL{Scheme: AddressSchemeUDP, Host: "time.cloudflare.com:123"}}}, Version: 4, MaximumDesync: time.Second * 3, } diff --git a/internal/configuration/schema/storage.go b/internal/configuration/schema/storage.go index d8eb93808..3dc2836f0 100644 --- a/internal/configuration/schema/storage.go +++ b/internal/configuration/schema/storage.go @@ -2,6 +2,7 @@ package schema import ( "crypto/tls" + "net/url" "time" ) @@ -12,12 +13,17 @@ type LocalStorageConfiguration struct { // SQLStorageConfiguration represents the configuration of the SQL database. type SQLStorageConfiguration struct { - Host string `koanf:"host"` - Port int `koanf:"port"` + Address *AddressTCP `koanf:"address"` Database string `koanf:"database"` Username string `koanf:"username"` Password string `koanf:"password"` Timeout time.Duration `koanf:"timeout"` + + // Deprecated: use address instead. + Host string `koanf:"host"` + + // Deprecated: use address instead. + Port int `koanf:"port"` } // MySQLStorageConfiguration represents the configuration of a MySQL database. @@ -68,6 +74,9 @@ var DefaultMySQLStorageConfiguration = MySQLStorageConfiguration{ // DefaultPostgreSQLStorageConfiguration represents the default PostgreSQL configuration. var DefaultPostgreSQLStorageConfiguration = PostgreSQLStorageConfiguration{ + SQLStorageConfiguration: SQLStorageConfiguration{ + Address: &AddressTCP{Address{true, false, 5432, &url.URL{Scheme: AddressSchemeTCP, Host: "localhost:5432"}}}, + }, Schema: "public", TLS: &TLSConfig{ MinimumVersion: TLSVersion{tls.VersionTLS12}, diff --git a/internal/configuration/schema/types.go b/internal/configuration/schema/types.go index d27c5c48a..bc5bd988c 100644 --- a/internal/configuration/schema/types.go +++ b/internal/configuration/schema/types.go @@ -9,11 +9,7 @@ import ( "crypto/x509" "encoding/pem" "fmt" - "net" - "net/url" - "strconv" "strings" - "syscall" "time" "github.com/go-crypt/crypt" @@ -21,388 +17,6 @@ import ( "github.com/go-crypt/crypt/algorithm/plaintext" ) -// NewAddress returns an *Address and error depending on the ability to parse the string as an Address. -// It also assumes any value without a scheme which looks like a path is the 'unix' scheme, and everything else without -// a scheme is the 'tcp' scheme. -func NewAddress(value string) (address *Address, err error) { - return NewAddressDefault(value, AddressSchemeTCP, AddressSchemeUnix) -} - -// NewAddressDefault returns an *Address and error depending on the ability to parse the string as an Address. -// It also assumes any value without a scheme which looks like a path is the schemeDefaultPath scheme, and everything -// else without a scheme is the schemeDefault scheme. -func NewAddressDefault(value, schemeDefault, schemeDefaultPath string) (address *Address, err error) { - if len(value) == 0 { - return &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: ":0"}}, nil - } - - var u *url.URL - - if regexpHasScheme.MatchString(value) { - u, err = url.Parse(value) - } else { - if strings.HasPrefix(value, "/") { - u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefaultPath, value)) - } else { - u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefault, value)) - } - } - - if err != nil { - return nil, fmt.Errorf("could not parse string '%s' as address: expected format is [://][:]: %w", value, err) - } - - return NewAddressFromURL(u) -} - -// NewAddressUnix returns an *Address from a path value. -func NewAddressUnix(path string) Address { - return Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: path}} -} - -// NewAddressFromNetworkValues returns an *Address from network values. -func NewAddressFromNetworkValues(network, host string, port int) Address { - return Address{true, false, port, &url.URL{Scheme: network, Host: fmt.Sprintf("%s:%d", host, port)}} -} - -// NewAddressFromURL returns an *Address and error depending on the ability to parse the *url.URL as an Address. -func NewAddressFromURL(u *url.URL) (addr *Address, err error) { - addr = &Address{ - url: u, - } - - if err = addr.validate(); err != nil { - return nil, err - } - - return addr, nil -} - -// AddressTCP is just a type with an underlying type of Address. -type AddressTCP struct { - Address -} - -// AddressUDP is just a type with an underlying type of Address. -type AddressUDP struct { - Address -} - -// AddressLDAP is just a type with an underlying type of Address. -type AddressLDAP struct { - Address -} - -// AddressSMTP is just a type with an underlying type of Address. -type AddressSMTP struct { - Address -} - -// Address represents an address. -type Address struct { - valid bool - socket bool - port int - - url *url.URL -} - -// Valid returns true if the Address is valid. -func (a *Address) Valid() bool { - return a.valid -} - -// ValidateHTTP returns true if the Address is valid for a HTTP connection listener. -func (a *Address) ValidateHTTP() error { - switch a.Scheme() { - case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUnix: - break - default: - return fmt.Errorf("scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as '%s'", a.Scheme()) - } - - return nil -} - -// ValidateListener returns true if the Address is valid for a connection listener. -func (a *Address) ValidateListener() error { - switch a.Scheme() { - case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6, AddressSchemeUnix: - break - default: - return fmt.Errorf("scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as '%s'", a.Scheme()) - } - - return nil -} - -// ValidateSMTP returns true if the Address is valid for a remote SMTP connection opener. -func (a *Address) ValidateSMTP() error { - switch a.Scheme() { - case AddressSchemeSMTP, AddressSchemeSUBMISSION, AddressSchemeSUBMISSIONS: - break - default: - return fmt.Errorf("scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as '%s'", a.Scheme()) - } - - return nil -} - -// ValidateLDAP returns true if the Address has a value Scheme for an LDAP connection opener. -func (a *Address) ValidateLDAP() error { - switch a.Scheme() { - case AddressSchemeLDAP, AddressSchemeLDAPS, AddressSchemeLDAPI: - break - default: - return fmt.Errorf("scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as '%s'", a.Scheme()) - } - - return nil -} - -// IsExplicitlySecure returns true if the address is an explicitly secure. -func (a *Address) IsExplicitlySecure() bool { - switch a.Scheme() { - case AddressSchemeSUBMISSIONS, AddressSchemeLDAPS: - return true - default: - return false - } -} - -// String returns a string representation of the Address. -func (a *Address) String() string { - if !a.valid || a.url == nil { - return "" - } - - return a.url.String() -} - -// Network returns the Scheme() if it's appropriate for the net packages network arguments otherwise it returns tcp. -func (a *Address) Network() string { - switch scheme := a.Scheme(); scheme { - case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6, AddressSchemeUnix: - return scheme - default: - return AddressSchemeTCP - } -} - -// Scheme returns the *url.URL Scheme field. -func (a *Address) Scheme() string { - if !a.valid || a.url == nil { - return "" - } - - return a.url.Scheme -} - -// Hostname returns the output of the *url.URL Hostname func. -func (a *Address) Hostname() string { - if !a.valid || a.url == nil { - return "" - } - - return a.url.Hostname() -} - -// SocketHostname returns the correct hostname for a socket connection. -func (a *Address) SocketHostname() string { - if !a.valid || a.url == nil { - return "" - } - - if a.socket { - return a.url.Path - } - - return a.url.Hostname() -} - -// SetHostname sets the hostname preserving the port. -func (a *Address) SetHostname(hostname string) { - if !a.valid || a.url == nil { - return - } - - if port := a.url.Port(); port == "" { - a.url.Host = hostname - } else { - a.url.Host = fmt.Sprintf("%s:%s", hostname, port) - } -} - -// Port returns the port. -func (a *Address) Port() int { - return a.port -} - -// SetPort sets the port preserving the hostname. -func (a *Address) SetPort(port int) { - if !a.valid || a.url == nil { - return - } - - a.setport(port) -} - -// Host returns the *url.URL Host field. -func (a *Address) Host() string { - if !a.valid || a.url == nil { - return "" - } - - return a.url.Host -} - -// NetworkAddress returns a string representation of the Address with just the host and port. -func (a *Address) NetworkAddress() string { - if !a.valid || a.url == nil { - return "" - } - - if a.socket { - return a.url.Path - } - - return a.url.Host -} - -// Listener creates and returns a net.Listener. -func (a *Address) Listener() (net.Listener, error) { - return a.listener() -} - -// Dial creates and returns a dialed net.Conn. -func (a *Address) Dial() (net.Conn, error) { - if a.url == nil { - return nil, fmt.Errorf("address url is nil") - } - - return net.Dial(a.Network(), a.NetworkAddress()) -} - -// ListenerWithUMask creates and returns a net.Listener with a temporary UMask if the scheme is `unix`. -func (a *Address) ListenerWithUMask(umask int) (ln net.Listener, err error) { - if !a.socket { - return a.listener() - } - - if a.url == nil { - return nil, fmt.Errorf("address url is nil") - } - - umask = syscall.Umask(umask) - - ln, err = net.Listen(a.Network(), a.NetworkAddress()) - - _ = syscall.Umask(umask) - - return ln, err -} - -func (a *Address) listener() (net.Listener, error) { - if a.url == nil { - return nil, fmt.Errorf("address url is nil") - } - - return net.Listen(a.Network(), a.NetworkAddress()) -} - -func (a *Address) setport(port int) { - a.port = port - a.url.Host = net.JoinHostPort(a.url.Hostname(), strconv.Itoa(port)) -} - -func (a *Address) validate() (err error) { - if a.url == nil { - return fmt.Errorf("error validating the address: address url was nil") - } - - switch { - case a.url.RawQuery != "": - return fmt.Errorf("error validating the address: the url '%s' appears to have a query but this is not valid for addresses", a.url.String()) - case a.url.RawFragment != "", a.url.Fragment != "": - return fmt.Errorf("error validating the address: the url '%s' appears to have a fragment but this is not valid for addresses", a.url.String()) - case a.url.User != nil: - return fmt.Errorf("error validating the address: the url '%s' appears to have user info but this is not valid for addresses", a.url.String()) - } - - switch a.url.Scheme { - case AddressSchemeUnix, AddressSchemeLDAPI: - if err = a.validateUnixSocket(); err != nil { - return err - } - case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6: - if err = a.validateTCPUDP(); err != nil { - return err - } - case AddressSchemeLDAP, AddressSchemeLDAPS, AddressSchemeSMTP, AddressSchemeSUBMISSION, AddressSchemeSUBMISSIONS: - if err = a.validateProtocol(); err != nil { - return err - } - } - - a.valid = true - - return nil -} - -func (a *Address) validateProtocol() (err error) { - port := a.url.Port() - - switch port { - case "": - switch a.url.Scheme { - case AddressSchemeLDAP: - a.setport(389) - case AddressSchemeLDAPS: - a.setport(636) - case AddressSchemeSMTP: - a.setport(25) - case AddressSchemeSUBMISSION: - a.setport(587) - case AddressSchemeSUBMISSIONS: - a.setport(465) - } - default: - actualPort, _ := strconv.Atoi(port) - - a.setport(actualPort) - } - - return nil -} - -func (a *Address) validateTCPUDP() (err error) { - port := a.url.Port() - - switch port { - case "": - a.setport(0) - default: - actualPort, _ := strconv.Atoi(port) - - a.setport(actualPort) - } - - return nil -} - -func (a *Address) validateUnixSocket() (err error) { - switch { - case a.url.Path == "" && a.url.Scheme != AddressSchemeLDAPI: - return fmt.Errorf("error validating the unix socket address: could not determine path from '%s'", a.url.String()) - case a.url.Host != "": - return fmt.Errorf("error validating the unix socket address: the url '%s' appears to have a host but this is not valid for unix sockets: this may occur if you omit the leading forward slash from the socket path", a.url.String()) - } - - a.socket = true - - return nil -} - var cdecoder algorithm.DecoderRegister // DecodePasswordDigest returns a new PasswordDigest if it can be decoded. diff --git a/internal/configuration/schema/types_address.go b/internal/configuration/schema/types_address.go new file mode 100644 index 000000000..c33dcf6c0 --- /dev/null +++ b/internal/configuration/schema/types_address.go @@ -0,0 +1,482 @@ +package schema + +import ( + "fmt" + "net" + "net/url" + "strconv" + "strings" + "syscall" +) + +// NewAddress returns an *Address and error depending on the ability to parse the string as an Address. +// It also assumes any value without a scheme which looks like a path is the 'unix' scheme, and everything else without +// a scheme is the 'tcp' scheme. +func NewAddress(value string) (address *Address, err error) { + return NewAddressDefault(value, AddressSchemeTCP, AddressSchemeUnix) +} + +// NewAddressDefault returns an *Address and error depending on the ability to parse the string as an Address. +// It also assumes any value without a scheme which looks like a path is the schemeDefaultPath scheme, and everything +// else without a scheme is the schemeDefault scheme. +func NewAddressDefault(value, schemeDefault, schemeDefaultPath string) (address *Address, err error) { + if len(value) == 0 { + return &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: ":0"}}, nil + } + + var u *url.URL + + if regexpHasScheme.MatchString(value) { + u, err = url.Parse(value) + } else { + if strings.HasPrefix(value, "/") { + u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefaultPath, value)) + } else { + u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefault, value)) + } + } + + if err != nil { + return nil, fmt.Errorf("could not parse string '%s' as address: expected format is [://][:]: %w", value, err) + } + + return NewAddressFromURL(u) +} + +// NewAddressFromNetworkValuesDefault returns an *Address and error depending on the ability to parse the string as an Address. +// It also assumes any value without a scheme which looks like a path is the schemeDefaultPath scheme, and everything +// else without a scheme is the schemeDefault scheme. +func NewAddressFromNetworkValuesDefault(value string, port int, schemeDefault, schemeDefaultPath string) (address *Address, err error) { + var u *url.URL + + if regexpHasScheme.MatchString(value) { + u, err = url.Parse(value) + } else { + switch { + case strings.HasPrefix(value, "/"): + u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefaultPath, value)) + case port > 0: + u, err = url.Parse(fmt.Sprintf("%s://%s:%d", schemeDefault, value, port)) + default: + u, err = url.Parse(fmt.Sprintf("%s://%s", schemeDefault, value)) + } + } + + if err != nil { + return nil, fmt.Errorf("could not parse string '%s' as address: expected format is [://][:]: %w", value, err) + } + + return NewAddressFromURL(u) +} + +// NewAddressUnix returns an *Address from a path value. +func NewAddressUnix(path string) Address { + return Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: path}} +} + +// NewAddressFromNetworkValues returns an *Address from network values. +func NewAddressFromNetworkValues(network, host string, port int) Address { + return Address{true, false, port, &url.URL{Scheme: network, Host: fmt.Sprintf("%s:%d", host, port)}} +} + +// NewSMTPAddress returns an *AddressSMTP from SMTP values. +func NewSMTPAddress(scheme, host string, port int) *AddressSMTP { + if port == 0 { + switch scheme { + case AddressSchemeSUBMISSIONS: + port = 465 + case AddressSchemeSUBMISSION: + port = 587 + default: + port = 25 + } + } + + if scheme == "" { + switch port { + case 465: + scheme = AddressSchemeSUBMISSIONS + case 587: + scheme = AddressSchemeSUBMISSION + default: + scheme = AddressSchemeSMTP + } + } + + return &AddressSMTP{Address: Address{true, false, port, &url.URL{Scheme: scheme, Host: fmt.Sprintf("%s:%d", host, port)}}} +} + +// NewAddressFromURL returns an *Address and error depending on the ability to parse the *url.URL as an Address. +func NewAddressFromURL(u *url.URL) (addr *Address, err error) { + addr = &Address{ + url: u, + } + + if err = addr.validate(); err != nil { + return nil, err + } + + return addr, nil +} + +// AddressTCP is just a type with an underlying type of Address. +type AddressTCP struct { + Address +} + +// AddressUDP is just a type with an underlying type of Address. +type AddressUDP struct { + Address +} + +// AddressLDAP is just a type with an underlying type of Address. +type AddressLDAP struct { + Address +} + +// AddressSMTP is just a type with an underlying type of Address. +type AddressSMTP struct { + Address +} + +// Address represents an address. +type Address struct { + valid bool + socket bool + port int + + url *url.URL +} + +// Valid returns true if the Address is valid. +func (a *Address) Valid() bool { + return a.valid +} + +// IsUnixDomainSocket returns true if the address has been determined to be a Unix Domain Socket. +func (a *Address) IsUnixDomainSocket() bool { + return a.socket +} + +// IsTCP returns true if the address is one of the TCP schemes (not including application schemes that use TCP). +func (a *Address) IsTCP() bool { + switch a.Scheme() { + case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6: + return true + default: + return false + } +} + +// IsUDP returns true if the address is one of the UDP schemes (not including application schemes that use UDP). +func (a *Address) IsUDP() bool { + switch a.Scheme() { + case AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6: + return true + default: + return false + } +} + +// IsExplicitlySecure returns true if the address is an explicitly secure. +func (a *Address) IsExplicitlySecure() bool { + switch a.Scheme() { + case AddressSchemeSUBMISSIONS, AddressSchemeLDAPS: + return true + default: + return false + } +} + +// ValidateListener returns true if the Address is valid for a connection listener. +func (a *Address) ValidateListener() error { + switch a.Scheme() { + case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6, AddressSchemeUnix: + break + default: + return fmt.Errorf("scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as '%s'", a.Scheme()) + } + + return nil +} + +// ValidateHTTP returns true if the Address is valid for a HTTP connection listener. +func (a *Address) ValidateHTTP() error { + if a.IsTCP() { + return nil + } + + switch a.Scheme() { + case AddressSchemeUnix: + return nil + default: + return fmt.Errorf("scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as '%s'", a.Scheme()) + } +} + +// ValidateSMTP returns true if the Address is valid for a remote SMTP connection opener. +func (a *Address) ValidateSMTP() error { + switch a.Scheme() { + case AddressSchemeSMTP, AddressSchemeSUBMISSION, AddressSchemeSUBMISSIONS: + return nil + default: + return fmt.Errorf("scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as '%s'", a.Scheme()) + } +} + +// ValidateSQL returns true if the Address is valid for a remote SQL connection opener. +func (a *Address) ValidateSQL() error { + if a.IsTCP() { + return nil + } + + switch a.Scheme() { + case AddressSchemeUnix: + return nil + default: + return fmt.Errorf("scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as '%s'", a.Scheme()) + } +} + +// ValidateLDAP returns true if the Address has a value Scheme for an LDAP connection opener. +func (a *Address) ValidateLDAP() error { + switch a.Scheme() { + case AddressSchemeLDAP, AddressSchemeLDAPS, AddressSchemeLDAPI: + return nil + default: + return fmt.Errorf("scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as '%s'", a.Scheme()) + } +} + +// String returns a string representation of the Address. +func (a *Address) String() string { + if !a.valid || a.url == nil { + return "" + } + + return a.url.String() +} + +// Network returns the Scheme() if it's appropriate for the net packages network arguments otherwise it returns tcp. +func (a *Address) Network() string { + switch scheme := a.Scheme(); scheme { + case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6, AddressSchemeUnix: + return scheme + default: + return AddressSchemeTCP + } +} + +// Scheme returns the *url.URL Scheme field. +func (a *Address) Scheme() string { + if !a.valid || a.url == nil { + return "" + } + + return a.url.Scheme +} + +// Hostname returns the output of the *url.URL Hostname func. +func (a *Address) Hostname() string { + if !a.valid || a.url == nil { + return "" + } + + return a.url.Hostname() +} + +// SocketHostname returns the correct hostname for a socket connection. +func (a *Address) SocketHostname() string { + if !a.valid || a.url == nil { + return "" + } + + if a.socket { + return a.url.Path + } + + return a.url.Hostname() +} + +// SetHostname sets the hostname preserving the port. +func (a *Address) SetHostname(hostname string) { + if !a.valid || a.url == nil { + return + } + + if port := a.url.Port(); port == "" { + a.url.Host = hostname + } else { + a.url.Host = fmt.Sprintf("%s:%s", hostname, port) + } +} + +// Port returns the port. +func (a *Address) Port() int { + return a.port +} + +// SetPort sets the port preserving the hostname. +func (a *Address) SetPort(port int) { + if !a.valid || a.url == nil { + return + } + + a.setport(port) +} + +// Host returns the *url.URL Host field. +func (a *Address) Host() string { + if !a.valid || a.url == nil { + return "" + } + + return a.url.Host +} + +// NetworkAddress returns a string representation of the Address with just the host and port. +func (a *Address) NetworkAddress() string { + if !a.valid || a.url == nil { + return "" + } + + if a.socket { + return a.url.Path + } + + return a.url.Host +} + +// Listener creates and returns a net.Listener. +func (a *Address) Listener() (net.Listener, error) { + return a.listener() +} + +// Dial creates and returns a dialed net.Conn. +func (a *Address) Dial() (net.Conn, error) { + if a.url == nil { + return nil, fmt.Errorf("address url is nil") + } + + return net.Dial(a.Network(), a.NetworkAddress()) +} + +// ListenerWithUMask creates and returns a net.Listener with a temporary UMask if the scheme is `unix`. +func (a *Address) ListenerWithUMask(umask int) (ln net.Listener, err error) { + if !a.socket { + return a.listener() + } + + if a.url == nil { + return nil, fmt.Errorf("address url is nil") + } + + umask = syscall.Umask(umask) + + ln, err = net.Listen(a.Network(), a.NetworkAddress()) + + _ = syscall.Umask(umask) + + return ln, err +} + +func (a *Address) listener() (net.Listener, error) { + if a.url == nil { + return nil, fmt.Errorf("address url is nil") + } + + return net.Listen(a.Network(), a.NetworkAddress()) +} + +func (a *Address) setport(port int) { + a.port = port + a.url.Host = net.JoinHostPort(a.url.Hostname(), strconv.Itoa(port)) +} + +func (a *Address) validate() (err error) { + if a.url == nil { + return fmt.Errorf("error validating the address: address url was nil") + } + + switch { + case a.url.RawQuery != "": + return fmt.Errorf("error validating the address: the url '%s' appears to have a query but this is not valid for addresses", a.url.String()) + case a.url.RawFragment != "", a.url.Fragment != "": + return fmt.Errorf("error validating the address: the url '%s' appears to have a fragment but this is not valid for addresses", a.url.String()) + case a.url.User != nil: + return fmt.Errorf("error validating the address: the url '%s' appears to have user info but this is not valid for addresses", a.url.String()) + } + + switch a.url.Scheme { + case AddressSchemeUnix, AddressSchemeLDAPI: + if err = a.validateUnixSocket(); err != nil { + return err + } + case AddressSchemeTCP, AddressSchemeTCP4, AddressSchemeTCP6, AddressSchemeUDP, AddressSchemeUDP4, AddressSchemeUDP6: + if err = a.validateTCPUDP(); err != nil { + return err + } + case AddressSchemeLDAP, AddressSchemeLDAPS, AddressSchemeSMTP, AddressSchemeSUBMISSION, AddressSchemeSUBMISSIONS: + if err = a.validateProtocol(); err != nil { + return err + } + } + + a.valid = true + + return nil +} + +func (a *Address) validateProtocol() (err error) { + port := a.url.Port() + + switch port { + case "": + switch a.url.Scheme { + case AddressSchemeLDAP: + a.setport(389) + case AddressSchemeLDAPS: + a.setport(636) + case AddressSchemeSMTP: + a.setport(25) + case AddressSchemeSUBMISSION: + a.setport(587) + case AddressSchemeSUBMISSIONS: + a.setport(465) + } + default: + actualPort, _ := strconv.Atoi(port) + + a.setport(actualPort) + } + + return nil +} + +func (a *Address) validateTCPUDP() (err error) { + port := a.url.Port() + + switch port { + case "": + a.setport(0) + default: + actualPort, _ := strconv.Atoi(port) + + a.setport(actualPort) + } + + return nil +} + +func (a *Address) validateUnixSocket() (err error) { + switch { + case a.url.Path == "" && a.url.Scheme != AddressSchemeLDAPI: + return fmt.Errorf("error validating the unix socket address: could not determine path from '%s'", a.url.String()) + case a.url.Host != "": + return fmt.Errorf("error validating the unix socket address: the url '%s' appears to have a host but this is not valid for unix sockets: this may occur if you omit the leading forward slash from the socket path", a.url.String()) + } + + a.socket = true + + return nil +} diff --git a/internal/configuration/schema/types_address_test.go b/internal/configuration/schema/types_address_test.go new file mode 100644 index 000000000..f40393d60 --- /dev/null +++ b/internal/configuration/schema/types_address_test.go @@ -0,0 +1,743 @@ +package schema + +import ( + "net" + "net/url" + "path/filepath" + "testing" + + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" +) + +func TestNewAddressFromString(t *testing.T) { + testCases := []struct { + name string + have string + expected *Address + expectedAddress, expectedString, expectedErr string + }{ + { + "ShouldParseBasicAddress", + "tcp://0.0.0.0:9091", + &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}}, + "0.0.0.0:9091", + "tcp://0.0.0.0:9091", + "", + }, + { + "ShouldParseEmptyAddress", + "", + &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: ":0"}}, + ":0", + "tcp://:0", + "", + }, + { + "ShouldParseAddressMissingScheme", + "0.0.0.0:9091", + &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}}, + "0.0.0.0:9091", + "tcp://0.0.0.0:9091", + "", + }, + { + "ShouldParseUnixAddressMissingScheme", + "/var/run/example.sock", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: "/var/run/example.sock"}}, + "/var/run/example.sock", + "unix:///var/run/example.sock", + "", + }, + { + "ShouldParseAddressMissingPort", + "tcp://0.0.0.0", + &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:0"}}, + "0.0.0.0:0", + "tcp://0.0.0.0:0", + "", + }, + { + "ShouldParseUnixSocket", + "unix:///path/to/a/socket.sock", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: "/path/to/a/socket.sock"}}, + "/path/to/a/socket.sock", + "unix:///path/to/a/socket.sock", + "", + }, + { + "ShouldNotParseUnixSocketWithHost", + "unix://ahost/path/to/a/socket.sock", + nil, + "", + "", + "error validating the unix socket address: the url 'unix://ahost/path/to/a/socket.sock' appears to have a host but this is not valid for unix sockets: this may occur if you omit the leading forward slash from the socket path", + }, + { + "ShouldNotParseUnixSocketWithoutPath", + "unix://nopath.com", + nil, + "", + "", + "error validating the unix socket address: could not determine path from 'unix://nopath.com'", + }, + { + "ShouldNotParseUnixSocketWithQuery", + "unix:///path/to/a/socket.sock?q=yes", + nil, + "", + "", + "error validating the address: the url 'unix:///path/to/a/socket.sock?q=yes' appears to have a query but this is not valid for addresses", + }, + { + "ShouldNotParseUnixSocketWithFragment", + "unix:///path/to/a/socket.sock#example", + nil, + "", + "", + "error validating the address: the url 'unix:///path/to/a/socket.sock#example' appears to have a fragment but this is not valid for addresses", + }, + { + "ShouldNotParseUnixSocketWithUserInfo", + "unix://user:example@/path/to/a/socket.sock", + nil, + "", + "", + "error validating the address: the url 'unix://user:example@/path/to/a/socket.sock' appears to have user info but this is not valid for addresses", + }, + { + "ShouldParseUnknownScheme", + "a://0.0.0.0", + &Address{true, false, 0, &url.URL{Scheme: "a", Host: "0.0.0.0"}}, + "0.0.0.0", + "a://0.0.0.0", + "", + }, + { + "ShouldNotParseInvalidPort", + "tcp://0.0.0.0:abc", + nil, + "", + "", + "could not parse string 'tcp://0.0.0.0:abc' as address: expected format is [://][:]: parse \"tcp://0.0.0.0:abc\": invalid port \":abc\" after host", + }, + { + "ShouldNotParseInvalidAddress", + "@$@#%@#$@@", + nil, + "", + "", + "could not parse string '@$@#%@#$@@' as address: expected format is [://][:]: parse \"tcp://@$@#%@#$@@\": invalid URL escape \"%@#\"", + }, + { + "ShouldNotParseInvalidAddressWithScheme", + "tcp://@$@#%@#$@@", + nil, + "", + "", + "could not parse string 'tcp://@$@#%@#$@@' as address: expected format is [://][:]: parse \"tcp://@$@#%@#$@@\": invalid URL escape \"%@#\"", + }, + { + "ShouldSetDefaultPortLDAP", + "ldap://127.0.0.1", + &Address{true, false, 389, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1:389"}}, + "127.0.0.1:389", + "ldap://127.0.0.1:389", + "", + }, + { + "ShouldSetDefaultPortLDAPS", + "ldaps://127.0.0.1", + &Address{true, false, 636, &url.URL{Scheme: AddressSchemeLDAPS, Host: "127.0.0.1:636"}}, + "127.0.0.1:636", + "ldaps://127.0.0.1:636", + "", + }, + { + "ShouldAllowLDAPI", + "ldapi:///abc", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: "/abc"}}, + "/abc", + "ldapi:///abc", + "", + }, + { + "ShouldAllowImplicitLDAPI", + "ldapi://", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: ""}}, + "", + "ldapi:", + "", + }, + { + "ShouldAllowImplicitLDAPINoSlash", + "ldapi:", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: ""}}, + "", + "ldapi:", + "", + }, + { + "ShouldSetDefaultPortSMTP", + "smtp://127.0.0.1", + &Address{true, false, 25, &url.URL{Scheme: AddressSchemeSMTP, Host: "127.0.0.1:25"}}, + "127.0.0.1:25", + "smtp://127.0.0.1:25", + "", + }, + { + "ShouldSetDefaultPortSUBMISSION", + "submission://127.0.0.1", + &Address{true, false, 587, &url.URL{Scheme: AddressSchemeSUBMISSION, Host: "127.0.0.1:587"}}, + "127.0.0.1:587", + "submission://127.0.0.1:587", + "", + }, + { + "ShouldSetDefaultPortSUBMISSIONS", + "submissions://127.0.0.1", + &Address{true, false, 465, &url.URL{Scheme: AddressSchemeSUBMISSIONS, Host: "127.0.0.1:465"}}, + "127.0.0.1:465", + "submissions://127.0.0.1:465", + "", + }, + { + "ShouldNotOverridePort", + "ldap://127.0.0.1:123", + &Address{true, false, 123, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1:123"}}, + "127.0.0.1:123", + "ldap://127.0.0.1:123", + "", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + actual, actualErr := NewAddress(tc.have) + + if len(tc.expectedErr) != 0 { + assert.EqualError(t, actualErr, tc.expectedErr) + } else { + assert.Nil(t, actualErr) + + assert.Equal(t, tc.expectedAddress, actual.NetworkAddress()) + assert.Equal(t, tc.expectedString, actual.String()) + + assert.True(t, actual.Valid()) + } + + assert.Equal(t, tc.expected, actual) + }) + } +} + +func TestAddress_ValidateErrors(t *testing.T) { + testCases := []struct { + name string + have *Address + expectedLDAP, expectedSMTP, expectedHTTP, expectedSQL, expectedListener string + }{ + { + "ShouldValidateLDAPAddress", + &Address{true, false, 0, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1"}}, + "", + "scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'ldap'", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'ldap'", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'ldap'", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as 'ldap'", + }, + { + "ShouldValidateSMTPAddress", + &Address{true, false, 0, &url.URL{Scheme: AddressSchemeSMTP, Host: "127.0.0.1"}}, + "scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'smtp'", + "", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'smtp'", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'smtp'", + "scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as 'smtp'", + }, + { + "ShouldValidateTCPAddress", + &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "127.0.0.1"}}, + "scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'tcp'", + "scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'tcp'", + "", + "", + "", + }, + { + "ShouldValidateUnixSocket", + &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: "/path/to/socket"}}, + "scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'unix'", + "scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'unix'", + "", + "", + "", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + if tc.expectedLDAP == "" { + assert.NoError(t, tc.have.ValidateLDAP()) + } else { + assert.EqualError(t, tc.have.ValidateLDAP(), tc.expectedLDAP) + } + + if tc.expectedSMTP == "" { + assert.NoError(t, tc.have.ValidateSMTP()) + } else { + assert.EqualError(t, tc.have.ValidateSMTP(), tc.expectedSMTP) + } + + if tc.expectedHTTP == "" { + assert.NoError(t, tc.have.ValidateHTTP()) + } else { + assert.EqualError(t, tc.have.ValidateHTTP(), tc.expectedHTTP) + } + + if tc.expectedSQL == "" { + assert.NoError(t, tc.have.ValidateSQL()) + } else { + assert.EqualError(t, tc.have.ValidateSQL(), tc.expectedSQL) + } + + if tc.expectedListener == "" { + assert.NoError(t, tc.have.ValidateListener()) + } else { + assert.EqualError(t, tc.have.ValidateListener(), tc.expectedListener) + } + }) + } +} + +func TestAddress_SetHostname(t *testing.T) { + address := &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0"}} + + assert.Equal(t, "tcp://0.0.0.0", address.String()) + + address.SetHostname("127.0.0.1") + + assert.Equal(t, "tcp://127.0.0.1", address.String()) +} + +func TestAddress_ListenerWithUMask(t *testing.T) { + dir := t.TempDir() + + address := &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: filepath.Join(dir, "example.sock")}} + + ln, err := address.ListenerWithUMask(600) + + assert.NotNil(t, ln) + assert.NoError(t, err) + assert.NoError(t, ln.Close()) + + address = &Address{true, true, 0, nil} + + ln, err = address.ListenerWithUMask(600) + + assert.Nil(t, ln) + assert.EqualError(t, err, "address url is nil") + + address = &Address{true, false, 0, nil} + + ln, err = address.ListenerWithUMask(600) + + assert.Nil(t, ln) + assert.EqualError(t, err, "address url is nil") +} + +func TestAddressOutputValues(t *testing.T) { + var ( + address *Address + listener net.Listener + err error + ) + + address = &Address{} + assert.EqualError(t, address.validate(), "error validating the address: address url was nil") + + address = &Address{false, false, 0, nil} + + assert.Equal(t, "", address.String()) + assert.Equal(t, "", address.Scheme()) + assert.Equal(t, "", address.Host()) + assert.Equal(t, "", address.Hostname()) + assert.Equal(t, "", address.NetworkAddress()) + assert.Equal(t, 0, address.Port()) + + listener, err = address.Listener() + + assert.Nil(t, listener) + assert.EqualError(t, err, "address url is nil") + + address = &Address{true, false, 8080, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:8080"}} + + assert.Equal(t, "tcp://0.0.0.0:8080", address.String()) + assert.Equal(t, "tcp", address.Scheme()) + assert.Equal(t, "0.0.0.0:8080", address.Host()) + assert.Equal(t, "0.0.0.0", address.Hostname()) + assert.Equal(t, "0.0.0.0:8080", address.NetworkAddress()) + assert.Equal(t, 8080, address.Port()) + + listener, err = address.Listener() + + assert.NotNil(t, listener) + assert.NoError(t, err) + + address = &Address{true, false, 0, nil} + + assert.Equal(t, "", address.String()) + assert.Equal(t, "", address.Scheme()) + assert.Equal(t, "", address.Host()) + assert.Equal(t, "", address.Hostname()) + assert.Equal(t, "", address.NetworkAddress()) + assert.Equal(t, 0, address.Port()) + + listener, err = address.Listener() + + assert.Nil(t, listener) + assert.EqualError(t, err, "address url is nil") + + address.SetHostname("abc123.com") + address.SetPort(50) + + assert.Equal(t, "", address.String()) + assert.Equal(t, "", address.Scheme()) + assert.Equal(t, "", address.Host()) + assert.Equal(t, "", address.Hostname()) + assert.Equal(t, "", address.NetworkAddress()) + assert.Equal(t, 0, address.Port()) + + listener, err = address.Listener() + + assert.Nil(t, listener) + assert.EqualError(t, err, "address url is nil") + + address = &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}} + + assert.Equal(t, "tcp://0.0.0.0:9091", address.String()) + assert.Equal(t, "tcp", address.Scheme()) + assert.Equal(t, "0.0.0.0:9091", address.Host()) + assert.Equal(t, "0.0.0.0", address.Hostname()) + assert.Equal(t, "0.0.0.0:9091", address.NetworkAddress()) + assert.Equal(t, 9091, address.Port()) + + listener, err = address.Listener() + + assert.NotNil(t, listener) + assert.NoError(t, err) + + assert.NoError(t, listener.Close()) + + address.SetPort(9092) + + assert.Equal(t, "tcp://0.0.0.0:9092", address.String()) + assert.Equal(t, "tcp", address.Scheme()) + assert.Equal(t, "0.0.0.0:9092", address.Host()) + assert.Equal(t, "0.0.0.0", address.Hostname()) + assert.Equal(t, "0.0.0.0:9092", address.NetworkAddress()) + assert.Equal(t, 9092, address.Port()) + + listener, err = address.Listener() + + assert.NotNil(t, listener) + assert.NoError(t, err) + + assert.NoError(t, listener.Close()) + + address.SetHostname("example.com") + + assert.Equal(t, "tcp://example.com:9092", address.String()) + assert.Equal(t, "tcp", address.Scheme()) + assert.Equal(t, "example.com:9092", address.Host()) + assert.Equal(t, "example.com", address.Hostname()) + assert.Equal(t, "example.com:9092", address.NetworkAddress()) + assert.Equal(t, 9092, address.Port()) +} + +func TestNewAddressUnix(t *testing.T) { + have := NewAddressUnix("/abc/123") + + require.NotNil(t, have) + assert.Equal(t, "unix:///abc/123", have.String()) +} + +func TestNewAddressFromNetworkValues(t *testing.T) { + have := NewAddressFromNetworkValues(AddressSchemeUDP, "av", 1) + + require.NotNil(t, have) + assert.Equal(t, "udp://av:1", have.String()) +} + +func TestNewSMTPAddress(t *testing.T) { + testCases := []struct { + name string + haveScheme string + haveHost string + havePort int + expected string + expectedNetwork, expectedScheme string + expectedHostname string + expectedPort int + expectedExplicitTLS bool + }{ + { + "ShouldParseUnknownSchemePort25", + "", + "hosta", + 25, + "smtp://hosta:25", + "tcp", + "smtp", + "hosta", + 25, + false, + }, + { + "ShouldParseUnknownSchemePort465", + "", + "hostb", + 465, + "submissions://hostb:465", + "tcp", + "submissions", + "hostb", + 465, + true, + }, + { + "ShouldParseUnknownSchemePort587", + "", + "hostc", + 587, + "submission://hostc:587", + "tcp", + "submission", + "hostc", + 587, + false, + }, + { + "ShouldParseUnknownPortSchemeSMTP", + "smtp", + "hostd", + 0, + "smtp://hostd:25", + "tcp", + "smtp", + "hostd", + 25, + false, + }, + { + "ShouldParseUnknownPortSchemeSUBMISSION", + "submission", + "hoste", + 0, + "submission://hoste:587", + "tcp", + "submission", + "hoste", + 587, + false, + }, + { + "ShouldParseUnknownPortSchemeSUBMISSIONS", + "submissions", + "hostf", + 0, + "submissions://hostf:465", + "tcp", + "submissions", + "hostf", + 465, + true, + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + have := NewSMTPAddress(tc.haveScheme, tc.haveHost, tc.havePort) + + assert.Equal(t, tc.expected, have.String()) + assert.Equal(t, tc.expectedScheme, have.Scheme()) + assert.Equal(t, tc.expectedNetwork, have.Network()) + assert.Equal(t, tc.expectedHostname, have.Hostname()) + assert.Equal(t, tc.expectedHostname, have.SocketHostname()) + assert.Equal(t, tc.expectedPort, have.Port()) + assert.Equal(t, tc.expectedExplicitTLS, have.IsExplicitlySecure()) + }) + } +} + +func TestAddress_SocketHostname(t *testing.T) { + testCases := []struct { + name string + have Address + expected string + }{ + { + "ShouldReturnHostname", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeTCP, Host: "examplea:80"}}, + "examplea", + }, + { + "ShouldReturnPath", + Address{true, true, 80, &url.URL{Scheme: AddressSchemeUnix, Path: "/abc/123"}}, + "/abc/123", + }, + { + "ShouldReturnNothing", + Address{false, true, 80, &url.URL{Scheme: AddressSchemeUnix, Path: "/abc/123"}}, + "", + }, + { + "ShouldReturnNothingNil", + Address{true, true, 80, nil}, + "", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + assert.Equal(t, tc.expected, tc.have.SocketHostname()) + }) + } +} + +func TestAddress_IsTCP_IsUDP(t *testing.T) { + testCases := []struct { + name string + have Address + isTCP bool + isUDP bool + }{ + { + "ShouldReturnTrueTCP", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeTCP, Host: "tcphosta"}}, + true, + false, + }, + { + "ShouldReturnTrueTCP4", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeTCP4, Host: "tcphostb"}}, + true, + false, + }, + { + "ShouldReturnTrueTCP6", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeTCP6, Host: "tcphostc"}}, + true, + false, + }, + { + "ShouldReturnFalseUDP", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeUDP, Host: "tcphostd"}}, + false, + true, + }, + { + "ShouldReturnFalseUDP4", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeUDP4, Host: "tcphoste"}}, + false, + true, + }, + { + "ShouldReturnFalseUDP6", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeUDP6, Host: "tcphostf"}}, + false, + true, + }, + { + "ShouldReturnFalseSMTP", + Address{true, false, 80, &url.URL{Scheme: AddressSchemeSMTP, Host: "tcphostg"}}, + false, + false, + }, + { + "ShouldReturnFalseUnix", + Address{true, true, 80, &url.URL{Scheme: AddressSchemeUnix, Host: "tcphosth"}}, + false, + false, + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + assert.Equal(t, tc.isTCP, tc.have.IsTCP()) + assert.Equal(t, tc.isUDP, tc.have.IsUDP()) + }) + } +} + +func TestNewAddressFromNetworkValuesDefault(t *testing.T) { + testCases := []struct { + name string + haveHost string + havePort int + haveSchemeDefault string + haveSchemeDefaultPath string + expected string + expectedErr string + }{ + { + "ShouldParseTCPWithTCPUnix", + "cba", + 80, + AddressSchemeTCP, + AddressSchemeUnix, + "tcp://cba:80", + "", + }, + { + "ShouldParseTCPWithTCPUnixNoPort", + "cba", + 0, + AddressSchemeTCP, + AddressSchemeUnix, + "tcp://cba:0", + "", + }, + { + "ShouldParseUnixWithTCPUnix", + "/abc/123", + 80, + AddressSchemeTCP, + AddressSchemeUnix, + "unix:///abc/123", + "", + }, + { + "ShouldParseUnixWithScheme", + "unix:///abc/123", + 0, + AddressSchemeTCP, + AddressSchemeUnix, + "unix:///abc/123", + "", + }, + { + "ShouldErrBadURL", + "tcp://127.0.0.1:abc", + 0, + AddressSchemeTCP, + AddressSchemeUnix, + "", + "could not parse string 'tcp://127.0.0.1:abc' as address: expected format is [://][:]: parse \"tcp://127.0.0.1:abc\": invalid port \":abc\" after host", + }, + } + + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + actual, theError := NewAddressFromNetworkValuesDefault(tc.haveHost, tc.havePort, tc.haveSchemeDefault, tc.haveSchemeDefaultPath) + + if tc.expectedErr == "" { + require.NoError(t, theError) + assert.Equal(t, tc.expected, actual.String()) + } else { + assert.EqualError(t, theError, tc.expectedErr) + assert.Nil(t, actual) + } + }) + } +} diff --git a/internal/configuration/schema/types_test.go b/internal/configuration/schema/types_test.go index aa42b4a54..886b9ce32 100644 --- a/internal/configuration/schema/types_test.go +++ b/internal/configuration/schema/types_test.go @@ -7,9 +7,6 @@ import ( "crypto/x509" "encoding/pem" "fmt" - "net" - "net/url" - "path/filepath" "regexp" "testing" @@ -17,433 +14,6 @@ import ( "github.com/stretchr/testify/require" ) -func TestNewAddressFromString(t *testing.T) { - testCases := []struct { - name string - have string - expected *Address - expectedAddress, expectedString, expectedErr string - }{ - { - "ShouldParseBasicAddress", - "tcp://0.0.0.0:9091", - &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}}, - "0.0.0.0:9091", - "tcp://0.0.0.0:9091", - "", - }, - { - "ShouldParseEmptyAddress", - "", - &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: ":0"}}, - ":0", - "tcp://:0", - "", - }, - { - "ShouldParseAddressMissingScheme", - "0.0.0.0:9091", - &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}}, - "0.0.0.0:9091", - "tcp://0.0.0.0:9091", - "", - }, - { - "ShouldParseUnixAddressMissingScheme", - "/var/run/example.sock", - &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: "/var/run/example.sock"}}, - "/var/run/example.sock", - "unix:///var/run/example.sock", - "", - }, - { - "ShouldParseAddressMissingPort", - "tcp://0.0.0.0", - &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:0"}}, - "0.0.0.0:0", - "tcp://0.0.0.0:0", - "", - }, - { - "ShouldParseUnixSocket", - "unix:///path/to/a/socket.sock", - &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: "/path/to/a/socket.sock"}}, - "/path/to/a/socket.sock", - "unix:///path/to/a/socket.sock", - "", - }, - { - "ShouldNotParseUnixSocketWithHost", - "unix://ahost/path/to/a/socket.sock", - nil, - "", - "", - "error validating the unix socket address: the url 'unix://ahost/path/to/a/socket.sock' appears to have a host but this is not valid for unix sockets: this may occur if you omit the leading forward slash from the socket path", - }, - { - "ShouldNotParseUnixSocketWithoutPath", - "unix://nopath.com", - nil, - "", - "", - "error validating the unix socket address: could not determine path from 'unix://nopath.com'", - }, - { - "ShouldNotParseUnixSocketWithQuery", - "unix:///path/to/a/socket.sock?q=yes", - nil, - "", - "", - "error validating the address: the url 'unix:///path/to/a/socket.sock?q=yes' appears to have a query but this is not valid for addresses", - }, - { - "ShouldNotParseUnixSocketWithFragment", - "unix:///path/to/a/socket.sock#example", - nil, - "", - "", - "error validating the address: the url 'unix:///path/to/a/socket.sock#example' appears to have a fragment but this is not valid for addresses", - }, - { - "ShouldNotParseUnixSocketWithUserInfo", - "unix://user:example@/path/to/a/socket.sock", - nil, - "", - "", - "error validating the address: the url 'unix://user:example@/path/to/a/socket.sock' appears to have user info but this is not valid for addresses", - }, - { - "ShouldParseUnknownScheme", - "a://0.0.0.0", - &Address{true, false, 0, &url.URL{Scheme: "a", Host: "0.0.0.0"}}, - "0.0.0.0", - "a://0.0.0.0", - "", - }, - { - "ShouldNotParseInvalidPort", - "tcp://0.0.0.0:abc", - nil, - "", - "", - "could not parse string 'tcp://0.0.0.0:abc' as address: expected format is [://][:]: parse \"tcp://0.0.0.0:abc\": invalid port \":abc\" after host", - }, - { - "ShouldNotParseInvalidAddress", - "@$@#%@#$@@", - nil, - "", - "", - "could not parse string '@$@#%@#$@@' as address: expected format is [://][:]: parse \"tcp://@$@#%@#$@@\": invalid URL escape \"%@#\"", - }, - { - "ShouldNotParseInvalidAddressWithScheme", - "tcp://@$@#%@#$@@", - nil, - "", - "", - "could not parse string 'tcp://@$@#%@#$@@' as address: expected format is [://][:]: parse \"tcp://@$@#%@#$@@\": invalid URL escape \"%@#\"", - }, - { - "ShouldSetDefaultPortLDAP", - "ldap://127.0.0.1", - &Address{true, false, 389, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1:389"}}, - "127.0.0.1:389", - "ldap://127.0.0.1:389", - "", - }, - { - "ShouldSetDefaultPortLDAPS", - "ldaps://127.0.0.1", - &Address{true, false, 636, &url.URL{Scheme: AddressSchemeLDAPS, Host: "127.0.0.1:636"}}, - "127.0.0.1:636", - "ldaps://127.0.0.1:636", - "", - }, - { - "ShouldAllowLDAPI", - "ldapi:///abc", - &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: "/abc"}}, - "/abc", - "ldapi:///abc", - "", - }, - { - "ShouldAllowImplicitLDAPI", - "ldapi://", - &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: ""}}, - "", - "ldapi:", - "", - }, - { - "ShouldAllowImplicitLDAPINoSlash", - "ldapi:", - &Address{true, true, 0, &url.URL{Scheme: AddressSchemeLDAPI, Path: ""}}, - "", - "ldapi:", - "", - }, - { - "ShouldSetDefaultPortSMTP", - "smtp://127.0.0.1", - &Address{true, false, 25, &url.URL{Scheme: AddressSchemeSMTP, Host: "127.0.0.1:25"}}, - "127.0.0.1:25", - "smtp://127.0.0.1:25", - "", - }, - { - "ShouldSetDefaultPortSUBMISSION", - "submission://127.0.0.1", - &Address{true, false, 587, &url.URL{Scheme: AddressSchemeSUBMISSION, Host: "127.0.0.1:587"}}, - "127.0.0.1:587", - "submission://127.0.0.1:587", - "", - }, - { - "ShouldSetDefaultPortSUBMISSIONS", - "submissions://127.0.0.1", - &Address{true, false, 465, &url.URL{Scheme: AddressSchemeSUBMISSIONS, Host: "127.0.0.1:465"}}, - "127.0.0.1:465", - "submissions://127.0.0.1:465", - "", - }, - { - "ShouldNotOverridePort", - "ldap://127.0.0.1:123", - &Address{true, false, 123, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1:123"}}, - "127.0.0.1:123", - "ldap://127.0.0.1:123", - "", - }, - } - - for _, tc := range testCases { - t.Run(tc.name, func(t *testing.T) { - actual, actualErr := NewAddress(tc.have) - - if len(tc.expectedErr) != 0 { - assert.EqualError(t, actualErr, tc.expectedErr) - } else { - assert.Nil(t, actualErr) - - assert.Equal(t, tc.expectedAddress, actual.NetworkAddress()) - assert.Equal(t, tc.expectedString, actual.String()) - - assert.True(t, actual.Valid()) - } - - assert.Equal(t, tc.expected, actual) - }) - } -} - -func TestAddress_ValidateErrors(t *testing.T) { - testCases := []struct { - name string - have *Address - expectedLDAP, expectedSMTP, expectedHTTP, expectedListener string - }{ - { - "ShouldValidateLDAPAddress", - &Address{true, false, 0, &url.URL{Scheme: AddressSchemeLDAP, Host: "127.0.0.1"}}, - "", - "scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'ldap'", - "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'ldap'", - "scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as 'ldap'", - }, - { - "ShouldValidateSMTPAddress", - &Address{true, false, 0, &url.URL{Scheme: AddressSchemeSMTP, Host: "127.0.0.1"}}, - "scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'smtp'", - "", - "scheme must be one of 'tcp', 'tcp4', 'tcp6', or 'unix' but is configured as 'smtp'", - "scheme must be one of 'tcp', 'tcp4', 'tcp6', 'udp', 'udp4', 'udp6', or 'unix' but is configured as 'smtp'", - }, - { - "ShouldValidateTCPAddress", - &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "127.0.0.1"}}, - "scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'tcp'", - "scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'tcp'", - "", - "", - }, - } - - for _, tc := range testCases { - t.Run(tc.name, func(t *testing.T) { - if tc.expectedLDAP == "" { - assert.NoError(t, tc.have.ValidateLDAP()) - } else { - assert.EqualError(t, tc.have.ValidateLDAP(), tc.expectedLDAP) - } - - if tc.expectedSMTP == "" { - assert.NoError(t, tc.have.ValidateSMTP()) - } else { - assert.EqualError(t, tc.have.ValidateSMTP(), tc.expectedSMTP) - } - - if tc.expectedListener == "" { - assert.NoError(t, tc.have.ValidateListener()) - } else { - assert.EqualError(t, tc.have.ValidateListener(), tc.expectedListener) - } - - if tc.expectedHTTP == "" { - assert.NoError(t, tc.have.ValidateHTTP()) - } else { - assert.EqualError(t, tc.have.ValidateHTTP(), tc.expectedHTTP) - } - }) - } -} - -func TestAddress_SetHostname(t *testing.T) { - address := &Address{true, false, 0, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0"}} - - assert.Equal(t, "tcp://0.0.0.0", address.String()) - - address.SetHostname("127.0.0.1") - - assert.Equal(t, "tcp://127.0.0.1", address.String()) -} - -func TestAddress_ListenerWithUMask(t *testing.T) { - dir := t.TempDir() - - address := &Address{true, true, 0, &url.URL{Scheme: AddressSchemeUnix, Path: filepath.Join(dir, "example.sock")}} - - ln, err := address.ListenerWithUMask(600) - - assert.NotNil(t, ln) - assert.NoError(t, err) - assert.NoError(t, ln.Close()) - - address = &Address{true, true, 0, nil} - - ln, err = address.ListenerWithUMask(600) - - assert.Nil(t, ln) - assert.EqualError(t, err, "address url is nil") - - address = &Address{true, false, 0, nil} - - ln, err = address.ListenerWithUMask(600) - - assert.Nil(t, ln) - assert.EqualError(t, err, "address url is nil") -} - -func TestAddressOutputValues(t *testing.T) { - var ( - address *Address - listener net.Listener - err error - ) - - address = &Address{} - assert.EqualError(t, address.validate(), "error validating the address: address url was nil") - - address = &Address{false, false, 0, nil} - - assert.Equal(t, "", address.String()) - assert.Equal(t, "", address.Scheme()) - assert.Equal(t, "", address.Host()) - assert.Equal(t, "", address.Hostname()) - assert.Equal(t, "", address.NetworkAddress()) - assert.Equal(t, 0, address.Port()) - - listener, err = address.Listener() - - assert.Nil(t, listener) - assert.EqualError(t, err, "address url is nil") - - address = &Address{true, false, 8080, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:8080"}} - - assert.Equal(t, "tcp://0.0.0.0:8080", address.String()) - assert.Equal(t, "tcp", address.Scheme()) - assert.Equal(t, "0.0.0.0:8080", address.Host()) - assert.Equal(t, "0.0.0.0", address.Hostname()) - assert.Equal(t, "0.0.0.0:8080", address.NetworkAddress()) - assert.Equal(t, 8080, address.Port()) - - listener, err = address.Listener() - - assert.NotNil(t, listener) - assert.NoError(t, err) - - address = &Address{true, false, 0, nil} - - assert.Equal(t, "", address.String()) - assert.Equal(t, "", address.Scheme()) - assert.Equal(t, "", address.Host()) - assert.Equal(t, "", address.Hostname()) - assert.Equal(t, "", address.NetworkAddress()) - assert.Equal(t, 0, address.Port()) - - listener, err = address.Listener() - - assert.Nil(t, listener) - assert.EqualError(t, err, "address url is nil") - - address.SetHostname("abc123.com") - address.SetPort(50) - - assert.Equal(t, "", address.String()) - assert.Equal(t, "", address.Scheme()) - assert.Equal(t, "", address.Host()) - assert.Equal(t, "", address.Hostname()) - assert.Equal(t, "", address.NetworkAddress()) - assert.Equal(t, 0, address.Port()) - - listener, err = address.Listener() - - assert.Nil(t, listener) - assert.EqualError(t, err, "address url is nil") - - address = &Address{true, false, 9091, &url.URL{Scheme: AddressSchemeTCP, Host: "0.0.0.0:9091"}} - - assert.Equal(t, "tcp://0.0.0.0:9091", address.String()) - assert.Equal(t, "tcp", address.Scheme()) - assert.Equal(t, "0.0.0.0:9091", address.Host()) - assert.Equal(t, "0.0.0.0", address.Hostname()) - assert.Equal(t, "0.0.0.0:9091", address.NetworkAddress()) - assert.Equal(t, 9091, address.Port()) - - listener, err = address.Listener() - - assert.NotNil(t, listener) - assert.NoError(t, err) - - assert.NoError(t, listener.Close()) - - address.SetPort(9092) - - assert.Equal(t, "tcp://0.0.0.0:9092", address.String()) - assert.Equal(t, "tcp", address.Scheme()) - assert.Equal(t, "0.0.0.0:9092", address.Host()) - assert.Equal(t, "0.0.0.0", address.Hostname()) - assert.Equal(t, "0.0.0.0:9092", address.NetworkAddress()) - assert.Equal(t, 9092, address.Port()) - - listener, err = address.Listener() - - assert.NotNil(t, listener) - assert.NoError(t, err) - - assert.NoError(t, listener.Close()) - - address.SetHostname("example.com") - - assert.Equal(t, "tcp://example.com:9092", address.String()) - assert.Equal(t, "tcp", address.Scheme()) - assert.Equal(t, "example.com:9092", address.Host()) - assert.Equal(t, "example.com", address.Hostname()) - assert.Equal(t, "example.com:9092", address.NetworkAddress()) - assert.Equal(t, 9092, address.Port()) -} - func TestNewTLSVersion(t *testing.T) { testCases := []struct { name string diff --git a/internal/configuration/test_resources/config.deprecated.alt.yml b/internal/configuration/test_resources/config.deprecated.alt.yml new file mode 100644 index 000000000..9ea5f9cd6 --- /dev/null +++ b/internal/configuration/test_resources/config.deprecated.alt.yml @@ -0,0 +1,173 @@ +--- +default_redirection_url: https://home.example.com:8080/ + +server: + address: "tcp://127.0.0.1:9091" + endpoints: + authz: + forward-auth: + implementation: ForwardAuth + authn_strategies: + - name: HeaderProxyAuthorization + - name: CookieSession + ext-authz: + implementation: ExtAuthz + authn_strategies: + - name: HeaderProxyAuthorization + - name: CookieSession + auth-request: + implementation: AuthRequest + authn_strategies: + - name: HeaderAuthRequestProxyAuthorization + - name: CookieSession + legacy: + implementation: Legacy + +log: + level: debug + +totp: + issuer: authelia.com + +duo_api: + hostname: api-123456789.example.com + integration_key: ABCDEF + +authentication_backend: + ldap: + url: 'ldap://127.0.0.1' + tls: + private_key: | + -----BEGIN RSA PRIVATE KEY----- + MIIEpAIBAAKCAQEA6z1LOg1ZCqb0lytXWZ+MRBpMHEXOoTOLYgfZXt1IYyE3Z758 + cyalk0NYQhY5cZDsXPYWPvAHiPMUxutWkoxFwby56S+AbIMa3/Is+ILrHRJs8Exn + ZkpyrYFxPX12app2kErdmAkHSx0Z5/kuXiz96PHs8S8/ZbyZolLHzdfLtSzjvRm5 + Zue5iFzsf19NJz5CIBfv8g5lRwtE8wNJoRSpn1xq7fqfuA0weDNFPzjlNWRLy6aa + rK7qJexRkmkCs4sLgyl+9NODYJpvmN8E1yhyC27E0joI6rBFVW7Ihv+cSPCdDzGp + EWe81x3AeqAa3mjVqkiq4u4Z2i8JDgBaPboqJwIDAQABAoIBAAFdLZ58jVOefDSU + L8F5R1rtvBs93GDa56f926jNJ6pLewLC+/2+757W+SAI+PRLntM7Kg3bXm/Q2QH+ + Q1Y+MflZmspbWCdI61L5GIGoYKyeers59i+FpvySj5GHtLQRiTZ0+Kv1AXHSDWBm + 9XneUOqU3IbZe0ifu1RRno72/VtjkGXbW8Mkkw+ohyGbIeTx/0/JQ6sSNZTT3Vk7 + 8i4IXptq3HSF0/vqZuah8rShoeNq72pD1YLM9YPdL5by1QkDLnqATDiCpLBTCaNV + I8sqYEun+HYbQzBj8ZACG2JVZpEEidONWQHw5BPWO95DSZYrVnEkuCqeH+u5vYt7 + CHuJ3AECgYEA+W3v5z+j91w1VPHS0VB3SCDMouycAMIUnJPAbt+0LPP0scUFsBGE + hPAKddC54pmMZRQ2KIwBKiyWfCrJ8Xz8Yogn7fJgmwTHidJBr2WQpIEkNGlK3Dzi + jXL2sh0yC7sHvn0DqiQ79l/e7yRbSnv2wrTJEczOOH2haD7/tBRyCYECgYEA8W+q + E9YyGvEltnPFaOxofNZ8LHVcZSsQI5b6fc0iE7fjxFqeXPXEwGSOTwqQLQRiHn9b + CfPmIG4Vhyq0otVmlPvUnfBZ2OK+tl5X2/mQFO3ROMdvpi0KYa994uqfJdSTaqLn + jjoKFB906UFHnDQDLZUNiV1WwnkTglgLc+xrd6cCgYEAqqthyv6NyBTM3Tm2gcio + Ra9Dtntl51LlXZnvwy3IkDXBCd6BHM9vuLKyxZiziGx+Vy90O1xI872cnot8sINQ + Am+dur/tAEVN72zxyv0Y8qb2yfH96iKy9gxi5s75TnOEQgAygLnYWaWR2lorKRUX + bHTdXBOiS58S0UzCFEslGIECgYBqkO4SKWYeTDhoKvuEj2yjRYyzlu28XeCWxOo1 + otiauX0YSyNBRt2cSgYiTzhKFng0m+QUJYp63/wymB/5C5Zmxi0XtWIDADpLhqLj + HmmBQ2Mo26alQ5YkffBju0mZyhVzaQop1eZi8WuKFV1FThPlB7hc3E0SM5zv2Grd + tQnOWwKBgQC40yZY0PcjuILhy+sIc0Wvh7LUA7taSdTye149kRvbvsCDN7Jh75lM + USjhLXY0Nld2zBm9r8wMb81mXH29uvD+tDqqsICvyuKlA/tyzXR+QTr7dCVKVwu0 + 1YjCJ36UpTsLre2f8nOSLtNmRfDPtbOE2mkOoO9dD9UU0XZwnvn9xw== + -----END RSA PRIVATE KEY----- + base_dn: dc=example,dc=com + username_attribute: uid + additional_users_dn: ou=users + users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) + additional_groups_dn: ou=groups + groups_filter: (&(member={dn})(objectClass=groupOfNames)) + group_name_attribute: cn + mail_attribute: mail + user: cn=admin,dc=example,dc=com + +access_control: + default_policy: deny + + rules: + # Rules applied to everyone + - domain: public.example.com + policy: bypass + + - domain: secure.example.com + policy: one_factor + # Network based rule, if not provided any network matches. + networks: + - 192.168.1.0/24 + - domain: secure.example.com + policy: two_factor + + - domain: [singlefactor.example.com, onefactor.example.com] + policy: one_factor + + # Rules applied to 'admins' group + - domain: "mx2.mail.example.com" + subject: "group:admins" + policy: deny + - domain: "*.example.com" + subject: "group:admins" + policy: two_factor + + # Rules applied to 'dev' group + - domain: dev.example.com + resources: + - "^/groups/dev/.*$" + subject: "group:dev" + policy: two_factor + + # Rules applied to user 'john' + - domain: dev.example.com + resources: + - "^/users/john/.*$" + subject: "user:john" + policy: two_factor + + # Rules applied to 'dev' group and user 'john' + - domain: dev.example.com + resources: + - "^/deny-all.*$" + subject: ["group:dev", "user:john"] + policy: deny + + # Rules applied to user 'harry' + - domain: dev.example.com + resources: + - "^/users/harry/.*$" + subject: "user:harry" + policy: two_factor + + # Rules applied to user 'bob' + - domain: "*.mail.example.com" + subject: "user:bob" + policy: two_factor + - domain: "dev.example.com" + resources: + - "^/users/bob/.*$" + subject: "user:bob" + policy: two_factor + +session: + name: authelia_session + expiration: 3600000 # 1 hour + inactivity: 300000 # 5 minutes + domain: example.com + redis: + host: 127.0.0.1 + port: 6379 + high_availability: + sentinel_name: test + +regulation: + max_retries: 3 + find_time: 120 + ban_time: 300 + +storage: + postgres: + host: 127.0.0.1 + port: 5432 + database: authelia + username: authelia + +notifier: + smtp: + username: test + host: 127.0.0.1 + port: 1025 + sender: admin@example.com + disable_require_tls: true +... diff --git a/internal/configuration/test_resources/config.deprecated.yml b/internal/configuration/test_resources/config.deprecated.yml new file mode 100644 index 000000000..24a577b4f --- /dev/null +++ b/internal/configuration/test_resources/config.deprecated.yml @@ -0,0 +1,173 @@ +--- +default_redirection_url: https://home.example.com:8080/ + +server: + address: "tcp://127.0.0.1:9091" + endpoints: + authz: + forward-auth: + implementation: ForwardAuth + authn_strategies: + - name: HeaderProxyAuthorization + - name: CookieSession + ext-authz: + implementation: ExtAuthz + authn_strategies: + - name: HeaderProxyAuthorization + - name: CookieSession + auth-request: + implementation: AuthRequest + authn_strategies: + - name: HeaderAuthRequestProxyAuthorization + - name: CookieSession + legacy: + implementation: Legacy + +log: + level: debug + +totp: + issuer: authelia.com + +duo_api: + hostname: api-123456789.example.com + integration_key: ABCDEF + +authentication_backend: + ldap: + url: 'ldap://127.0.0.1' + tls: + private_key: | + -----BEGIN RSA PRIVATE KEY----- + MIIEpAIBAAKCAQEA6z1LOg1ZCqb0lytXWZ+MRBpMHEXOoTOLYgfZXt1IYyE3Z758 + cyalk0NYQhY5cZDsXPYWPvAHiPMUxutWkoxFwby56S+AbIMa3/Is+ILrHRJs8Exn + ZkpyrYFxPX12app2kErdmAkHSx0Z5/kuXiz96PHs8S8/ZbyZolLHzdfLtSzjvRm5 + Zue5iFzsf19NJz5CIBfv8g5lRwtE8wNJoRSpn1xq7fqfuA0weDNFPzjlNWRLy6aa + rK7qJexRkmkCs4sLgyl+9NODYJpvmN8E1yhyC27E0joI6rBFVW7Ihv+cSPCdDzGp + EWe81x3AeqAa3mjVqkiq4u4Z2i8JDgBaPboqJwIDAQABAoIBAAFdLZ58jVOefDSU + L8F5R1rtvBs93GDa56f926jNJ6pLewLC+/2+757W+SAI+PRLntM7Kg3bXm/Q2QH+ + Q1Y+MflZmspbWCdI61L5GIGoYKyeers59i+FpvySj5GHtLQRiTZ0+Kv1AXHSDWBm + 9XneUOqU3IbZe0ifu1RRno72/VtjkGXbW8Mkkw+ohyGbIeTx/0/JQ6sSNZTT3Vk7 + 8i4IXptq3HSF0/vqZuah8rShoeNq72pD1YLM9YPdL5by1QkDLnqATDiCpLBTCaNV + I8sqYEun+HYbQzBj8ZACG2JVZpEEidONWQHw5BPWO95DSZYrVnEkuCqeH+u5vYt7 + CHuJ3AECgYEA+W3v5z+j91w1VPHS0VB3SCDMouycAMIUnJPAbt+0LPP0scUFsBGE + hPAKddC54pmMZRQ2KIwBKiyWfCrJ8Xz8Yogn7fJgmwTHidJBr2WQpIEkNGlK3Dzi + jXL2sh0yC7sHvn0DqiQ79l/e7yRbSnv2wrTJEczOOH2haD7/tBRyCYECgYEA8W+q + E9YyGvEltnPFaOxofNZ8LHVcZSsQI5b6fc0iE7fjxFqeXPXEwGSOTwqQLQRiHn9b + CfPmIG4Vhyq0otVmlPvUnfBZ2OK+tl5X2/mQFO3ROMdvpi0KYa994uqfJdSTaqLn + jjoKFB906UFHnDQDLZUNiV1WwnkTglgLc+xrd6cCgYEAqqthyv6NyBTM3Tm2gcio + Ra9Dtntl51LlXZnvwy3IkDXBCd6BHM9vuLKyxZiziGx+Vy90O1xI872cnot8sINQ + Am+dur/tAEVN72zxyv0Y8qb2yfH96iKy9gxi5s75TnOEQgAygLnYWaWR2lorKRUX + bHTdXBOiS58S0UzCFEslGIECgYBqkO4SKWYeTDhoKvuEj2yjRYyzlu28XeCWxOo1 + otiauX0YSyNBRt2cSgYiTzhKFng0m+QUJYp63/wymB/5C5Zmxi0XtWIDADpLhqLj + HmmBQ2Mo26alQ5YkffBju0mZyhVzaQop1eZi8WuKFV1FThPlB7hc3E0SM5zv2Grd + tQnOWwKBgQC40yZY0PcjuILhy+sIc0Wvh7LUA7taSdTye149kRvbvsCDN7Jh75lM + USjhLXY0Nld2zBm9r8wMb81mXH29uvD+tDqqsICvyuKlA/tyzXR+QTr7dCVKVwu0 + 1YjCJ36UpTsLre2f8nOSLtNmRfDPtbOE2mkOoO9dD9UU0XZwnvn9xw== + -----END RSA PRIVATE KEY----- + base_dn: dc=example,dc=com + username_attribute: uid + additional_users_dn: ou=users + users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) + additional_groups_dn: ou=groups + groups_filter: (&(member={dn})(objectClass=groupOfNames)) + group_name_attribute: cn + mail_attribute: mail + user: cn=admin,dc=example,dc=com + +access_control: + default_policy: deny + + rules: + # Rules applied to everyone + - domain: public.example.com + policy: bypass + + - domain: secure.example.com + policy: one_factor + # Network based rule, if not provided any network matches. + networks: + - 192.168.1.0/24 + - domain: secure.example.com + policy: two_factor + + - domain: [singlefactor.example.com, onefactor.example.com] + policy: one_factor + + # Rules applied to 'admins' group + - domain: "mx2.mail.example.com" + subject: "group:admins" + policy: deny + - domain: "*.example.com" + subject: "group:admins" + policy: two_factor + + # Rules applied to 'dev' group + - domain: dev.example.com + resources: + - "^/groups/dev/.*$" + subject: "group:dev" + policy: two_factor + + # Rules applied to user 'john' + - domain: dev.example.com + resources: + - "^/users/john/.*$" + subject: "user:john" + policy: two_factor + + # Rules applied to 'dev' group and user 'john' + - domain: dev.example.com + resources: + - "^/deny-all.*$" + subject: ["group:dev", "user:john"] + policy: deny + + # Rules applied to user 'harry' + - domain: dev.example.com + resources: + - "^/users/harry/.*$" + subject: "user:harry" + policy: two_factor + + # Rules applied to user 'bob' + - domain: "*.mail.example.com" + subject: "user:bob" + policy: two_factor + - domain: "dev.example.com" + resources: + - "^/users/bob/.*$" + subject: "user:bob" + policy: two_factor + +session: + name: authelia_session + expiration: 3600000 # 1 hour + inactivity: 300000 # 5 minutes + domain: example.com + redis: + host: 127.0.0.1 + port: 6379 + high_availability: + sentinel_name: test + +regulation: + max_retries: 3 + find_time: 120 + ban_time: 300 + +storage: + mysql: + host: 127.0.0.1 + port: 3306 + database: authelia + username: authelia + +notifier: + smtp: + username: test + host: 127.0.0.1 + port: 1025 + sender: admin@example.com + disable_require_tls: true +... diff --git a/internal/configuration/test_resources/config.filtered.yml b/internal/configuration/test_resources/config.filtered.yml index 8917d3253..aa7f5ca27 100644 --- a/internal/configuration/test_resources/config.filtered.yml +++ b/internal/configuration/test_resources/config.filtered.yml @@ -16,7 +16,7 @@ duo_api: authentication_backend: ldap: - url: 'ldap://{{ env "SERVICES_SERVER" }}' + address: 'ldap://{{ env "SERVICES_SERVER" }}' tls: private_key: | -----BEGIN RSA PRIVATE KEY----- @@ -161,16 +161,14 @@ regulation: storage: mysql: - host: '{{ env "SERVICES_SERVER" }}' - port: 3306 + address: 'tcp://{{ env "SERVICES_SERVER" }}:3306' database: authelia username: authelia notifier: smtp: username: test - host: '{{ env "SERVICES_SERVER" }}' - port: 1025 + address: 'smtp://{{ env "SERVICES_SERVER" }}:1025' sender: 'admin@{{ env "ROOT_DOMAIN" }}' disable_require_tls: true diff --git a/internal/configuration/test_resources/config.yml b/internal/configuration/test_resources/config.yml index 9705b64f6..816e422ce 100644 --- a/internal/configuration/test_resources/config.yml +++ b/internal/configuration/test_resources/config.yml @@ -1,41 +1,41 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' endpoints: authz: forward-auth: - implementation: ForwardAuth + implementation: 'ForwardAuth' authn_strategies: - - name: HeaderProxyAuthorization - - name: CookieSession + - name: 'HeaderProxyAuthorization' + - name: 'CookieSession' ext-authz: - implementation: ExtAuthz + implementation: 'ExtAuthz' authn_strategies: - - name: HeaderProxyAuthorization - - name: CookieSession + - name: 'HeaderProxyAuthorization' + - name: 'CookieSession' auth-request: - implementation: AuthRequest + implementation: 'AuthRequest' authn_strategies: - - name: HeaderAuthRequestProxyAuthorization - - name: CookieSession + - name: 'HeaderAuthRequestProxyAuthorization' + - name: 'CookieSession' legacy: - implementation: Legacy + implementation: 'Legacy' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 + address: 'ldap://127.0.0.1' tls: private_key: | -----BEGIN RSA PRIVATE KEY----- @@ -65,109 +65,107 @@ authentication_backend: USjhLXY0Nld2zBm9r8wMb81mXH29uvD+tDqqsICvyuKlA/tyzXR+QTr7dCVKVwu0 1YjCJ36UpTsLre2f8nOSLtNmRfDPtbOE2mkOoO9dD9UU0XZwnvn9xw== -----END RSA PRIVATE KEY----- - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_alt.yml b/internal/configuration/test_resources/config_alt.yml index 6697bd4b7..ec9177f72 100644 --- a/internal/configuration/test_resources/config_alt.yml +++ b/internal/configuration/test_resources/config_alt.yml @@ -1,124 +1,122 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes remember_me: -1 - domain: example.com + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: postgres: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:5432' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: Admin + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'Admin ' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_bad_keys.yml b/internal/configuration/test_resources/config_bad_keys.yml index 8d27b1f67..fc898ac75 100644 --- a/internal/configuration/test_resources/config_bad_keys.yml +++ b/internal/configuration/test_resources/config_bad_keys.yml @@ -1,124 +1,122 @@ --- -loggy_file: /config/svc.log +loggy_file: '/config/svc.log' -logs_level: debug +logs_level: 'debug' -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_bad_quoting.yml b/internal/configuration/test_resources/config_bad_quoting.yml index 59db7a7d6..3bf7c4be0 100644 --- a/internal/configuration/test_resources/config_bad_quoting.yml +++ b/internal/configuration/test_resources/config_bad_quoting.yml @@ -1,56 +1,54 @@ --- -jwt_secret: RUtG9TnbXrOl1XLLmDgySw1DGgx9QcrtepIf1uDDBlBVKFZxkVBruYKBi32PvaU +jwt_secret: 'RUtG9TnbXrOl1XLLmDgySw1DGgx9QcrtepIf1uDDBlBVKFZxkVBruYKBi32PvaU' -default_redirection_url: example.com +default_redirection_url: 'example.com' server: - address: "tcp://0.0.0.0:9091" + address: 'tcp://:9091' log: - level: debug + level: 'debug' totp: - issuer: example.com + issuer: 'example.com' period: 30 skew: 1 authentication_backend: file: - path: /config/users_database.yml + path: '/config/users_database.yml' access_control: - default_policy: deny + default_policy: 'deny' rules: - - domain: example.com - policy: bypass - - domain: *.example.com - policy: one_factor + - domain: 'example.com' + policy: 'bypass' + - domain: '*.example.com' + policy: 'one_factor' session: - name: authelia_session - secret: TVPMIcDFbBwhnW3kLJzKhdjeHhtqisr7m28FgRY8oLh2A4lwuV2jV2ZGdGbh4aa - expiration: 3600 - inactivity: 300 - domain: example.com + name: 'authelia_session' + secret: 'TVPMIcDFbBwhnW3kLJzKhdjeHhtqisr7m28FgRY8oLh2A4lwuV2jV2ZGdGbh4aa' + expiration: '1h' + inactivity: '5m' + domain: 'example.com' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: example.com - port: 3306 - database: authelia - username: authelia - password: example.com + address: 'tcp://example.com:3306' + database: 'authelia' + username: 'authelia' + password: 'example.com' notifier: smtp: - username: example.com - password: example.com - host: smtp.gmail.com - port: 465 - sender: example.com + address: 'submissions://smtp.gmail.com:465' + username: 'example.com' + password: 'example.com' + sender: 'example.com' ... diff --git a/internal/configuration/test_resources/config_domain_bad_regex.yml b/internal/configuration/test_resources/config_domain_bad_regex.yml index 4e7be7ad4..7c8250dae 100644 --- a/internal/configuration/test_resources/config_domain_bad_regex.yml +++ b/internal/configuration/test_resources/config_domain_bad_regex.yml @@ -1,125 +1,123 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain_regex: ^\K(public|public2).example.com$ - policy: bypass + - domain_regex: '^\K(public|public2).example.com$' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_domain_regex.yml b/internal/configuration/test_resources/config_domain_regex.yml index 360e1787c..78a486d21 100644 --- a/internal/configuration/test_resources/config_domain_regex.yml +++ b/internal/configuration/test_resources/config_domain_regex.yml @@ -1,131 +1,129 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain_regex: ^(public|public2).example.com$ - policy: bypass + - domain_regex: '^(public|public2).example.com$' + policy: 'bypass' - - domain_regex: ^portfolio-(?P[a-zA-Z0-9]+).example.com$ - policy: one_factor + - domain_regex: '^portfolio-(?P[a-zA-Z0-9]+).example.com$' + policy: 'one_factor' - - domain_regex: ^portfolio-(?P[a-zA-Z0-9]+)-(?P[a-zA-Z0-9]+).example.com$ - policy: one_factor + - domain_regex: '^portfolio-(?P[a-zA-Z0-9]+)-(?P[a-zA-Z0-9]+).example.com$' + policy: 'one_factor' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_oidc.yml b/internal/configuration/test_resources/config_oidc.yml index da72366a0..076d5ae82 100644 --- a/internal/configuration/test_resources/config_oidc.yml +++ b/internal/configuration/test_resources/config_oidc.yml @@ -1,136 +1,134 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true identity_providers: oidc: cors: allowed_origins: - - https://google.com - - https://example.com + - 'https://google.com' + - 'https://example.com' clients: - - id: abc + - id: 'abc' secret: '123' - consent_mode: explicit + consent_mode: 'explicit' ... diff --git a/internal/configuration/test_resources/config_smtp_sender_blank.yml b/internal/configuration/test_resources/config_smtp_sender_blank.yml index 3af9013c0..0fe8205a5 100644 --- a/internal/configuration/test_resources/config_smtp_sender_blank.yml +++ b/internal/configuration/test_resources/config_smtp_sender_blank.yml @@ -1,125 +1,123 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: "" + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: '' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_smtp_sender_invalid.yml b/internal/configuration/test_resources/config_smtp_sender_invalid.yml index 9d0dc5b25..8d2b55a35 100644 --- a/internal/configuration/test_resources/config_smtp_sender_invalid.yml +++ b/internal/configuration/test_resources/config_smtp_sender_invalid.yml @@ -1,125 +1,123 @@ --- -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 high_availability: - sentinel_name: test + sentinel_name: 'test' regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin' disable_require_tls: true ... diff --git a/internal/configuration/test_resources/config_with_secret.yml b/internal/configuration/test_resources/config_with_secret.yml index 6efca13c9..aa2b3acc9 100644 --- a/internal/configuration/test_resources/config_with_secret.yml +++ b/internal/configuration/test_resources/config_with_secret.yml @@ -1,125 +1,123 @@ --- -jwt_secret: secret_from_config +jwt_secret: 'secret_from_config' -default_redirection_url: https://home.example.com:8080/ +default_redirection_url: 'https://home.example.com:8080/' server: - address: "tcp://127.0.0.1:9091" + address: 'tcp://127.0.0.1:9091' log: - level: debug + level: 'debug' totp: - issuer: authelia.com + issuer: 'authelia.com' duo_api: - hostname: api-123456789.example.com - integration_key: ABCDEF + hostname: 'api-123456789.example.com' + integration_key: 'ABCDEF' authentication_backend: ldap: - url: ldap://127.0.0.1 - base_dn: dc=example,dc=com - username_attribute: uid - additional_users_dn: ou=users - users_filter: (&({username_attribute}={input})(objectCategory=person)(objectClass=user)) - additional_groups_dn: ou=groups - groups_filter: (&(member={dn})(objectClass=groupOfNames)) - group_name_attribute: cn - mail_attribute: mail - user: cn=admin,dc=example,dc=com + address: 'ldap://127.0.0.1' + base_dn: 'dc=example,dc=com' + username_attribute: 'uid' + additional_users_dn: 'ou=users' + users_filter: '(&({username_attribute}={input})(objectCategory=person)(objectClass=user))' + additional_groups_dn: 'ou=groups' + groups_filter: '(&(member={dn})(objectClass=groupOfNames))' + group_name_attribute: 'cn' + mail_attribute: 'mail' + user: 'cn=admin,dc=example,dc=com' access_control: - default_policy: deny + default_policy: 'deny' rules: # Rules applied to everyone - - domain: public.example.com - policy: bypass + - domain: 'public.example.com' + policy: 'bypass' - - domain: secure.example.com - policy: one_factor + - domain: 'secure.example.com' + policy: 'one_factor' # Network based rule, if not provided any network matches. networks: - - 192.168.1.0/24 - - domain: secure.example.com - policy: two_factor + - '192.168.1.0/24' + - domain: 'secure.example.com' + policy: 'two_factor' - - domain: [singlefactor.example.com, onefactor.example.com] - policy: one_factor + - domain: ['singlefactor.example.com', 'onefactor.example.com'] + policy: 'one_factor' # Rules applied to 'admins' group - - domain: "mx2.mail.example.com" - subject: "group:admins" - policy: deny - - domain: "*.example.com" - subject: "group:admins" - policy: two_factor + - domain: 'mx2.mail.example.com' + subject: 'group:admins' + policy: 'deny' + - domain: '*.example.com' + subject: 'group:admins' + policy: 'two_factor' # Rules applied to 'dev' group - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/groups/dev/.*$" - subject: "group:dev" - policy: two_factor + - '^/groups/dev/.*$' + subject: 'group:dev' + policy: 'two_factor' # Rules applied to user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/john/.*$" - subject: "user:john" - policy: two_factor + - '^/users/john/.*$' + subject: 'user:john' + policy: 'two_factor' # Rules applied to 'dev' group and user 'john' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/deny-all.*$" - subject: ["group:dev", "user:john"] - policy: deny + - '^/deny-all.*$' + subject: ['group:dev', 'user:john'] + policy: 'deny' # Rules applied to user 'harry' - - domain: dev.example.com + - domain: 'dev.example.com' resources: - - "^/users/harry/.*$" - subject: "user:harry" - policy: two_factor + - '^/users/harry/.*$' + subject: 'user:harry' + policy: 'two_factor' # Rules applied to user 'bob' - - domain: "*.mail.example.com" - subject: "user:bob" - policy: two_factor - - domain: "dev.example.com" + - domain: '*.mail.example.com' + subject: 'user:bob' + policy: 'two_factor' + - domain: 'dev.example.com' resources: - - "^/users/bob/.*$" - subject: "user:bob" - policy: two_factor + - '^/users/bob/.*$' + subject: 'user:bob' + policy: 'two_factor' session: - name: authelia_session - expiration: 3600000 # 1 hour - inactivity: 300000 # 5 minutes - domain: example.com + name: 'authelia_session' + expiration: '1h' # 1 hour + inactivity: '5m' # 5 minutes + domain: 'example.com' redis: - host: 127.0.0.1 + host: '127.0.0.1' port: 6379 regulation: max_retries: 3 - find_time: 120 - ban_time: 300 + find_time: '2m' + ban_time: '5m' storage: mysql: - host: 127.0.0.1 - port: 3306 - database: authelia - username: authelia + address: 'tcp://127.0.0.1:3306' + database: 'authelia' + username: 'authelia' notifier: smtp: - username: test - host: 127.0.0.1 - port: 1025 - sender: admin@example.com + address: 'smtp://127.0.0.1:1025' + username: 'test' + sender: 'admin@example.com' disable_require_tls: true ... diff --git a/internal/configuration/validator/authentication.go b/internal/configuration/validator/authentication.go index fb209f179..cf90832bc 100644 --- a/internal/configuration/validator/authentication.go +++ b/internal/configuration/validator/authentication.go @@ -2,7 +2,6 @@ package validator import ( "fmt" - "net/url" "strings" "github.com/go-crypt/crypt/algorithm/argon2" @@ -323,11 +322,7 @@ func validateLDAPAuthenticationBackend(config *schema.AuthenticationBackend, val defaultTLS := validateLDAPAuthenticationBackendImplementation(config, validator) - if config.LDAP.URL == "" { - validator.Push(fmt.Errorf(errFmtLDAPAuthBackendMissingOption, "url")) - } else { - defaultTLS.ServerName = validateLDAPAuthenticationBackendURL(config.LDAP, validator) - } + defaultTLS.ServerName = validateLDAPAuthenticationAddress(config.LDAP, validator) if config.LDAP.TLS == nil { config.LDAP.TLS = &schema.TLSConfig{} @@ -428,27 +423,22 @@ func setDefaultImplementationLDAPAuthenticationBackendProfileAttributes(config * } } -func validateLDAPAuthenticationBackendURL(config *schema.LDAPAuthenticationBackend, validator *schema.StructValidator) (hostname string) { +func validateLDAPAuthenticationAddress(config *schema.LDAPAuthenticationBackend, validator *schema.StructValidator) (hostname string) { + if config.Address == nil { + validator.Push(fmt.Errorf(errFmtLDAPAuthBackendMissingOption, "address")) + + return + } + var ( - parsedURL *url.URL - err error + err error ) - if parsedURL, err = url.Parse(config.URL); err != nil { - validator.Push(fmt.Errorf(errFmtLDAPAuthBackendURLNotParsable, err)) - - return + if err = config.Address.ValidateLDAP(); err != nil { + validator.Push(fmt.Errorf(errFmtLDAPAuthBackendAddress, config.Address.String(), err)) } - if parsedURL.Scheme != schemeLDAP && parsedURL.Scheme != schemeLDAPS { - validator.Push(fmt.Errorf(errFmtLDAPAuthBackendURLInvalidScheme, parsedURL.Scheme)) - - return - } - - config.URL = parsedURL.String() - - return parsedURL.Hostname() + return config.Address.Hostname() } func validateLDAPRequiredParameters(config *schema.AuthenticationBackend, validator *schema.StructValidator) { diff --git a/internal/configuration/validator/authentication_test.go b/internal/configuration/validator/authentication_test.go index 9abec6e1a..fa5c4830d 100644 --- a/internal/configuration/validator/authentication_test.go +++ b/internal/configuration/validator/authentication_test.go @@ -26,7 +26,7 @@ func TestShouldRaiseErrorWhenBothBackendsProvided(t *testing.T) { require.Len(t, validator.Errors(), 7) assert.EqualError(t, validator.Errors()[0], "authentication_backend: please ensure only one of the 'file' or 'ldap' backend is configured") - assert.EqualError(t, validator.Errors()[1], "authentication_backend: ldap: option 'url' is required") + assert.EqualError(t, validator.Errors()[1], "authentication_backend: ldap: option 'address' is required") assert.EqualError(t, validator.Errors()[2], "authentication_backend: ldap: option 'user' is required") assert.EqualError(t, validator.Errors()[3], "authentication_backend: ldap: option 'password' is required") assert.EqualError(t, validator.Errors()[4], "authentication_backend: ldap: option 'base_dn' is required") @@ -61,8 +61,8 @@ func (suite *FileBasedAuthenticationBackend) SetupTest() { func (suite *FileBasedAuthenticationBackend) TestShouldValidateCompleteConfiguration() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenNoPathProvided() { @@ -70,38 +70,38 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenNoPathProvi ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: option 'path' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: option 'path' is required") } func (suite *FileBasedAuthenticationBackend) TestShouldSetDefaultConfigurationWhenBlank() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal(0, suite.config.File.Password.KeyLength) - suite.Assert().Equal(0, suite.config.File.Password.Iterations) - suite.Assert().Equal(0, suite.config.File.Password.SaltLength) - suite.Assert().Equal("", suite.config.File.Password.Algorithm) - suite.Assert().Equal(0, suite.config.File.Password.Memory) - suite.Assert().Equal(0, suite.config.File.Password.Parallelism) + suite.Equal(0, suite.config.File.Password.KeyLength) + suite.Equal(0, suite.config.File.Password.Iterations) + suite.Equal(0, suite.config.File.Password.SaltLength) + suite.Equal("", suite.config.File.Password.Algorithm) + suite.Equal(0, suite.config.File.Password.Memory) + suite.Equal(0, suite.config.File.Password.Parallelism) ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(schema.DefaultPasswordConfig.KeyLength, suite.config.File.Password.KeyLength) - suite.Assert().Equal(schema.DefaultPasswordConfig.Iterations, suite.config.File.Password.Iterations) - suite.Assert().Equal(schema.DefaultPasswordConfig.SaltLength, suite.config.File.Password.SaltLength) - suite.Assert().Equal(schema.DefaultPasswordConfig.Algorithm, suite.config.File.Password.Algorithm) - suite.Assert().Equal(schema.DefaultPasswordConfig.Memory, suite.config.File.Password.Memory) - suite.Assert().Equal(schema.DefaultPasswordConfig.Parallelism, suite.config.File.Password.Parallelism) + suite.Equal(schema.DefaultPasswordConfig.KeyLength, suite.config.File.Password.KeyLength) + suite.Equal(schema.DefaultPasswordConfig.Iterations, suite.config.File.Password.Iterations) + suite.Equal(schema.DefaultPasswordConfig.SaltLength, suite.config.File.Password.SaltLength) + suite.Equal(schema.DefaultPasswordConfig.Algorithm, suite.config.File.Password.Algorithm) + suite.Equal(schema.DefaultPasswordConfig.Memory, suite.config.File.Password.Memory) + suite.Equal(schema.DefaultPasswordConfig.Parallelism, suite.config.File.Password.Parallelism) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationSHA512() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password = schema.Password{ Algorithm: digestSHA512, @@ -111,18 +111,18 @@ func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfiguratio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) - suite.Assert().Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) - suite.Assert().Equal(1000000, suite.config.File.Password.SHA2Crypt.Iterations) - suite.Assert().Equal(8, suite.config.File.Password.SHA2Crypt.SaltLength) + suite.Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) + suite.Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) + suite.Equal(1000000, suite.config.File.Password.SHA2Crypt.Iterations) + suite.Equal(8, suite.config.File.Password.SHA2Crypt.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationSHA512ButNotOverride() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password = schema.Password{ Algorithm: digestSHA512, @@ -137,18 +137,18 @@ func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfiguratio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) - suite.Assert().Equal(digestSHA256, suite.config.File.Password.SHA2Crypt.Variant) - suite.Assert().Equal(50000, suite.config.File.Password.SHA2Crypt.Iterations) - suite.Assert().Equal(12, suite.config.File.Password.SHA2Crypt.SaltLength) + suite.Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) + suite.Equal(digestSHA256, suite.config.File.Password.SHA2Crypt.Variant) + suite.Equal(50000, suite.config.File.Password.SHA2Crypt.Iterations) + suite.Equal(12, suite.config.File.Password.SHA2Crypt.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationSHA512Alt() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password = schema.Password{ Algorithm: digestSHA512, @@ -158,18 +158,18 @@ func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfiguratio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) - suite.Assert().Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) - suite.Assert().Equal(1000000, suite.config.File.Password.SHA2Crypt.Iterations) - suite.Assert().Equal(16, suite.config.File.Password.SHA2Crypt.SaltLength) + suite.Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) + suite.Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) + suite.Equal(1000000, suite.config.File.Password.SHA2Crypt.Iterations) + suite.Equal(16, suite.config.File.Password.SHA2Crypt.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationArgon2() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password = schema.Password{ Algorithm: "argon2id", @@ -182,21 +182,21 @@ func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfiguratio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("argon2", suite.config.File.Password.Algorithm) - suite.Assert().Equal("argon2id", suite.config.File.Password.Argon2.Variant) - suite.Assert().Equal(4, suite.config.File.Password.Argon2.Iterations) - suite.Assert().Equal(1048576, suite.config.File.Password.Argon2.Memory) - suite.Assert().Equal(4, suite.config.File.Password.Argon2.Parallelism) - suite.Assert().Equal(64, suite.config.File.Password.Argon2.KeyLength) - suite.Assert().Equal(64, suite.config.File.Password.Argon2.SaltLength) + suite.Equal("argon2", suite.config.File.Password.Algorithm) + suite.Equal("argon2id", suite.config.File.Password.Argon2.Variant) + suite.Equal(4, suite.config.File.Password.Argon2.Iterations) + suite.Equal(1048576, suite.config.File.Password.Argon2.Memory) + suite.Equal(4, suite.config.File.Password.Argon2.Parallelism) + suite.Equal(64, suite.config.File.Password.Argon2.KeyLength) + suite.Equal(64, suite.config.File.Password.Argon2.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationArgon2ButNotOverride() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password = schema.Password{ Algorithm: "argon2id", @@ -217,102 +217,102 @@ func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfiguratio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("argon2", suite.config.File.Password.Algorithm) - suite.Assert().Equal("argon2d", suite.config.File.Password.Argon2.Variant) - suite.Assert().Equal(1, suite.config.File.Password.Argon2.Iterations) - suite.Assert().Equal(2048, suite.config.File.Password.Argon2.Memory) - suite.Assert().Equal(1, suite.config.File.Password.Argon2.Parallelism) - suite.Assert().Equal(32, suite.config.File.Password.Argon2.KeyLength) - suite.Assert().Equal(32, suite.config.File.Password.Argon2.SaltLength) + suite.Equal("argon2", suite.config.File.Password.Algorithm) + suite.Equal("argon2d", suite.config.File.Password.Argon2.Variant) + suite.Equal(1, suite.config.File.Password.Argon2.Iterations) + suite.Equal(2048, suite.config.File.Password.Argon2.Memory) + suite.Equal(1, suite.config.File.Password.Argon2.Parallelism) + suite.Equal(32, suite.config.File.Password.Argon2.KeyLength) + suite.Equal(32, suite.config.File.Password.Argon2.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldMigrateLegacyConfigurationWhenOnlySHA512Set() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = digestSHA512 ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) - suite.Assert().Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) - suite.Assert().Equal(schema.DefaultPasswordConfig.SHA2Crypt.Iterations, suite.config.File.Password.SHA2Crypt.Iterations) - suite.Assert().Equal(schema.DefaultPasswordConfig.SHA2Crypt.SaltLength, suite.config.File.Password.SHA2Crypt.SaltLength) + suite.Equal(hashSHA2Crypt, suite.config.File.Password.Algorithm) + suite.Equal(digestSHA512, suite.config.File.Password.SHA2Crypt.Variant) + suite.Equal(schema.DefaultPasswordConfig.SHA2Crypt.Iterations, suite.config.File.Password.SHA2Crypt.Iterations) + suite.Equal(schema.DefaultPasswordConfig.SHA2Crypt.SaltLength, suite.config.File.Password.SHA2Crypt.SaltLength) } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorOnInvalidArgon2Variant() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = "argon2" suite.config.File.Password.Argon2.Variant = testInvalid ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'variant' must be one of 'argon2id', 'id', 'argon2i', 'i', 'argon2d', or 'd' but it's configured as 'invalid'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'variant' must be one of 'argon2id', 'id', 'argon2i', 'i', 'argon2d', or 'd' but it's configured as 'invalid'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorOnInvalidSHA2CryptVariant() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = hashSHA2Crypt suite.config.File.Password.SHA2Crypt.Variant = testInvalid ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'variant' must be one of 'sha256' or 'sha512' but it's configured as 'invalid'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'variant' must be one of 'sha256' or 'sha512' but it's configured as 'invalid'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorOnInvalidSHA2CryptSaltLength() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = hashSHA2Crypt suite.config.File.Password.SHA2Crypt.SaltLength = 40 ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '40' but must be less than or equal to '16'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '40' but must be less than or equal to '16'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorOnInvalidPBKDF2Variant() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = "pbkdf2" suite.config.File.Password.PBKDF2.Variant = testInvalid ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'variant' must be one of 'sha1', 'sha224', 'sha256', 'sha384', or 'sha512' but it's configured as 'invalid'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'variant' must be one of 'sha1', 'sha224', 'sha256', 'sha384', or 'sha512' but it's configured as 'invalid'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorOnInvalidBCryptVariant() { suite.config.File.Password = schema.Password{} - suite.Assert().Equal("", suite.config.File.Password.Algorithm) + suite.Equal("", suite.config.File.Password.Algorithm) suite.config.File.Password.Algorithm = "bcrypt" suite.config.File.Password.BCrypt.Variant = testInvalid ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'variant' must be one of 'standard' or 'sha256' but it's configured as 'invalid'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'variant' must be one of 'standard' or 'sha256' but it's configured as 'invalid'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSHA2CryptOptionsTooLow() { @@ -321,11 +321,11 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSHA2CryptOp ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 2) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'iterations' is configured as '-1' but must be greater than or equal to '1000'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '-1' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'iterations' is configured as '-1' but must be greater than or equal to '1000'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '-1' but must be greater than or equal to '1'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSHA2CryptOptionsTooHigh() { @@ -334,11 +334,11 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSHA2CryptOp ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 2) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'iterations' is configured as '999999999999' but must be less than or equal to '999999999'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '99' but must be less than or equal to '16'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: sha2crypt: option 'iterations' is configured as '999999999999' but must be less than or equal to '999999999'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: sha2crypt: option 'salt_length' is configured as '99' but must be less than or equal to '16'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenPBKDF2OptionsTooLow() { @@ -347,11 +347,11 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenPBKDF2Optio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 2) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'iterations' is configured as '-1' but must be greater than or equal to '100000'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: pbkdf2: option 'salt_length' is configured as '-1' but must be greater than or equal to '8'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'iterations' is configured as '-1' but must be greater than or equal to '100000'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: pbkdf2: option 'salt_length' is configured as '-1' but must be greater than or equal to '8'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenPBKDF2OptionsTooHigh() { @@ -360,11 +360,11 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenPBKDF2Optio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 2) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'iterations' is configured as '2147483649' but must be less than or equal to '2147483647'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: pbkdf2: option 'salt_length' is configured as '2147483650' but must be less than or equal to '2147483647'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: pbkdf2: option 'iterations' is configured as '2147483649' but must be less than or equal to '2147483647'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: pbkdf2: option 'salt_length' is configured as '2147483650' but must be less than or equal to '2147483647'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBCryptOptionsTooLow() { @@ -372,10 +372,10 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBCryptOptio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'cost' is configured as '-1' but must be greater than or equal to '10'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'cost' is configured as '-1' but must be greater than or equal to '10'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBCryptOptionsTooHigh() { @@ -383,10 +383,10 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBCryptOptio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'cost' is configured as '900' but must be less than or equal to '31'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: bcrypt: option 'cost' is configured as '900' but must be less than or equal to '31'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSCryptOptionsTooLow() { @@ -398,14 +398,14 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSCryptOptio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 5) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: scrypt: option 'iterations' is configured as '-1' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: scrypt: option 'block_size' is configured as '-21' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: scrypt: option 'parallelism' is configured as '-11' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: scrypt: option 'key_length' is configured as '-77' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: scrypt: option 'salt_length' is configured as '7' but must be greater than or equal to '8'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: scrypt: option 'iterations' is configured as '-1' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: scrypt: option 'block_size' is configured as '-21' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: scrypt: option 'parallelism' is configured as '-11' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: scrypt: option 'key_length' is configured as '-77' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: scrypt: option 'salt_length' is configured as '7' but must be greater than or equal to '8'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSCryptOptionsTooHigh() { @@ -417,14 +417,14 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenSCryptOptio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 5) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: scrypt: option 'iterations' is configured as '59' but must be less than or equal to '58'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: scrypt: option 'block_size' is configured as '360287970189639672' but must be less than or equal to '36028797018963967'") - suite.Assert().EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: scrypt: option 'parallelism' is configured as '1073741825' but must be less than or equal to '1073741823'") - suite.Assert().EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: scrypt: option 'key_length' is configured as '1374389534409' but must be less than or equal to '137438953440'") - suite.Assert().EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: scrypt: option 'salt_length' is configured as '2147483647' but must be less than or equal to '1024'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: scrypt: option 'iterations' is configured as '59' but must be less than or equal to '58'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: scrypt: option 'block_size' is configured as '360287970189639672' but must be less than or equal to '36028797018963967'") + suite.EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: scrypt: option 'parallelism' is configured as '1073741825' but must be less than or equal to '1073741823'") + suite.EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: scrypt: option 'key_length' is configured as '1374389534409' but must be less than or equal to '137438953440'") + suite.EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: scrypt: option 'salt_length' is configured as '2147483647' but must be less than or equal to '1024'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2OptionsTooLow() { @@ -436,14 +436,14 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2Optio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 5) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'iterations' is configured as '-1' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: argon2: option 'parallelism' is configured as '-1' but must be greater than or equal to '1'") - suite.Assert().EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: argon2: option 'memory' is configured as '-1' but must be greater than or equal to '8'") - suite.Assert().EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: argon2: option 'key_length' is configured as '1' but must be greater than or equal to '4'") - suite.Assert().EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: argon2: option 'salt_length' is configured as '-1' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'iterations' is configured as '-1' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: argon2: option 'parallelism' is configured as '-1' but must be greater than or equal to '1'") + suite.EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: argon2: option 'memory' is configured as '-1' but must be greater than or equal to '8'") + suite.EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: argon2: option 'key_length' is configured as '1' but must be greater than or equal to '4'") + suite.EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: argon2: option 'salt_length' is configured as '-1' but must be greater than or equal to '1'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2OptionsTooHigh() { @@ -455,14 +455,14 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2Optio ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 5) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'iterations' is configured as '9999999999' but must be less than or equal to '2147483647'") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: argon2: option 'parallelism' is configured as '16777216' but must be less than or equal to '16777215'") - suite.Assert().EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: argon2: option 'memory' is configured as '4294967296' but must be less than or equal to '4294967295'") - suite.Assert().EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: argon2: option 'key_length' is configured as '9999999998' but must be less than or equal to '2147483647'") - suite.Assert().EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: argon2: option 'salt_length' is configured as '9999999997' but must be less than or equal to '2147483647'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'iterations' is configured as '9999999999' but must be less than or equal to '2147483647'") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: file: password: argon2: option 'parallelism' is configured as '16777216' but must be less than or equal to '16777215'") + suite.EqualError(suite.validator.Errors()[2], "authentication_backend: file: password: argon2: option 'memory' is configured as '4294967296' but must be less than or equal to '4294967295'") + suite.EqualError(suite.validator.Errors()[3], "authentication_backend: file: password: argon2: option 'key_length' is configured as '9999999998' but must be less than or equal to '2147483647'") + suite.EqualError(suite.validator.Errors()[4], "authentication_backend: file: password: argon2: option 'salt_length' is configured as '9999999997' but must be less than or equal to '2147483647'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2MemoryTooLow() { @@ -471,10 +471,10 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2Memor ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'memory' is configured as '4' but must be greater than or equal to '8'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'memory' is configured as '4' but must be greater than or equal to '8'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2MemoryTooLowMultiplier() { @@ -483,10 +483,10 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenArgon2Memor ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'memory' is configured as '8' but must be greater than or equal to '32' or '4' (the value of 'parallelism) multiplied by '8'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: argon2: option 'memory' is configured as '8' but must be greater than or equal to '32' or '4' (the value of 'parallelism) multiplied by '8'") } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBadAlgorithmDefined() { @@ -494,10 +494,10 @@ func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenBadAlgorith ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: option 'algorithm' must be one of 'sha2crypt', 'pbkdf2', 'scrypt', 'bcrypt', or 'argon2' but it's configured as 'bogus'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: file: password: option 'algorithm' must be one of 'sha2crypt', 'pbkdf2', 'scrypt', 'bcrypt', or 'argon2' but it's configured as 'bogus'") } func (suite *FileBasedAuthenticationBackend) TestShouldSetDefaultValues() { @@ -509,30 +509,30 @@ func (suite *FileBasedAuthenticationBackend) TestShouldSetDefaultValues() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(schema.DefaultPasswordConfig.Algorithm, suite.config.File.Password.Algorithm) - suite.Assert().Equal(schema.DefaultPasswordConfig.Iterations, suite.config.File.Password.Iterations) - suite.Assert().Equal(schema.DefaultPasswordConfig.SaltLength, suite.config.File.Password.SaltLength) - suite.Assert().Equal(schema.DefaultPasswordConfig.Memory, suite.config.File.Password.Memory) - suite.Assert().Equal(schema.DefaultPasswordConfig.Parallelism, suite.config.File.Password.Parallelism) + suite.Equal(schema.DefaultPasswordConfig.Algorithm, suite.config.File.Password.Algorithm) + suite.Equal(schema.DefaultPasswordConfig.Iterations, suite.config.File.Password.Iterations) + suite.Equal(schema.DefaultPasswordConfig.SaltLength, suite.config.File.Password.SaltLength) + suite.Equal(schema.DefaultPasswordConfig.Memory, suite.config.File.Password.Memory) + suite.Equal(schema.DefaultPasswordConfig.Parallelism, suite.config.File.Password.Parallelism) } func (suite *FileBasedAuthenticationBackend) TestShouldRaiseErrorWhenResetURLIsInvalid() { suite.config.PasswordReset.CustomURL = url.URL{Scheme: "ldap", Host: "google.com"} suite.config.PasswordReset.Disable = true - suite.Assert().True(suite.config.PasswordReset.Disable) + suite.True(suite.config.PasswordReset.Disable) ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: password_reset: option 'custom_url' is configured to 'ldap://google.com' which has the scheme 'ldap' but the scheme must be either 'http' or 'https'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: password_reset: option 'custom_url' is configured to 'ldap://google.com' which has the scheme 'ldap' but the scheme must be either 'http' or 'https'") - suite.Assert().True(suite.config.PasswordReset.Disable) + suite.True(suite.config.PasswordReset.Disable) } func (suite *FileBasedAuthenticationBackend) TestShouldNotRaiseErrorWhenResetURLIsValid() { @@ -540,22 +540,22 @@ func (suite *FileBasedAuthenticationBackend) TestShouldNotRaiseErrorWhenResetURL ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *FileBasedAuthenticationBackend) TestShouldConfigureDisableResetPasswordWhenCustomURL() { suite.config.PasswordReset.CustomURL = url.URL{Scheme: "https", Host: "google.com"} suite.config.PasswordReset.Disable = true - suite.Assert().True(suite.config.PasswordReset.Disable) + suite.True(suite.config.PasswordReset.Disable) ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().False(suite.config.PasswordReset.Disable) + suite.False(suite.config.PasswordReset.Disable) } func TestFileBasedAuthenticationBackend(t *testing.T) { @@ -573,7 +573,7 @@ func (suite *LDAPAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationCustom - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -585,8 +585,8 @@ func (suite *LDAPAuthenticationBackendSuite) SetupTest() { func (suite *LDAPAuthenticationBackendSuite) TestShouldValidateCompleteConfiguration() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *LDAPAuthenticationBackendSuite) TestShouldValidateDefaultImplementationAndUsernameAttribute() { @@ -594,11 +594,11 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldValidateDefaultImplementa suite.config.LDAP.UsernameAttribute = "" ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Equal(schema.LDAPImplementationCustom, suite.config.LDAP.Implementation) + suite.Equal(schema.LDAPImplementationCustom, suite.config.LDAP.Implementation) - suite.Assert().Equal(suite.config.LDAP.UsernameAttribute, schema.DefaultLDAPAuthenticationBackendConfigurationImplementationCustom.UsernameAttribute) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Equal(suite.config.LDAP.UsernameAttribute, schema.DefaultLDAPAuthenticationBackendConfigurationImplementationCustom.UsernameAttribute) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenImplementationIsInvalidMSAD() { @@ -606,20 +606,20 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenImplementat ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'implementation' must be one of 'custom', 'activedirectory', 'rfc2307bis', 'freeipa', 'lldap', or 'glauth' but it's configured as 'masd'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'implementation' must be one of 'custom', 'activedirectory', 'rfc2307bis', 'freeipa', 'lldap', or 'glauth' but it's configured as 'masd'") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenURLNotProvided() { - suite.config.LDAP.URL = "" + suite.config.LDAP.Address = nil ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'url' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'address' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenUserNotProvided() { @@ -627,10 +627,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenUserNotProv ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'user' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'user' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenPasswordNotProvided() { @@ -638,10 +638,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenPasswordNot ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'password' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'password' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseErrorWhenPasswordNotProvidedWithPermitUnauthenticatedBind() { @@ -650,10 +650,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseErrorWhenPassword ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'permit_unauthenticated_bind' can't be enabled when password reset is enabled") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'permit_unauthenticated_bind' can't be enabled when password reset is enabled") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenPasswordProvidedWithPermitUnauthenticatedBind() { @@ -663,10 +663,39 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenPasswordPro ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'permit_unauthenticated_bind' can't be enabled when a password is specified") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'permit_unauthenticated_bind' can't be enabled when a password is specified") +} + +func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultPorts() { + suite.config.LDAP.Address = &schema.AddressLDAP{Address: MustParseAddress("ldap://abc")} + + ValidateAuthenticationBackend(&suite.config, suite.validator) + + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) + + suite.Equal("ldap://abc:389", suite.config.LDAP.Address.String()) + + suite.config.LDAP.Address = &schema.AddressLDAP{Address: MustParseAddress("ldaps://abc")} + + ValidateAuthenticationBackend(&suite.config, suite.validator) + + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) + + suite.Equal("ldaps://abc:636", suite.config.LDAP.Address.String()) + + suite.config.LDAP.Address = &schema.AddressLDAP{Address: MustParseAddress("ldapi:///a/path")} + + ValidateAuthenticationBackend(&suite.config, suite.validator) + + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) + + suite.Equal("ldapi:///a/path", suite.config.LDAP.Address.String()) } func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseErrorWhenPermitUnauthenticatedBindConfiguredCorrectly() { @@ -676,7 +705,7 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseErrorWhenPermitUn ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 0) } @@ -685,10 +714,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorWhenBaseDNNotPr ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'base_dn' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'base_dn' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnEmptyGroupsFilter() { @@ -696,10 +725,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnEmptyGroupsFilter( ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'groups_filter' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'groups_filter' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnEmptyUsersFilter() { @@ -707,10 +736,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnEmptyUsersFilter() ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' is required") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' is required") } func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseOnEmptyUsernameAttribute() { @@ -718,8 +747,8 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldNotRaiseOnEmptyUsernameAt ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnBadRefreshInterval() { @@ -727,19 +756,19 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseOnBadRefreshInterval ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: option 'refresh_interval' is configured to 'blah' but it must be either a duration notation or one of 'disable', or 'always': could not parse 'blah' as a duration") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: option 'refresh_interval' is configured to 'blah' but it must be either a duration notation or one of 'disable', or 'always': could not parse 'blah' as a duration") } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultImplementation() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(schema.LDAPImplementationCustom, suite.config.LDAP.Implementation) + suite.Equal(schema.LDAPImplementationCustom, suite.config.LDAP.Implementation) } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorOnBadFilterPlaceholders() { @@ -748,50 +777,50 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseErrorOnBadFilterPlac ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().True(suite.validator.HasErrors()) + suite.Len(suite.validator.Warnings(), 0) + suite.True(suite.validator.HasErrors()) suite.Require().Len(suite.validator.Errors(), 4) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' has an invalid placeholder: '{0}' has been removed, please use '{input}' instead") - suite.Assert().EqualError(suite.validator.Errors()[1], "authentication_backend: ldap: option 'groups_filter' has an invalid placeholder: '{0}' has been removed, please use '{input}' instead") - suite.Assert().EqualError(suite.validator.Errors()[2], "authentication_backend: ldap: option 'groups_filter' has an invalid placeholder: '{1}' has been removed, please use '{username}' instead") - suite.Assert().EqualError(suite.validator.Errors()[3], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{input}' but it's absent") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' has an invalid placeholder: '{0}' has been removed, please use '{input}' instead") + suite.EqualError(suite.validator.Errors()[1], "authentication_backend: ldap: option 'groups_filter' has an invalid placeholder: '{0}' has been removed, please use '{input}' instead") + suite.EqualError(suite.validator.Errors()[2], "authentication_backend: ldap: option 'groups_filter' has an invalid placeholder: '{1}' has been removed, please use '{username}' instead") + suite.EqualError(suite.validator.Errors()[3], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{input}' but it's absent") } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultGroupNameAttribute() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("cn", suite.config.LDAP.GroupNameAttribute) + suite.Equal("cn", suite.config.LDAP.GroupNameAttribute) } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultMailAttribute() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("mail", suite.config.LDAP.MailAttribute) + suite.Equal("mail", suite.config.LDAP.MailAttribute) } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultDisplayNameAttribute() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("displayName", suite.config.LDAP.DisplayNameAttribute) + suite.Equal("displayName", suite.config.LDAP.DisplayNameAttribute) } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultRefreshInterval() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("5m", suite.config.RefreshInterval) + suite.Equal("5m", suite.config.RefreshInterval) } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseWhenUsersFilterDoesNotContainEnclosingParenthesis() { @@ -799,10 +828,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseWhenUsersFilterDoesN ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain enclosing parenthesis: '{username_attribute}={input}' should probably be '({username_attribute}={input})'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain enclosing parenthesis: '{username_attribute}={input}' should probably be '({username_attribute}={input})'") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseWhenGroupsFilterDoesNotContainEnclosingParenthesis() { @@ -810,20 +839,20 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseWhenGroupsFilterDoes ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'groups_filter' must contain enclosing parenthesis: 'cn={input}' should probably be '(cn={input})'") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'groups_filter' must contain enclosing parenthesis: 'cn={input}' should probably be '(cn={input})'") } func (suite *LDAPAuthenticationBackendSuite) TestShouldRaiseWhenUsersFilterDoesNotContainUsernameAttribute() { suite.config.LDAP.UsersFilter = "(&({mail_attribute}={input})(objectClass=person))" ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{username_attribute}' but it's absent") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{username_attribute}' but it's absent") } func (suite *LDAPAuthenticationBackendSuite) TestShouldHelpDetectNoInputPlaceholder() { @@ -831,10 +860,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldHelpDetectNoInputPlacehol ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{input}' but it's absent") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'users_filter' must contain the placeholder '{input}' but it's absent") } func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultTLSMinimumVersion() { @@ -842,10 +871,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldSetDefaultTLSMinimumVersi ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(schema.DefaultLDAPAuthenticationBackendConfigurationImplementationCustom.TLS.MinimumVersion.Value, suite.config.LDAP.TLS.MinimumVersion.MinVersion()) + suite.Equal(schema.DefaultLDAPAuthenticationBackendConfigurationImplementationCustom.TLS.MinimumVersion.Value, suite.config.LDAP.TLS.MinimumVersion.MinVersion()) } func (suite *LDAPAuthenticationBackendSuite) TestShouldNotAllowSSL30() { @@ -855,10 +884,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldNotAllowSSL30() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: tls: option 'minimum_version' is invalid: minimum version is TLS1.0 but SSL3.0 was configured") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: tls: option 'minimum_version' is invalid: minimum version is TLS1.0 but SSL3.0 was configured") } func (suite *LDAPAuthenticationBackendSuite) TestShouldNotAllowTLSVerMinGreaterThanVerMax() { @@ -869,10 +898,10 @@ func (suite *LDAPAuthenticationBackendSuite) TestShouldNotAllowTLSVerMinGreaterT ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: tls: option combination of 'minimum_version' and 'maximum_version' is invalid: minimum version TLS1.3 is greater than the maximum version TLS1.2") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: tls: option combination of 'minimum_version' and 'maximum_version' is invalid: minimum version TLS1.3 is greater than the maximum version TLS1.2") } func TestLDAPAuthenticationBackend(t *testing.T) { @@ -890,7 +919,7 @@ func (suite *ActiveDirectoryAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationActiveDirectory - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -900,40 +929,40 @@ func (suite *ActiveDirectoryAuthenticationBackendSuite) SetupTest() { func (suite *ActiveDirectoryAuthenticationBackendSuite) TestShouldSetActiveDirectoryDefaults() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.Timeout, suite.config.LDAP.Timeout) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -951,51 +980,42 @@ func (suite *ActiveDirectoryAuthenticationBackendSuite) TestShouldOnlySetDefault ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } func (suite *ActiveDirectoryAuthenticationBackendSuite) TestShouldRaiseErrorOnInvalidURLWithHTTP() { - suite.config.LDAP.URL = "http://dc1:389" + suite.config.LDAP.Address = &schema.AddressLDAP{Address: MustParseAddress("http://dc1:389")} - validateLDAPAuthenticationBackendURL(suite.config.LDAP, suite.validator) + validateLDAPAuthenticationAddress(suite.config.LDAP, suite.validator) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'url' must have either the 'ldap' or 'ldaps' scheme but it's configured as 'http'") -} - -func (suite *ActiveDirectoryAuthenticationBackendSuite) TestShouldRaiseErrorOnInvalidURLWithBadCharacters() { - suite.config.LDAP.URL = "ldap://dc1:abc" - - validateLDAPAuthenticationBackendURL(suite.config.LDAP, suite.validator) - - suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'url' could not be parsed: parse \"ldap://dc1:abc\": invalid port \":abc\" after host") + suite.EqualError(suite.validator.Errors()[0], "authentication_backend: ldap: option 'address' with value 'http://dc1:389' is invalid: scheme must be one of 'ldap', 'ldaps', or 'ldapi' but is configured as 'http'") } func TestActiveDirectoryAuthenticationBackend(t *testing.T) { @@ -1013,7 +1033,7 @@ func (suite *RFC2307bisAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationRFC2307bis - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -1023,34 +1043,34 @@ func (suite *RFC2307bisAuthenticationBackendSuite) SetupTest() { func (suite *RFC2307bisAuthenticationBackendSuite) TestShouldSetDefaults() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.Timeout, suite.config.LDAP.Timeout) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1068,34 +1088,34 @@ func (suite *RFC2307bisAuthenticationBackendSuite) TestShouldOnlySetDefaultsIfNo ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1115,7 +1135,7 @@ func (suite *FreeIPAAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationFreeIPA - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -1125,34 +1145,34 @@ func (suite *FreeIPAAuthenticationBackendSuite) SetupTest() { func (suite *FreeIPAAuthenticationBackendSuite) TestShouldSetDefaults() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.Timeout, suite.config.LDAP.Timeout) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1170,31 +1190,31 @@ func (suite *FreeIPAAuthenticationBackendSuite) TestShouldOnlySetDefaultsIfNotMa ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1214,7 +1234,7 @@ func (suite *LLDAPAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationLLDAP - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -1224,34 +1244,34 @@ func (suite *LLDAPAuthenticationBackendSuite) SetupTest() { func (suite *LLDAPAuthenticationBackendSuite) TestShouldSetDefaults() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.Timeout, suite.config.LDAP.Timeout) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1269,34 +1289,34 @@ func (suite *LLDAPAuthenticationBackendSuite) TestShouldOnlySetDefaultsIfNotManu ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1316,7 +1336,7 @@ func (suite *GLAuthAuthenticationBackendSuite) SetupTest() { suite.config = schema.AuthenticationBackend{} suite.config.LDAP = &schema.LDAPAuthenticationBackend{} suite.config.LDAP.Implementation = schema.LDAPImplementationGLAuth - suite.config.LDAP.URL = testLDAPURL + suite.config.LDAP.Address = &schema.AddressLDAP{Address: *testLDAPAddress} suite.config.LDAP.User = testLDAPUser suite.config.LDAP.Password = testLDAPPassword suite.config.LDAP.BaseDN = testLDAPBaseDN @@ -1326,34 +1346,34 @@ func (suite *GLAuthAuthenticationBackendSuite) SetupTest() { func (suite *GLAuthAuthenticationBackendSuite) TestShouldSetDefaults() { ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.Timeout, suite.config.LDAP.Timeout) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().Equal( + suite.Equal( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } @@ -1371,34 +1391,34 @@ func (suite *GLAuthAuthenticationBackendSuite) TestShouldOnlySetDefaultsIfNotMan ValidateAuthenticationBackend(&suite.config, suite.validator) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.AdditionalUsersDN, suite.config.LDAP.AdditionalUsersDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.AdditionalGroupsDN, suite.config.LDAP.AdditionalGroupsDN) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.Timeout, suite.config.LDAP.Timeout) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.UsersFilter, suite.config.LDAP.UsersFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.UsernameAttribute, suite.config.LDAP.UsernameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.DisplayNameAttribute, suite.config.LDAP.DisplayNameAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.MailAttribute, suite.config.LDAP.MailAttribute) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.GroupsFilter, suite.config.LDAP.GroupsFilter) - suite.Assert().NotEqual( + suite.NotEqual( schema.DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth.GroupNameAttribute, suite.config.LDAP.GroupNameAttribute) } diff --git a/internal/configuration/validator/const.go b/internal/configuration/validator/const.go index 8191de1eb..d96bfc1bb 100644 --- a/internal/configuration/validator/const.go +++ b/internal/configuration/validator/const.go @@ -45,8 +45,6 @@ const ( // Scheme constants. const ( - schemeLDAP = "ldap" - schemeLDAPS = "ldaps" schemeHTTP = "http" schemeHTTPS = "https" ) @@ -61,7 +59,10 @@ const ( errFmtNotifierFileSystemFileNameNotConfigured = "notifier: filesystem: option 'filename' is required" errFmtNotifierSMTPNotConfigured = "notifier: smtp: option '%s' is required" errFmtNotifierSMTPTLSConfigInvalid = "notifier: smtp: tls: %w" - errFmtNotifierStartTlsDisabled = "notifier: smtp: option 'disable_starttls' is enabled: " + + errFmtNotifierSMTPAddress = "notifier: smtp: option 'address' with value '%s' is invalid: %w" + errFmtNotifierSMTPAddressLegacyAndModern = "notifier: smtp: option 'host' and 'port' can't be configured at the same time as 'address'" + + errFmtNotifierStartTlsDisabled = "notifier: smtp: option 'disable_starttls' is enabled: " + "opportunistic STARTTLS is explicitly disabled which means all emails will be sent insecurely over plaintext " + "and this setting is only necessary for non-compliant SMTP servers which advertise they support STARTTLS " + "when they actually don't support STARTTLS" @@ -103,10 +104,7 @@ const ( errSuffixMustBeOneOf errFmtLDAPAuthBackendFilterReplacedPlaceholders = "authentication_backend: ldap: option " + "'%s' has an invalid placeholder: '%s' has been removed, please use '%s' instead" - errFmtLDAPAuthBackendURLNotParsable = "authentication_backend: ldap: option " + - "'url' could not be parsed: %w" - errFmtLDAPAuthBackendURLInvalidScheme = "authentication_backend: ldap: option " + - "'url' must have either the 'ldap' or 'ldaps' scheme but it's configured as '%s'" + errFmtLDAPAuthBackendAddress = "authentication_backend: ldap: option 'address' with value '%s' is invalid: %w" errFmtLDAPAuthBackendFilterEnclosingParenthesis = "authentication_backend: ldap: option " + "'%s' must contain enclosing parenthesis: '%s' should probably be '(%s)'" errFmtLDAPAuthBackendFilterMissingPlaceholder = "authentication_backend: ldap: option " + @@ -123,11 +121,14 @@ const ( // Storage Error constants. const ( - errStrStorage = "storage: configuration for a 'local', 'mysql' or 'postgres' database must be provided" - errStrStorageEncryptionKeyMustBeProvided = "storage: option 'encryption_key' is required" - errStrStorageEncryptionKeyTooShort = "storage: option 'encryption_key' must be 20 characters or longer" - errFmtStorageUserPassMustBeProvided = "storage: %s: option 'username' and 'password' are required" //nolint:gosec - errFmtStorageOptionMustBeProvided = "storage: %s: option '%s' is required" + errStrStorage = "storage: configuration for a 'local', 'mysql' or 'postgres' database must be provided" + errStrStorageEncryptionKeyMustBeProvided = "storage: option 'encryption_key' is required" + errStrStorageEncryptionKeyTooShort = "storage: option 'encryption_key' must be 20 characters or longer" + errFmtStorageUserPassMustBeProvided = "storage: %s: option 'username' and 'password' are required" //nolint:gosec + errFmtStorageOptionMustBeProvided = "storage: %s: option '%s' is required" + errFmtStorageOptionAddressConflictWithHostPort = "storage: %s: option 'host' and 'port' can't be configured at the same time as 'address'" + errFmtStorageFailedToConvertHostPortToAddress = "storage: %s: option 'address' failed to parse options 'host' and 'port' as address: %w" + errFmtStorageTLSConfigInvalid = "storage: %s: tls: %w" errFmtStoragePostgreSQLInvalidSSLMode = "storage: postgres: ssl: option 'mode' must be one of %s but it's configured as '%s'" errFmtStoragePostgreSQLInvalidSSLAndTLSConfig = "storage: postgres: can't define both 'tls' and 'ssl' configuration options" @@ -246,7 +247,8 @@ const ( // NTP Error constants. const ( - errFmtNTPVersion = "ntp: option 'version' must be either 3 or 4 but it's configured as '%d'" + errFmtNTPVersion = "ntp: option 'version' must be either 3 or 4 but it's configured as '%d'" + errFmtNTPAddressScheme = "ntp: option 'address' with value '%s' is invalid: %w" ) // Session error constants. @@ -290,7 +292,6 @@ const ( errFmtServerTLSClientAuthNoAuth = "server: tls: client authentication cannot be configured if no server certificate and key are provided" - errFmtServerAddressWarnLegacy = "server: option 'address' replaces options 'host' and 'port': these will automatically be mapped for you but we recommend adjusting your configuration: the equivalent address value based on your configuration is 'tcp://%s:%d'" errFmtServerAddressLegacyAndModern = "server: option 'host' and 'port' can't be configured at the same time as 'address'" errFmtServerAddress = "server: option 'address' with value '%s' is invalid: %w" diff --git a/internal/configuration/validator/const_test.go b/internal/configuration/validator/const_test.go index c691551e7..2ae760b5d 100644 --- a/internal/configuration/validator/const_test.go +++ b/internal/configuration/validator/const_test.go @@ -1,5 +1,9 @@ package validator +import ( + "github.com/authelia/authelia/v4/internal/configuration/schema" +) + // Test constants. const ( testInvalid = "invalid" @@ -18,3 +22,25 @@ const ( const ( local25 = "127.0.0.25" ) + +var ( + testLDAPAddress = MustParseAddressPtr(testLDAPURL) +) + +func MustParseAddressPtr(input string) *schema.Address { + address, err := schema.NewAddress(input) + if err != nil { + panic(err) + } + + return address +} + +func MustParseAddress(input string) schema.Address { + address, err := schema.NewAddress(input) + if err != nil { + panic(err) + } + + return *address +} diff --git a/internal/configuration/validator/notifier.go b/internal/configuration/validator/notifier.go index b3515188f..eaa64508b 100644 --- a/internal/configuration/validator/notifier.go +++ b/internal/configuration/validator/notifier.go @@ -54,18 +54,12 @@ func validateNotifierTemplates(config *schema.NotifierConfiguration, validator * } func validateSMTPNotifier(config *schema.SMTPNotifierConfiguration, validator *schema.StructValidator) { + validateSMTPNotifierAddress(config, validator) + if config.StartupCheckAddress.Address == "" { config.StartupCheckAddress = schema.DefaultSMTPNotifierConfiguration.StartupCheckAddress } - if config.Host == "" { - validator.Push(fmt.Errorf(errFmtNotifierSMTPNotConfigured, "host")) - } - - if config.Port == 0 { - validator.Push(fmt.Errorf(errFmtNotifierSMTPNotConfigured, "port")) - } - if config.Timeout == 0 { config.Timeout = schema.DefaultSMTPNotifierConfiguration.Timeout } @@ -87,11 +81,14 @@ func validateSMTPNotifier(config *schema.SMTPNotifierConfiguration, validator *s } configDefaultTLS := &schema.TLSConfig{ - ServerName: config.Host, MinimumVersion: schema.DefaultSMTPNotifierConfiguration.TLS.MinimumVersion, MaximumVersion: schema.DefaultSMTPNotifierConfiguration.TLS.MaximumVersion, } + if config.Address != nil { + configDefaultTLS.ServerName = config.Address.Hostname() + } + if err := ValidateTLSConfig(config.TLS, configDefaultTLS); err != nil { validator.Push(fmt.Errorf(errFmtNotifierSMTPTLSConfigInvalid, err)) } @@ -100,3 +97,26 @@ func validateSMTPNotifier(config *schema.SMTPNotifierConfiguration, validator *s validator.PushWarning(fmt.Errorf(errFmtNotifierStartTlsDisabled)) } } + +func validateSMTPNotifierAddress(config *schema.SMTPNotifierConfiguration, validator *schema.StructValidator) { + if config.Address == nil { + if config.Host == "" && config.Port == 0 { //nolint:staticcheck + validator.Push(fmt.Errorf(errFmtNotifierSMTPNotConfigured, "address")) + } else { + host := config.Host //nolint:staticcheck + port := config.Port //nolint:staticcheck + + config.Address = schema.NewSMTPAddress("", host, port) + } + } else { + if config.Host != "" || config.Port != 0 { //nolint:staticcheck + validator.Push(fmt.Errorf(errFmtNotifierSMTPAddressLegacyAndModern)) + } + + var err error + + if err = config.Address.ValidateSMTP(); err != nil { + validator.Push(fmt.Errorf(errFmtNotifierSMTPAddress, config.Address.String(), err)) + } + } +} diff --git a/internal/configuration/validator/notifier_test.go b/internal/configuration/validator/notifier_test.go index 17819993f..e3c764153 100644 --- a/internal/configuration/validator/notifier_test.go +++ b/internal/configuration/validator/notifier_test.go @@ -22,11 +22,10 @@ type NotifierSuite struct { func (suite *NotifierSuite) SetupTest() { suite.validator = schema.NewStructValidator() suite.config.SMTP = &schema.SMTPNotifierConfiguration{ + Address: &schema.AddressSMTP{Address: schema.NewAddressFromNetworkValues(schema.AddressSchemeSMTP, exampleDotCom, 25)}, Username: "john", Password: "password", Sender: mail.Address{Name: "Authelia", Address: "authelia@example.com"}, - Host: exampleDotCom, - Port: 25, } suite.config.FileSystem = nil } @@ -37,25 +36,25 @@ Common Tests. func (suite *NotifierSuite) TestShouldEnsureAtLeastSMTPOrFilesystemIsProvided() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) suite.config.SMTP = nil ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().True(suite.validator.HasErrors()) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], errFmtNotifierNotConfigured) + suite.EqualError(suite.validator.Errors()[0], errFmtNotifierNotConfigured) } func (suite *NotifierSuite) TestShouldEnsureEitherSMTPOrFilesystemIsProvided() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Errors(), 0) suite.config.FileSystem = &schema.FileSystemNotifierConfiguration{ Filename: "test", @@ -63,12 +62,12 @@ func (suite *NotifierSuite) TestShouldEnsureEitherSMTPOrFilesystemIsProvided() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().True(suite.validator.HasErrors()) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], errFmtNotifierMultipleConfigured) + suite.EqualError(suite.validator.Errors()[0], errFmtNotifierMultipleConfigured) } /* @@ -77,57 +76,104 @@ SMTP Tests. func (suite *NotifierSuite) TestSMTPShouldSetTLSDefaults() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(exampleDotCom, suite.config.SMTP.TLS.ServerName) - suite.Assert().Equal(uint16(tls.VersionTLS12), suite.config.SMTP.TLS.MinimumVersion.Value) - suite.Assert().False(suite.config.SMTP.TLS.SkipVerify) + suite.Equal(exampleDotCom, suite.config.SMTP.TLS.ServerName) + suite.Equal(uint16(tls.VersionTLS12), suite.config.SMTP.TLS.MinimumVersion.Value) + suite.False(suite.config.SMTP.TLS.SkipVerify) } -func (suite *NotifierSuite) TestSMTPShouldDefaultStartupCheckAddress() { - suite.Assert().Equal(mail.Address{Name: "", Address: ""}, suite.config.SMTP.StartupCheckAddress) +func (suite *NotifierSuite) TestSMTPShouldSetDefaultsWithLegacyAddress() { + suite.config.SMTP.Address = nil + suite.config.SMTP.Host = "xyz" //nolint:staticcheck + suite.config.SMTP.Port = 123 //nolint:staticcheck ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal(mail.Address{Name: "Authelia Test", Address: "test@authelia.com"}, suite.config.SMTP.StartupCheckAddress) + suite.Equal(&schema.AddressSMTP{Address: MustParseAddress("smtp://xyz:123")}, suite.config.SMTP.Address) + suite.Equal("xyz", suite.config.SMTP.TLS.ServerName) + suite.Equal(uint16(tls.VersionTLS12), suite.config.SMTP.TLS.MinimumVersion.Value) + suite.False(suite.config.SMTP.TLS.SkipVerify) +} + +func (suite *NotifierSuite) TestSMTPShouldErrorWithAddressAndLegacyAddress() { + suite.config.SMTP.Host = "fgh" //nolint:staticcheck + suite.config.SMTP.Port = 123 //nolint:staticcheck + + ValidateNotifier(&suite.config, suite.validator) + + suite.Equal(&schema.AddressSMTP{Address: MustParseAddress("smtp://example.com:25")}, suite.config.SMTP.Address) + suite.Equal(exampleDotCom, suite.config.SMTP.TLS.ServerName) + suite.Equal(uint16(tls.VersionTLS12), suite.config.SMTP.TLS.MinimumVersion.Value) + suite.False(suite.config.SMTP.TLS.SkipVerify) + + suite.Len(suite.validator.Warnings(), 0) + suite.Require().Len(suite.validator.Errors(), 1) + + suite.EqualError(suite.validator.Errors()[0], "notifier: smtp: option 'host' and 'port' can't be configured at the same time as 'address'") +} + +func (suite *NotifierSuite) TestSMTPShouldErrorWithInvalidAddressScheme() { + suite.config.SMTP.Address = &schema.AddressSMTP{Address: MustParseAddress("udp://example.com:25")} + + ValidateNotifier(&suite.config, suite.validator) + + suite.Equal(&schema.AddressSMTP{Address: MustParseAddress("udp://example.com:25")}, suite.config.SMTP.Address) + suite.Equal(exampleDotCom, suite.config.SMTP.TLS.ServerName) + suite.Equal(uint16(tls.VersionTLS12), suite.config.SMTP.TLS.MinimumVersion.Value) + suite.False(suite.config.SMTP.TLS.SkipVerify) + + suite.Len(suite.validator.Warnings(), 0) + suite.Require().Len(suite.validator.Errors(), 1) + + suite.EqualError(suite.validator.Errors()[0], "notifier: smtp: option 'address' with value 'udp://example.com:25' is invalid: scheme must be one of 'smtp', 'submission', or 'submissions' but is configured as 'udp'") +} + +func (suite *NotifierSuite) TestSMTPShouldDefaultStartupCheckAddress() { + suite.Equal(mail.Address{Name: "", Address: ""}, suite.config.SMTP.StartupCheckAddress) + + ValidateNotifier(&suite.config, suite.validator) + + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) + + suite.Equal(mail.Address{Name: "Authelia Test", Address: "test@authelia.com"}, suite.config.SMTP.StartupCheckAddress) } func (suite *NotifierSuite) TestSMTPShouldDefaultTLSServerNameToHost() { - suite.config.SMTP.Host = "google.com" + suite.config.SMTP.Address.SetHostname("google.com") suite.config.SMTP.TLS = &schema.TLSConfig{ MinimumVersion: schema.TLSVersion{Value: tls.VersionTLS11}, } ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().Equal("google.com", suite.config.SMTP.TLS.ServerName) - suite.Assert().Equal(uint16(tls.VersionTLS11), suite.config.SMTP.TLS.MinimumVersion.MinVersion()) - suite.Assert().False(suite.config.SMTP.TLS.SkipVerify) + suite.Equal("google.com", suite.config.SMTP.TLS.ServerName) + suite.Equal(uint16(tls.VersionTLS11), suite.config.SMTP.TLS.MinimumVersion.MinVersion()) + suite.False(suite.config.SMTP.TLS.SkipVerify) } func (suite *NotifierSuite) TestSMTPShouldErrorOnSSL30() { - suite.config.SMTP.Host = exampleDotCom suite.config.SMTP.TLS = &schema.TLSConfig{ MinimumVersion: schema.TLSVersion{Value: tls.VersionSSL30}, //nolint:staticcheck } ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "notifier: smtp: tls: option 'minimum_version' is invalid: minimum version is TLS1.0 but SSL3.0 was configured") + suite.EqualError(suite.validator.Errors()[0], "notifier: smtp: tls: option 'minimum_version' is invalid: minimum version is TLS1.0 but SSL3.0 was configured") } func (suite *NotifierSuite) TestSMTPShouldErrorOnTLSMinVerGreaterThanMaxVer() { - suite.config.SMTP.Host = exampleDotCom suite.config.SMTP.TLS = &schema.TLSConfig{ MinimumVersion: schema.TLSVersion{Value: tls.VersionTLS13}, MaximumVersion: schema.TLSVersion{Value: tls.VersionTLS10}, @@ -135,45 +181,40 @@ func (suite *NotifierSuite) TestSMTPShouldErrorOnTLSMinVerGreaterThanMaxVer() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], "notifier: smtp: tls: option combination of 'minimum_version' and 'maximum_version' is invalid: minimum version TLS1.3 is greater than the maximum version TLS1.0") + suite.EqualError(suite.validator.Errors()[0], "notifier: smtp: tls: option combination of 'minimum_version' and 'maximum_version' is invalid: minimum version TLS1.3 is greater than the maximum version TLS1.0") } func (suite *NotifierSuite) TestSMTPShouldWarnOnDisabledSTARTTLS() { - suite.config.SMTP.Host = exampleDotCom suite.config.SMTP.DisableStartTLS = true ValidateNotifier(&suite.config, suite.validator) suite.Require().Len(suite.validator.Warnings(), 1) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.Assert().EqualError(suite.validator.Warnings()[0], "notifier: smtp: option 'disable_starttls' is enabled: opportunistic STARTTLS is explicitly disabled which means all emails will be sent insecurely over plaintext and this setting is only necessary for non-compliant SMTP servers which advertise they support STARTTLS when they actually don't support STARTTLS") + suite.EqualError(suite.validator.Warnings()[0], "notifier: smtp: option 'disable_starttls' is enabled: opportunistic STARTTLS is explicitly disabled which means all emails will be sent insecurely over plaintext and this setting is only necessary for non-compliant SMTP servers which advertise they support STARTTLS when they actually don't support STARTTLS") } func (suite *NotifierSuite) TestSMTPShouldEnsureHostAndPortAreProvided() { suite.config.FileSystem = nil ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) - suite.config.SMTP.Host = "" - suite.config.SMTP.Port = 0 + suite.config.SMTP.Address = nil ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().True(suite.validator.HasErrors()) - errors := suite.validator.Errors() - suite.Require().Len(errors, 2) + suite.Len(suite.validator.Warnings(), 0) + suite.Require().Len(errors, 1) - suite.Assert().EqualError(errors[0], fmt.Sprintf(errFmtNotifierSMTPNotConfigured, "host")) - suite.Assert().EqualError(errors[1], fmt.Sprintf(errFmtNotifierSMTPNotConfigured, "port")) + suite.EqualError(errors[0], "notifier: smtp: option 'address' is required") } func (suite *NotifierSuite) TestSMTPShouldEnsureSenderIsProvided() { @@ -181,12 +222,12 @@ func (suite *NotifierSuite) TestSMTPShouldEnsureSenderIsProvided() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().True(suite.validator.HasErrors()) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], fmt.Sprintf(errFmtNotifierSMTPNotConfigured, "sender")) + suite.EqualError(suite.validator.Errors()[0], fmt.Sprintf(errFmtNotifierSMTPNotConfigured, "sender")) } func (suite *NotifierSuite) TestTemplatesEmptyDir() { @@ -196,8 +237,8 @@ func (suite *NotifierSuite) TestTemplatesEmptyDir() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) } func (suite *NotifierSuite) TestTemplatesEmptyDirNoExist() { @@ -209,8 +250,8 @@ func (suite *NotifierSuite) TestTemplatesEmptyDirNoExist() { ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 1) assert.EqualError(suite.T(), suite.validator.Errors()[0], fmt.Sprintf("notifier: option 'template_path' refers to location '%s' which does not exist", p)) } @@ -225,19 +266,19 @@ func (suite *NotifierSuite) TestFileShouldEnsureFilenameIsProvided() { } ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) - suite.Assert().Len(suite.validator.Errors(), 0) + suite.Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Errors(), 0) suite.config.FileSystem.Filename = "" ValidateNotifier(&suite.config, suite.validator) - suite.Assert().Len(suite.validator.Warnings(), 0) + suite.Len(suite.validator.Warnings(), 0) suite.Require().True(suite.validator.HasErrors()) - suite.Assert().Len(suite.validator.Errors(), 1) + suite.Len(suite.validator.Errors(), 1) - suite.Assert().EqualError(suite.validator.Errors()[0], errFmtNotifierFileSystemFileNameNotConfigured) + suite.EqualError(suite.validator.Errors()[0], errFmtNotifierFileSystemFileNameNotConfigured) } func TestNotifierSuite(t *testing.T) { diff --git a/internal/configuration/validator/ntp.go b/internal/configuration/validator/ntp.go index d3914c961..42aa1ce61 100644 --- a/internal/configuration/validator/ntp.go +++ b/internal/configuration/validator/ntp.go @@ -8,10 +8,14 @@ import ( // ValidateNTP validates and update NTP configuration. func ValidateNTP(config *schema.Configuration, validator *schema.StructValidator) { - if config.NTP.Address == "" { + if config.NTP.Address == nil { config.NTP.Address = schema.DefaultNTPConfiguration.Address } + if !config.NTP.Address.IsUDP() { + validator.Push(fmt.Errorf(errFmtNTPAddressScheme, config.NTP.Address.String(), fmt.Errorf("scheme must be one of 'udp', 'udp4', or 'udp6' but is configured as '%s'", config.NTP.Address.Scheme()))) + } + if config.NTP.Version == 0 { config.NTP.Version = schema.DefaultNTPConfiguration.Version } else if config.NTP.Version < 3 || config.NTP.Version > 4 { diff --git a/internal/configuration/validator/ntp_test.go b/internal/configuration/validator/ntp_test.go index 0bae5b830..39ffe7907 100644 --- a/internal/configuration/validator/ntp_test.go +++ b/internal/configuration/validator/ntp_test.go @@ -51,3 +51,15 @@ func TestShouldRaiseErrorOnInvalidNTPVersion(t *testing.T) { assert.EqualError(t, validator.Errors()[0], "ntp: option 'version' must be either 3 or 4 but it's configured as '1'") } + +func TestShouldRaiseErrorOnInvalidNTPScheme(t *testing.T) { + validator := schema.NewStructValidator() + config := newDefaultNTPConfig() + config.NTP.Address = &schema.AddressUDP{Address: MustParseAddress("tcp://abc:123")} + + ValidateNTP(&config, validator) + + require.Len(t, validator.Errors(), 1) + + assert.EqualError(t, validator.Errors()[0], "ntp: option 'address' with value 'tcp://abc:123' is invalid: scheme must be one of 'udp', 'udp4', or 'udp6' but is configured as 'tcp'") +} diff --git a/internal/configuration/validator/server_test.go b/internal/configuration/validator/server_test.go index 82af45386..8c0c9d56b 100644 --- a/internal/configuration/validator/server_test.go +++ b/internal/configuration/validator/server_test.go @@ -35,6 +35,55 @@ func TestShouldSetDefaultServerValues(t *testing.T) { assert.Equal(t, schema.DefaultServerConfiguration.Endpoints.Authz, config.Server.Endpoints.Authz) } +func TestShouldSetDefaultServerValuesWithLegacyAddress(t *testing.T) { + validator := schema.NewStructValidator() + config := &schema.Configuration{ + Server: schema.ServerConfiguration{ + Host: "abc", + Port: 123, + }, + } + + ValidateServer(config, validator) + + assert.Len(t, validator.Errors(), 0) + assert.Len(t, validator.Warnings(), 0) + + assert.Equal(t, "abc", config.Server.Host) //nolint:staticcheck + assert.Equal(t, 123, config.Server.Port) //nolint:staticcheck + assert.Equal(t, &schema.AddressTCP{Address: MustParseAddress("tcp://abc:123")}, config.Server.Address) + + config = &schema.Configuration{ + Server: schema.ServerConfiguration{ + Host: "abc", + }, + } + + ValidateServer(config, validator) + + assert.Len(t, validator.Errors(), 0) + assert.Len(t, validator.Warnings(), 0) + + assert.Equal(t, "abc", config.Server.Host) //nolint:staticcheck + assert.Equal(t, 0, config.Server.Port) //nolint:staticcheck + assert.Equal(t, &schema.AddressTCP{Address: MustParseAddress("tcp://abc:9091")}, config.Server.Address) + + config = &schema.Configuration{ + Server: schema.ServerConfiguration{ + Port: 123, + }, + } + + ValidateServer(config, validator) + + assert.Len(t, validator.Errors(), 0) + assert.Len(t, validator.Warnings(), 0) + + assert.Equal(t, "", config.Server.Host) //nolint:staticcheck + assert.Equal(t, 123, config.Server.Port) //nolint:staticcheck + assert.Equal(t, &schema.AddressTCP{Address: MustParseAddress("tcp://:123")}, config.Server.Address) +} + func TestShouldSetDefaultConfig(t *testing.T) { validator := schema.NewStructValidator() config := &schema.Configuration{} diff --git a/internal/configuration/validator/storage.go b/internal/configuration/validator/storage.go index 035ac62e8..0f6f1dad6 100644 --- a/internal/configuration/validator/storage.go +++ b/internal/configuration/validator/storage.go @@ -31,12 +31,29 @@ func ValidateStorage(config schema.StorageConfiguration, validator *schema.Struc } func validateSQLConfiguration(config *schema.SQLStorageConfiguration, validator *schema.StructValidator, provider string) { - if config.Timeout == 0 { - config.Timeout = schema.DefaultSQLStorageConfiguration.Timeout - } + if config.Address == nil { + if config.Host == "" { //nolint:staticcheck + validator.Push(fmt.Errorf(errFmtStorageOptionMustBeProvided, provider, "address")) + } else { + host := config.Host //nolint:staticcheck + port := config.Port //nolint:staticcheck - if config.Host == "" { - validator.Push(fmt.Errorf(errFmtStorageOptionMustBeProvided, provider, "host")) + if address, err := schema.NewAddressFromNetworkValuesDefault(host, port, schema.AddressSchemeTCP, schema.AddressSchemeUnix); err != nil { + validator.Push(fmt.Errorf(errFmtStorageFailedToConvertHostPortToAddress, provider, err)) + } else { + config.Address = &schema.AddressTCP{Address: *address} + } + } + } else { + if config.Host != "" || config.Port != 0 { //nolint:staticcheck + validator.Push(fmt.Errorf(errFmtStorageOptionAddressConflictWithHostPort, provider)) + } + + var err error + + if err = config.Address.ValidateSQL(); err != nil { + validator.Push(fmt.Errorf(errFmtServerAddress, config.Address.String(), err)) + } } if config.Username == "" || config.Password == "" { @@ -46,6 +63,10 @@ func validateSQLConfiguration(config *schema.SQLStorageConfiguration, validator if config.Database == "" { validator.Push(fmt.Errorf(errFmtStorageOptionMustBeProvided, provider, "database")) } + + if config.Timeout == 0 { + config.Timeout = schema.DefaultSQLStorageConfiguration.Timeout + } } func validateMySQLConfiguration(config *schema.MySQLStorageConfiguration, validator *schema.StructValidator) { @@ -53,11 +74,14 @@ func validateMySQLConfiguration(config *schema.MySQLStorageConfiguration, valida if config.TLS != nil { configDefaultTLS := &schema.TLSConfig{ - ServerName: config.Host, MinimumVersion: schema.DefaultMySQLStorageConfiguration.TLS.MinimumVersion, MaximumVersion: schema.DefaultMySQLStorageConfiguration.TLS.MaximumVersion, } + if config.Address != nil { + configDefaultTLS.ServerName = config.Address.Hostname() + } + if err := ValidateTLSConfig(config.TLS, configDefaultTLS); err != nil { validator.Push(fmt.Errorf(errFmtStorageTLSConfigInvalid, "mysql", err)) } @@ -76,7 +100,7 @@ func validatePostgreSQLConfiguration(config *schema.PostgreSQLStorageConfigurati validator.Push(fmt.Errorf(errFmtStoragePostgreSQLInvalidSSLAndTLSConfig)) case config.TLS != nil: configDefaultTLS := &schema.TLSConfig{ - ServerName: config.Host, + ServerName: config.Address.Hostname(), MinimumVersion: schema.DefaultPostgreSQLStorageConfiguration.TLS.MinimumVersion, MaximumVersion: schema.DefaultPostgreSQLStorageConfiguration.TLS.MaximumVersion, } diff --git a/internal/configuration/validator/storage_test.go b/internal/configuration/validator/storage_test.go index f69bffab1..1001add41 100644 --- a/internal/configuration/validator/storage_test.go +++ b/internal/configuration/validator/storage_test.go @@ -61,7 +61,7 @@ func (suite *StorageSuite) TestShouldValidateMySQLHostUsernamePasswordAndDatabas ValidateStorage(suite.config, suite.validator) suite.Require().Len(suite.validator.Errors(), 3) - suite.Assert().EqualError(suite.validator.Errors()[0], "storage: mysql: option 'host' is required") + suite.Assert().EqualError(suite.validator.Errors()[0], "storage: mysql: option 'address' is required") suite.Assert().EqualError(suite.validator.Errors()[1], "storage: mysql: option 'username' and 'password' are required") suite.Assert().EqualError(suite.validator.Errors()[2], "storage: mysql: option 'database' is required") @@ -83,7 +83,7 @@ func (suite *StorageSuite) TestShouldValidateMySQLHostUsernamePasswordAndDatabas func (suite *StorageSuite) TestShouldSetDefaultMySQLTLSServerName() { suite.config.MySQL = &schema.MySQLStorageConfiguration{ SQLStorageConfiguration: schema.SQLStorageConfiguration{ - Host: "mysql1", + Address: &schema.AddressTCP{Address: MustParseAddress("tcp://mysql:1234")}, Username: "myuser", Password: "pass", Database: "database", @@ -98,7 +98,8 @@ func (suite *StorageSuite) TestShouldSetDefaultMySQLTLSServerName() { suite.Assert().Len(suite.validator.Warnings(), 0) suite.Assert().Len(suite.validator.Errors(), 0) - suite.Assert().Equal(suite.config.MySQL.Host, suite.config.MySQL.TLS.ServerName) + suite.Assert().Equal(suite.config.MySQL.Address.Hostname(), suite.config.MySQL.TLS.ServerName) + suite.Assert().Equal("mysql", suite.config.MySQL.TLS.ServerName) } func (suite *StorageSuite) TestShouldRaiseErrorOnInvalidMySQLTLSVersion() { @@ -150,7 +151,7 @@ func (suite *StorageSuite) TestShouldValidatePostgreSQLHostUsernamePasswordAndDa ValidateStorage(suite.config, suite.validator) suite.Require().Len(suite.validator.Errors(), 3) - suite.Assert().EqualError(suite.validator.Errors()[0], "storage: postgres: option 'host' is required") + suite.Assert().EqualError(suite.validator.Errors()[0], "storage: postgres: option 'address' is required") suite.Assert().EqualError(suite.validator.Errors()[1], "storage: postgres: option 'username' and 'password' are required") suite.Assert().EqualError(suite.validator.Errors()[2], "storage: postgres: option 'database' is required") @@ -230,7 +231,7 @@ func (suite *StorageSuite) TestShouldSetDefaultPostgreSQLTLSServerName() { suite.Assert().Len(suite.validator.Warnings(), 0) suite.Assert().Len(suite.validator.Errors(), 0) - suite.Assert().Equal(suite.config.PostgreSQL.Host, suite.config.PostgreSQL.TLS.ServerName) + suite.Assert().Equal(suite.config.PostgreSQL.Address.Hostname(), suite.config.PostgreSQL.TLS.ServerName) } func (suite *StorageSuite) TestShouldRaiseErrorOnInvalidPostgreSQLTLSVersion() { diff --git a/internal/notification/const.go b/internal/notification/const.go index f244ebef3..55b3a0052 100644 --- a/internal/notification/const.go +++ b/internal/notification/const.go @@ -5,10 +5,6 @@ const ( fileNotifierHeader = "Date: %s\nRecipient: %s\nSubject: %s\n" ) -const ( - smtpPortSUBMISSIONS = 465 -) - const ( posixNewLine = "\n" ) diff --git a/internal/notification/smtp_auth.go b/internal/notification/smtp_auth.go index 5901f9209..2cf34e4c2 100644 --- a/internal/notification/smtp_auth.go +++ b/internal/notification/smtp_auth.go @@ -20,7 +20,7 @@ func NewOpportunisticSMTPAuth(config *schema.SMTPNotifierConfiguration) *Opportu return &OpportunisticSMTPAuth{ username: config.Username, password: config.Password, - host: config.Host, + host: config.Address.Hostname(), } } diff --git a/internal/notification/smtp_notifier.go b/internal/notification/smtp_notifier.go index a7533e67b..41a873933 100644 --- a/internal/notification/smtp_notifier.go +++ b/internal/notification/smtp_notifier.go @@ -28,14 +28,14 @@ func NewSMTPNotifier(config *schema.SMTPNotifierConfiguration, certPool *x509.Ce } opts := []gomail.Option{ - gomail.WithPort(config.Port), + gomail.WithPort(config.Address.Port()), gomail.WithTLSConfig(tlsconfig), gomail.WithHELO(config.Identifier), gomail.WithTimeout(config.Timeout), gomail.WithoutNoop(), } - ssl := config.Port == smtpPortSUBMISSIONS + ssl := config.Address.IsExplicitlySecure() if ssl { opts = append(opts, gomail.WithSSL()) @@ -86,7 +86,7 @@ type SMTPNotifier struct { func (n *SMTPNotifier) StartupCheck() (err error) { var client *gomail.Client - if client, err = gomail.NewClient(n.config.Host, n.opts...); err != nil { + if client, err = gomail.NewClient(n.config.Address.Hostname(), n.opts...); err != nil { return fmt.Errorf("failed to establish client: %w", err) } @@ -139,7 +139,7 @@ func (n *SMTPNotifier) Send(ctx context.Context, recipient mail.Address, subject var client *gomail.Client - if client, err = gomail.NewClient(n.config.Host, n.opts...); err != nil { + if client, err = gomail.NewClient(n.config.Address.Hostname(), n.opts...); err != nil { return fmt.Errorf("notifier: smtp: failed to establish client: %w", err) } diff --git a/internal/ntp/ntp.go b/internal/ntp/ntp.go index fe8ba1964..2d5d55a01 100644 --- a/internal/ntp/ntp.go +++ b/internal/ntp/ntp.go @@ -3,6 +3,7 @@ package ntp import ( "encoding/binary" "errors" + "fmt" "net" "time" @@ -20,19 +21,37 @@ func NewProvider(config *schema.NTPConfiguration) *Provider { // StartupCheck implements the startup check provider interface. func (p *Provider) StartupCheck() (err error) { - conn, err := net.Dial("udp", p.config.Address) - if err != nil { - p.log.Warnf("Could not connect to NTP server to validate the system time is properly synchronized: %+v", err) + var offset time.Duration + + if offset, err = p.GetOffset(); err != nil { + p.log.WithError(err).Warnf("Could not determine the clock offset due to an error") return nil } - defer conn.Close() + if offset > p.config.MaximumDesync { + return errors.New("the system clock is not synchronized accurately enough with the configured NTP server") + } - if err := conn.SetDeadline(time.Now().Add(5 * time.Second)); err != nil { - p.log.Warnf("Could not connect to NTP server to validate the system time is properly synchronized: %+v", err) + return nil +} - return nil +// GetOffset returns the current offset for this provider. +func (p *Provider) GetOffset() (offset time.Duration, err error) { + var conn net.Conn + + if conn, err = net.Dial(p.config.Address.Network(), p.config.Address.NetworkAddress()); err != nil { + return offset, fmt.Errorf("error occurred during dial: %w", err) + } + + defer func() { + if closeErr := conn.Close(); closeErr != nil { + p.log.WithError(err).Error("Error occurred closing connection with NTP sever") + } + }() + + if err = conn.SetDeadline(time.Now().Add(5 * time.Second)); err != nil { + return offset, fmt.Errorf("error occurred setting connection deadline: %w", err) } version := ntpV4 @@ -42,27 +61,19 @@ func (p *Provider) StartupCheck() (err error) { req := &ntpPacket{LeapVersionMode: ntpLeapVersionClientMode(version)} - if err := binary.Write(conn, binary.BigEndian, req); err != nil { - p.log.Warnf("Could not write to the NTP server socket to validate the system time is properly synchronized: %+v", err) - - return nil + if err = binary.Write(conn, binary.BigEndian, req); err != nil { + return offset, fmt.Errorf("error occurred writing ntp packet request to the connection: %w", err) } now := time.Now() resp := &ntpPacket{} - if err := binary.Read(conn, binary.BigEndian, resp); err != nil { - p.log.Warnf("Could not read from the NTP server socket to validate the system time is properly synchronized: %+v", err) - - return nil + if err = binary.Read(conn, binary.BigEndian, resp); err != nil { + return offset, fmt.Errorf("error occurred reading ntp packet response to the connection: %w", err) } ntpTime := ntpPacketToTime(resp) - if result := ntpIsOffsetTooLarge(p.config.MaximumDesync, now, ntpTime); result { - return errors.New("the system clock is not synchronized accurately enough with the configured NTP server") - } - - return nil + return calcOffset(now, ntpTime), nil } diff --git a/internal/ntp/ntp_test.go b/internal/ntp/ntp_test.go index de88edfc3..2f3bf92cb 100644 --- a/internal/ntp/ntp_test.go +++ b/internal/ntp/ntp_test.go @@ -13,7 +13,7 @@ import ( func TestShouldCheckNTPV4(t *testing.T) { config := &schema.Configuration{ NTP: schema.NTPConfiguration{ - Address: "time.cloudflare.com:123", + Address: &schema.AddressUDP{Address: schema.NewAddressFromNetworkValues(schema.AddressSchemeUDP, "time.cloudflare.com", 123)}, Version: 4, MaximumDesync: time.Second * 3, }, @@ -30,7 +30,7 @@ func TestShouldCheckNTPV4(t *testing.T) { func TestShouldCheckNTPV3(t *testing.T) { config := &schema.Configuration{ NTP: schema.NTPConfiguration{ - Address: "time.cloudflare.com:123", + Address: &schema.AddressUDP{Address: schema.NewAddressFromNetworkValues(schema.AddressSchemeUDP, "time.cloudflare.com", 123)}, Version: 3, MaximumDesync: time.Second * 3, }, diff --git a/internal/ntp/util.go b/internal/ntp/util.go index 4e590c6d1..67be2faed 100644 --- a/internal/ntp/util.go +++ b/internal/ntp/util.go @@ -38,3 +38,11 @@ func ntpIsOffsetTooLarge(maxOffset time.Duration, first, second time.Time) (tooL return offset > maxOffset } + +func calcOffset(first, second time.Time) time.Duration { + if first.After(second) { + return first.Sub(second) + } + + return second.Sub(first) +} diff --git a/internal/storage/const.go b/internal/storage/const.go index 286d39620..2dec1b5e4 100644 --- a/internal/storage/const.go +++ b/internal/storage/const.go @@ -81,11 +81,6 @@ func (s OAuth2SessionType) Table() string { } } -const ( - sqlNetworkTypeTCP = "tcp" - sqlNetworkTypeUnixSocket = "unix" -) - const ( encryptionNameCheck = "check" ) diff --git a/internal/storage/sql_provider_backend_mysql.go b/internal/storage/sql_provider_backend_mysql.go index 32cc7de16..5ff2e531a 100644 --- a/internal/storage/sql_provider_backend_mysql.go +++ b/internal/storage/sql_provider_backend_mysql.go @@ -2,8 +2,6 @@ package storage import ( "crypto/x509" - "fmt" - "path" "time" "github.com/go-sql-driver/mysql" @@ -35,17 +33,8 @@ func NewMySQLProvider(config *schema.Configuration, caCertPool *x509.CertPool) ( func dsnMySQL(config *schema.MySQLStorageConfiguration, caCertPool *x509.CertPool) (dataSourceName string) { dsnConfig := mysql.NewConfig() - switch { - case path.IsAbs(config.Host): - dsnConfig.Net = sqlNetworkTypeUnixSocket - dsnConfig.Addr = config.Host - case config.Port == 0: - dsnConfig.Net = sqlNetworkTypeTCP - dsnConfig.Addr = fmt.Sprintf("%s:%d", config.Host, 3306) - default: - dsnConfig.Net = sqlNetworkTypeTCP - dsnConfig.Addr = fmt.Sprintf("%s:%d", config.Host, config.Port) - } + dsnConfig.Net = config.Address.Network() + dsnConfig.Addr = config.Address.NetworkAddress() if config.TLS != nil { _ = mysql.RegisterTLSConfig("storage", utils.NewTLSConfig(config.TLS, caCertPool)) @@ -53,13 +42,6 @@ func dsnMySQL(config *schema.MySQLStorageConfiguration, caCertPool *x509.CertPoo dsnConfig.TLSConfig = "storage" } - switch config.Port { - case 0: - dsnConfig.Addr = config.Host - default: - dsnConfig.Addr = fmt.Sprintf("%s:%d", config.Host, config.Port) - } - dsnConfig.DBName = config.Database dsnConfig.User = config.Username dsnConfig.Passwd = config.Password diff --git a/internal/storage/sql_provider_backend_postgres.go b/internal/storage/sql_provider_backend_postgres.go index 252ec3e0e..ef7054951 100644 --- a/internal/storage/sql_provider_backend_postgres.go +++ b/internal/storage/sql_provider_backend_postgres.go @@ -6,7 +6,6 @@ import ( "errors" "fmt" "os" - "path" "github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5/stdlib" @@ -136,8 +135,8 @@ func NewPostgreSQLProvider(config *schema.Configuration, caCertPool *x509.CertPo func dsnPostgreSQL(config *schema.PostgreSQLStorageConfiguration, globalCACertPool *x509.CertPool) (dsn string) { dsnConfig, _ := pgx.ParseConfig("") - dsnConfig.Host = config.Host - dsnConfig.Port = uint16(config.Port) + dsnConfig.Host = config.Address.SocketHostname() + dsnConfig.Port = uint16(config.Address.Port()) dsnConfig.Database = config.Database dsnConfig.User = config.Username dsnConfig.Password = config.Password @@ -147,7 +146,7 @@ func dsnPostgreSQL(config *schema.PostgreSQLStorageConfiguration, globalCACertPo "search_path": config.Schema, } - if dsnConfig.Port == 0 && !path.IsAbs(dsnConfig.Host) { + if dsnConfig.Port == 0 && config.Address.IsUnixDomainSocket() { dsnConfig.Port = 5432 } @@ -190,7 +189,7 @@ func loadPostgreSQLTLSConfig(config *schema.PostgreSQLStorageConfiguration, glob tlsConfig.VerifyPeerCertificate = newPostgreSQLVerifyCAFunc(tlsConfig) case config.SSL.Mode == "verify-full": tlsConfig.InsecureSkipVerify = false - tlsConfig.ServerName = config.Host + tlsConfig.ServerName = config.Address.Hostname() } } diff --git a/internal/suites/ActiveDirectory/configuration.yml b/internal/suites/ActiveDirectory/configuration.yml index cf309813a..a16d41a22 100644 --- a/internal/suites/ActiveDirectory/configuration.yml +++ b/internal/suites/ActiveDirectory/configuration.yml @@ -8,7 +8,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -18,8 +18,8 @@ log: authentication_backend: ldap: + address: 'ldap://sambaldap' implementation: activedirectory - url: ldap://sambaldap tls: skip_verify: true start_tls: true @@ -65,8 +65,7 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/BypassAll/configuration.yml b/internal/suites/BypassAll/configuration.yml index 5611c59d7..7802b6493 100644 --- a/internal/suites/BypassAll/configuration.yml +++ b/internal/suites/BypassAll/configuration.yml @@ -4,7 +4,7 @@ ############################################################### server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -48,8 +48,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/CLI/configuration.yml b/internal/suites/CLI/configuration.yml index 798b79ab6..e27f5a1d1 100644 --- a/internal/suites/CLI/configuration.yml +++ b/internal/suites/CLI/configuration.yml @@ -4,7 +4,7 @@ ############################################################### server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem diff --git a/internal/suites/Caddy/configuration.yml b/internal/suites/Caddy/configuration.yml index 8dc14b612..a1b55633d 100644 --- a/internal/suites/Caddy/configuration.yml +++ b/internal/suites/Caddy/configuration.yml @@ -6,8 +6,8 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" - asset_path: /config/assets/ + address: 'tcp://:9091' + asset_path: '/config/assets/' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -52,8 +52,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/Docker/configuration.yml b/internal/suites/Docker/configuration.yml index c1d593fdb..70692bb00 100644 --- a/internal/suites/Docker/configuration.yml +++ b/internal/suites/Docker/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -85,8 +85,7 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/DuoPush/configuration.yml b/internal/suites/DuoPush/configuration.yml index 6e96949ac..3235ce73c 100644 --- a/internal/suites/DuoPush/configuration.yml +++ b/internal/suites/DuoPush/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem diff --git a/internal/suites/Envoy/configuration.yml b/internal/suites/Envoy/configuration.yml index d1e59588c..4ec2d94fd 100644 --- a/internal/suites/Envoy/configuration.yml +++ b/internal/suites/Envoy/configuration.yml @@ -6,8 +6,8 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" - asset_path: /config/assets/ + address: 'tcp://:9091' + asset_path: '/config/assets/' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -55,8 +55,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/HAProxy/configuration.yml b/internal/suites/HAProxy/configuration.yml index 664349df6..2a0c29bbb 100644 --- a/internal/suites/HAProxy/configuration.yml +++ b/internal/suites/HAProxy/configuration.yml @@ -6,7 +6,7 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -46,8 +46,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/HighAvailability/configuration.yml b/internal/suites/HighAvailability/configuration.yml index 32883e329..8aece0597 100644 --- a/internal/suites/HighAvailability/configuration.yml +++ b/internal/suites/HighAvailability/configuration.yml @@ -6,7 +6,7 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -19,7 +19,7 @@ totp: authentication_backend: ldap: - url: ldap://openldap + address: 'ldap://openldap' base_dn: dc=example,dc=com username_attribute: uid additional_users_dn: ou=users @@ -114,16 +114,14 @@ regulation: storage: encryption_key: a_not_so_secure_encryption_key mysql: - host: mariadb - port: 3306 + address: 'tcp://mariadb:3306' database: authelia username: admin password: password notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/LDAP/configuration.yml b/internal/suites/LDAP/configuration.yml index ac5b4379c..1847f411e 100644 --- a/internal/suites/LDAP/configuration.yml +++ b/internal/suites/LDAP/configuration.yml @@ -8,7 +8,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -18,7 +18,7 @@ log: authentication_backend: ldap: - url: ldaps://openldap + address: 'ldaps://openldap' tls: skip_verify: true base_dn: dc=example,dc=com @@ -69,8 +69,7 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/MariaDB/configuration.yml b/internal/suites/MariaDB/configuration.yml index 3ec3af71d..3b7fb220f 100644 --- a/internal/suites/MariaDB/configuration.yml +++ b/internal/suites/MariaDB/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -32,8 +32,7 @@ session: storage: encryption_key: a_not_so_secure_encryption_key mysql: - host: mariadb - port: 3306 + address: 'tcp://mariadb:3306' database: authelia username: admin password: password @@ -71,8 +70,7 @@ regulation: notifier: # Use a SMTP server for sending notifications smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/MultiCookieDomain/configuration.yml b/internal/suites/MultiCookieDomain/configuration.yml index d47a5a80d..c4dd3fa1b 100644 --- a/internal/suites/MultiCookieDomain/configuration.yml +++ b/internal/suites/MultiCookieDomain/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: unsecure_secret theme: auto server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -15,7 +15,7 @@ server: telemetry: metrics: enabled: true - address: tcp://0.0.0.0:9959 + address: 'tcp://:9959' log: level: debug @@ -187,13 +187,12 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ntp: ## NTP server address - address: "time.cloudflare.com:123" + address: 'udp://time.cloudflare.com:123' ## ntp version version: 4 ## "maximum desynchronization" is the allowed offset time between the host and the ntp server diff --git a/internal/suites/MySQL/configuration.yml b/internal/suites/MySQL/configuration.yml index 87846b214..2427b915e 100644 --- a/internal/suites/MySQL/configuration.yml +++ b/internal/suites/MySQL/configuration.yml @@ -4,7 +4,7 @@ ############################################################### server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -33,11 +33,10 @@ session: storage: encryption_key: a_not_so_secure_encryption_key mysql: - host: mysql - port: 3306 - database: authelia - username: admin - password: password + address: 'tcp://mysql:3306' + database: 'authelia' + username: 'admin' + password: 'password' # TOTP Issuer Name # @@ -72,8 +71,7 @@ regulation: notifier: # Use a SMTP server for sending notifications smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/NetworkACL/configuration.yml b/internal/suites/NetworkACL/configuration.yml index 793469eea..309d1ba4a 100644 --- a/internal/suites/NetworkACL/configuration.yml +++ b/internal/suites/NetworkACL/configuration.yml @@ -4,7 +4,7 @@ ############################################################### server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -70,8 +70,7 @@ regulation: notifier: # Use a SMTP server for sending notifications smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/OIDC/configuration.yml b/internal/suites/OIDC/configuration.yml index c1f77f557..e2c640839 100644 --- a/internal/suites/OIDC/configuration.yml +++ b/internal/suites/OIDC/configuration.yml @@ -1,6 +1,6 @@ --- server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -55,8 +55,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true diff --git a/internal/suites/OIDCTraefik/configuration.yml b/internal/suites/OIDCTraefik/configuration.yml index 0c545972d..be074e1f6 100644 --- a/internal/suites/OIDCTraefik/configuration.yml +++ b/internal/suites/OIDCTraefik/configuration.yml @@ -1,6 +1,6 @@ --- server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -56,8 +56,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true diff --git a/internal/suites/OneFactorOnly/configuration.yml b/internal/suites/OneFactorOnly/configuration.yml index b93f37170..21f6cc5f0 100644 --- a/internal/suites/OneFactorOnly/configuration.yml +++ b/internal/suites/OneFactorOnly/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: unsecure_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem diff --git a/internal/suites/PathPrefix/configuration.yml b/internal/suites/PathPrefix/configuration.yml index e40b4f0eb..441b88b20 100644 --- a/internal/suites/PathPrefix/configuration.yml +++ b/internal/suites/PathPrefix/configuration.yml @@ -6,8 +6,8 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" - path: auth + address: 'tcp://:9091' + path: 'auth' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -47,8 +47,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/Postgres/configuration.yml b/internal/suites/Postgres/configuration.yml index cf2c31d6f..d4c60290d 100644 --- a/internal/suites/Postgres/configuration.yml +++ b/internal/suites/Postgres/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: very_important_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -32,11 +32,10 @@ session: storage: encryption_key: a_not_so_secure_encryption_key postgres: - host: postgres - port: 5432 - database: authelia - username: admin - password: password + address: 'tcp://postgres:5432' + database: 'authelia' + username: 'admin' + password: 'password' # TOTP Issuer Name # @@ -71,8 +70,7 @@ regulation: notifier: # Use a SMTP server for sending notifications smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/ShortTimeouts/configuration.yml b/internal/suites/ShortTimeouts/configuration.yml index d0b57b826..e330dca6c 100644 --- a/internal/suites/ShortTimeouts/configuration.yml +++ b/internal/suites/ShortTimeouts/configuration.yml @@ -7,7 +7,7 @@ jwt_secret: unsecure_secret default_redirection_url: https://home.example.com:8080/ server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -77,8 +77,7 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/Standalone/configuration.yml b/internal/suites/Standalone/configuration.yml index 4589ead9d..255afeeae 100644 --- a/internal/suites/Standalone/configuration.yml +++ b/internal/suites/Standalone/configuration.yml @@ -6,7 +6,7 @@ theme: auto server: - address: "tcp://:9091" + address: 'tcp://:9091' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -94,8 +94,7 @@ regulation: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ntp: diff --git a/internal/suites/Traefik/configuration.yml b/internal/suites/Traefik/configuration.yml index 5b169f8a9..2276926be 100644 --- a/internal/suites/Traefik/configuration.yml +++ b/internal/suites/Traefik/configuration.yml @@ -6,8 +6,8 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" - asset_path: /config/assets/ + address: 'tcp://:9091' + asset_path: '/config/assets/' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -47,8 +47,7 @@ access_control: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/Traefik2/configuration.yml b/internal/suites/Traefik2/configuration.yml index ee7218872..a77c46b13 100644 --- a/internal/suites/Traefik2/configuration.yml +++ b/internal/suites/Traefik2/configuration.yml @@ -6,8 +6,8 @@ jwt_secret: unsecure_secret server: - address: "tcp://:9091" - asset_path: /config/assets/ + address: 'tcp://:9091' + asset_path: '/config/assets/' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -61,8 +61,7 @@ ntp: notifier: smtp: - host: smtp - port: 1025 + address: 'smtp://smtp:1025' sender: admin@example.com disable_require_tls: true ... diff --git a/internal/suites/example/compose/envoy/envoy.yaml b/internal/suites/example/compose/envoy/envoy.yaml index 2e7248e7f..2c4935e42 100644 --- a/internal/suites/example/compose/envoy/envoy.yaml +++ b/internal/suites/example/compose/envoy/envoy.yaml @@ -7,240 +7,240 @@ admin: port_value: 9901 static_resources: listeners: - - name: listener_0 + - name: 'listener_0' address: socket_address: - address: 0.0.0.0 + address: '0.0.0.0' port_value: 8080 filter_chains: - filters: - - name: envoy.filters.network.http_connection_manager + - name: 'envoy.filters.network.http_connection_manager' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager # yamllint disable-line rule:line-length - stat_prefix: ingress_http + "@type": 'type.googleapis.com/envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager' # yamllint disable-line rule:line-length + stat_prefix: 'ingress_http' use_remote_address: true skip_xff_append: false access_log: - - name: envoy.access_loggers.stdout + - name: 'envoy.access_loggers.stdout' typed_config: - "@type": type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog + "@type": 'type.googleapis.com/envoy.extensions.access_loggers.stream.v3.StdoutAccessLog' route_config: - name: local_route + name: 'local_route' virtual_hosts: - - name: login_service - domains: ["login.example.com:8080"] + - name: 'login_service' + domains: ['login.example.com:8080'] typed_per_filter_config: envoy.filters.http.ext_authz: - "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute + "@type": 'type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute' disabled: true routes: - match: - prefix: "/.well-known/" + prefix: '/.well-known/' route: - cluster: authelia-backend + cluster: 'authelia-backend' - match: - prefix: "/api/" + prefix: '/api/' route: - cluster: authelia-backend + cluster: 'authelia-backend' - match: - prefix: "/locales/" + prefix: '/locales/' route: - cluster: authelia-backend + cluster: 'authelia-backend' - match: - path: "/devworkflow" + path: '/devworkflow' route: - cluster: authelia-backend + cluster: 'authelia-backend' - match: - path: "/jwks.json" + path: '/jwks.json' route: - cluster: authelia-backend + cluster: 'authelia-backend' - match: - prefix: "/" + prefix: '/' route: - cluster: authelia-frontend - - name: mail_service - domains: ["mail.example.com:8080"] + cluster: 'authelia-frontend' + - name: 'mail_service' + domains: ['mail.example.com:8080'] typed_per_filter_config: envoy.filters.http.ext_authz: - "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute + "@type": 'type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthzPerRoute' disabled: true routes: - match: - prefix: "/" + prefix: '/' route: - cluster: smtp - - name: http_service - domains: ["*.example.com:8080"] + cluster: 'smtp' + - name: 'http_service' + domains: ['*.example.com:8080'] routes: - match: - prefix: "/headers" + prefix: '/headers' route: - cluster: httpbin + cluster: 'httpbin' - match: - prefix: "/" + prefix: '/' route: - cluster: nginx-backend + cluster: 'nginx-backend' http_filters: - - name: envoy.filters.http.ext_authz + - name: 'envoy.filters.http.ext_authz' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz - transport_api_version: v3 + "@type": 'type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz' + transport_api_version: 'v3' allowed_headers: patterns: - - exact: authorization - - exact: proxy-authorization - - exact: accept - - exact: cookie + - exact: 'authorization' + - exact: 'proxy-authorization' + - exact: 'accept' + - exact: 'cookie' http_service: - path_prefix: /api/authz/ext-authz/ + path_prefix: '/api/authz/ext-authz/' server_uri: - uri: authelia-backend:9091 - cluster: authelia-backend - timeout: 0.25s + uri: 'authelia-backend:9091' + cluster: 'authelia-backend' + timeout: '0.25s' authorization_request: headers_to_add: - - key: X-Forwarded-Proto + - key: 'X-Forwarded-Proto' value: '%REQ(:SCHEME)%' authorization_response: allowed_upstream_headers: patterns: - - exact: authorization - - exact: proxy-authorization - - prefix: remote- - - prefix: authelia- + - exact: 'authorization' + - exact: 'proxy-authorization' + - prefix: 'remote-' + - prefix: 'authelia-' allowed_client_headers: patterns: - - exact: set-cookie + - exact: 'set-cookie' allowed_client_headers_on_success: patterns: - - exact: set-cookie + - exact: 'set-cookie' failure_mode_allow: false - - name: envoy.filters.http.router + - name: 'envoy.filters.http.router' typed_config: - "@type": type.googleapis.com/envoy.extensions.filters.http.router.v3.Router + "@type": 'type.googleapis.com/envoy.extensions.filters.http.router.v3.Router' transport_socket: - name: envoy.transport_sockets.tls + name: 'envoy.transport_sockets.tls' typed_config: - "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.DownstreamTlsContext + "@type": 'type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.DownstreamTlsContext' common_tls_context: tls_certificates: - certificate_chain: - filename: /pki/public.chain.pem + filename: '/pki/public.chain.pem' private_key: - filename: /pki/private.pem + filename: '/pki/private.pem' clusters: - - name: authelia-frontend + - name: 'authelia-frontend' transport_socket_matches: - - name: "enableTLS" + - name: 'enableTLS' match: enableTLS: true transport_socket: - name: envoy.transport_sockets.tls + name: 'envoy.transport_sockets.tls' typed_config: - "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext + "@type": 'type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext' common_tls_context: {} - - name: "defaultTLSDisabled" + - name: 'defaultTLSDisabled' match: {} transport_socket: - name: envoy.transport_sockets.raw_buffer + name: 'envoy.transport_sockets.raw_buffer' typed_config: - "@type": type.googleapis.com/envoy.extensions.transport_sockets.raw_buffer.v3.RawBuffer - connect_timeout: 0.25s - type: strict_dns - dns_lookup_family: V4_ONLY - lb_policy: round_robin + "@type": 'type.googleapis.com/envoy.extensions.transport_sockets.raw_buffer.v3.RawBuffer' + connect_timeout: '0.25s' + type: 'strict_dns' + dns_lookup_family: 'V4_ONLY' + lb_policy: 'round_robin' load_assignment: - cluster_name: authelia-frontend + cluster_name: 'authelia-frontend' endpoints: - locality: - region: dev + region: 'dev' priority: 0 lb_endpoints: - endpoint: health_check_config: - hostname: authelia-frontend + hostname: 'authelia-frontend' port_value: 3000 address: socket_address: - address: authelia-frontend + address: 'authelia-frontend' port_value: 3000 - locality: - region: ci + region: 'ci' priority: 1 lb_endpoints: - endpoint: address: socket_address: - address: authelia-backend + address: 'authelia-backend' port_value: 9091 metadata: filter_metadata: envoy.transport_socket_match: enableTLS: true - - name: authelia-backend - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'authelia-backend' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: authelia-backend + cluster_name: 'authelia-backend' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: authelia-backend + address: 'authelia-backend' port_value: 9091 transport_socket: - name: envoy.transport_sockets.tls + name: 'envoy.transport_sockets.tls' typed_config: - "@type": type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext + "@type": 'type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext' common_tls_context: {} - - name: smtp - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'smtp' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: smtp + cluster_name: 'smtp' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: smtp + address: 'smtp' port_value: 1080 - - name: httpbin - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'httpbin' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: httpbin + cluster_name: 'httpbin' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: httpbin + address: 'httpbin' port_value: 8000 - - name: nginx-backend - connect_timeout: 0.25s - type: logical_dns - dns_lookup_family: v4_only - lb_policy: round_robin + - name: 'nginx-backend' + connect_timeout: '0.25s' + type: 'logical_dns' + dns_lookup_family: 'v4_only' + lb_policy: 'round_robin' load_assignment: - cluster_name: nginx-backend + cluster_name: 'nginx-backend' endpoints: - lb_endpoints: - endpoint: address: socket_address: - address: nginx-backend + address: 'nginx-backend' port_value: 80 layered_runtime: layers: - - name: static_layer_0 + - name: 'static_layer_0' static_layer: envoy: resource_limits: diff --git a/internal/suites/example/kube/authelia/configs/configuration.yml b/internal/suites/example/kube/authelia/configs/configuration.yml index 8b8dc8180..edb8e04d7 100644 --- a/internal/suites/example/kube/authelia/configs/configuration.yml +++ b/internal/suites/example/kube/authelia/configs/configuration.yml @@ -6,7 +6,7 @@ default_redirection_url: https://home.example.com:8080 server: - port: 443 + address: 'tcp://:443' tls: certificate: /pki/public.backend.crt key: /pki/private.backend.pem @@ -16,7 +16,7 @@ log: authentication_backend: ldap: - url: ldaps://ldap-service + address: 'ldaps://ldap-service' tls: skip_verify: true base_dn: dc=example,dc=com @@ -102,15 +102,13 @@ regulation: storage: mysql: - host: mariadb-service - port: 3306 + address: 'tcp://mariadb-service:3306' database: authelia username: admin notifier: smtp: - host: "mailcatcher-service" - port: 1025 - sender: admin@example.com + address: 'smtp://mailcatcher-service:1025' + sender: 'admin@example.com' disable_require_tls: true ...