Mercurial > prosody-wiki

annotate mod_auth_ldap.wiki @ 494:fb9e558dd1df

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add page
author Kim Alvefur <zash@zash.se>
date Tue, 18 Nov 2014 14:03:41 +0100
parents bb454e0cb7fc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
1 #summary LDAP authentication module
181
dbe3fcc3dbbb Add Type-Auth tag.
MWild1
parents: 137
diff changeset
2 #labels Stage-Alpha,Type-Auth
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
3
183
99ccedc61bca Edited wiki page mod_auth_ldap through web user interface.
MWild1
parents: 181
diff changeset
4 _*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 [http://groups.google.com/group/prosody-dev/browse_thread/thread/282e876116ae4177/906121492495ad35#906121492495ad35 this thread]._
99ccedc61bca Edited wiki page mod_auth_ldap through web user interface.
MWild1
parents: 181
diff changeset
5
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
6 = Introduction =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
7
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
8 This is a Prosody authentication plugin which uses LDAP as the backend.
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
9
472
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
10 = Dependecies =
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
11
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
12 This module depends on [http://www.keplerproject.org/lualdap/ LuaLDAP] for connecting to an LDAP server.
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
13
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
14 = Configuration =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
15
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
16 Copy the module to the prosody modules/plugins directory.
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
17
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
18 In Prosody's configuration file, under the desired host section, add:
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
19 {{{
420
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
20 authentication = "ldap"
472
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
21 ldap_base = "ou=people,dc=example,dc=com"
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
22 }}}
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
23
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
24 LDAP options are:
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
25 || *Name* || *Description* || *Default value* ||
472
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
26 || ldap_server || Space-separated list of hostnames or IPs, optionally with port numbers (e.g. "localhost:8389") || "localhost" ||
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
27 || ldap_rootdn || The distinguished name to auth against || "" (anonymous) ||
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
28 || ldap_password || Password for rootdn || "" ||
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
29 || ldap_filter || Search filter, with $user and $host substituded for user- and hostname || "(uid=$user)" ||
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
30 || ldap_scope || Search scope. other values: "base" and "subtree" || "onelevel" ||
468
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
31 || ldap_tls || Enable TLS (StartTLS) to connect to LDAP (can be true or false). The non-standard 'LDAPS' protocol is not supported. || false ||
450
042161223488 mod_auth_ldap: Update configuration section
Kim Alvefur <zash@zash.se>
parents: 422
diff changeset
32 || ldap_base || LDAP base directory which stores user accounts || This is required ||
472
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
33 || ldap_mode || How passwords are validated. || "bind" ||
420
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
34
468
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
35 *Note:* lua-ldap reads from /etc/ldap/ldap.conf and other files like
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
36 ~prosody/.ldaprc if they exist. Users wanting to use a particular TLS
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
37 root certificate can specify it in the normal way using TLS_CACERT in
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
38 the OpenLDAP config file.
eb771cbbf410 Incorporated feedback from Daniel Pocock
MWild1@gmail.com
parents: 450
diff changeset
39
420
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
40 = Modes =
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
41
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
42 The "getpasswd" mode requires plain text access to passwords in LDAP and
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
43 feeds them into Prosodys authentication system. This enables more secure
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
44 authentication mechanisms but does not work for all deployments.
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
45
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
46 The "bind" performs an LDAP bind, does not require plain text access to
eb372e6bb82f mod_auth_ldap: Document the ldap_mode option
Kim Alvefur <zash@zash.se>
parents: 403
diff changeset
47 passwords but limits you to the PLAIN authentication mechanism.
137
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
48
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
49 = Compatibility =
eb945500dae4 mod_auth_ldap: Added some documentation.
Waqas Hussain <waqas20@gmail.com>
parents:
diff changeset
50
472
bb454e0cb7fc Update mod_auth_ldap page
Kim Alvefur <zash@zash.se>
parents: 468
diff changeset
51 || 0.8 and above || should work ||