The ejb-security
quickstart demonstrates the use of Java EE declarative security to control access to EJBs in WildFly.
What is it?
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:
-
Add an
application-security-domain
mapping in theejb3
subsystem to enable Elytron security for theSecuredEJB
. -
Add the
@SecurityDomain("other")
security annotation to the EJB declaration to tell the EJB container to apply authorization to this EJB. -
Add the
@RolesAllowed({ "guest" })
annotation to the EJB declaration to authorize access only to users withguest
role access rights. -
Add the
@RolesAllowed({ "admin" })
annotation to the administrative method in theSecuredEJB
to authorize access only to users withadmin
role access rights. -
Add an application user with
guest
role access rights to the EJB. This quickstart defines a userquickstartUser
with passwordquickstartPwd1!
in theguest
role. Theguest
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 withRolesAllowed({"admin"})
.
System Requirements
The application this project produces is designed to be run on WildFly Application Server 12 or later.
All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven to Build and Deploy the Quickstarts 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 the WildFly server, see the Getting Started Guide for JBoss Enterprise Application Platform Continuous Delivery located on the Red Hat Customer Portal.
Use of WILDFLY_HOME
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.
Add the Authorized Application User
This quickstart uses secured management interfaces and requires that you create the following application user to access the running application.
UserName | Realm | Password | Roles |
---|---|---|---|
quickstartUser |
ApplicationRealm |
quickstartPwd1! |
guest |
To add the application user, open a terminal and type the following command:
$ WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest'
Note
|
For Windows, use the WILDFLY_HOME\bin\add-user.bat script.
|
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.
Back Up the WildFly Standalone Server Configuration
Before you begin, back up your server configuration file.
-
If it is running, stop the WildFly server.
-
Back up the
WILDFLY_HOME/standalone/configuration/standalone.xml
file.
After you have completed testing this quickstart, you can replace this file to restore the server to its original configuration.
Start the WildFly Standalone Server
-
Open a terminal and navigate to the root of the WildFly directory.
-
Start the WildFly server with the default profile by typing the following command.
$ WILDFLY_HOME/bin/standalone.sh
NoteFor Windows, use the WILDFLY_HOME\bin\standalone.bat
script.
Configure the Server
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, make sure you do the following:
-
Back up the WildFly standalone server configuration as described above.
-
Start the WildFly server with the standalone default profile as described above.
-
-
Review the
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 terminal, navigate to the root directory of this quickstart, and run the following command, replacing
WILDFLY_HOME
with the path to your server:$ WILDFLY_HOME/bin/jboss-cli.sh --connect --file=configure-elytron.cli
NoteFor Windows, use the WILDFLY_HOME\bin\jboss-cli.bat
script.You should see the following result when you run the script:
The batch executed successfully process-state: reload-required
-
Stop the WildFly server.
Review the Modified Server Configuration
After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone.xml
file and review the changes.
-
The following
application-security-domain
mapping was added to theejb3
subsystem:<application-security-domains> <application-security-domain name="other" security-domain="ApplicationDomain"/> </application-security-domains>
The
application-security-domain
enables Elytron security for the quickstart EJBs. It maps theother
security domain that is set in the EJBs using the Java annotation@SecurityDomain("other")
to the ElytronApplicationDomain
that is responsible for authenticating and authorizing access to the EJBs. -
The
http-remoting-connector
in theremoting
subsystem was updated to use theapplication-sasl-authentication
factory:<http-connector name="http-remoting-connector" connector-ref="default" security-realm="ApplicationRealm" sasl-authentication-factory="application-sasl-authentication"/>
This configuration allows the identity that was established at the connection level to be propagated to the components.
Build and Deploy the Quickstart
-
Make sure you start the WildFly server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type the following command to build the artifacts.
$ mvn clean install wildfly:deploy
This deploys the ejb-security/target/ejb-security.jar
to the running instance of the server.
You should see a message in the server log indicating that the archive deployed successfully.
Run the Client
Before you run the client, make sure you have already successfully deployed the EJBs to the server in the previous step and that your terminal is still in the root directory of this quickstart.
Type this command to execute the client:
$ mvn exec:exec
Investigate the Console Output
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 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 |
Update the Authorized Application User Role
As an exercise, you can rerun the add-user
script described in the Add the Authorized Application User section, but this time grant the quickstartUser
the admin
role as follows:
$ WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest,admin'
Note
|
For Windows, use the WILDFLY_HOME\bin\add-user.bat scripts.
|
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 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Undeploy the Quickstart
When you are finished testing the quickstart, follow these steps to undeploy the archive.
-
Make sure you start the WildFly server as described above.
-
Open a terminal and navigate to the root directory of this quickstart.
-
Type this command to undeploy the archive:
$ mvn wildfly:undeploy
Restore the WildFly Standalone Server Configuration
You can restore the original server configuration using either of the following methods.
-
You can run the
restore-configuration.cli
script provided in the root directory of this quickstart. -
You can manually restore the configuration using the backup copy of the configuration file.
Restore the WildFly Standalone Server Configuration by Running the JBoss CLI Script
-
Start the WildFly server as described above.
-
Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing
WILDFLY_HOME
with the path to your server:$ WILDFLY_HOME/bin/jboss-cli.sh --connect --file=restore-configuration.cli
NoteFor Windows, use the WILDFLY_HOME\bin\jboss-cli.bat
script.
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
Restore the WildFly Standalone Server Configuration Manually
When you have completed testing the quickstart, you can restore the original server configuration by manually restoring the backup copy the configuration file.
-
If it is running, stop the WildFly server.
-
Replace the
WILDFLY_HOME/standalone/configuration/standalone.xml
file with the backup copy of the file.
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 in Red Hat JBoss Developer Studio or 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.
-
Make sure you Add the authorized application user as described above.
-
Make sure you configure the server by running the JBoss CLI script as described above under Configure the Server.
-
To deploy the server project, right-click on the 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. -
Right-click on the ejb-security project and choose Run As –> Run Configurations. Enter exec:exec for the Goals, and then click Run.
-
Review the output in the console window. You should see the same results as when running Maven in the command line.
-
To undeploy the project, right-click on the ejb-security project and choose Run As –> Run Configurations. Enter
wildfly:undeploy
for the Goals and click Run. -
Make sure you restore the server configuration when you have completed testing this quickstart.
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