package
4.39.1
Repository: https://github.com/authelia/authelia.git
Documentation: pkg.go.dev

# Functions

DecodeAlgorithmDigest returns a new algorithm.Digest if it can be decoded.
DecodePasswordDigest returns a new PasswordDigest if it can be decoded.
NewAddress returns an *Address and error depending on the ability to parse the string as an Address.
NewAddressDefault returns an *Address and error depending on the ability to parse the string as an Address.
NewAddressFromNetworkPathValues returns an *Address from network values and a path.
NewAddressFromNetworkValues returns an *Address from network values.
NewAddressFromNetworkValuesDefault returns an *Address and error depending on the ability to parse the string as an Address.
NewAddressFromURL returns an *Address and error depending on the ability to parse the *url.URL as an Address.
NewAddressUnix returns an *Address from a path value.
NewPasswordDigest returns a new *PasswordDigest from an algorithm.Digest.
NewRefreshIntervalDuration returns a RefreshIntervalDuration given a time.Duration.
NewRefreshIntervalDurationAlways returns a RefreshIntervalDuration with an always value.
NewRefreshIntervalDurationNever returns a RefreshIntervalDuration with a never value.
NewSMTPAddress returns an *AddressSMTP from SMTP values.
NewStructValidator is a constructor of struct validator.
NewTLSVersion returns a new TLSVersion given a string.
NewX509CertificateChain creates a new *X509CertificateChain from a given string, parsing each PEM block one by one.
NewX509CertificateChainFromCerts returns a chain from a given list of certificates without validation.

# Constants

Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Address Schemes.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
Authz values.
LDAPGroupSearchModeFilter is the string for the filter group search mode.
LDAPGroupSearchModeMemberOf is the string for the memberOf group search mode.
LDAPImplementationActiveDirectory is the string for the Active Directory LDAP implementation.
LDAPImplementationCustom is the string for the custom LDAP implementation.
LDAPImplementationFreeIPA is the string for the FreeIPA LDAP implementation.
LDAPImplementationGLAuth is the string for the GLAuth LDAP implementation.
LDAPImplementationLLDAP is the string for the lldap LDAP implementation.
LDAPImplementationRFC2307bis is the string for the RFC2307bis LDAP implementation.
ProfileRefreshAlways represents a value for refresh_interval that's the same as 0ms.
ProfileRefreshDisabled represents a Value for refresh_interval that disables the check entirely.
RefreshIntervalDefault represents the default value of refresh_interval.
RememberMeDisabled represents the duration for a disabled remember me session configuration.
Authorization Schemes.
Authorization Schemes.
SSLVersion30 is the textual representation of SSL 3.0.
TLSVersion10 is the textual representation of TLS 1.0.
TLSVersion11 is the textual representation of TLS 1.1.
TLSVersion12 is the textual representation of TLS 1.2.
TLSVersion13 is the textual representation of TLS 1.3.
TOTP Algorithm.
TOTP Algorithm.
TOTP Algorithm.
TOTPSecretSizeDefault is the default secret size.
TOTPSecretSizeMinimum is the minimum secret size.
Version10 is the textual representation of version 1.0.
Version11 is the textual representation of version 1.1.
Version12 is the textual representation of version 1.2.
Version13 is the textual representation of version 1.3.

# Variables

DefaultACLRule represents the default configuration related to access control rule configuration.
DefaultCIPasswordConfig represents the default configuration related to Argon2id hashing for CI.
DefaultIdentityValidation has the default values for the IdentityValidation configuration.
DefaultLDAPAuthenticationBackendConfigurationImplementationActiveDirectory represents the default LDAP config for the LDAPImplementationActiveDirectory Implementation.
DefaultLDAPAuthenticationBackendConfigurationImplementationCustom represents the default LDAP config.
DefaultLDAPAuthenticationBackendConfigurationImplementationFreeIPA represents the default LDAP config for the LDAPImplementationFreeIPA Implementation.
DefaultLDAPAuthenticationBackendConfigurationImplementationGLAuth represents the default LDAP config for the LDAPImplementationGLAuth Implementation.
DefaultLDAPAuthenticationBackendConfigurationImplementationLLDAP represents the default LDAP config for the LDAPImplementationLLDAP Implementation.
DefaultLDAPAuthenticationBackendConfigurationImplementationRFC2307bis represents the default LDAP config for the LDAPImplementationRFC2307bis Implementation.
DefaultLoggingConfiguration is the default logging configuration.
DefaultMySQLStorageConfiguration represents the default MySQL configuration.
DefaultNTPConfiguration represents default configuration parameters for the NTP server.
DefaultOpenIDConnectClientConfiguration contains defaults for OIDC Clients.
DefaultOpenIDConnectConfiguration contains defaults for OIDC.
No description provided by the author
DefaultPasswordConfig represents the default configuration related to Argon2id hashing.
DefaultPasswordPolicyConfiguration is the default password policy configuration.
DefaultPostgreSQLStorageConfiguration represents the default PostgreSQL configuration.
DefaultRedisConfiguration is the default redis configuration.
DefaultRedisHighAvailabilityConfiguration is the default redis configuration.
DefaultRegulationConfiguration represents default configuration parameters for the regulator.
DefaultServerConfiguration represents the default values of the Server.
DefaultSessionConfiguration is the default session configuration.
DefaultSMTPNotifierConfiguration represents default configuration parameters for the SMTP notifier.
DefaultSQLStorageConfiguration represents the default SQL configuration.
DefaultTelemetryConfig is the default telemetry configuration.
DefaultTOTPConfiguration represents default configuration parameters for TOTP generation.
DefaultWebAuthnConfiguration describes the default values for the WebAuthn.
ErrTLSVersionNotSupported returned when an unknown TLS version supplied.
Keys is a list of valid schema keys detected by reflecting over a schema.Configuration struct.
TOTPPossibleAlgorithms is a list of valid TOTP Algorithms.

# Structs

AccessControl represents the configuration related to ACLs.
AccessControlNetwork represents one ACL network group entry.
AccessControlRule represents one ACL rule entry.
AccessControlRuleQuery represents the ACL query criteria.
Address represents an address.
AddressLDAP is just a type with an underlying type of Address.
AddressSMTP is just a type with an underlying type of Address.
AddressTCP is just a type with an underlying type of Address.
AddressUDP is just a type with an underlying type of Address.
AuthenticationBackend represents the configuration related to the authentication backend.
No description provided by the author
AuthenticationBackendFile represents the configuration related to file-based backend.
AuthenticationBackendFilePassword represents the configuration related to password hashing.
AuthenticationBackendFilePasswordArgon2 represents the argon2 hashing settings.
AuthenticationBackendFilePasswordBCrypt represents the bcrypt hashing settings.
AuthenticationBackendFilePasswordPBKDF2 represents the PBKDF2 hashing settings.
AuthenticationBackendFilePasswordSCrypt represents the scrypt hashing settings.
AuthenticationBackendFilePasswordSHA2Crypt represents the sha2crypt hashing settings.
AuthenticationBackendFileSearch represents the configuration related to file-based backend searching.
AuthenticationBackendLDAP represents the configuration related to LDAP server.
AuthenticationBackendLDAPAttributes represents the configuration related to LDAP server attributes.
No description provided by the author
No description provided by the author
AuthenticationBackendPasswordChange represents the configuration related to password reset functionality.
AuthenticationBackendPasswordReset represents the configuration related to password reset functionality.
Configuration object extracted from YAML configuration file.
No description provided by the author
DuoAPI represents the configuration related to Duo API.
IdentityProviders represents the Identity Providers configuration for Authelia.
IdentityProvidersOpenIDConnect represents the configuration for OpenID Connect 1.0.
No description provided by the author
IdentityProvidersOpenIDConnectClient represents a configuration for an OpenID Connect 1.0 client.
IdentityProvidersOpenIDConnectCORS represents an OpenID Connect 1.0 CORS config.
No description provided by the author
IdentityProvidersOpenIDConnectDiscovery is information discovered during validation reused for the discovery handlers.
IdentityProvidersOpenIDConnectLifespan allows tuning the lifespans for OpenID Connect 1.0 issued tokens.
IdentityProvidersOpenIDConnectLifespanGrants allows tuning the lifespans for each grant type.
No description provided by the author
IdentityProvidersOpenIDConnectLifespanToken allows tuning the lifespans for each token type.
IdentityProvidersOpenIDConnectPolicy configuration for OpenID Connect 1.0 authorization policies.
IdentityProvidersOpenIDConnectPolicyRule configuration for OpenID Connect 1.0 authorization policies rules.
No description provided by the author
IdentityValidation represents the configuration for identity verification actions/flows.
IdentityValidationElevatedSession represents the tunable aspects of the credential control identity verification action/flow.
IdentityValidationResetPassword represents the tunable aspects of the reset password identity verification action/flow.
JWK represents a JWK.
Log represents the logging configuration.
Notifier represents the configuration of the notifier to use when sending notifications to users.
NotifierFileSystem represents the configuration of the notifier writing emails in a file.
NotifierSMTP represents the configuration of the SMTP server to send emails with.
NTP represents the configuration related to ntp server.
PasswordDigest is a configuration type for the crypt.Digest.
PasswordPolicy represents the configuration related to password policy.
PasswordPolicyStandard represents the configuration related to standard parameters of password policy.
PasswordPolicyZXCVBN represents the configuration related to ZXCVBN parameters of password policy.
PrivacyPolicy is the privacy policy configuration.
RefreshIntervalDuration is a special time.Duration for the refresh interval.
Regulation represents the configuration related to regulation.
Server represents the configuration of the http server.
ServerBuffers represents server buffer configurations.
No description provided by the author
No description provided by the author
No description provided by the author
ServerEndpoints is the endpoints configuration for the HTTP server.
ServerEndpointsAuthz is the Authz endpoints configuration for the HTTP server.
ServerEndpointsAuthzAuthnStrategy is the Authz endpoints configuration for the HTTP server.
ServerHeaders represents the customization of the http server headers.
ServerTimeouts represents server timeout configurations.
ServerTLS represents the configuration of the http servers TLS options.
Session represents the configuration related to user sessions.
SessionCookie represents the configuration for a cookie domain.
No description provided by the author
SessionRedis represents the configuration related to redis session store.
SessionRedisHighAvailability holds configuration variables for Redis Cluster/Sentinel.
SessionRedisHighAvailabilityNode Represents a Node.
Storage represents the configuration of the storage backend.
StorageLocal represents the configuration when using local storage.
StorageMySQL represents the configuration of a MySQL database.
StoragePostgreSQL represents the configuration of a PostgreSQL database.
No description provided by the author
StoragePostgreSQLSSL represents the SSL configuration of a PostgreSQL database.
StorageSQL represents the configuration of the SQL database.
StructValidator is a validator for structs.
Telemetry represents the telemetry config.
TelemetryMetrics represents the telemetry metrics config.
TLS is a representation of the TLS configuration.
TLSVersion is a struct which handles tls.Config versions.
TOTP represents the configuration related to TOTP options.
No description provided by the author
WebAuthn represents the webauthn config.
No description provided by the author
No description provided by the author
No description provided by the author
X509CertificateChain is a helper struct that holds a list of *x509.Certificate's.

# Interfaces

CryptographicPrivateKey represents the actual crypto.PrivateKey interface.
ErrorContainer represents a container where we can add errors and retrieve them.

# Type aliases

No description provided by the author
No description provided by the author
AccessControlRuleRegex represents the ACL AccessControlRuleSubjects type.
AccessControlRuleSubjects represents the ACL AccessControlRuleSubjects type.
CryptographicKey represents an artificial cryptographic public or private key.
No description provided by the author
No description provided by the author