README.adoc

../shared-doc/attributes.adoc

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

The ejb-security quickstart demonstrates the use of Jakarta EE declarative security to control access to EJBs in {productName}.

What is it?

The ejb-security quickstart demonstrates the use of Jakarta EE declarative security to control access to EJBs in {productNameFull}.

This quickstart takes the following steps to implement EJB security:

1. Add an application-security-domain mapping in the ejb3 subsystem to enable Elytron security for the SecuredEJB.

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({ "admin" }) annotation to the administrative method in the SecuredEJB to authorize access only to users with admin role access rights.

5. 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 but it should not be granted access to the administrative method annotated with RolesAllowed({"admin"}).

../shared-doc/system-requirements.adoc

../shared-doc/use-of-jboss-home-name.adoc

../shared-doc/add-application-user.adoc

../shared-doc/back-up-server-standalone-configuration.adoc

../shared-doc/start-the-standalone-server.adoc

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.

1. Before you begin, make sure you do the following:

   • Back up the {productName} standalone server configuration as described above.

   • Start the {productName} server with the standalone default profile as described above.

2. 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.

3. Open a new terminal, navigate to the root directory of this quickstart, and run the following command, replacing {jbossHomeName} with the path to your server:

   $ {jbossHomeName}/bin/jboss-cli.sh --connect --file=configure-elytron.cli

   Note	For Windows, use the {jbossHomeName}\bin\jboss-cli.bat script.

   You should see the following result when you run the script:

   The batch executed successfully
   process-state: reload-required

4. Stop the {productName} server.

Review the Modified Server Configuration

After stopping the server, open the {jbossHomeName}/standalone/configuration/standalone.xml file and review the changes.

1. The following 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 enables Elytron security for the quickstart EJBs. It maps the other security domain that is set in the EJBs using the Java annotation @SecurityDomain("other") to the Elytron ApplicationDomain that is responsible for authenticating and authorizing access to the EJBs.

2. The 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 the identity that was established at the connection level to be propagated to the components.

../shared-doc/build-and-deploy-the-quickstart.adoc

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 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. 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:

$ {jbossHomeName}/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'guest,admin'

Note	For Windows, use the {jbossHomeName}\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

* * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

../shared-doc/undeploy-the-quickstart.adoc ../shared-doc/restore-standalone-server-configuration.adoc

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

../shared-doc/restore-standalone-server-configuration-manual.adoc ../shared-doc/run-the-quickstart-in-jboss-developer-studio.adoc

1. Make sure you Add the authorized application user as described above.

2. Make sure you configure the server by running the JBoss CLI script as described above under Configure the Server.

3. To deploy the server project, right-click on the {artifactId} project and choose Run As –> Maven build. Enter clean package wildfly:deploy for the Goals and click Run. This deploys the {artifactId} JAR to the {productName} server.

4. Right-click on the {artifactId} project and choose Run As –> Run Configurations. Enter exec:exec for the Goals, and then click Run.

5. Review the output in the console window. You should see the same results as when running Maven in the command line.

6. To undeploy the project, right-click on the {artifactId} project and choose Run As –> Run Configurations. Enter wildfly:undeploy for the Goals and click Run.

7. Make sure you restore the server configuration when you have completed testing this quickstart.

../shared-doc/debug-the-application.adoc