Show last authors
1 Here you can find some detailed uses cases of LDAP authentication configuration:
3 {{toc/}}
5 = Active Directory =
7 Here are the values of the properties you need to set if your LDAP server implementation is Microsoft Active Directory:
9 * **ldap_server**: name/IP of AD server machine
10 * **ldap_port**: port //(e.g. 389)//
11 * **ldap_base_DN**: name of root DN //(e.g. dc=ad,dc=company,dc=com)//
12 * **ldap_bind_DN**: domain{0} //(e.g. ad{0} where {0} will be replaced by username during validation)//
13 * **ldap_bind_pass**: {1} //(where {1} will be replaced by password during validation)//
14 * **ldap_UID_attr**: sAMAccountName
15 * **ldap_fields_mapping**: name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,email=mail,ldap_dn=dn
17 Example:
19 {{code}}
20 xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
21 xwiki.authentication.ldap=1
22 xwiki.authentication.ldap.server=adserver
23 xwiki.authentication.ldap.port=389
24 xwiki.authentication.ldap.base_DN=dc=subdomain,dc=domain,dc=suffix
25 xwiki.authentication.ldap.bind_DN=subdomain\\{0}
26 xwiki.authentication.ldap.bind_pass={1}
27 xwiki.authentication.ldap.UID_attr=sAMAccountName
28 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,email=mail,ldap_dn=dn
29 {{/code}}
31 = Apple Open Directory Server =
33 In order to set this up your **xwiki.cfg** file should have the attributes below set like this:
35 {{code}}
36 xwiki.authentication.ldap.bind_DN=uid={0},cn=users,dc=sub,dc=domain,dc=tld
37 xwiki.authentication.ldap.bind_pass={1}
38 xwiki.authentication.ldap.UID_attr=uid
39 xwiki.authentication.ldap.group_classes=apple-group
40 xwiki.authentication.ldap.group_memberfields=memberUid,uid
41 {{/code}}
43 Note that if you set it up like this the users logging will need the right to list group members in LDAP server.
45 = Open Directory Server (OpenDS) =
47 Here are the values of the properties you need to set if you would like to **authorize only members of a group to log-in**. In this case, the group is cn=xwiki,ou=roles,dc=domain,dc=tld
49 {{code}}
50 xwiki.authentication.ldap.server=ldap.domain.tld
51 xwiki.authentication.ldap.port=389
53 xwiki.authentication.ldap.bind_DN=
54 xwiki.authentication.ldap.bind_pass=
56 xwiki.authentication.ldap.base_DN=ou=people,dc=domain,dc=tld
57 xwiki.authentication.ldap.UID_attr=cn
59 xwiki.authentication.ldap.group_classes=groupOfNames
60 xwiki.authentication.ldap.group_memberfields=memberUid
61 xwiki.authentication.ldap.user_group=cn=xwiki,ou=roles,dc=domain,dc=tld
62 {{/code}}
64 **bind_DN** and **bind_pass** are both empty. The connection to the LDAP server will be anonymous. With OpenDS an anonymous connection can read some needed attributes like userPassword, home, etc.
66 = Generic =
68 == I want to have LDAP on ##subwiki1## but not on ##subwiki2##
70 Each wiki can have it's own LDAP setup. When LDAP fail on a subwiki it fallback on main wiki.
72 Two possibilities:
74 === Disable LDAP by default for all wikis and then enable it only in wikis where you want it
76 * disable LDAP at xwiki.cfg level (which is the default configuration for all wikis)(((
77 {{code language="properties"}}
78 xwiki.authentication.ldap=0
79 {{/code}})))
80 *enable it only in subwikis where we want it: can be done by directly editing XWiki.XWikiReference document with object editor ( or using [[extensions:Extension.LDAP Application]].
82 === Enable LDAP by default for all wikis and then disable it only on wikis where you don't want it
84 * enable LDAP at xwiki.cfg level (which is the default configuration for all wikis)(((
85 {{code language="properties"}}
86 xwiki.authentication.ldap=1
87 {{/code}})))
88 * disable it only in subwikis where we want it: can be done by directly editing XWiki.XWikiReference document with object editor ( or using [[extensions:Extension.LDAP Application]].
90 {{warning}}
91 Righs now the authenticator always fallback on main wiki when LDAP is disabled or does not work on subwiki. That mean it's not possible to have LDAP auth working when logging in from main wiki but and failing when logging in from a subwiki. In such a case you will be logged with a global user (main wiki user), same as if you were accessing main wiki and then subwiki in the same session.
93 But what you can do in this case is to not allow main wiki users from accessing the subwiki which will essentially have the same result.
94 {{/warning}}
96 == I want to be able to reuse LDAP users membership in XWiki ==
98 E.g. if you want all the LDAP users of the group ##cn=HMS Lydia,ou=crews,ou=groups,o=sevenSeas## to be automatically added in the XWiki group ##XWiki.XWikiAdminGroup## when the user logs in, set:
100 {{code}}
101 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=HMS Lydia,ou=crews,ou=groups,o=sevenSeas
102 {{/code}}
104 If you want to add more mapping add them separated by ##|##:
106 {{code}}
107 xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=HMS Lydia,ou=crews,ou=groups,o=sevenSeas|\
108 XWiki.OtherXWikiGroup=HMS Victory,ou=crews,ou=groups,o=sevenSeas
109 {{/code}}
111 == My users are not located in the same organization unit ==
113 So you can't use the ##xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP## pattern.
115 The trick here is to to connect to LDAP with a user able to list LDAP users (and groups if you want to do membership synchronization).
117 To handle that LDAP authentication automatically searches for the user's DN trying to match the provided login with ##xwiki.authentication.ldap.UID_attr## attribute value. So simply set an existing administrator DN (or any other LDAP user with the right to search in the whole LDAP server) at ##xwiki.authentication.ldap.bind_DN## and its password at ##xwiki.authentication.ldap.bind_pass##. LDAP authentication will use it to connect to the LDAP server, search for the provided user and bind the found DN with the provided password to validate it.
119 For example if you have an admin user with the DN = "cn=Administrator,dc=mydomain,dc=org" and password "pass" set:
121 {{code}}
122 xwiki.authentication.ldap.bind_DN=cn=Administrator,dc=mydomain,dc=org
123 xwiki.authentication.ldap.bind_pass=pass
124 {{/code}}
126 == My users are not located on the same server ==
128 E.g. if you use several subdomains and the users are defined separately in each subdomain. This will likely be the case when you have a configuration like this:
130 {{code}}
134 ...
135 {{/code}}
137 XWiki cannot search in multiple domains (as of XWiki 1.5).
139 === Approach 1: Configure group membership login ===
141 One possible solution is to make one (or more) group(s) in your AD and set the group membership to all users that have to have access to your wiki. Then configure XWiki to only let members of that group log in. If a user wants to log in, XWiki will look up if the user's credentials are found in the group member attributes in AD. With this setting, XWiki will ignore the base_DN search, if a user was found in that group.
143 {{info}}
144 The group membership attribute in AD (in its default configuration) will contain the CN ("FirstName LastName") - not the sAMAccountName. So your users will have to login with their full name instead of their username.
145 {{/info}}
147 == I'm in a multiwiki environment and I want my LDAP users to register only on the main wiki ==
149 Each wiki can have its own LDAP configuration (even enable/disable LDAP) in the ##XWiki.XWikiPreference## page (edit it in [[objects mode>>platform:Features.PageEditing||anchor="HAdvancedMode"]]. See [[How to navigate to a page>>xwiki:FAQ.How can I navigate to a given page]]). What you can find in the ##xwiki.cfg## configuration file is just the default LDAP configuration and it can be overridden in subwikis.
151 When the LDAP authenticator fails to authenticate to a wiki it will try in the main wiki.
153 In order to forbid LDAP authentication to create users on subwikis you can use one of the following ways:
155 * disable LDAP in **xwiki.cfg** and enable it in the main wiki by choosing "Yes" in the "Ldap" field of ##XWiki.XWikiPreference## page object
156 * disable LDAP in every sub-wikis by choosing "No" in the "Ldap" field of ##XWiki.XWikiPreference## page object
158 == I want to allow access to users depending on a specific attribute on their LDAP entry ==
160 For example, suppose you want to prevent access to the wiki for deactivated users, and you have an attribute in LDAP showing the current status of the user.
162 Typically, you may have this kind of attribute:
164 * For Zimbra based LDAP, an active account has this attribute: **zimbraAccountStatus=active**
165 * For ActiveDirectory, a deactivated account has this attribute: **userAccountControl:1.2.840.113556.1.4.803:=2**
166 * Or you can have your own attribute in your private schema, for example: **accountstatus=active**
168 In this case, you just have to modify the **xwiki.authentication.ldap.user_group** value by putting the filter corresponding to what you want. Using the same example as above, you'll have:
170 * For Zimbra based LDAP:(((
171 {{code}}
172 xwiki.authentication.ldap.user_group=(zimbraAccountStatus=active)
173 {{/code}}
174 )))
175 * For ActiveDirectory:(((
176 {{code}}
177 xwiki.authentication.ldap.user_group=(!(userAccountControl:1.2.840.113556.1.4.803:=2))
178 {{/code}}
179 )))
180 * For a private attribute:(((
181 {{code}}
182 xwiki.authentication.ldap.user_group=(accountstatus=active)
183 {{/code}}
184 )))
186 You can of course use any kind of filter. For instance, you can check if the account is active and has any other attribute, like an attribute listing the different services the user can access:
188 {{code}}
189 xwiki.authentication.ldap.user_group=(&(accountstatus=active)(allowedservice=xwiki))
190 {{/code}}

Get Connected