Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
235 lines (189 sloc) 10.6 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 {productName}.

What is it?

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

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.

    • Defines an http-authentication-factory in the elytron subsystem that uses the security domain created in step 1 for BASIC authentication.

    • Adds an application-security-domain mapping in the undertow subsystem to map the Servlet security domain to the HTTP authentication factory defined in step 2.

  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

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 {jbossHomeName} with the path to your server:

    $ {jbossHomeName}/bin/ --connect --file=configure-server.cli
    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
  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 datasource was added to the datasources subsystem.

    <datasource jndi-name="java:jboss/datasources/ServletSecurityDS" pool-name="ServletSecurityDS">
  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 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 to="roles" index="1"/>

    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 following role-decoder was added to the elytron subsystem.

    <simple-role-decoder name="from-roles-attribute" attribute="roles"/>

    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). 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" role-decoder="from-roles-attribute"/>
  5. The following http-authentication-factory was added to the elytron subsystem.

    <http-authentication-factory name="servlet-security-quickstart-http-auth" http-server-mechanism-factory="global" security-domain="servlet-security-quickstart-sd">
            <mechanism mechanism-name="BASIC">
                <mechanism-realm realm-name="RealmUsersRoles"/>

    It basically defines an HTTP authentication factory for the BASIC mechanism that relies on the servlet-security-quickstart-sd security domain to authenticate and authorize access to web applications.

  6. The following application-security-domain was added to the undertow subsystem.

        <application-security-domain name="servlet-security-quickstart" http-authentication-factory="servlet-security-quickstart-http-auth"/>

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 http-authentication-factory named servlet-security-quickstart-http-auth. If no application-security-domain is defined for a particular security domain, Undertow assumes the legacy JAAS based security domains should be used for authentication/authorization and, in this case, the security domain defined in the Web application must match a security domain in the legacy security subsystem. The presence of an application-security-domain configuration is what enables Elytron authentication for a Web application.

Access the Application

The application will be running at the following URL http://localhost:8080/{artifactId}/.

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:


Server Log: Expected Warnings and Errors

You will see the following warning in the server log. You can ignore it.

HHH000431: Unable to determine H2 database version, certain features may not work

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
  • Make sure you configure the server by running the JBoss CLI commands as described above under xref:configure_the_server{Configure the Server]. Stop the server at the end of that step.

  • Make sure you restore the {productName} server configuration when you have completed testing this quickstart.

You can’t perform that action at this time.