Show last authors
1 1 User Authentication
2
3 XWiki supports several different authentication mechanisms for authenticating users:
4 #toc("" "" "")
5
6 The form authentication is the default mechanism.
7
8 #info("Note that currently XWiki allows only one method of authentication to be enabled at a time which means you cannot implement policies such as if the user is not found in LDAP then check if he's in the XWiki database. This will probably be improved in the future.")
9
10 1.1 Form Authentication
11
12 TODO
13
14 1.1 LDAP Authentication
15
16 1.1.1 Generic LDAP configuration
17
18 In order to enable the LDAP support you have to change the authentication method in ~~WEB-INF/xwiki.cfg~~ as follows:
19 {code}
20 xwiki.authentication.ldap=1
21 {code}
22
23 You can setup the LDAP configuration either on the XWiki.XWikiPreferences page or in the ~~xwiki.cfg~~ file
24
25 * *XWiki.XWikiPreferences*: you will need to use the class editor to add the following fields:
26 ** ldap_server
27 ** ldap_port
28 ** ldap_check_level
29 ** ldap_base_DN
30 ** ldap_bind_DN
31 ** ldap_bind_pass
32 ** ldap_UID_attr
33 ** ldap_fields_mapping
34 * *xwiki.cfg*: use the following properties in the xwiki.cfg file
35 ** xwiki.authentication.ldap.server
36 ** xwiki.authentication.ldap.port
37 ** xwiki.authentication.ldap.check_level
38 ** xwiki.authentication.ldap.base_DN
39 ** xwiki.authentication.ldap.bind_DN
40 ** xwiki.authentication.ldap.bind_pass
41 ** xwiki.authentication.ldap.UID_attr
42 ** xwiki.authentication.ldap.fields_mapping
43
44 Example:
45
46 {code}
47 xwiki.authentication.ldap=1
48 xwiki.authentication.ldap.authclass=com.xpn.xwiki.user.impl.LDAP.LDAPAuthServiceImpl
49 xwiki.authentication.ldap.server=dsmaster
50 xwiki.authentication.ldap.check_level=1
51 xwiki.authentication.ldap.port=389
52 xwiki.authentication.ldap.base_DN=department=USER,department=INFORMATIK,department=1230,o=MP
53 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
54 xwiki.authentication.ldap.bind_pass={1}
55 xwiki.authentication.ldap.UID_attr=uid
56 {code}
57
58 1.1.1 LDAP Configuration for Active Directory
59
60 Here are values of the properties you need to set if your LDAP server implementation is Miscrosoft Active Directory:
61 - *ldap_server*: name/IP of AD server machine
62 - *ldap_port*: port ~~(e.g. 389)~~
63 - *ldap_check_level*: 1
64 - *ldap_base_DN*: name of root DN ~~(e.g. dc=ad,dc=company,dc=com)~~
65 - *ldap_bind_DN*: domain\{0\} ~~(e.g. ad\{0\} where \{0\} will be replaced by username during validation)~~
66 - *ldap_bind_pass*: \{1\} ~~(where \{1\} will be replaced by password during validation)~~
67 - *ldap_UID_attr*: sAMAccountName
68 - *ldap_fields_mapping*: name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
69
70 Example:
71 {code}
72 xwiki.authentication.ldap=1
73 xwiki.authentication.ldap.authclass=com.xpn.xwiki.user.impl.LDAP.LDAPAuthServiceImpl
74 xwiki.authentication.ldap.server=adserver
75 xwiki.authentication.ldap.check_level=1
76 xwiki.authentication.ldap.port=389
77 xwiki.authentication.ldap.base_DN=dc=subdomain,dc=domain,dc=suffix
78 xwiki.authentication.ldap.bind_DN=subdomain\\{0}
79 xwiki.authentication.ldap.bind_pass={1}
80 xwiki.authentication.ldap.UID_attr=sAMAccountName
81 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
82 {code}
83
84 The bind_DN and bind_pass fields contain the username and password for binding to the LDAP server in order to search, which will not necessarily be the same credentials as the user logging in.
85
86
87 The exact details of this configuration will vary based on your server configuration. It may not be necessary to prefix the username (represented by {0}) with the subdomain.
88
89 For testing purposes, you may wish to omit the "ldap.fields_mapping" field, to test the authentication first, and then add it later to get the mappings right.
90
91 This java client, [LDAP Browser/Editor > http://www-unix.mcs.anl.gov/~gawor/ldap/] is a handy tool for checking your configuration.
92
93
94
95
96 1.1 eXo Authentication
97
98 The eXo authentication is used automatically by adding/editing the ~~xwiki.exo=1~~ property in ~~WEB-INF/xwiki.cfg~~.
99
100 1.1 Custom Authentication
101
102 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
103 # Implement the XWikiAuthService interface.
104 # Edit the ~~WEB-INF/xwiki.cfg~~ file and add a ~~xwiki.authentication.authclass~~ property pointing to your class. For example:
105
106 {code}
107 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
108 {code}
109
110 1.1 Authentication parameters
111
112 You can set each of these parameters by setting:
113
114 {code}
115 xwiki.authentication.~~param_name~~=~~param_value~~
116 {code}
117
118 {table}
119 Name | Optional | Allowed values | Default value | Description
120 encryptionKey | No(1) | ? | n/a | Set the Encryption Key used to create a secret key, the secret key is passed to the Cipher object to be used during encryption and decryption of cookie values.
121 validationKey | No(2) | ? | n/a | Set the Validation Key used to generate hash value; the hash value is stored with the cookie and used to verify that the cookie has not been tampered with.
122 cookiedomains | Yes | String | Server host name | Which host(s) should your cookies be sent to; use only if you want to share cookies across domains, otherwise should be commented out
123 cookielife | Yes | Number | 14 | Number of days cookies take to expire
124 cookiepath | Yes | String | / | The webapp path that XWiki cookies should be sent to; if you have anything else running on your web server, this should be set to ~~/xwiki~~
125 default_page | Yes | String | /bin/view/ Main/WebHome | Page to redirect to if xredirect parameter is not set
126 encryptionalgorithm | Yes | ? | ? | Set the Encryption Algorithm used to encrypt and decrypt cookies
127 encryptionmode | Yes | ? | ? | Set the Encryption Mode used to encrypt and decrypt cookies
128 encryptionpadding | Yes | ? | ? | Set the Encryption Padding used to encrypt and decrypt cookies
129 errorpage | Yes | String | /bin/loginerror/ XWiki/XWikiLogin | Page to redirect to if there is an error logging in
130 loginpage | Yes | String | /bin/login/ XWiki/XWikiLogin | Page to redirect to when not logged in
131 loginsubmitpage | Yes | String | /loginsubmit/ XWiki/XWikiLogin | ?
132 logoutpage | Yes | String | /bin/logout/ XWiki/XWikiLogout | Page to redirect to after logged out
133 realname | Yes | String | XWiki | Sets the realm name (should be ~~realmname~~???)
134 protection | Yes | all, validation, encryption, none | all | Protection level for the "remember me" cookie functionality
135 unauthorized_code | Yes | ? | ? | ?
136 useip | Yes | true / false | true | Specify to use the IP address when encrypting the cookie data; if IP address changes will need to re-login.
137 {table}
138 # Only required if protection = encryption or all (default)
139 # Only required if protection = validation or all (default)

Get Connected