Step 7: Implement CA SiteMinder Use Cases

Learn how to use CA SiteMinder in a variety of different usage scenarios.

Using Admin Console Integrate CA SiteMinder with Policy Manager

Table of Contents

  1. Use Case #1: Using CA SiteMinder as Application Identity
  2. Use Case #2: Using Username/Password Security with WS-Security Policy
  3. Use Case #3: Using SMSESSION Cookie with HTTP Security Policy (Network Director)
  4. Use Case #4: Using SMSESSION Cookie with HTTP Security Policy (Intermediary for Microsoft)
  5. Use Case #5: Basic Authentication using CA SiteMinder Identity
  6. Use Case #6: Using Binary Security Token with WS-Security Policy
  7. Use Case #7: Set Up CA SiteMinder to Support Single Sign-On with Community Manager

Use Case #1: Using CA SiteMinder as an Application Identity

Learn how to use CA SiteMinder as an application identity.

Steps:

  1. Introduction
  2. Step 1: Create Policy
  3. Step 2: Attach Policies
  4. Step 3: Configure Outbound Identities
  5. Step 4: Configure Message Processing
  6. Step 5: Test Configuration

Introduction

This use case will use the Manage Outbound Identity option to send the CA SiteMinder identity to a downstream service that is enforcing Basic Authentication using the HTTP Security Policy. The consuming application (AccountManagerDocLiteralWrappedService_vs3_vs0) does not have a security policy and will only be used to pass the CA SiteMinder identity to the downstream application (AccountManagerDocLiteralWrappedService_vs3).

Step 1: Create Policy

  1. Launch the Policy Manager Management Console. In the Policies folder, use Add Policy to create the following policy configurations.

Step 2: Attach Policies

  1. Attach the policies to a virtual service.

Step 3: Configure Outbound Identities

  1. On the Service Details of the virtual service, select Manage Outbound Identities from the Actions Portlet.
  2. Select Specify Outbound Identities, then click Add and configure the identity as illustrated below.

Step 4: Configure Message Processing

  1. On the Service Details of the virtual service, select Configure Message Processing in the Actions Portlet set Preserve Binding Headers to All.

Step 5: Test Configuration

  1. Send requests to the virtual service and the usage data in the Services > Monitoring section.

Back to top

Use Case #2: Using Username/Password Security with WS-Security Policy

Learn how to authenticate a web service request with CA SiteMinder Username/Password with a WS-Security Policy.

Steps:

  1. Introduction
  2. Step 1: Create Policies
  3. Step 2: Attach Policies
  4. Step 3: Select UsernamePassword in Client
  5. Step 4: Test Configuration

Introduction

The WS-Security Username/Password Use Case client authentication is performed with a Username Token which appears at the SOAP layer as a signed supporting token that is always sent from the client to the service. The user is authenticated using username/password pass in the WS-Security header.

This use case is composed of the Authentication Policy, WS-Security Transport Binding Policy, and WS-Security Supporting Tokens Policy Authentication Policy.

Step 1: Create Policies

  1. Launch the Policy Manager Management Console. In the Policies folder, use Add Policy to create the following policy configurations.
    Policy Name Configuration Requirements
    Authentication Policy
    1. Subject Category = End-User
    2. Domain (Realms) = CA SiteMinder
    WS-Security Transport Binding Policy Use default configuration.
    WS-Security Supporting Tokens Policy

    Use default configuration with the following changes:

    On the Specify Supporting Token Options screen:

    1. Click Add Token Choice
    2. Select the Token Choice
    3. Click Add Token

    On the Add Supporting Token screen:

    1. Token Type = Username
    2. Token Inclusion - Always to Recipient
    3. Subject Category - Consumer

    On the Specify Username Token Options screen:

    1. Version = UsernameToken profile 1.0

Step 2: Attach Policies

  1. Attach the policies to a virtual service.

Step 3: Select UsernamePassword in Client

  1. Launch SOAPUI and select UsernamePassword for Outgoing WS-Security Configurations.

Step 4: Test Configuration

Send requests to the virtual service and the usage data in the Services > Monitoring section.

Back to top

Learn how to authenticate a web service request with CA SiteMinder using an SMSESSION cookie with an HTTP Security Policy.

Steps:

  1. Introduction
  2. Step 1: Confirm SiteMinder Administrative Settings
  3. Step 2: Configure CA SiteMinder Identity System
  4. Step 3: Create Virtual Services
  5. Step 4: Create Policies
  6. Step 5: Attach Policies
  7. Step 6: Enable Preserve Transport Headers
  8. Step 7: Test Configuration

Introduction

When a user in SiteMinder protected realm is authenticated, a cookie called SMSESSION is generated. This use case will test authentication of this SMSESSION cookie using HTTP Security Policy. To generate the SMSESSION cookie, we will first use Basic Authentication.

Step 1: Confirm SiteMinder Administrative Settings

  1. Confirm that the SiteMinder Agent Configuration Object in the CA SiteMinder Administrative UI has a parameter called AcceptTPCookie with the value yes.

Step 2: Configure CA SiteMinder Identity System

  1. Configure a CA SiteMinder Identity System. This step should have been completed as part of the initial configuration. See Configure CA SiteMinder Identity System in Policy Manager 7.x. for more information. Configuration of the Login Process Options screen and Identity System integration is not required.

Step 3: Create Virtual Services

  1. Create a Virtual Service (VS1) then virtualize this Virtual Service again (VS2). Host each Virtual Service on a separate Network Director (ND).

Step 4: Create Policies

In the Policies folder, use Add Policy to create the following policy configurations for VS1 and VS2.

  1. Create an HTTP Security Policy with Basic Authentication, and a Response Cookie called SMSESSION.

  2. Create an HTTP Security Policy with Cookie Authentication.

Step 5: Attach Policies

  1. Attach the HTTP Security Policy with Basic Authentication to VS1.

  2. Attach the HTTP Security Policy with Cookie Authentication to VS2.

Step 6: Enable Preserve Transport Headers

  1. On the Service Details page of VS1 select Configure Message Processing in the Actions Portlet. Set Preserve Transport Headers to All to preserve this cookie header downstream.

Step 7: Test Configuration

  1. Send requests to VS1 and VS2 and view the usage data in the Services > Monitoring section.

Back to top

Learn how to authenticate a web service request with CA SiteMinder using an SMSESSION cookie with an HTTP Security Policy.

Steps:

  1. Introduction
  2. Step 1: Confirm SiteMinder Administrative Settings
  3. Step 2: Configure CA SiteMinder Identity System
  4. Step 3: Create Virtual Service
  5. Step 4: Create Policies
  6. Step 5: Attach Policies
  7. Step 6: Test Configuration

Introduction

When a user in SiteMinder protected realm is authenticated, a cookie called SMSESSION is generated. This use case will test authentication of this SMSESSION cookie using HTTP Security Policy. To generate the SMSESSION cookie, we will first use Basic Authentication.

Step 1: Confirm SiteMinder Administrative Settings

  1. Confirm that the SiteMinder Agent Configuration Object in the CA SiteMinder Administrative UI has a parameter called AcceptTPCookie with the value yes.

Step 2: Configure CA SiteMinder Identity System

  1. Configure a CA SiteMinder Identity System. This step should have been completed as part of the initial configuration. See Configure CA SiteMinder Identity System in Policy Manager 7.x. for more information. Configuration of the Login Process Options screen and Identity System integration is not required.

Step 3: Create Virtual Service

  1. Create a Virtual Service (VS1). Host a Virtual Service on Intermediary for Microsoft (IMS) container

Step 4: Create Policies

In the Policies folder, use Add Policy to create the following policy configurations for VS1.

  1. Create an HTTP Security Policy SiteMinder Cookie Authentication. Specify Cookie Name as SMSESSION on the Cookie Authentication Options screen.

  2. Create an Authentication Policy with the CA SiteMinder Domain and Subject-Category Consumer selected.

Step 5: Attach Policies

  1. Attach Detailed Auditing, Authentication, and HTTP Security Policy SiteMinder Cookie Authentication policies to VS1.

Step 6: Test Configuration

  1. Send requests to VS1 and view the usage data in Services > Monitoring section.

Back to top

Use Case #5: Basic Authentication using CA SiteMinder Identity

Learn how to authenticate a web service request with CA SiteMinder Identity.

Steps:

  1. Introduction
  2. Step 1: Create Policy
  3. Step 2: Attach Policies
  4. Step 3: Test Configuration

Introduction

The Basic Authentication Use Case is performed with a CA SiteMinder Identity that is always sent from the client to a service that is enforcing Basic Authentication using the HTTP Security Policy.

Step 1: Create Policy

In the Policies folder, use Add Policy to create the following policy configuration.

  1. Create an Authentication Policy with Subject Category = Consumer, and Domain (Realms = CA SiteMinder).

  2. Create an HTTP Security Policy with Require Authentication = True, Authentication Scheme = Basic Authentication, and Sub Category = Consumer.

Step 2: Attach Policies

  1. Attach the policies to a virtual service.

Step 3: Test Configuration

  1. Send requests to the virtual service and the usage data in the Services > Monitoring section.

Back to top

Use Case #6: Using Binary Security Token with WS-Security Policy

Learn how to authenticate a web service request with CA SiteMinder Binary Security Token with a WS-Security Policy.

Steps:

  1. Introduction
  2. Step 1: Create Policies
  3. Step 2: Attach Policies
  4. Step 3: Send Request
  5. Step 4: Test Configuration

Introduction

The WS-Security Binary Token Use Case client authentication is performed with a Binary Token which appears at the SOAP layer as a signed supporting token that is always sent from the client to the service. The user is authenticated using a Binary Token password in the WS-Security header.

This use case is composed of the Authentication Policy, WS-Security Transport Binding Policy, and WS-Security Supporting Tokens Policy.

Step 1: Create Policies

In the Policies folder, use Add Policy to create the following policy configurations.

  1. Create an Authentication Policy with Subject Category = End-User, and Domain (Realms = CA SiteMinder).

  2. Create a WS-Security Transport Binding Policy with HTTPS Token > Certificate Subject Category = End-User.

  3. Create a WS-Security Supporting Tokens Policy and configure as follows:
    Screen Name Configuration Steps
    Specify Supporting Token Options
    1. Click Add Token Choice
    2. Select the Token Choice
    3. Click Add Token
    Add Supporting Token
    1. Token Type = Binary Security
    2. Token Inclusion = Always to Recipient
    3. Subject Category = End-User
    Specify Binary Security Token Options
    1. Binary Security Token Type = urn:soa.com:security.tokens:siteminder-ssotoken

Step 2: Attach Policies

  1. Attach the policies to a virtual service.

Step 3: Send Request

Send a request from the SiteMinder Client or SOAP UI as illustrated below:

Option 1: Send Request with SiteMinder Client

  1. Launch the SiteMinder client and send request with the Binary Security Token.

Option 2: Send Request from SOAP UI

  1. Launch SOAPUI and send a request with the Binary Security Token.

Step 4: Test Configuration

  1. Send requests to the virtual service and view the usage data in the Services > Monitoring section.

Back to top

Use Case #7: Set Up CA SiteMinder to Support Single Sign-On with Community Manager

Learn how to set up CA SiteMinder and create login for Community Manager.

Steps:

  1. Introduction
  2. Set up CA SiteMinder Login for Enterprise API Platform
  3. Step 1: Define Domain for Enterprise API Platform Access Control
  4. Step 2: Define SOA Authentication Realm
  5. Step 3: Define the Global Policies for Community Manager
  6. Step 4: Protect the Community Manager Login Redirect Page
  7. Complete Integrate CA SiteMinder with Policy Manager Steps
  8. Set up OAuth Provider Domain to use CA SiteMinder in Community Manager

Introduction

Akana API Platform (Community Manager) uses CA SiteMinder facilities in two ways:

  • To authenticate credentials and SSO tokens for the CA SiteMinder Identity System defined in Akana Policy Manager.
  • To perform a CA SiteMinder managed login process when connecting to the Akana API Platform portal (Community Manager) or when issuing an OAuth/OpenID access token.

Note: Community Manager must be installed and configured prior to performing these configuration tasks.

Set up CA SiteMinder Login for Enterprise API Platform

Customers who are integrating with other Akana Products (e.g., Akana Enterprise API Platform) must create a global on/off accept rule for agents. Many of the properties defined in this section are referenced when you configure the CA SiteMinder Identity System in Policy Manager, and enable Single Sign-On functionality with other Akana products.

The setup process is accomplished by performing the following configuration tasks in CA SiteMinder:

Step 1: Define Domain for Enterprise API Platform Access Control

The domain contains all the access control definitions that Akana Enterprise API Platform will use When the CA SiteMinder Identity System is defined in Policy Manager, the Identity System is associated with the Domain.

When you check Global Policies Apply, this enables responses to be processed from authentication requests in the Domain. In addition, checking this option adds the CA SiteMinder resource to the Admin > Domains section of the Enterprise API Platform portal so it is available for selection when you define an OAuth Provider.
  1. Launch the CA SiteMinder Domain Dialog and create a new CA SiteMinder Domain.
  2. Verify that the Global Policies Apply checkbox is checked.

    SiteMinder Domain Dialog - SiteMinder Domain Dialog

Step 2: Define SOA Authentication Realm

Akana Enterprise API Platform uses a common, bare Realm to authenticate all credentials and SSO tokens under the CA SiteMinder Identity System.

  1. Define a Realm using the Basic Authentication Scheme.

    SiteMinder Domain Dialog - SiteMinder Realm Dialog

Step 3: Define the Global Policies for Community Manager

Global Policies must be defined to allow user information to be extracted from LDAP and passed into Akana Enterprise API Platform. This is to allow Enterprise API Platform to know the name and email address of the user logging into Enterprise API Platform using CA SiteMinder.

  1. Define a Global Rule as follows:

    SiteMinder Domain Dialog - SiteMinder Global Rule Dialog

  2. The next step is to configure a Global Response Object. The Global Response Object facilitates the log in to the Enterprise API Platform via CA SiteMinder. The purpose of the Global Response Object is to get information from the CA SiteMinder controlled User Directory into the Enterprise API Platform.

    Define Global Responses as follows (customer’s LDAP attributes may be different).

    SiteMinder Domain Dialog - SiteMinder Global Response Dialog

  3. Define a Global Policy as follows:

    SiteMinder Domain Dialog - SiteMinder Global Policy Dialog

Step 4: Protect the Community Manager Login Redirect Page

The Akana SiteMinder Security Provider feature includes a small HTML page that will redirect a browser to a specified URL. This page must be loaded onto the customer’s web site and placed under protection of the customer’s SiteMinder Web Agent. After the page is loaded, perform the following steps to protect it.

  1. Define a new Realm if necessary. (Some customers will already have appropriate Realms defined).

    SiteMinder Domain Dialog - SiteMinder Realm Dialog

  2. Define a Rule under the Realm:

    SiteMinder Domain Dialog - SiteMinder Rule Dialog

  3. Define a Policy to protect the redirection page and on the Rules tab:

    SiteMinder Domain Dialog - SiteMinder Policy Dialog

    SiteMinder Domain Dialog - SiteMinder Policy Dialog

back to top

Complete Integrate CA SiteMinder with Policy Manager Steps

Complete steps 1-6 outlined in Integrate CA SiteMinder with Policy Manager. For Step 6, use the Configure CA SiteMinder Identity System in Policy Manager (Integrate other Akana Products).

back to top

Set up OAuth Provider Domain to use CA SiteMinder in Community Manager

The final step in the process is to install the OAuth Provider features to the Community Manager container, launch the Akana API Platform portal (Community Manager) and enable the domain in the Site Administrator > Config > Logins section of the platform or select it as a Resource Owner Authentication Domain when defining an OAuth Provider.

for more information, refer to Domains (developer portal help).

Back to top