9.8. REST Interface Security

Note

Note that the JBoss Data Grid 6.1 REST endpoint is set to public as a default.
Report a bug

9.8.1. Enable Security for the REST Endpoint

Prerequisite

JBoss Data Grid includes an example standalone-rest-auth.xml file located within the JBoss Data Grid directory at the location /docs/examples/configs).

Copy the file to the $JDG_HOME/standalone/configuration directory to use the configuration. From the $JDG_HOME location, enter the following command to create a copy of the standalone-rest-auth.xml in the appropriate location: 
$ cp docs/examples/configs/standalone-rest-auth.xml standalone/configuration/standalone.xml
If required, create a new copy of the example standalone-rest-auth.xml to start with a new configuration template.

Procedure 9.1. Enable Security for the REST Endpoint

To enable security for the JBoss Data Grid when using the REST interface, make the following changes to standalone.xml:

  1. Specify Security Parameters

    Ensure that the rest endpoint specifies a valid value for the security-domain and auth-method parameters. Recommended settings for these parameters are as follows: 
    <subsystem xmlns="urn:jboss:domain:datagrid:1.0">
            <rest-connector virtual-server="default-host" 
                            cache-container="local" 
                            security-domain="other" 
                            auth-method="BASIC"/>
</subsystem>

  2. Check Security Domain Declaration

    Ensure that the security subsystem contains the corresponding security-domain declaration. For details about setting up security-domain declarations, refer to the JBoss Application Server 7 or JBoss Enterprise Application Platform 6 documentation.

  3. Add an Application User

    Run the relevant script and enter the configuration settings to add an application user.
    1. Run the adduser.sh script (located in $JDG_HOME/bin).
      • On a Windows system, run the adduser.bat file (located in $JDG_HOME/bin) instead.
    2. When prompted about the type of user to add, select Application User (application-users.properties) by entering b.
    3. Accept the default value for realm (ApplicationRealm) by pressing the return key.
    4. Specify a username and password.
    5. When prompted for a role for the created user, enter REST.
    6. Ensure the username and application realm information is correct when prompted and enter "yes" to continue.

  4. Verify the Created Application User

    Ensure that the created application user is correctly configured.
    1. Check the configuration listed in the application-users.properties file (located in $JDG_HOME/standalone/configuration/). The following is an example of what the correct configuration looks like in this file: 
      user1=2dc3eacfed8cf95a4a31159167b936fc
    2. Check the configuration listed in the application-roles.properties file (located in $JDG_HOME/standalone/configuration/). The following is an example of what the correct configuration looks like in this file: 
      user1=REST

  5. Test the Server

    Start the server and enter the following link in a browser window to access the REST endpoint: 
    http://localhost:8080/rest/namedCache

    Note

    If testing using a GET request, a 405 response code is expected and indicates that the server was successfully authenticated.
Report a bug