mod_auth_ldap

Introduction

This is a Prosody authentication plugin which uses LDAP as the backend.

Dependecies

This module depends on LuaLDAP for connecting to an LDAP server.

Configuration

Copy the module to the prosody modules/plugins directory.

In Prosody's configuration file, under the desired host section, add:

authentication = "ldap"
ldap_base = "ou=people,dc=example,dc=com"

Further LDAP options are:

Name Description Default value
ldap_base LDAP base directory which stores user accounts Required field
ldap_server Space-separated list of hostnames or IPs, optionally with port numbers (e.g. "localhost:8389") "localhost"
ldap_rootdn The distinguished name to auth against "" (anonymous)
ldap_password Password for rootdn ""
ldap_filter Search filter, with $user and $host substituded for user- and hostname "(uid=$user)"
ldap_scope Search scope. other values: "base" and "onelevel" "subtree"
ldap_tls Enable TLS (StartTLS) to connect to LDAP (can be true or false). The non-standard 'LDAPS' protocol is not supported. false
ldap_mode How passwords are validated. "bind"
ldap_admins Search filter to match admins, works like ldap_scope

Note: lua-ldap reads from /etc/ldap/ldap.conf and other files like ~prosody/.ldaprc if they exist. Users wanting to use a particular TLS root certificate can specify it in the normal way using TLS_CACERT in the OpenLDAP config file.

Modes

The "getpasswd" mode requires plain text access to passwords in LDAP and feeds them into Prosodys authentication system. This enables more secure authentication mechanisms but does not work for all deployments.

The "bind" mode performs an LDAP bind, does not require plain text access to passwords but limits you to the PLAIN authentication mechanism.

Compatibility

Works with 0.8 and later.