Implementing Not-Enforced URIs With a SwitchFilter

On your system, add the following data in a comma-separated value file called /tmp/userfile (on Windows C:\Temp\userfile):

username,password,fullname,email
george,C0stanza,George Costanza,george@example.com
kramer,N3wman12,Kramer,kramer@example.com
bjensen,H1falutin,Babs Jensen,bjensen@example.com
demo,Ch4ng31t,Demo User,demo@example.com
kvaughan,B5ibery12,Kirsten Vaughan,kvaughan@example.com
scarter,S9rain12,Sam Carter,scarter@example.com

Set up AM:

1. (For AM 6.5.x and earlier versions) Select  Identities > demo, and set the demo user password to Ch4ng31t.

2. (For AM 6.5.3 and later versions) Select  Services > Add a Service, and add a Validation Service with the following Valid goto URL Resources:

   • http://openig.example.com:8080/*

   • http://openig.example.com:8080/*?*

3. Select Applications > Agents > Identity Gateway, add an agent with the following values:

   • Agent ID: ig_agent

   • Password: password

   Leave all other values as default.

   See how to set up an agent in AM 6.5.2 and earlier versions.

   1. Select Applications > Agents > Java (or J2EE).

   2. Add an agent with the following values:

      • Agent ID: ig_agent

      • Agent URL: http://openig.example.com:8080/agentapp

      • Server URL: http://openam.example.com:8088/openam

      • Password: password

   3. On the Global tab, deselect Agent Configuration Change Notification.

      This option stops IG from being notified about agent configuration changes in AM, because they are not required by IG.

Set up IG:

1. Set an environment variable for the IG agent password, and then restart IG:

   $ export AGENT_SECRET_ID='cGFzc3dvcmQ='

   The password is retrieved by a SystemAndEnvSecretStore, and must be base64-encoded.

2. Add the following route to IG, to serve .css and other static resources for the sample application:

   $HOME/.openig/config/routes/static-resources.json

   %appdata%\OpenIG\config\routes\static-resources.json

   {
     "name" : "sampleapp_resources",
     "baseURI" : "http://app.example.com:8081",
     "condition": "${matches(request.uri.path,'^/css')}",
     "handler": "ReverseProxyHandler"
   }

3. Add the following route to IG:

   $HOME/.openig/config/routes/not-enforced-switch.json

   %appdata%\OpenIG\config\routes\not-enforced-switch.json

   {
     "properties": {
       "notEnforcedPathPatterns": "^/home|^/favicon.ico|^/css"
     },
     "heap": [
       {
         "name": "SystemAndEnvSecretStore-1",
         "type": "SystemAndEnvSecretStore"
       },
       {
         "name": "AmService-1",
         "type": "AmService",
         "config": {
           "agent": {
             "username": "ig_agent",
             "passwordSecretId": "agent.secret.id"
           },
           "secretsProvider": "SystemAndEnvSecretStore-1",
           "url": "http://openam.example.com:8088/openam/",
           "version": "7"
         }
       }
     ],
     "name": "not-enforced-switch",
     "condition": "${matches(request.uri.path, '^/')}",
     "baseURI": "http://app.example.com:8081",
     "handler": {
       "type": "Chain",
       "config": {
         "filters": [
           {
             "name": "SwitchFilter-1",
             "type": "SwitchFilter",
             "config": {
               "onRequest": [{
                 "condition": "${matches(request.uri.path, '&{notEnforcedPathPatterns}')}",
                 "handler": "ReverseProxyHandler"
               }]
             }
           },
           {
             "type": "SingleSignOnFilter",
             "config": {
               "amService": "AmService-1"
             }
           },
           {
             "type": "PasswordReplayFilter",
             "config": {
               "loginPage": "${true}",
               "credentials": {
                 "type": "FileAttributesFilter",
                 "config": {
                   "file": "/tmp/userfile",
                   "key": "email",
                   "value": "${contexts.ssoToken.info.uid}@example.com",
                   "target": "${attributes.credentials}"
                 }
               },
               "request": {
                 "method": "POST",
                 "uri": "http://app.example.com:8081/login",
                 "form": {
                   "username": [
                     "${attributes.credentials.username}"
                   ],
                   "password": [
                     "${attributes.credentials.password}"
                   ]
                 }
               }
             }
           }
         ],
         "handler": "ReverseProxyHandler"
       }
     }
   }

   Notice the following features of the route:

   • The route condition is /, so the route matches all requests.

   • The SwitchFilter passes requests on the path ^/home, ^/favicon.ico, and ^/css directly to the ReverseProxyHandler. All other requests continue the along the chain to the SingleSignOnFilter.

   • If the request does not have a valid AM session cookie, the SingleSignOnFilter redirects the request to AM for authentication. The SingleSignOnFilter stores the cookie value in an SsoTokenContext.

   • Because the PasswordReplayFilter detects that the response is a login page, it uses the FileAttributesFilter to replay the password, and logs the request into the sample application.

Test the setup:

1. If you are logged in to AM, log out and clear any cookies.

2. Access the route on the not-enforced URL http://openig.example.com:8080/home. The home page of the sample app is displayed without authentication.

3. Access the route on the enforced URL http://openig.example.com:8080/profile. The SingleSignOnFilter redirects the request to AM for authentication.

4. Log in to AM as user demo, password Ch4ng31t. The PasswordReplayFilter replays the credentials for the demo user. The request is passed to the sample app's profile page for the demo user.