LLDAP

LLDAP is supported by Authelia.

Important: When using these guides, it’s important to recognize that we cannot provide a guide for every possible method of deploying an LDAP server. These guides show a suggested setup only, and you need to understand the LDAP configuration and customize it to your needs. To-that-end, we include links to the official documentation specific to the LDAP implementation throughout this documentation and in the See Also section.

Important: This guide makes use of a default configuration. Check the Defaults section and make adjustments according to your needs.

Assumptions and Adaptation#

This guide makes a few assumptions. These assumptions may require adaptation in more advanced and complex scenarios. We can not reasonably have examples for every advanced configuration option that exists. Some of these values can automatically be replaced with documentation variables.

The following are the assumptions we make:

• The LDAP implementation to be used with Authelia is fully setup and reachable by Authelia.
• All services are part of the example.com domain:
  • This domain and the subdomains will have to be adapted in all examples to match your specific domains unless you’re just testing or you want to use that specific domain.

Configuration#

Authelia#

The following YAML configuration is an example Authelia authentication backend configuration for use with lldap which will operate with the application example:

authentication_backend:
  ldap:
    implementation: 'lldap'
    address: 'ldap://lldap:3890'
    base_dn: 'DC=example,DC=com'
    user: 'UID=authelia,OU=people,DC=example,DC=com'
    password: 'insecure_secret'

Application#

Create a service user within the application with a complex password. Use the users Distinguished Name as a username, and make sure the user has the appropriate permissions to perform the following actions:

• Read the attributes of users and groups that are meant to be able to use Authelia.
• Change the password of users provided the functionality to reset passwords is desired.

See the lldap documentation on how to configure permissions for the newly created user.

Defaults#

The below tables describes the current attribute defaults for the lldap implementation.

Search Base defaults#

The following set defaults for the additional_users_dn and additional_groups_dn values.

Attribute defaults#

This table describes the attribute defaults for the lldap implementation. i.e. the username_attribute is described by the Username column.

Filter defaults#

The filters are probably the most important part to get correct when setting up LDAP. You want to exclude accounts under the following conditions:

• The account is disabled or locked:
  • The lldap implementation has no suitable attribute for this as far as we’re aware.
• Their password is expired:
  • The lldap implementation has no suitable attribute for this as far as we’re aware.
• Their account is expired:
  • The lldap implementation has no suitable attribute for this as far as we’re aware.

Users Filter#

(&(|({username_attribute}={input})({mail_attribute}={input}))(objectClass=person))

Groups Filter#

(&(member={dn})(objectClass=groupOfNames))

See Also#

• LLDAP Client Configuration