User Authentication
XWiki supports several different authentication mechanisms for authenticating users:
- Form Authentication
- Basic Authentication
- LDAP Authentication
- eXo Authentication
- Custom Authentication
- Authentication parameters
- Kerberos SSO Authentication
The form authentication is the default mechanism.
Form Authentication
Form authentication is the default way to get authenticated within a Wiki. It requires a user and a password.
Basic Authentication
XWiki supports [basic access authentication>http://en.wikipedia.org/wiki/Basic_access_authentication], a method designed to allow a Web browser, or other client program, to provide credentials - in the form of a user name and password - when making a request. You can get authenticated against an XWiki server with the basic authentication protocol using the following URL scheme:
LDAP Authentication
Generic LDAP configuration
In order to enable the LDAP support you have to change the authentication method in WEB-INF/xwiki.cfg as follows:
## 0 : disable
## 1 : enable
xwiki.authentication.ldap=1
## set LDAP as authentication service
xwiki.authentication.authclass=com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl
You can setup the LDAP configuration in the xwiki.cfg file by filling the following properties:
xwiki.authentication.ldap.server=127.0.0.1
xwiki.authentication.ldap.port=389
#-# LDAP login, empty = anonymous access, otherwise specify full dn
#-# {0} is replaced with the username, {1} with the password
xwiki.authentication.ldap.bind_DN=cn={0},department=USER,department=INFORMATIK,department=1230,o=MP
xwiki.authentication.ldap.bind_pass={1}
#-# Force to check password after LDAP connection
#-# 0: disable
#-# 1: enable
xwiki.authentication.ldap.validate_password=0
#-# only members of the following group will be verified in the LDAP
#-# otherwise only users that are found after searching starting from the base_DN
# xwiki.authentication.ldap.user_group=cn=developers,ou=groups,o=MegaNova,c=US
#-# only users not member of the following group can autheticate
# xwiki.authentication.ldap.exclude_group=cn=admin,ou=groups,o=MegaNova,c=US
#-# base DN for searches
xwiki.authentication.ldap.base_DN=
#-# Specifies the LDAP attribute containing the identifier to be used as the XWiki name (default=cn)
# xwiki.authentication.ldap.UID_attr=cn
#-# Specifies the LDAP attribute containing the password to be used "when xwiki.authentication.ldap.validate_password" is set to 1
# xwiki.authentication.ldap.password_field=userPassword
#-# The potential LDAP groups classes. Separated by commas.
# xwiki.authentication.ldap.group_classes=group,groupOfNames,groupOfUniqueNames,dynamicGroup,dynamicGroupAux,groupWiseDistributionList
#-# The potential names of the LDAP groups fields containings the members. Separated by commas.
# xwiki.authentication.ldap.group_memberfields=member,uniqueMember
#-# retrieve the following fields from LDAP and store them in the XWiki user object (xwiki-attribute=ldap-attribute)
xwiki.authentication.ldap.fields_mapping=last_name=sn,first_name=givenName,email=mail
#-# on every login update the mapped attributes from LDAP to XWiki otherwise this happens only once when the XWiki account is created.
xwiki.authentication.ldap.update_user=1
#-# mapps XWiki groups to LDAP groups, separator is "|"
# xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=cn=AdminRole,ou=groups,o=MegaNova,c=US|\
# XWiki.Organisation=cn=testers,ou=groups,o=MegaNova,c=US
#-# time in s after which the list of members in a group is refreshed from LDAP (default=3600*6)
# xwiki.authentication.ldap.groupcache_expiration=21800
#-# - create : synchronize group membership only when the user is first created
#-# - always: synchronize on every login
# xwiki.authentication.ldap.mode_group_sync=always
#-# if ldap authentication fails for any reason, try XWiki DB authentication with the same credentials
xwiki.authentication.ldap.trylocal=1
#-# SSL connection to LDAP server
#-# 0: normal
#-# 1: SSL
# xwiki.authentication.ldap.ssl=0
#-# The keystore file to use in SSL connection
# xwiki.authentication.ldap.ssl.keystore=
#-# The java secure provider used in SSL connection
# xwiki.authentication.ldap.ssl.secure_provider=com.sun.net.ssl.internal.ssl.Provider
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.
Here are some LDAP client for checking your configuration:
Detailed use cases
See LDAP configuration uses cases for some detailed use cases.
Enable LDAP debug log
See Logging.
The specific packages to track for LDAP are com.xpn.xwiki.plugin.ldap and com.xpn.xwiki.user.impl.LDAP.
Before 3.1, add the following to the log4j configuration file:
log4j.logger.com.xpn.xwiki.user.impl.LDAP=trace
eXo Authentication
The eXo authentication is used automatically by adding/editing the xwiki.exo=1 property in WEB-INF/xwiki.cfg.
Custom Authentication
This allows plugging to any existing authentication mechanism such as SiteMinder, etc. To configure a custom authentication do the following:
- Implement the XWikiAuthService interface.
- Edit the WEB-INF/xwiki.cfg file and add a xwiki.authentication.authclass property pointing to your class. For example:
Here's a tutorial on implementing a custom authentication class for authenticating against Oracle's SSO.
Note, that you also can implement own right management service by implementing XWikiRightService interface:
and Group Service by implementing XWikiGroupService:
Custom Authentication using a Groovy script in a wiki page
Start by specifying you want to use the Groovy Authenticator:
Then add another configuration parameter to specify in which wiki page the authenticator is:
Then in a wiki page put some Groovy code that returns a XWikiAuthService object.
Authentication parameters
You can set each of these parameters by setting:
| Name | Optional | Allowed values | Default value | Description |
|---|---|---|---|---|
| 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. |
| 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. |
| 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 |
| cookielife | Yes | Number | 14 | Number of days cookies take to expire |
| 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 |
| default_page | Yes | String | /bin/view/ Main/WebHome | Page to redirect to if xredirect parameter is not set |
| encryptionalgorithm | Yes | ? | ? | Set the Encryption Algorithm used to encrypt and decrypt cookies |
| encryptionmode | Yes | ? | ? | Set the Encryption Mode used to encrypt and decrypt cookies |
| encryptionpadding | Yes | ? | ? | Set the Encryption Padding used to encrypt and decrypt cookies |
| errorpage | Yes | String | /bin/loginerror/ XWiki/XWikiLogin | Page to redirect to if there is an error logging in |
| loginpage | Yes | String | /bin/login/ XWiki/XWikiLogin | Page to redirect to when not logged in |
| loginsubmitpage | Yes | String | /loginsubmit/ XWiki/XWikiLogin | The URL where the username and password are posted to when logging in. |
| logoutpage | Yes | String | /bin/logout/ XWiki/XWikiLogout | Page to redirect to after logged out |
| realmname | Yes | String | XWiki | Sets the realm name |
| protection | Yes | all, validation, encryption, none | all | Protection level for the "remember me" cookie functionality |
| unauthorized_code | Yes | Number | 401 | The HTTP status code to return when the login has failed. |
| 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. |
- Only required if protection = encryption or all (default)
- Only required if protection = validation or all (default)
Kerberos SSO Authentication
The following is an example of mod_auth_kerb for Apache being used to easily implement Xwiki authentication of users via by HTTP Negotiate on a linux server. This example assumes you already have a working Apache2 HTTPD and Apache Tomcat setup with mod_jk.
First of all you need to create a principal and keytab for the webserver:
kadmin> addprinc -randkey HTTP/wiki.example.com
kadmin> ktadd -k /etc/apache2/ssl/wiki.keytab HTTP/wiki.example.com
kadmin> quit
Make sure the keytab has the right permissions and ownership:
chmod 400 /etc/apache2/ssl/wiki.keytab
Install mod_auth_kerb in your linux installation. On Debian or Ubuntu this would be achieved by running:
Of course the installation procedure varies per Linux distribution.
If your xwiki installation is mounted in Apache HTTPD under /xwiki, add the following to the virtual host configuration:
AuthType Kerberos
AuthName "Kerberos Login"
KrbAuthRealms EXAMPLE.COM
Krb5Keytab "/etc/apache2/ssl/wiki.keytab"
KrbMethodK5Passwd off
KrbMethodNegotiate on
KrbSaveCredentials on
require valid-user
</Location>
Make sure Apache Tomcat uses the authentication performed by Apache HTTPD with the "tomcatAuthentication" property in the connector description (which is in the server.xml file of Apache Tomcat):
Place the authkerb.jar jar in the WEB-INF/lib directory of Xwiki in Apache Tomcat.
Have Xwiki use the authentication module by changing the "xwiki.authentication.authclass" property in WEB-INF/lib/xwiki.cfg file.
If you use Firefox, do not forget to whitelist the xwiki URL for HTTP Negotiate in about:config with the "network.negotiate-auth.trusted-uris" property. possible values for this propperty include (without the quotes): "https://" for all secured connections or "example.com" for all example.com subdomains.
2 JBoss SPNEGO (Kerberos in combination with LDAP) I changed the code of the XWikiLDAPAuthServiceImpl to be able to detect the sso user. The authenication already happend by using the SPNEGO module (JAAS). After that I'm using the ldap synchronisation feature to make sure that the user is up to date. The combination leads to an automatic login in the xwiki and the user rights are controlled in the Active Directory server. I hope you can adopt this code or that you can use it for your own projects.
The configuration of ldap:
xwiki.authentication.ldap=1
xwiki.authentication.ldap.server=<ad-server>
xwiki.authentication.ldap.port=389
xwiki.authentication.ldap.base_DN=<OU=Users,...............>
#use a fixed user to attach to the ldap database,
#the password is not provided with the SSOLdapAuthenicationImpl
xwiki.authentication.ldap.bind_DN=<domain>\\<user>
xwiki.authentication.ldap.bind_pass=<password>
#Microsoft AD configuration
xwiki.authentication.ldap.UID_attr=sAMAccountName
xwiki.authentication.ldap.fields_mapping=name=sAMAccountName,last_name=sn,first_name=givenName,fullname=displayName,mail=mail,ldap_dn=dn
xwiki.authentication.ldap.group_memberfields=member,uniqueMember
#LDAP group mapping
xwiki.authentication.ldap.group_mapping=XWiki.XWikiAdminGroup=CN=WIKI_Admin,............|\
XWiki.XWikiAllGroup=CN=WIKI_User,...........
The java code
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import com.xpn.xwiki.XWikiContext;
import com.xpn.xwiki.XWikiException;
import com.xpn.xwiki.user.api.XWikiUser;
import com.xpn.xwiki.user.impl.LDAP.XWikiLDAPAuthServiceImpl;
import java.security.Principal;
public class SSOLdapAuthenicationImpl extends XWikiLDAPAuthServiceImpl {
/**
* Logging tool.
*/
private static final Log LOG = LogFactory.getLog(SSOLdapAuthenicationImpl.class);
public XWikiUser checkAuth(XWikiContext context) throws XWikiException {
String user = getRemoteUser(context);
if ((user != null) || !user.equals("")) {
if (LOG.isInfoEnabled())
LOG.info("Launching create user for " + user);
if ( authenticate(user, context) != null ) {
if (LOG.isInfoEnabled())
LOG.info("Create user done for " + user);
user = "XWiki." + user;
context.setUser(user);
System.out.println("User is set to:" + user);
return new XWikiUser(user);
} else {
LOG.error( "User " + user + " can't be authenticated against ldap" );
}
}
return super.checkAuth(context);
}
/**
* We cannot authenticate locally since we need to trust the app server for
* authentication
*
* @param username
* @param password
* @param context
* @return
* @throws XWikiException
*/
public XWikiUser checkAuth(String username, String password,
String rememberme, XWikiContext context) throws XWikiException {
String user = getRemoteUser(context);
if ((user == null) || user.equals("")) {
return super.checkAuth(username, password, rememberme, context);
}
return checkAuth(context);
}
private String getRemoteUser(XWikiContext context) {
String userName = context.getRequest().getHttpServletRequest()
.getRemoteUser();
if (userName != null) {
// only take the front of the username@domain
String[] elements = userName.split("@", 2);
userName = elements[0];
}
return userName;
}
public Principal authenticate(String login, XWikiContext context) throws XWikiException
{
if (LOG.isTraceEnabled()) {
LOG.trace("Starting LDAP authentication");
}
/*
* TODO: Put the next 4 following "if" in common with XWikiAuthService to ensure coherence This method was
* returning null on failure so I preserved that behaviour, while adding the exact error messages to the context
* given as argument. However, the right way to do this would probably be to throw XWikiException-s.
*/
if (login == null) {
// If we can't find the username field then we are probably on the login screen
if (LOG.isDebugEnabled()) {
LOG.debug("The provided user is null."
+ " We don't try to authenticate, it probably means the user is in non logged mode.");
}
return null;
}
// Check for empty usernames
if (login.equals("")) {
context.put("message", "nousername");
if (LOG.isDebugEnabled()) {
LOG.debug("LDAP authentication failed: login empty");
}
return null;
}
// If we have the context then we are using direct mode
// then we should specify the database
// This is needed for virtual mode to work
Principal principal = null;
// Try authentication against ldap
principal = ldapAuthenticate(login, "", context);
if (LOG.isDebugEnabled()) {
if (principal != null) {
LOG.debug("LDAP authentication succeed with principal [" + principal.getName() + "]");
} else {
LOG.debug("LDAP authentication failed for user [" + login + "]");
}
}
return principal;
}
}
