Developer Materials

ejb-security: Using Java EE Declarative Security to Control Access

  • Author:
  • Contributors: Sande Gilda, Pete Muir
  • Published: Oct 22, 2015
  • Level: Intermediate
  • Technologies:EJB, Security
  • Target Product:JBoss EAP

What is it?

The ejb-security quickstart demonstrates the use of Java EE declarative security to control access to Servlets and EJBs in Red Hat JBoss Enterprise Application Platform.

This quickstart takes the following steps to implement EJB security:

  1. Define the security domain. This can be done either in the security subsytem of the standalone.xml configuration file or in the WEB-INF/jboss-web.xml configuration file. This quickstart uses the other security domain, which is provided by default in the standalone.xml file.

     <security-domain name="other" cache-type="default">
             <login-module code="Remoting" flag="optional">
                 <module-option name="password-stacking" value="useFirstPass"/>
             <login-module code="RealmDirect" flag="required">
                 <module-option name="password-stacking" value="useFirstPass"/>
  2. Add the @SecurityDomain("other") security annotation to the EJB declaration to tell the EJB container to apply authorization to this EJB.
  3. Add the @RolesAllowed({ "guest" }) annotation to the EJB declaration to authorize access only to users with guest role access rights.
  4. Add the @RolesAllowed({ "guest" }) annotation to the Servlet declaration to authorize access only to users with guest role access rights.
  5. Add a <login-config> security constraint to the WEB-INF/web.xml file to force the login prompt.
  6. Add an application user with guest role access rights to the EJB. This quickstart defines a user quickstartUser with password quickstartPwd1! in the guest role. The guest role matches the allowed user role defined in the @RolesAllowed annotation in the EJB.
  7. Add a second user that has no guest role access rights.

System requirements

The application this project produces is designed to be run on Red Hat JBoss Enterprise Application Platform 7 or later.

All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later. See Configure Maven for JBoss EAP 7 to make sure you are configured correctly for testing the quickstarts.

Use of EAP7_HOME

In the following instructions, replace EAP7_HOME with the actual path to your JBoss EAP installation. The installation path is described in detail here: Use of EAP7_HOME and JBOSS_HOME Variables.

Add the Application Users

Using the add-user utility script, you must add the following users to the ApplicationRealm:

UserName Realm Password Roles
quickstartUser ApplicationRealm quickstartPwd1! guest
user1 ApplicationRealm password1! app-user

The first application user has access rights to the application. The second application user is not authorized to access the application.

To add the application users, open a command prompt and type the following commands:

    For Linux:        
      EAP7_HOME/bin/ -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
      EAP7_HOME/bin/ -a -u 'user1' -p 'password1!' -g 'app-user'

    For Windows: 
      EAP7_HOME\bin\add-user.bat  -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
      EAP7_HOME\bin\add-user.bat -a -u 'user1' -p 'password1!' -g 'app-user'

If you prefer, you can use the add-user utility interactively. For an example of how to use the add-user utility, see the instructions located here: Add an Application User.

Start the JBoss EAP Server

  1. Open a command prompt and navigate to the root of the JBoss EAP directory.
  2. The following shows the command line to start the server:

     For Linux:   EAP7_HOME/bin/
     For Windows: EAP7_HOME\bin\standalone.bat

Build and Deploy the Quickstart

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. Type this command to build and deploy the archive:

     mvn clean install wildfly:deploy
  4. This will deploy target/jboss-ejb-security.war to the running instance of the server.

Access the application

The application will be running at the following URL http://localhost:8080/jboss-ejb-security/.

When you access the application, you are presented with a browser login challenge.

  1. If you attempt to login with a user name and password combination that has not been added to the server, the login challenge will be redisplayed.
  2. When you login successfully using quickstartUser/quickstartPwd1!, the browser displays the following security info:

     Successfully called Secured EJB
     Principal : quickstartUser
     Remote User : quickstartUser
     Authentication Type : BASIC
  3. Now close and reopen the brower session and access the application using the user1/password1! credentials. In this case, the Servlet, which only allows the guest role, restricts the access and you get a security exception similar to the following:

     HTTP Status 403 - Access to the requested resource has been denied
     type Status report
     message Access to the requested resource has been denied
     description Access to the specified resource (Access to the requested resource has been denied) has been forbidden.
  4. Next, change the EJB ( to a different role, for example, @RolesAllowed({ "other-role" }). Do not modify the guest role in the Servlet ( Build and redeploy the quickstart, then close and reopen the browser and login using quickstartUser/quickstartPwd1!. This time the Servlet will allow the guest access, but the EJB, which only allows the role other-role, will throw an EJBAccessException:

     HTTP Status 500
     description  The server encountered an internal error () that prevented it from fulfilling this request.
     javax.ejb.EJBAccessException: WFLYEJB0364: Invocation on method: public java.lang.String of bean: SecuredEJB is not allowed

Undeploy the Archive

  1. Make sure you have started the JBoss EAP server as described above.
  2. Open a command prompt and navigate to the root directory of this quickstart.
  3. When you are finished testing, type this command to undeploy the archive:

     mvn wildfly:undeploy

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a JBoss EAP server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

  • Be sure to Add the Application Users as described above.
  • To deploy the server project, right-click on the jboss-ejb-security project and choose Run As –> Run on Server.
  • You are presented with a browser login challenge. Enter the credentials as described above to access and test the running application.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

mvn dependency:sources

Recent Changelog

  • Oct 22, 2015(Sande Gilda):JBEAP 1446 Fix JBDS instructions in the ejb security README
  • Oct 15, 2015(Sande Gilda):JBEAP 1436 JBEAP 1446 Include consistent configuration steps in JBDS instructions for ejb security ejb security interceptors helloworld jms helloworld mdp propertysubstitution logging mail picketlink sts servlet security and shopping cart README files
  • Aug 20, 2015(Sande Gilda):JBEAP 577 Replace links to shared resources for JBoss EAP 7 material
  • Aug 14, 2015(Sande Gilda):JBEAP 678 Update the ejb security server log output in the README file
  • Aug 13, 2015(Sande Gilda):JBEAP 679 Add info EAP_HOME instructions back into the ejb security README
  • Aug 4, 2015(Sande Gilda):JBEAP 578 Update Maven version in README files
  • Aug 3, 2015(Sande Gilda):JBEAP 564 Clarify Maven instructions
  • Jul 23, 2015(Sande Gilda):Replace CONFIGURE_MAVEN link with CONFIGURE_MAVEN_JBOSS_EAP7 link
  • Jun 24, 2015(Sande Gilda):JDF833 Plugin commands have changed from jboss as prefix to wildfly prefix. jboss as deploy is now wildfly deploy and jboss as undeploy is now wildfly undeploy. Same replacement for port and hostname
  • Jun 17, 2015(Sande Gilda):Update the quickstart README files to remove instructions related to the Maven settings
Your Rating: