Custom Principal and LoginModule for Wildfly

posted by Roberto Cortez on

Did you ever had the need to implement your own custom JAAS Principal and LoginModule for you JEE application? There are a couple of reasons for it. I’ve done it in the following cases:

  • Authenticate the user using different strategies.
  • Have additional user information on the Principal object.
  • Share user information between applications using the Principal object.

Maybe you have your own specific reason, it doesn’t matter. Today’s post will guide you on how to do it for Wildfly. There are a few articles on the topic, but each of them deal with a different aspect of the problem. I got motivated to write this post to aggregate all the steps in a single article, including the Arquillian test.

Wildfly uses PicketBox for Java Application Security and already implements some handy classes to take care of the authentication of the user for you. Have a look into UsersRolesLoginModule, DatabaseServerLoginModule, LdapUsersLoginModule, BaseCertLoginModule and so on. Let’s start by creating a Maven project with the following dependency:

Next, just create a CustomPrincipal and a CustomLoginModule classes:

Note that we’re extending the present in PicketBox, but you can also implement instead.

Here again we’re extending a PicketBox class, You can code your own login module by implementing, but I recommend to extend one of the PicketBox classes, since they already have a lot of the behaviour that you will need. is a very simple login module that authenticates an user by matching his login and password to a file. You shouldn’t use it for production applications, but it’s very handy for prototypes.

CustomLoginModule is also overriding two methods. These are needed to access our CustomPrincipal in a JEE application. The login() method as the name says is called when the user is performing the login action, so in here we create our CustomPrincipal object. On the other hand, the getIdentity() method is called to return the Principal that corresponds to the user primary identity, so we return our own instance if the login was successful.

Ok, great. How do we test it now? We use Arquillian, JUnit and HttpUnit. Start by adding the needed Maven dependencies (these are all the project dependencies):

Note that we also included the javaee-api 7 dependency. Next, we’re creating a simple EJB to access our CustomPrincipal and a Servlet to perform the authentication:

Now the Servlet:

I think the code is self-explanatory, but we still need to wire everything together. The way we configure our login module to be used on Wildfly and on our application is by using Security Domains. You can add a Security Domain by hand using the standalone/configuration/standalone.xml and domain/configuration/domain.xml files on the Wildfly installation folder, but we’re going to do something more interesting.

Using the Command Line Interface (CLI), is really easy to make changes to the server configuration without modifying any XML. This also allows you to setup a test environment and clean up your changes in the end. To achieve that, create the following files:


As you probably have guessed, jboss-add-login-module.cli contains the CLI commands to add our Security Domain to the Wildfly instance. We first add the Security Domain and then assign the login modules to the domain. Both commands should be able to be executed as a single command, but for some reason I was getting an error so I had to split them apart. The configuration is not available on the server unless you perform a reload command. For the login module, please note the FQN of our CustomLoginModule associated with the configuration. That’s how we wire the custom login module to the Security Domain. The configuration also references two other files: and that are used to perform the user credential verification and load the user roles. Here are examples for both files:

Define all valid usernames and their corresponding passwords.

Define the sets of roles for valid usernames.

We still need the CLI commands to remove the Security Domain at the cleanup phase:


Almost done? Not yet! We still need to associate our Security Domain to our JEE application so our custom code runs when we perform authentication or execute Principal related behaviour. We need the following files now:


The previous file sets the Security Domain into Servlets.


This file sets the Security Domain in EJB’s.

Uff! Now we’re finally ready to see some action! We required a bit of setup to have this example working! Here is the test class:

That’s it! Now your servlet login method will authenticate using your custom login module and methods like getUserPrincipal() from the servlet request or getCallerPrincipal() from the EJBContext will return the CustomPrincipal instance.

Fire up a Wildfly instance and run the test using mvm test or just use your favourite IDE.

A few problems:

  • It should be possible to add the security domain using only one single CLI command, but for some reason I was getting an erro. I need to have a better look into this.
  • I couldn’t find a way to run code before and after the Arquillian deployment, so the code to add the Security Domain is inside the deployment method. I’ll try to find a way to do it.

If you want additional information, please check the following references:

If you’re too lazy to write the code on your own or just want a working sample, you can download it here. Enjoy!

First Coimbra JUG meeting – The new Java 8 Features

posted by Roberto Cortez on

Last Thursday, 19 December 2013, the first ever meeting of Coimbra JUG was held on the Department of Informatics Engineering of the University of Coimbra, in Portugal. I couldn’t be more proud, more than 50 people attended the event.

After a quick intro to the JUG by myself, explaining the JUG objective and purposes, we had Samuel Santos from PT.JUG to share some of his experience running and managing the biggest JUG in Portugal.

The highlight of the meeting was the my talk about the new features in Java 8, especially lambdas. I think that most of the people enjoyed it, but maybe it was not that interesting for the folks that already use lambdas or equivalents on other languages. Also a lesson learned for me.

If you’re curious, here are the materials (in portuguese):
YouTube Channel

You can find more photos of the event on our Meetup page. We also have a few videos that I’m uploading right now. I’ll update the post when I’m done.

A special thanks to Jetbrains for giving away 2 free licenses of IntelliJ 13 to raffle among the participants. Congratulations to the lucky winners of Math.random(), Hugo Lopes and Luis Rosa.

Feel free to comment 🙂

Hi Everyone!

posted by Roberto Cortez on

Hi Everyone!

Welcome to my blog, and thank you for the visit. Please take some time to read my About me page.

I have created this blog to share any Java related topic to anyone that may care. For me, it would be useful to improve my English and keep a record of stuff I work and do. I usually forget a lot of stuff!

Anyway… Enjoy!