#summary Library module for LDAP

= Introduction =

This module is used by other modules to access an LDAP server.  It's pretty useless on its own; you should use it if you want to write your own LDAP-related module, or if you want to use one of mine ([mod_auth_ldap2], [mod_storage_ldap]).

== Configuration ==

= API =

== ldap.getconnection() ==

Returns an LDAP connection object corresponding to the configuration in prosody.cfg.lua.  The connection object is a [http://www.keplerproject.org/lualdap/ LuaLDAP] connection.

== ldap.getparams() ==

Returns the LDAP configuration provided in prosody.cfg.lua.  Use this if you want to stick some configuration information for your module into the LDAP section in the configuration file.

== ldap.bind(username, password) ==

Verifies that _username_ and _password_ bind ok.  *NOTE*: This does not bind the current LDAP connection to the given username!

== ldap.singlematch(query) ==

Used to fetch a single LDAP record given an LDAP query.  A convenience function.

== ldap.filter.combine_and(...) ==

Takes a list of LDAP filter expressions and returns a filter expression that results in the intersection of each given expression (it ANDs them together).