package validator import ( "errors" "fmt" "net/url" "strings" "github.com/authelia/authelia/v4/internal/configuration/schema" "github.com/authelia/authelia/v4/internal/utils" ) // ValidateAuthenticationBackend validates and updates the authentication backend configuration. func ValidateAuthenticationBackend(configuration *schema.AuthenticationBackendConfiguration, validator *schema.StructValidator) { if configuration.LDAP == nil && configuration.File == nil { validator.Push(errors.New("Please provide `ldap` or `file` object in `authentication_backend`")) } if configuration.LDAP != nil && configuration.File != nil { validator.Push(errors.New("You cannot provide both `ldap` and `file` objects in `authentication_backend`")) } if configuration.File != nil { validateFileAuthenticationBackend(configuration.File, validator) } else if configuration.LDAP != nil { validateLDAPAuthenticationBackend(configuration.LDAP, validator) } if configuration.RefreshInterval == "" { configuration.RefreshInterval = schema.RefreshIntervalDefault } else { _, err := utils.ParseDurationString(configuration.RefreshInterval) if err != nil && configuration.RefreshInterval != schema.ProfileRefreshDisabled && configuration.RefreshInterval != schema.ProfileRefreshAlways { validator.Push(fmt.Errorf("Auth Backend `refresh_interval` is configured to '%s' but it must be either a duration notation or one of 'disable', or 'always'. Error from parser: %s", configuration.RefreshInterval, err)) } } } // validateFileAuthenticationBackend validates and updates the file authentication backend configuration. func validateFileAuthenticationBackend(configuration *schema.FileAuthenticationBackendConfiguration, validator *schema.StructValidator) { if configuration.Path == "" { validator.Push(errors.New("Please provide a `path` for the users database in `authentication_backend`")) } if configuration.Password == nil { configuration.Password = &schema.DefaultPasswordConfiguration } else { // Salt Length switch { case configuration.Password.SaltLength == 0: configuration.Password.SaltLength = schema.DefaultPasswordConfiguration.SaltLength case configuration.Password.SaltLength < 8: validator.Push(fmt.Errorf("The salt length must be 2 or more, you configured %d", configuration.Password.SaltLength)) } switch configuration.Password.Algorithm { case "": configuration.Password.Algorithm = schema.DefaultPasswordConfiguration.Algorithm fallthrough case hashArgon2id: validateFileAuthenticationBackendArgon2id(configuration, validator) case hashSHA512: validateFileAuthenticationBackendSHA512(configuration) default: validator.Push(fmt.Errorf("Unknown hashing algorithm supplied, valid values are argon2id and sha512, you configured '%s'", configuration.Password.Algorithm)) } if configuration.Password.Iterations < 1 { validator.Push(fmt.Errorf("The number of iterations specified is invalid, must be 1 or more, you configured %d", configuration.Password.Iterations)) } } } func validateFileAuthenticationBackendSHA512(configuration *schema.FileAuthenticationBackendConfiguration) { // Iterations (time) if configuration.Password.Iterations == 0 { configuration.Password.Iterations = schema.DefaultPasswordSHA512Configuration.Iterations } } func validateFileAuthenticationBackendArgon2id(configuration *schema.FileAuthenticationBackendConfiguration, validator *schema.StructValidator) { // Iterations (time) if configuration.Password.Iterations == 0 { configuration.Password.Iterations = schema.DefaultPasswordConfiguration.Iterations } // Parallelism if configuration.Password.Parallelism == 0 { configuration.Password.Parallelism = schema.DefaultPasswordConfiguration.Parallelism } else if configuration.Password.Parallelism < 1 { validator.Push(fmt.Errorf("Parallelism for argon2id must be 1 or more, you configured %d", configuration.Password.Parallelism)) } // Memory if configuration.Password.Memory == 0 { configuration.Password.Memory = schema.DefaultPasswordConfiguration.Memory } else if configuration.Password.Memory < configuration.Password.Parallelism*8 { validator.Push(fmt.Errorf("Memory for argon2id must be %d or more (parallelism * 8), you configured memory as %d and parallelism as %d", configuration.Password.Parallelism*8, configuration.Password.Memory, configuration.Password.Parallelism)) } // Key Length if configuration.Password.KeyLength == 0 { configuration.Password.KeyLength = schema.DefaultPasswordConfiguration.KeyLength } else if configuration.Password.KeyLength < 16 { validator.Push(fmt.Errorf("Key length for argon2id must be 16, you configured %d", configuration.Password.KeyLength)) } } func validateLDAPAuthenticationBackend(configuration *schema.LDAPAuthenticationBackendConfiguration, validator *schema.StructValidator) { if configuration.Timeout == 0 { configuration.Timeout = schema.DefaultLDAPAuthenticationBackendConfiguration.Timeout } if configuration.Implementation == "" { configuration.Implementation = schema.DefaultLDAPAuthenticationBackendConfiguration.Implementation } if configuration.TLS == nil { configuration.TLS = schema.DefaultLDAPAuthenticationBackendConfiguration.TLS } if configuration.TLS.MinimumVersion == "" { configuration.TLS.MinimumVersion = schema.DefaultLDAPAuthenticationBackendConfiguration.TLS.MinimumVersion } if _, err := utils.TLSStringToTLSConfigVersion(configuration.TLS.MinimumVersion); err != nil { validator.Push(fmt.Errorf("error occurred validating the LDAP minimum_tls_version key with value %s: %v", configuration.TLS.MinimumVersion, err)) } switch configuration.Implementation { case schema.LDAPImplementationCustom: setDefaultImplementationCustomLDAPAuthenticationBackend(configuration) case schema.LDAPImplementationActiveDirectory: setDefaultImplementationActiveDirectoryLDAPAuthenticationBackend(configuration) default: validator.Push(fmt.Errorf("authentication backend ldap implementation must be blank or one of the following values `%s`, `%s`", schema.LDAPImplementationCustom, schema.LDAPImplementationActiveDirectory)) } if strings.Contains(configuration.UsersFilter, "{0}") { validator.Push(fmt.Errorf("authentication backend ldap users filter must not contain removed placeholders" + ", {0} has been replaced with {input}")) } if strings.Contains(configuration.GroupsFilter, "{0}") || strings.Contains(configuration.GroupsFilter, "{1}") { validator.Push(fmt.Errorf("authentication backend ldap groups filter must not contain removed " + "placeholders, {0} has been replaced with {input} and {1} has been replaced with {username}")) } if configuration.URL == "" { validator.Push(errors.New("Please provide a URL to the LDAP server")) } else { ldapURL, serverName := validateLDAPURL(configuration.URL, validator) configuration.URL = ldapURL if configuration.TLS.ServerName == "" { configuration.TLS.ServerName = serverName } } validateLDAPRequiredParameters(configuration, validator) } // Wrapper for test purposes to exclude the hostname from the return. func validateLDAPURLSimple(ldapURL string, validator *schema.StructValidator) (finalURL string) { finalURL, _ = validateLDAPURL(ldapURL, validator) return finalURL } func validateLDAPURL(ldapURL string, validator *schema.StructValidator) (finalURL string, hostname string) { parsedURL, err := url.Parse(ldapURL) if err != nil { validator.Push(errors.New("Unable to parse URL to ldap server. The scheme is probably missing: ldap:// or ldaps://")) return "", "" } if !(parsedURL.Scheme == schemeLDAP || parsedURL.Scheme == schemeLDAPS) { validator.Push(errors.New("Unknown scheme for ldap url, should be ldap:// or ldaps://")) return "", "" } return parsedURL.String(), parsedURL.Hostname() } func validateLDAPRequiredParameters(configuration *schema.LDAPAuthenticationBackendConfiguration, validator *schema.StructValidator) { // TODO: see if it's possible to disable this check if disable_reset_password is set and when anonymous/user binding is supported (#101 and #387) if configuration.User == "" { validator.Push(errors.New("Please provide a user name to connect to the LDAP server")) } // TODO: see if it's possible to disable this check if disable_reset_password is set and when anonymous/user binding is supported (#101 and #387) if configuration.Password == "" { validator.Push(errors.New("Please provide a password to connect to the LDAP server")) } if configuration.BaseDN == "" { validator.Push(errors.New("Please provide a base DN to connect to the LDAP server")) } if configuration.UsersFilter == "" { validator.Push(errors.New("Please provide a users filter with `users_filter` attribute")) } else { if !strings.HasPrefix(configuration.UsersFilter, "(") || !strings.HasSuffix(configuration.UsersFilter, ")") { validator.Push(errors.New("The users filter should contain enclosing parenthesis. For instance {username_attribute}={input} should be ({username_attribute}={input})")) } if !strings.Contains(configuration.UsersFilter, "{username_attribute}") { validator.Push(errors.New("Unable to detect {username_attribute} placeholder in users_filter, your configuration is broken. " + "Please review configuration options listed at https://www.authelia.com/docs/configuration/authentication/ldap.html")) } // This test helps the user know that users_filter is broken after the breaking change induced by this commit. if !strings.Contains(configuration.UsersFilter, "{0}") && !strings.Contains(configuration.UsersFilter, "{input}") { validator.Push(errors.New("Unable to detect {input} placeholder in users_filter, your configuration might be broken. " + "Please review configuration options listed at https://www.authelia.com/docs/configuration/authentication/ldap.html")) } } if configuration.GroupsFilter == "" { validator.Push(errors.New("Please provide a groups filter with `groups_filter` attribute")) } else if !strings.HasPrefix(configuration.GroupsFilter, "(") || !strings.HasSuffix(configuration.GroupsFilter, ")") { validator.Push(errors.New("The groups filter should contain enclosing parenthesis. For instance cn={input} should be (cn={input})")) } } func setDefaultImplementationActiveDirectoryLDAPAuthenticationBackend(configuration *schema.LDAPAuthenticationBackendConfiguration) { if configuration.UsersFilter == "" { configuration.UsersFilter = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.UsersFilter } if configuration.UsernameAttribute == "" { configuration.UsernameAttribute = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.UsernameAttribute } if configuration.DisplayNameAttribute == "" { configuration.DisplayNameAttribute = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.DisplayNameAttribute } if configuration.MailAttribute == "" { configuration.MailAttribute = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.MailAttribute } if configuration.GroupsFilter == "" { configuration.GroupsFilter = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.GroupsFilter } if configuration.GroupNameAttribute == "" { configuration.GroupNameAttribute = schema.DefaultLDAPAuthenticationBackendImplementationActiveDirectoryConfiguration.GroupNameAttribute } } func setDefaultImplementationCustomLDAPAuthenticationBackend(configuration *schema.LDAPAuthenticationBackendConfiguration) { if configuration.UsernameAttribute == "" { configuration.UsernameAttribute = schema.DefaultLDAPAuthenticationBackendConfiguration.UsernameAttribute } if configuration.GroupNameAttribute == "" { configuration.GroupNameAttribute = schema.DefaultLDAPAuthenticationBackendConfiguration.GroupNameAttribute } if configuration.MailAttribute == "" { configuration.MailAttribute = schema.DefaultLDAPAuthenticationBackendConfiguration.MailAttribute } if configuration.DisplayNameAttribute == "" { configuration.DisplayNameAttribute = schema.DefaultLDAPAuthenticationBackendConfiguration.DisplayNameAttribute } }