Skip to content

Latest commit

 

History

History
1224 lines (1024 loc) · 50.9 KB

File metadata and controls

1224 lines (1024 loc) · 50.9 KB

servlet-security: Using Jakarta EE Declarative Security to Control Servlet Access

The servlet-security quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in JBoss EAP.

What is it?

The servlet-security quickstart demonstrates the use of Jakarta EE declarative security to control access to Servlets and Security in Red Hat JBoss Enterprise Application Platform.

When you deploy this example, two users are automatically created for you: user quickstartUser with password quickstartPwd1! and user guest with password guestPwd1!. This data is located in the src/main/resources/import.sql file.

This quickstart takes the following steps to implement Servlet security:

  1. Web Application:

    • Adds a security constraint to the Servlet using the @ServletSecurity and @HttpConstraint annotations.

    • Adds a security domain reference to WEB-INF/jboss-web.xml.

    • Adds a login-config that sets the auth-method to BASIC in the WEB-INF/web.xml.

  2. Application Server (standalone.xml):

    • Defines a security domain in the elytron subsystem that uses the JDBC security realm to obtain the security data used to authenticate and authorize users.

    • Adds an application-security-domain mapping in the undertow subsystem to map the Servlet security domain to the security domain defined in step 1.

  3. Database Configuration:

    • Adds an application user with access rights to the application.

      User Name: quickstartUser
      Password: quickstartPwd1!
      Role: quickstarts
    • Adds another user with no access rights to the application.

      User Name: guest
      Password: guestPwd1!
      Role: notauthorized

Considerations for Use in a Production Environment

H2 Database

This quickstart uses the H2 database included with Red Hat JBoss Enterprise Application Platform 8.0. It is a lightweight, relational example datasource that is used for examples only. It is not robust or scalable, is not supported, and should NOT be used in a production environment.

System Requirements

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

All you need to build this project is Java 11.0 (Java SDK 11) or later and Maven 3.6.0 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.

Use of the EAP_HOME and QUICKSTART_HOME Variables

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

When you see the replaceable variable QUICKSTART_HOME, replace it with the path to the root directory of all of the quickstarts.

Building and running the quickstart application with a JBoss EAP server distribution

Back Up the JBoss EAP Standalone Server Configuration

Before you begin, back up your server configuration file.

  1. If it is running, stop the JBoss EAP server.

  2. Back up the EAP_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 JBoss EAP Standalone Server

  1. Open a terminal and navigate to the root of the JBoss EAP directory.

  2. Start the JBoss EAP server with the default profile by typing the following command.

    $ EAP_HOME/bin/standalone.sh 
    Note
    For Windows, use the EAP_HOME\bin\standalone.bat script.

Configure the Server

You can configure the server by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-server.cli script provided in the root directory of this quickstart.

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

  2. Review the configure-server.cli file in the root of this quickstart directory. This script adds security domain and HTTP authentication factory to the elytron subsystem in the server configuration and also configures the undertow subsystem to use the configured HTTP authentication factory for the Web application.

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

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=configure-server.cli
    Note
    For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

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

    The batch executed successfully
  4. Stop the JBoss EAP server.

Review the Modified Server Configuration

After stopping the server, open the EAP_HOME/standalone/configuration/standalone.xml file and review the changes.

  1. The following datasource was added to the datasources subsystem.

    <datasource jndi-name="java:jboss/datasources/ServletSecurityDS" pool-name="ServletSecurityDS">
        <connection-url>jdbc:h2:mem:servlet-security;DB_CLOSE_ON_EXIT=FALSE</connection-url>
        <driver>h2</driver>
        <security>
            <user-name>sa</user-name>
            <password>sa</password>
        </security>
    </datasource>
  2. The following security-realm was added to the elytron subsystem.

    <jdbc-realm name="servlet-security-jdbc-realm">
        <principal-query sql="SELECT PASSWORD FROM USERS WHERE USERNAME = ?" data-source="ServletSecurityDS">
            <clear-password-mapper password-index="1"/>
        </principal-query>
        <principal-query sql="SELECT R.NAME, 'Roles' FROM USERS_ROLES UR INNER JOIN ROLES R ON R.ID = UR.ROLE_ID INNER JOIN USERS U ON U.ID = UR.USER_ID WHERE U.USERNAME = ?" data-source="ServletSecurityDS">
            <attribute-mapping>
                <attribute to="roles" index="1"/>
            </attribute-mapping>
        </principal-query>
    </jdbc-realm>

    The security-realm is responsible for verifying the credentials for a given principal and for obtaining security attributes (like roles) that are associated with the authenticated identity.

  3. The jdbc-realm in this quickstart stores the roles associated with a principal in an attribute named Roles.

    Other realms might use different attributes for roles (such as group). If an attribute name other than "Roles" is used to store the roles, a role-decoder can be configured as follows:

    /subsystem=elytron/simple-role-decoder=from-roles-attribute:add(attribute=ATTRIBUTE_NAME)

    The command to create a security-domain could then be updated to reference this role-decoder:

    /subsystem=elytron/security-domain=servlet-security-quickstart-sd:add(default-realm=servlet-security-jdbc-realm, realms=[{realm=servlet-security-jdbc-realm, role-decoder=from-roles-attribute}], permission-mapper=default-permission-mapper)

    The purpose of a role-decoder is to instruct the security domain how roles are to be retrieved from an authorized identity.

  4. The following security-domain was added to the elytron subsystem.

    <security-domain name="servlet-security-quickstart-sd" default-realm="servlet-security-jdbc-realm" permission-mapper="default-permission-mapper">
        <realm name="servlet-security-jdbc-realm"/>
    </security-domain>
  5. The following application-security-domain was added to the undertow subsystem.

    <application-security-domains>
        <application-security-domain name="servlet-security-quickstart" security-domain="servlet-security-quickstart-sd"/>
    </application-security-domains>

This configuration tells Undertow that applications with the servlet-security-quickstart security domain, as defined in the jboss-web.xml or by using the @SecurityDomain annotation in the Servlet class, should use the security-domain named servlet-security-quickstart-sd.

Build and Deploy the Quickstart

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type the following command to build the quickstart.

    $ mvn clean package
  4. Type the following command to deploy the quickstart.

    $ mvn wildfly:deploy

This deploys the servlet-security/target/servlet-security.war to the running instance of the server.

You should see a message in the server log indicating that the archive deployed successfully.

Access the Application

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

When you access the application, you should get a browser login challenge.

Log in using the username quickstartUser and password quickstartPwd1!. The browser will display the following security info:

Successfully called Secured Servlet

Principal : quickstartUser
Remote User : quickstartUser
Authentication Type : BASIC

Now close the browser. Open a new browser and log in with username guest and password guestPwd1!. The browser will display the following error:

Forbidden

Run the Arquillian Integration Tests

This quickstart includes Arquillian integration tests. They are located under the src/test/ directory. The integration tests verify that the quickstart runs correctly when deployed on the server.

Follow these steps to run the integration tests.

  1. Make sure you start the JBoss EAP server, as previously described.

  2. Make sure you build and deploy the quickstart, as previously described.

  3. Type the following command to run the verify goal with the arq-remote profile activated.

    $ mvn verify -Parq-remote
Note

You may also use the environment variable SERVER_HOST or the system property server.host to define the target host of the tests.

Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

  1. Make sure you start the JBoss EAP server as described above.

  2. Open a terminal and navigate to the root directory of this quickstart.

  3. Type this command to undeploy the archive:

    $ mvn wildfly:undeploy

Restore the JBoss EAP Standalone Server Configuration

You can restore the original server configuration using either of the following methods.

Restore the JBoss EAP Standalone Server Configuration by Running the JBoss CLI Script

  1. Start the JBoss EAP server as described above.

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

    $ EAP_HOME/bin/jboss-cli.sh --connect --file=restore-configuration.cli
    Note
    For Windows, use the EAP_HOME\bin\jboss-cli.bat script.

This script removes the application-security-domain configuration from the undertow subsystem, the http-authentication-factory, security-domain, security-realm and role-decoder configuration from the elytron subsystem and it also removes the datasource used for this quickstart. You should see the following result when you run the script:

The batch executed successfully
process-state: reload-required

Restore the JBoss EAP 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.

  1. If it is running, stop the JBoss EAP server.

  2. Replace the EAP_HOME/standalone/configuration/standalone.xml file with the backup copy of the file.

Building and running the quickstart application with OpenShift

Build the JBoss EAP Source-to-Image (S2I) Quickstart to OpenShift with Helm Charts

On OpenShift, the S2I build with Apache Maven will use an openshift profile used to provision a JBoss EAP server to deploy and run the quickstart in OpenShift environment. You can activate the Maven profile named openshift when building the quickstart:

$ mvn clean package -Popenshift

The provisioned JBoss EAP server for OpenShift, with the quickstart deployed, can then be found in the target/server directory, and its usage is similar to a standard server distribution. You may note that it uses the cloud feature pack which enables a configuration tuned for OpenShift environment.

The server provisioning functionality is provided by the EAP Maven Plugin, and you may find its configuration in the quickstart pom.xml:

        <profile>
            <id>openshift</id>
            <build>
                <plugins>
                    <plugin>
                        <groupId>org.jboss.eap.plugins</groupId>
                        <artifactId>eap-maven-plugin</artifactId>
                        <version>${version.eap.maven.plugin}</version>
                        <configuration>
                            <feature-packs>
                                <feature-pack>
                                    <location>org.jboss.eap:wildfly-ee-galleon-pack</location>
                                </feature-pack>
                                <feature-pack>
                                    <location>org.jboss.eap.cloud:eap-cloud-galleon-pack</location>
                                </feature-pack>
                            </feature-packs>
                            <layers>
                                <layer>cloud-server</layer>
                            </layers>
                            <filename>ROOT.war</filename>
                        </configuration>
                        <executions>
                            <execution>
                                <goals>
                                    <goal>package</goal>
                                </goals>
                            </execution>
                        </executions>
                    </plugin>
                </plugins>
            </build>
        </profile>
Note

Since the plugin configuration above deploys quickstart on root web context of the provisioned server, the URL to access the application should not have the /servlet-security path segment after HOST:PORT.

Getting Started with JBoss EAP for OpenShift and Helm Charts

This section contains the basic instructions to build and deploy this quickstart to JBoss EAP for OpenShift or JBoss EAP for OpenShift Online using Helm Charts.

Prerequisites

  • You must be logged in OpenShift and have an oc client to connect to OpenShift

  • Helm must be installed to deploy the backend on OpenShift.

Once you have installed Helm, you need to add the repository that provides Helm Charts for JBoss EAP.

$ helm repo add jboss-eap https://jbossas.github.io/eap-charts/
"jboss-eap" has been added to your repositories
$ helm search repo jboss-eap
NAME                    CHART VERSION   APP VERSION     DESCRIPTION
jboss-eap/eap8         ...             ...             A Helm chart to build and deploy EAP 8.0 applications

Deploy the JBoss EAP Source-to-Image (S2I) Quickstart to OpenShift with Helm Charts

Log in to your OpenShift instance using the oc login command. The backend will be built and deployed on OpenShift with a Helm Chart for JBoss EAP.

Navigate to the root directory of this quickstart and run the following command:

$ helm install servlet-security -f charts/helm.yaml jboss-eap/eap8
NAME: servlet-security
...
STATUS: deployed
REVISION: 1

The Helm Chart for this quickstart contains all the information to build an image from the source code using S2I on Java 17:

build:
  uri: https://github.com/jboss-developer/jboss-eap-quickstarts.git
  ref: 8.0.x
  contextDir: servlet-security
deploy:
  replicas: 1

This will create a new deployment on OpenShift and deploy the application.

If you want to see all the configuration elements to customize your deployment you can use the following command:

$ helm show readme jboss-eap/eap8

Let’s wait for the application to be built and deployed:

$ oc get deployment servlet-security -w
NAME         DESIRED   CURRENT   UP-TO-DATE   AVAILABLE   AGE
servlet-security   1         1         1            0           12s
...
servlet-security   1         1         1            1           2m

Get the URL of the route to the deployment.

$ oc get route servlet-security -o jsonpath="{.spec.host}"

Access the application in your web browser using the displayed URL.

Note

The Maven profile named openshift is used by the Helm chart to provision the server with the quickstart deployed on the root web context, and thus the application should be accessed with the URL without the /servlet-security path segment after HOST:PORT.

Undeploy the JBoss EAP Source-to-Image (S2I) Quickstart from OpenShift with Helm Charts

$ helm uninstall servlet-security

Run the Arquillian Integration Tests with OpenShift

This quickstart includes Arquillian integration tests. They are located under the src/test/ directory. The integration tests verify that the quickstart runs correctly when deployed on the server.

Note

The Arquillian integration tests expect a deployed application, so make sure you have deployed the quickstart on OpenShift before you begin.

Run the integration tests using the following command to run the verify goal with the arq-remote profile activated and the proper URL:

$ mvn clean verify -Parq-remote -Dserver.host=https://$(oc get route servlet-security --template='{{ .spec.host }}')
Note

The tests are using SSL to connect to the quickstart running on OpenShift. So you need the certificates to be trusted by the machine the tests are run from.