Red Hat

Developer Materials

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

What is it?

This example 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 6.1 or later.

All you need to build this project is Java 6.0 (Java SDK 1.6) or later, Maven 3.0 or later.

Configure Maven

If you have not yet done so, you must Configure Maven before testing the quickstarts.

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:        
      EAP_HOME/bin/ -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
      EAP_HOME/bin/ -a -u 'user1' -p 'password1!' -g 'app-user'

    For Windows: 
      EAP_HOME\bin\add-user.bat  -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
      EAP_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 instructions in the root README file 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:   EAP_HOME/bin/
     For Windows: EAP_HOME\bin\standalone.bat

Build and Deploy the Quickstart

NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.

  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 jboss-as: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: JBAS014502: 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 jboss-as:undeploy

Run the Quickstart in JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts from Eclipse using JBoss tools. For more information, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts

Debug the Application

If you want to debug the source code or look at the Javadocs of any library in the project, run either of the following commands to pull them into your local repository. The IDE should then detect them.

mvn dependency:sources
mvn dependency:resolve -Dclassifier=javadoc

Recent Changelog

  • Apr 11, 2014(Sande Gilda):Bz1086883 Update Product Version metadata to include EAP 6.3
  • Mar 12, 2014(Sande Gilda):Bz1074530 replace JBOSS_HOME with EAP_HOME
  • Mar 2, 2014(Sande Gilda):Bz1025766 Replace JBoss with JBoss EAP
  • Feb 27, 2014(Sande Gilda):Bz1070677 Fix add user instructions in ejb security README file
  • Feb 14, 2014(Sande Gilda):Replace JDBS instructions with shared resource
  • Jan 28, 2014(Sande Gilda):JDF 602 Part 2 of changes to move common instructions to a shared repository. This commit contains the Maven Configuration link changes
  • Jan 28, 2014(Sande Gilda):Part 1 replace PostgreSQL Byteman and Add User links
  • Dec 16, 2013(Sande Gilda):JDF 577 Replace command line with command prompt when referring to a terminal
  • Nov 8, 2013(Sande Gilda):Bz1028448 Add spaces to end of metadata so it renders with a line break in HTML
  • Oct 8, 2013(Sande Gilda):BZ1011833 Add HTML versions of README files and fix deployment instructions
Your Rating: