view @ 468:eb771cbbf410

Incorporated feedback from Daniel Pocock
date Mon, 21 Jul 2014 11:56:43 +0000
parents 042161223488
children bb454e0cb7fc
line wrap: on
line source

#summary LDAP authentication module
#labels Stage-Alpha,Type-Auth

_*Note:* A modified version of this module is available, but is not yet committed here. The plan is to merge them, for more info see [ this thread]._

= Introduction =

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

= Configuration =

Copy the module to the prosody modules/plugins directory.

In Prosody's configuration file, under the desired host section, add:
	authentication = "ldap"

LDAP options are:
|| *Name*        || *Description*                                      || *Default value*  ||
|| 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 || the password                                       || ""               ||
|| ldap_filter   || search filter, with $user and $host substituded for user- and hostname || "(uid=$user)"    ||
|| ldap_scope    || search scope. other values: "base" and "subtree"   || "onelevel"       ||
|| ldap_tls      || Enable TLS (StartTLS) to connect to LDAP (can be true or false). The non-standard 'LDAPS' protocol is not supported. || false            ||
|| ldap_base     || LDAP base directory which stores user accounts     || This is required ||
|| ldap_mode     || How passwords are validated.                       || "getpasswd" if ldap_rootdn is set, "bind" otherwise ||

*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" performs an LDAP bind, does not require plain text access to
passwords but limits you to the PLAIN authentication mechanism.

= Compatibility =

|| 0.8 and above || should work ||