CA API Gateway 9.1

9.4 9.1

Install the CA Single Sign-On SDK for Software Gateways

This topic describes how to install the CA Single Sign-On SDK on a Software gateway running in these environments:
gateway91
This topic describes how to install the CA Single Sign-On SDK on a Software 
CA API Gateway
 running in these environments:
  • Red Hat Enterprise Linux (excluding RHEL 7)
  • Solaris
Installing the SDK enables the CA Single Sign-On functionality on the Gateway. The installation script will detect and install the appropriate SDK binary for your platform.
For information about the CA Single Sign-On features, see Working with CA Single Sign-On. 
(1) The CA Single Sign-On SDK is included in the Appliance and Virtual Appliance form factors of the
API Gateway
, so separate installation is
not
 required. (2) Even though the Software Gateway may be deployed in RHEL 7 environments, this version of the CA Single Sign-On SDK is not compatible with RHEL 7. (3) Contact CA Support if you need to install the SDK on a SUSE Linux platform.
Prerequisites:
  • Ensure that your
    API Gateway
     is configured and operational.
  • Ensure that you have the following file:
    siteminder-sdk_12.52.tar.gz
    This file is contained in the "CA API Gateway Software Installer Upgrader" distribution archive. For more information, see Release Notes 9.3.
    For a complete list of the supported CA Single Sign-On (formerly "Siteminder") versions, see "Identity Providers" in Requirements and Compatibility.
Installing the SDK
To install the CA Single Sign-On SDK on a RHEL/Solaris Gateway:
  1. Copy the appropriate tar file to the machine hosting the
    API Gateway
    .
  2. Create a new directory from the root and then change it to:
    # mkdir smsdk
    # cd smsdk
  3. Extract the tar file:
    RHEL:
    # tar -xzf ../siteminder-sdk_12.52.tar.gz
    Solaris:
    # gunzip ../siteminder-sdk_12.52.tar.gz
    # tar -xvf ../siteminder-sdk_12.52.tar
  4. Change to the extracted directory and run the script file:
    # cd /siteminder-sdk_12.52
    # ./sm_sdk_install.sh
    A success message displays indicating that installation is complete.
  5. Enable the CA Single Sign-On SDK by setting this system property:
    com.l7tech.server.siteminder.enable=true
  6. Restart the Gateway with these commands:
    # /opt/SecureSpan/Gateway/runtime/bin/gateway.sh stop
    # /opt/SecureSpan/Gateway/runtime/bin/gateway.sh start
The CA Single Sign-On features in the
API Gateway
 are now enabled. You can remove the directory containing the extracted files (
smsdk
).

Content feedback and comments