第9章 Integrating Red Hat JBoss BRMS with Red Hat Single Sign-On

Procedure: Setting Up RH-SSO with Realm Client

1. Download RH-SSO from the DOWNLOADS section of the Red Hat Customer Portal.

2. Install and configure a basic RH-SSO standalone server. To do this, follow the instructions in chapter Install and Boot of the Red Hat Single Sign On Getting Started Guide. For production environment settings, consult the Red Hat Single Sign On Server Administration Guide.

   注記

   If you want to run both RH-SSO and Red Hat JBoss BRMS servers on the same machine, ensure that you avoid port conflicts. To do so, do one of the following:

   • Update the RHSSO_HOME/standalone/configuration/standalone.xml file and set a port offset to 100. For example:

     <socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:100}">

   • Use an environment variable to run the server:

     bin/standalone.sh -Djboss.socket.binding.port-offset=100

3. Start the RH-SSO server using the following command from RHSSO_HOME/bin:

   ./standalone.sh

   Once the RH-SSO server starts, open http://localhost:8180/auth/admin in a web browser and log in using your admin credentials that you created while installing RH-SSO. When you login for the first time, you can set up the initial user using the new user registration form.

4. In the RH-SSO Admin Console, click the Realm Settings left menu item.

5. On the Realm Settings page, click Add Realm.

   The Add realm page opens.

6. On the Add realm page, provide a name for the realm and click Create.

7. Click the Clients left menu item and click Create.

   The Add Client page opens.

8. On the Add Client page, provide the required information to create a new client for your realm. For example:

   • Client ID: kie
   • Client protocol: openid-connect
   • Root URL: http://localhost:8080/business-central

9. Click Save to save your changes.

   Once you create a new client, its Access Type is set to public by default. Change it to confidential.

   At this point, the RH-SSO server is configured with a realm with a client for Red Hat JBoss BRMS applications (Business Central, in this example) and running and listening for HTTP connections at localhost:8180. This realm provides different users, roles, and sessions for the Red Hat JBoss BRMS applications.

1. Install the RH-SSO adapter for EAP.
2. Configure the Red Hat JBoss BRMS application and the RH-SSO client adapter.

Procedure: Installing the RH-SSO Adapter for Red Hat JBoss EAP 6 and 7

1. Install Red Hat JBoss EAP 6.4.X or 7.0.

   For version 6, see chapter Installation Instructions from the Red Hat JBoss Enterprise Application Platform Installation Guide.

   For version 7, see chapter Installing JBoss EAP from the Red Hat JBoss Enterprise Application Platform Installation Guide.

2. Install Red Hat JBoss BRMS in the freshly installed JBoss EAP.

   If you configure RH-SSO adapter by making changes in standalone.xml, and then unzip Red Hat JBoss BRMS, you may overwrite and lose the RH-SSO adapter configuration.

3. Download the EAP adapter from the Red Hat Customer Portal.
4. Unzip and install the adapter. For installation instructions, see section JBoss EAP Adapter from the Red Hat Single Sign On Securing Applications and Services Guide.

5. For version 7, go to EAP_HOME/standalone/configuration and open the standalone.xml and standalone-full.xml files. Delete the <single-sign-on/> element from both of them.

   You do not need to perform this step for Red Hat JBoss EAP 6.

Procedure: Configuring the RH-SSO Adapter

1. Navigate to EAP_HOME/standalone/configuration in your EAP installation and edit standalone.xml to add the RH-SSO subsystem configuration. For example:

   <subsystem xmlns="urn:jboss:domain:keycloak:1.1">
    <secure-deployment name="business-central.war">
      <realm>demo</realm>
      <realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrVrCuTtArbgaZzL1hvh0xtL5mc7o0NqPVnYXkLvgcwiC3BjLGw1tGEGoJaXDuSaRllobm53JBhjx33UNv+5z/UMG4kytBWxheNVKnL6GgqlNabMaFfPLPCF8kAgKnsi79NMo+n6KnSY8YeUmec/p2vjO2NjsSAVcWEQMVhJ31LwIDAQAB</realm-public-key>
      <auth-server-url>http://localhost:8180/auth</auth-server-url>
      <ssl-required>external</ssl-required>
      <enable-basic-auth>true</enable-basic-auth>
      <resource>kie</resource>
      <credential name="secret">759514d0-dbb1-46ba-b7e7-ff76e63c6891</credential>
      <principal-attribute>preferred_username</principal-attribute>
    </secure-deployment>
   </subsystem>

   Here,

   • secure-deployment name: Name of your application’s WAR file.
   • realm: Name of the realm that you created for the applications to use.
   • realm-public-key: The public key of the realm you created. You can find the key in the Keys tab in the Realm settings page of the realm you created in the RH-SSO Admin Console. If you do not provide a value for realm-public-key, the server retrieves it automatically.
   • auth-server-url: The URL for the RH-SSO authentication server.
   • enable-basic-auth: The setting to enable basic authentication mechanism, so that the clients can use both token-based and basic authentication approaches to perform the requests.
   • resource: The name for the client that you created.
   • credential name: The secret key for the client you created. You can find the key in the Credentials tab on the Clients page of the RH-SSO Admin Console.

   • principal-attribute: The login name of the user. If you do not provide this value, your User Id is displayed in the application instead of your user name.

     注記

     The RH-SSO server converts the user names to lowercase. Therefore, after integration with RH-SSO, your user name will appear in lowercase in Business Central. If you have user names in upper-case letters hard coded in business processes, the application may not be able to identify the upper-case user.

2. Navigate to EAP_HOME/bin/ and start the EAP server using the following command:

   ./standalone.sh

1. Log in to the RH-SSO Admin Console and open the realm to which you wish to add a user.

2. Click the Users left menu item under the Manage section.

   An empty user list page called Users opens.

3. Click the Add User button on the empty user list to start creating your new user.

   An Add user page opens.

4. Provide user information on the Add user page and click Save.
5. Set a new password under the Credentials tab.

6. Assign the new user one of the roles that allow access to Business Central. For example, the admin or analyst role.

   Define the roles as realm roles in the Realm Roles tab under the Roles section.

7. Click Role Mappings tab on the Users page to assign roles.

Procedure: Disabling BasicAuthSecurityFilter

1. Open your application deployment descriptor file (WEB-INF/web.xml) and apply the following changes to it:

   • Remove the following lines to remove the servlet filter and its mapping for class org.uberfire.ext.security.server.BasicAuthSecurityFilter:

     <filter>
       <filter-name>HTTP Basic Auth Filter</filter-name>
       <filter-class>org.uberfire.ext.security.server.BasicAuthSecurityFilter</filter-class>
       <init-param>
         <param-name>realmName</param-name>
         <param-value>KIE Workbench Realm</param-value>
       </init-param>
     </filter>
     
     <filter-mapping>
       <filter-name>HTTP Basic Auth Filter</filter-name>
       <url-pattern>/rest/*</url-pattern>
       <url-pattern>/maven2/*</url-pattern>
       <url-pattern>/ws/*</url-pattern>
     </filter-mapping>

   • Add the following lines to add the security-constraint for the url-patterns that you have removed from the filter mapping:

     <security-constraint>
       <web-resource-collection>
         <web-resource-name>remote-services</web-resource-name>
         <url-pattern>/rest/*</url-pattern>
         <url-pattern>/maven2/*</url-pattern>
         <url-pattern>/ws/*</url-pattern>
       </web-resource-collection>
       <auth-constraint>
         <role-name>rest-all</role-name>
         <role-name>rest-project</role-name>
         <role-name>rest-deployment</role-name>
         <role-name>rest-process</role-name>
         <role-name>rest-process-read-only</role-name>
         <role-name>rest-task</role-name>
         <role-name>rest-task-read-only</role-name>
         <role-name>rest-query</role-name>
         <role-name>rest-client</role-name>
       </auth-constraint>
     </security-constraint>

2. Save your changes.

1. Navigate to the RH-SSO Admin Console located at http://localhost:8080/auth/admin.
2. Click the Clients left menu item.

3. Create a new client with the following settings:

   • Set Client ID as kie-git.
   • Set Access Type as confidential.
   • Disable the Standard Flow Enabled option.
   • Enable the Direct Access Grants Enabled option.
   
4. Click Save.
5. Click the Installation tab at the top of the client configuration screen and choose Keycloak OIDC JSON as a Format Option.
6. Click Download.

7. Move the downloaded JSON file to an accessible directory in the server’s file system or add it to the application class path.

   For more information, see chapter JAAS plugin of the Keycloak Securing Applications and Services Guide.

Procedure: Creating a Client for the Realtime Decision Server

1. In the RH-SSO Admin Console, open the security realm that you created.

2. Click the Clients left menu item and click Create.

   The Add Client page opens.

3. On the Add Client page, provide the required information to create a new client for your realm. For example:

   • Client ID: kie-execution-server
   • Root URL: http://localhost:8080/kie-server
   • Client protocol: openid-connect

4. Click Save to save your changes.

   Once you create a new client, its Access Type is set to public by default. Change it to confidential and click Save again.

5. Navigate to the Credentials tab and copy the secret key. The secret key is necessary to configure the kie-execution-server client in the next section.

Procedure: Setting Up the Realtime Decision Server

1. Navigate to EAP_HOME/standalone/configuration in your EAP installation and edit standalone.xml to add the RH-SSO subsystem configuration. For example:

   <subsystem xmlns="urn:jboss:domain:keycloak:1.1">
     <secure-deployment name="kie-server.war">
        <realm>demo</realm>
        <realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCrVrCuTtArbgaZzL1hvh0xtL5mc7o0NqPVnYXkLvgcwiC3BjLGw1tGEGoJaXDuSaRllobm53JBhjx33UNv+5z/UMG4kytBWxheNVKnL6GgqlNabMaFfPLPCF8kAgKnsi79NMo+n6KnSY8YeUmec/p2vjO2NjsSAVcWEQMVhJ31LwIDAQAB</realm-public-key>
        <auth-server-url>http://localhost:8180/auth</auth-server-url>
        <ssl-required>external</ssl-required>
        <resource>kie-execution-server</resource>
        <enable-basic-auth>true</enable-basic-auth>
        <credential name="secret">03c2b267-7f64-4647-8566-572be673f5fa</credential>
        <principal-attribute>preferred_username</principal-attribute>
     </secure-deployment>
   </subsystem>
   
   <system-properties>
     <property name="org.kie.server.sync.deploy" value="false"/>
   </system-properties>

   Here,

   • secure-deployment name: Name of your application WAR file.
   • realm: Name of the realm that you created for the applications to use.
   • realm-public-key: The public key of the realm you created. You can find the key in the Keys tab in the Realm settings page of the realm you created in the RH-SSO Admin Console. If you do not provide a value for this public key, the server retrieves it automatically.
   • auth-server-url: The URL for the RH-SSO authentication server.
   • resource: The name for the server client that you created.
   • enable-basic-auth: The setting to enable basic authentication mechanism, so that the clients can use both token-based and basic authentication approaches to perform the requests.
   • credential name: The secret key of the server client you created. You can find the key in the Credentials tab on the Clients page of the RH-SSO Admin Console.
   • principal-attribute: The login name of the user. If you do not provide this value, your User Id is displayed in the application instead of your user name.
2. Save your configuration changes in standalone.xml.

3. Use the following command to restart the EAP server and run the Realtime Decision Server.

   EXEC_SERVER_HOME/bin/standalone.sh -Dorg.kie.server.id=<ID> -Dorg.kie.server.user=<USER> -Dorg.kie.server.pwd=<PWD> -Dorg.kie.server.location=<LOCATION_URL> -Dorg.kie.server.controller=<CONTROLLER_URL> -Dorg.kie.server.controller.user=<CONTROLLER_USER> -Dorg.kie.server.controller.pwd=<CONTOLLER_PASSWORD>

   Here is an example:

   EXEC_SERVER_HOME/bin/standalone.sh -Dorg.kie.server.id=kieserver1 -Dorg.kie.server.user=kieserver -Dorg.kie.server.pwd=password -Dorg.kie.server.location=http://localhost:8080/kie-server/services/rest/server -Dorg.kie.server.controller=http://localhost:8080/business-central/rest/controller -Dorg.kie.server.controller.user=kiecontroller -Dorg.kie.server.controller.pwd=password

4. Once the Realtime Decision Server is running, you can check the server status. In the following command, kieserver is a user name with the kie-server role and password password:

   curl http://kieserver:password@localhost:8080/kie-server/services/rest/server/

Procedure: Obtaining and Using Token for Authorizing Remote Calls

1. In the RH-SSO Admin Console, click the Clients left menu item and click Create to create a new client.

   The Add Client page opens.

2. On the Add Client page, provide the required information to create a new client for your realm. For example:

   • Client ID: kie-remote
   • Client protocol: openid-connect
3. Click Save to save your changes.

4. Change the token settings in Realm Settings:

   1. In the RH-SSO Admin Console, click the Realm Settings left menu item.
   2. Click the Tokens tab.

   3. Change the value for Access Token Lifespan to 15 minutes.

      This gives you enough time to get a token and invoke the service before it expires.

   4. Click Save to save your changes.

5. Once a public client for your remote clients is created, you can now obtain the token by making an HTTP request to the RH-SSO server’s token endpoint using:

   RESULT=`curl --data "grant_type=password&client_id=kie-remote&username=admin&password=password" http://localhost:8180/auth/realms/demo/protocol/openid-connect/token`

   The user used in the command above is an RH-SSO user. For further information, see 「Adding a New User」.

6. To view the token obtained from the RH-SSO server, use the following command:

   TOKEN=`echo $RESULT | sed 's/.*access_token":"//g' | sed 's/".*//g'`