Mercurial > prosody-wiki
comparison mod_lib_ldap.wiki @ 316:03633ab9afb6
Created wiki page through web user interface.
| author | rdhoelz@gmail.com |
|---|---|
| date | Wed, 05 Dec 2012 11:23:19 +0000 |
| parents | |
| children | 629d6b524cb9 |
comparison
equal
deleted
inserted
replaced
| 315:2c18ba3f99d9 | 316:03633ab9afb6 |
|---|---|
| 1 #summary Library module for LDAP | |
| 2 | |
| 3 = Introduction = | |
| 4 | |
| 5 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]). | |
| 6 | |
| 7 == Configuration == | |
| 8 | |
| 9 = API = | |
| 10 | |
| 11 == ldap.getconnection() == | |
| 12 | |
| 13 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. | |
| 14 | |
| 15 == ldap.getparams() == | |
| 16 | |
| 17 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. | |
| 18 | |
| 19 == ldap.bind(username, password) == | |
| 20 | |
| 21 Verifies that _username_ and _password_ bind ok. *NOTE*: This does not bind the current LDAP connection to the given username! | |
| 22 | |
| 23 == ldap.singlematch(query) == | |
| 24 | |
| 25 Used to fetch a single LDAP record given an LDAP query. A convenience function. | |
| 26 | |
| 27 == ldap.filter.combine_and(...) == | |
| 28 | |
| 29 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). |