HOWTO: Bonita and LDAP authentication

This how-to is written in the hope that it will help souls in achieving basic LDAP login with Bonita User Experience, using EJB3. This how-to is written based on the thread at http://www.bonitasoft.org/forum/viewtopic.php?id=2397.

It is working for me, but it may not for you. Please post your questions on the Bonita forums, many eyes will look at your issue and try to help you.

Here is a dirty PDF for those who wants. However, if you do use this howto, always refer to the online version for updates and up-to-date content.
Bonita LDAP howto

It may not render well in this blog, so I’d advise in pasting the code in your favorite editor to see clearly.

My environment at this time is:

  • Centos 5.4 latest updates
  • Jboss 5.1 GA
  • BOS 5.0.1
  • Java JDK 1.6.0 update 18
  • Active Directory 2003

To give a reference, here is how my base directory look like. I will refer to it when editing some files.

Under /opt:

[sourcecode language=’plain’]
lrwxrwxrwx 1 root root 9 Feb 23 11:39 BOS -> BOS-5.0.1
drwxr-xr-x 5 root root 4096 Feb 15 19:33 BOS-5.0.1
lrwxrwxrwx 1 root root 11 Feb 23 13:58 java-jdk-6 -> jdk1.6.0_18
lrwxrwxrwx 1 root root 14 Feb 23 16:19 jboss -> jboss-5.1.0.GA
drwxr-xr-x 9 root root 4096 Mar 4 09:57 jboss-5.1.0.GA
drwxr-xr-x 10 root root 4096 Feb 23 13:57 jdk1.6.0_18
[/sourcecode]

We will use the org.jboss.security.auth.spi.LdapExtLoginModule, as it will allow us to bind to the ActiveDirectory server. If you can allow for anonymous LDAP requests, then you may also try the Sun LDAPLoginModule.

jBoss configuration and EAR generation

JAVA_OPTS

In the run.sh file of jboss /opt/jboss/bin/run.sh) , edit it to configure your JAVA_OPTS:

[sourcecode language=’plain’]JAVA_OPTS=”-Dorg.ow2.bonita.api-type=EJB3 -server -Xms256m -Xmx512m -XX:PermSize=128m -XX:MaxPermSize=256m”
[/sourcecode]

Alongside specifying the EJB3 for Bonita, I am setting reasonable settings for jBoss java memory, and possible avoid Permgen out of memory errors.

Extra: For quick and unsecure monitoring using jconsole, also add the following.
[sourcecode language=’plain’]JAVA_OPTS=”$JAVA_OPTS -Dcom.sun.management.jmxremote=true -Dcom.sun.management.jmxremote.port=10001 -Dcom.sun.management.jmxremote.authenticate=false -Dcom.sun.management.jmxremote.ssl=false”
[/sourcecode]

bonita-environment.xml

… under the /opt/BOS/runtime/conf directory directly. It will be used when building the EAR file.

So, we can already specify the implementation of the AuthenticationService interface, which we will call SimpleLdapAuth.
Edit the file /opt/BOS/runtime/bonita-environment.xml. It should look like the following:

[sourcecode language=’xml’]

[/sourcecode]

Of course, your package path will vary.
A sample, simple, implementation of the interface follows later on.

Generating bonita.ear

We now need to go ahead and generate our bonita.ear file, which will then be used by jBoss.

[sourcecode language=’plain’]cd/opt/BOS/runtime[/sourcecode]

Now, build your ejb3.

[sourcecode language=’plain’]ant ear.ejb3[/sourcecode]

You should get something like this:

[sourcecode language=’plain’][root@bonita-test runtime]# ant ear.ejb3

Buildfile: build.xml

ear.genBonitaConfJar:

ear.ejb3:

ear:

[mkdir] Created dir: /opt/BOS-5.0.1/runtime/ear/tmp

[unjar] Expanding: /opt/BOS-5.0.1/runtime/lib/server/bonita-server-5.0.1.jar into /opt/BOS-5.0.1/runtime/ear/tmp

[copy] Copying 1 file to /opt/BOS-5.0.1/runtime/ear/tmp/META-INF

ear.copyJeeDD:

[copy] Copying 1 file to /opt/BOS-5.0.1/runtime/ear/tmp/META-INF

[jar] Building jar: /opt/BOS-5.0.1/runtime/ear/ejb3/bonita-ejbjar.jar

[delete] Deleting directory /opt/BOS-5.0.1/runtime/ear/tmp

[ear] Building ear: /opt/BOS-5.0.1/runtime/ear/ejb3/bonita.ear

[echo] EJB3 ear has been generated in ear/ejb3 directory.

[echo] You can use it in the easybeans container, jonas 5 and jboss 5 application server.

BUILD SUCCESSFUL

Total time: 4 seconds
[/sourcecode]

Now, copy the bonita.ear file into your jboss deploy directory.

[sourcecode language=’plain’]cp /opt/BOS-5.0.1/runtime/ear/ejb3/bonita.ear
/opt/jboss/server/default/deploy/[/sourcecode]

login-config.xml

Add the 2 stanzas to the end of your login-config.xml, before the end tag. It is valid for an AD server (ie: (sAMAccountName={0}) is typically AD).)

[sourcecode language=’xml’]

ldap://your_ldap_server:389

simple

DC=domain,DC=com

DOMAINldapbrowser

(sAMAccountName={0})

SUBTREE_SCOPE

false

true

DC=domain,DC=com

(sAMAccountName={0})

memberOf

true

cn

follow

useFirstPass

[/sourcecode]

Your jaas-standard.cfg will then not be used anymore. You can comment everything out.

Implementation of AuthentionService interface

Java Code

Here you need to develop a little piece of java. Here is an example that will get you through for starters.

[sourcecode language=’java’]package com.domain.bonita.auth;

/**
* @author chapeaurouge
* @date 04/03/2010
* @version 0.1
*/

import org.ow2.bonita.facade.exception.UserNotFoundException;
import org.ow2.bonita.services.AuthenticationService;

public class SimpleLdapAuth implements AuthenticationService {

private String persistenceServiceName;

public SimpleLdapAuth(String persistenceServiceName) {
super();
this.persistenceServiceName = persistenceServiceName;
}

/**
* Determines if the user should have amdin accesses to the bonita interface
* Let’s say that Domain Admins have that privilege
*/
public boolean isUserAdmin(String username) throws UserNotFoundException {
if (username.equals(“MyAdmin”)) {
return true;
} else {
return false;
}
}

/**
* @return always true. If the LDAP request failed before, it doesn’t matter (?)
* Necessary to implement interface
*/
public boolean checkUserCredentials(String username, String password) {
return true;
}
}[/sourcecode]

Compiling

Compile the java code into a .class. Make sure the bonita jars are in your classpath.
[sourcecode language=’plain’]javac -cp ~/BOS-5.0.1/runtime/lib/server/bonita* SimpleLdapAuth.java[/sourcecode]
You should then have your .class file. If you did it locally, you can then upload it to your server.

Deploying

A manual way would be to do the following.
Go to your /opt/jboss/server/default/lib, create the directory hierarchy for your package name. So with our example, you could type

[sourcecode language=’plain’]mkdir -p com/domain/bonita/auth[/sourcecode]

Then copy, your .class in it. Now, still in your jboss lib directory, create a .jar file, as:

[sourcecode language=’plain’]jar -cvf domainLdapAuth.jar com/domain/bonita/auth/SimpleLdapAuth.class[/sourcecode]

Your jar will now be deployed on the next server startup.

Getting more verbose output

Edit /opt/jboss/server/default/conf/jboss-log4j.xml, and uncomment the following block:

[sourcecode language=’xml’]

[/sourcecode]

Conclusion

This should be it. I may have forgotten some things, or overlooked some steps. Hopefully, this was of some help for some of you.
You can now (re)start your jBoss server for the changes to take effect. Don’t forget to tail -f server.log to see how it looks like.
Your feedback and comments are welcome.
Thanks to rlg and abirembaut for their help in the forums.