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 in the ~~xwiki.cfg~~ file by filling the following properties:
24 * xwiki.authentication.ldap.server
25 * xwiki.authentication.ldap.port
26 * xwiki.authentication.ldap.check_level
27 * xwiki.authentication.ldap.base_DN
28 * xwiki.authentication.ldap.bind_DN
29 * xwiki.authentication.ldap.bind_pass
30 * xwiki.authentication.ldap.UID_attr
31 * xwiki.authentication.ldap.fields_mapping
32
33 #info("You can also setup the LDAP configuration in XWiki.XWikiPreferences page by going to the class editor and adding the following fields:
34 * ldap_server
35 * ldap_port
36 * ldap_check_level
37 * ldap_base_DN
38 * ldap_bind_DN
39 * ldap_bind_pass
40 * ldap_UID_attr
41 * ldap_fields_mapping")
42
43 Example:
44
45 {code}
46 xwiki.authentication.ldap=1
47 xwiki.authentication.ldap.authclass=com.xpn.xwiki.user.impl.LDAP.LDAPAuthServiceImpl
48 xwiki.authentication.ldap.server=dsmaster
49 xwiki.authentication.ldap.check_level=1
50 xwiki.authentication.ldap.port=389
51 xwiki.authentication.ldap.base_DN=department=USER,department=INFORMATIK,department=1230,o=MP
52 xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
53 xwiki.authentication.ldap.bind_pass={1}
54 xwiki.authentication.ldap.UID_attr=uid
55 {code}
56
57 1.1.1 LDAP Configuration for Active Directory
58
59 Here are values of the properties you need to set if your LDAP server implementation is Miscrosoft Active Directory:
60 - *ldap_server*: name/IP of AD server machine
61 - *ldap_port*: port ~~(e.g. 389)~~
62 - *ldap_check_level*: 1
63 - *ldap_base_DN*: name of root DN ~~(e.g. dc=ad,dc=company,dc=com)~~
64 - *ldap_bind_DN*: domain\{0\} ~~(e.g. ad\{0\} where \{0\} will be replaced by username during validation)~~
65 - *ldap_bind_pass*: \{1\} ~~(where \{1\} will be replaced by password during validation)~~
66 - *ldap_UID_attr*: sAMAccountName
67 - *ldap_fields_mapping*: name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
68
69 Example:
70 {code}
71 xwiki.authentication.ldap=1
72 xwiki.authentication.ldap.authclass=com.xpn.xwiki.user.impl.LDAP.LDAPAuthServiceImpl
73 xwiki.authentication.ldap.server=adserver
74 xwiki.authentication.ldap.check_level=1
75 xwiki.authentication.ldap.port=389
76 xwiki.authentication.ldap.base_DN=dc=subdomain,dc=domain,dc=suffix
77 xwiki.authentication.ldap.bind_DN=subdomain\\{0}
78 xwiki.authentication.ldap.bind_pass={1}
79 xwiki.authentication.ldap.UID_attr=sAMAccountName
80 xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
81 {code}
82
83 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.
84
85
86 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.
87
88 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.
89
90 This java client, [LDAP Browser/Editor > http://www-unix.mcs.anl.gov/~gawor/ldap/] is a handy tool for checking your configuration.
91
92
93
94
95 1.1 eXo Authentication
96
97 The eXo authentication is used automatically by adding/editing the ~~xwiki.exo=1~~ property in ~~WEB-INF/xwiki.cfg~~.
98
99 1.1 Custom Authentication
100
101 This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
102 # Implement the XWikiAuthService interface.
103 # Edit the ~~WEB-INF/xwiki.cfg~~ file and add a ~~xwiki.authentication.authclass~~ property pointing to your class. For example:
104
105 {code}
106 xwiki.authentication.authclass = com.acme.MyCustomAuthenticationService
107 {code}
108
109 1.1 Authentication parameters
110
111 You can set each of these parameters by setting:
112
113 {code}
114 xwiki.authentication.~~param_name~~=~~param_value~~
115 {code}
116
117 {table}
118 Name | Optional | Allowed values | Default value | Description
119 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.
120 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.
121 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
122 cookielife | Yes | Number | 14 | Number of days cookies take to expire
123 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~~
124 default_page | Yes | String | /bin/view/ Main/WebHome | Page to redirect to if xredirect parameter is not set
125 encryptionalgorithm | Yes | ? | ? | Set the Encryption Algorithm used to encrypt and decrypt cookies
126 encryptionmode | Yes | ? | ? | Set the Encryption Mode used to encrypt and decrypt cookies
127 encryptionpadding | Yes | ? | ? | Set the Encryption Padding used to encrypt and decrypt cookies
128 errorpage | Yes | String | /bin/loginerror/ XWiki/XWikiLogin | Page to redirect to if there is an error logging in
129 loginpage | Yes | String | /bin/login/ XWiki/XWikiLogin | Page to redirect to when not logged in
130 loginsubmitpage | Yes | String | /loginsubmit/ XWiki/XWikiLogin | ?
131 logoutpage | Yes | String | /bin/logout/ XWiki/XWikiLogout | Page to redirect to after logged out
132 realname | Yes | String | XWiki | Sets the realm name (should be ~~realmname~~???)
133 protection | Yes | all, validation, encryption, none | all | Protection level for the "remember me" cookie functionality
134 unauthorized_code | Yes | ? | ? | ?
135 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.
136 {table}
137 # Only required if protection = encryption or all (default)
138 # Only required if protection = validation or all (default)

Get Connected