Author: Sherif F. Makary, Stefan Guilhen
Level: Intermediate
Technologies: EJB, Security
Summary: The ejb-security
quickstart demonstrates the use of Java EE declarative security to control access to EJBs in WildFly.
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
The ejb-security
quickstart demonstrates the use of Java EE declarative security to control access to EJBs in WildFly Application Server.
This quickstart takes the following steps to implement EJB security:
application-security-domain
mapping in the ejb3
subsystem to enable Elytron security for the SecuredEJB
.@SecurityDomain("other")
security annotation to the EJB declaration to tell the EJB container to apply authorization to this EJB.@RolesAllowed({ "guest" })
annotation to the EJB declaration to authorize access only to users with guest
role access rights.@RolesAllowed({ "admin" })
annotation to the administrative method in the SecuredEJB
to authorize access only to users with admin
role access rights.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 but it should not be granted access to the administrative method annotated with RolesAllowed({"admin"})
.The applications these projects produce are designed to be run on WildFly Application Server 11 or later.
All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
To run these quickstarts with the provided build scripts, you need the WildFly distribution ZIP. For information on how to install and run JBoss, see the WildFly Application Server Getting Started Guide located on the Customer Portal.
You can also run the quickstart in Red Hat JBoss Developer Studio or Eclipse.
In the following instructions, replace WILDFLY_HOME
with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.
Using the add-user utility script, you must add the following users to the ApplicationRealm
:
UserName | Realm | Password | Roles |
---|---|---|---|
quickstartUser | ApplicationRealm | quickstartPwd1! | guest |
The application user has guest
access rights to the application but no admin
rights.
To add the application users, open a command prompt and type the following commands:
For Linux:
WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
For Windows:
WILDFLY_HOME\bin\add-user.bat -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
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.
These steps assume you are running the server in standalone mode and using the default standalone.xml
supplied with the distribution.
You configure the security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-elytron.cli
script provided in the root directory of this quickstart.
Before you begin, back up your server configuration file
WILDFLY_HOME/standalone/configuration/standalone.xml
Start the WildFly server by typing the following:
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
configure-elytron.cli
file in the root of this quickstart directory. This script adds the configuration that enables Elytron security for the quickstart components. Comments in the script describe the purpose of each block of commands.Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing WILDFLY_HOME with the path to your server:
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=configure-elytron.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=configure-elytron.cli
You should see the following result when you run the script:
The batch executed successfully
process-state: reload-required
Stop the WildFly server.
After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone.xml
file and review the changes.
application-security-domain
mapping was added to the ejb3
subsystem:
<application-security-domains>
<application-security-domain name="other" security-domain="ApplicationDomain"/>
</application-security-domains>
The application-security-domain
essentially enables Elytron security for the quickstart EJBs. It maps the other
security domain that was set in the EJBs via annotation to the Elytron ApplicationDomain
that will be responsible for authenticating and authorizing access to the EJBs.
http-remoting-connector
in the remoting
subsystem was updated to use the application-sasl-authentication
factory:
<http-connector name="http-remoting-connector" connector-ref="default" security-realm="ApplicationRealm" sasl-authentication-factory="application-sasl-authentication"/>
This configuration allows for the identity that was established at the connection level to be propagated to the components.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
mvn clean package wildfly:deploy
This will deploy target/ejb-security.jar
to the running instance of the server.
Before you run the client, make sure you have already successfully deployed the EJBs to the server in the previous step and that your command prompt is still in the root directory of this quickstart.
Type this command to execute the client:
mvn exec:exec
When you run the mvn exec:exec
command, you see the following output. Note there may be other log messages interspersed between these messages.
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Successfully called secured bean, caller principal quickstartUser
Principal has admin permission: false
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
The username and credentials used to establish the connection to the application server are configured in the wildfly-config.xml
file. As expected, the quickstartUser
was able to invoke the method available for the guest
role, but not the administrative method that requires the admin
role.
NOTE: You should also see the following EJBAccessException
printed in the server log, followed by a stack trace. This is to be expected because the user does not have the correct permissions to access the EJB.
07:00:15,364 ERROR [org.jboss.as.ejb3.invocation] (default task-38) WFLYEJB0034: EJB Invocation failed on component SecuredEJB for method public abstract boolean org.jboss.as.quickstarts.ejb_security.SecuredEJBRemote.administrativeMethod(): javax.ejb.EJBAccessException: WFLYEJB0364: Invocation on method: public abstract boolean org.jboss.as.quickstarts.ejb_security.SecuredEJBRemote.administrativeMethod() of bean: SecuredEJB is not allowed
As an exercise, you can rerun the add-user
script described in the Add the Application Users section, but this time grant the quickstartUser
the admin role as follows:
For Linux:
WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest,admin'
For Windows:
WILDFLY_HOME\bin\add-user.bat -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest,admin'
After you update the quickstartUser
user role, you must restart the server for it to take effect. Running the client again should immediately reflect the new permission level of the user:
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Successfully called secured bean, caller principal quickstartUser
Principal has admin permission: true
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
mvn wildfly:undeploy
You can restore the original server configuration by running the restore-configuration.cli
script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=restore-configuration.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=restore-configuration.cli
This script reverts the changes made to the ejb3
and undertow
subsystems. You should see the following result when you run the script:
The batch executed successfully
process-state: reload-required
WILDFLY_HOME/standalone/configuration/standalone.xml
file with the back-up copy of the file.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 WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
ejb-security
project and choose Run As
--> Maven build
. Enter clean package wildfly:deploy
for the Goals:
and click Run
. This deploys the ejb-security
JAR to the WildFly server.ejb-security
project and choose Run As
--> Run Configurations
. Enter exec:exec
for the Goals
, and then click Run
.ejb-security
project and choose Run As
--> Run Configurations
. Enter wildfly:undeploy
for the Goals
and click Run
.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