Package: django-auth-ldap
This is a Django authentication backend that authenticates against an LDAP
service. Configuration can be as simple as a single distinguished name
template, but there are many rich configuration options for working with users,
groups, and permissions.Documentation:https://django-auth-ldap.readthedocs.io/PyPI:https://pypi.org/project/django-auth-ldap/Repository:https://github.com/django-auth-ldap/django-auth-ldapLicense: BSD 2-ClauseInstallationInstall the package with pip:$pipinstalldjango-auth-ldapIt requirespython-ldap>= 3.1. You’ll need theOpenLDAPlibraries and
headers available on your system.To use the auth backend in a Django project, add'django_auth_ldap.backend.LDAPBackend'toAUTHENTICATION_BACKENDS. Do
not add anything toINSTALLED_APPS.AUTHENTICATION_BACKENDS=['django_auth_ldap.backend.LDAPBackend',]LDAPBackendshould work with custom user models, but it does assume that a
database is present.NoteLDAPBackenddoes not inherit fromModelBackend. It is possible to
useLDAPBackendexclusively by configuring it to draw group membership
from the LDAP server. However, if you would like to assign permissions to
individual users or add users to groups within Django, you’ll need to have
both backends installed:AUTHENTICATION_BACKENDS=['django_auth_ldap.backend.LDAPBackend','django.contrib.auth.backends.ModelBackend',]Example ConfigurationHere is a complete example configuration fromsettings.pythat exercises
nearly all of the features. In this example, we’re authenticating against a
global pool of users in the directory, but we have a special area set aside for
Django groups (ou=django,ou=groups,dc=example,dc=com). Remember that most
of this is optional if you just need simple authentication. Some default
settings and arguments are included for completeness.importldapfromdjango_auth_ldap.configimportLDAPSearch,GroupOfNamesType# Baseline configuration.AUTH_LDAP_SERVER_URI='ldap://ldap.example.com'AUTH_LDAP_BIND_DN='cn=django-agent,dc=example,dc=com'AUTH_LDAP_BIND_PASSWORD='phlebotinum'AUTH_LDAP_USER_SEARCH=LDAPSearch('ou=users,dc=example,dc=com',ldap.SCOPE_SUBTREE,'(uid=%(user)s)',)# Or:# AUTH_LDAP_USER_DN_TEMPLATE = 'uid=%(user)s,ou=users,dc=example,dc=com'# Set up the basic group parameters.AUTH_LDAP_GROUP_SEARCH=LDAPSearch('ou=django,ou=groups,dc=example,dc=com',ldap.SCOPE_SUBTREE,'(objectClass=groupOfNames)',)AUTH_LDAP_GROUP_TYPE=GroupOfNamesType(name_attr='cn')# Simple group restrictionsAUTH_LDAP_REQUIRE_GROUP='cn=enabled,ou=django,ou=groups,dc=example,dc=com'AUTH_LDAP_DENY_GROUP='cn=disabled,ou=django,ou=groups,dc=example,dc=com'# Populate the Django user from the LDAP directory.AUTH_LDAP_USER_ATTR_MAP={'first_name':'givenName','last_name':'sn','email':'mail',}AUTH_LDAP_USER_FLAGS_BY_GROUP={'is_active':'cn=active,ou=django,ou=groups,dc=example,dc=com','is_staff':'cn=staff,ou=django,ou=groups,dc=example,dc=com','is_superuser':'cn=superuser,ou=django,ou=groups,dc=example,dc=com',}# This is the default, but I like to be explicit.AUTH_LDAP_ALWAYS_UPDATE_USER=True# Use LDAP group membership to calculate group permissions.AUTH_LDAP_FIND_GROUP_PERMS=True# Cache distinguished names and group memberships for an hour to minimize# LDAP traffic.AUTH_LDAP_CACHE_TIMEOUT=3600# Keep ModelBackend around for per-user permissions and maybe a local# superuser.AUTHENTICATION_BACKENDS=('django_auth_ldap.backend.LDAPBackend','django.contrib.auth.backends.ModelBackend',)ContributingIf you’d like to contribute, the best approach is to send a well-formed pull
request, complete with tests and documentation. Pull requests should be
focused: trying to do more than one thing in a single request will make it more
difficult to process.If you have a bug or feature request you can trylogging an issue.There’s no harm in creating an issue and then submitting a pull request to
resolve it. This can be a good way to start a conversation and can serve as an
anchor point.