Integrate with RSA Access Manager
7 minute read
RSA Access Manager (formerly RSA ClearTrust) provides Identity Management and access control services for web applications. It centrally manages access to web applications, ensuring that only authorized users are allowed access to resources. You can configure API Gateway to act as a client to the RSA Access Manager, and leverage the user information stored in RSA Access Manager for user authentication and authorization.
API Gateway uses the Access Manager filter to query authorization information for a particular user on a given resource from RSA Access Manager and to make the authorization decision. If the user has been authorized for the resource in question, the request is allowed through to the service. Otherwise, the request is rejected. In addition, you can also configure an authentication filter to authenticate users against a RSA Access Manager authentication repository.
Integration with RSA Access Manager requires RSA Access Manager SDK version 6.2 or server installation libraries.
For more details on the product, see the RSA Access Manager documentation.
RSA Access Manager server connections
API Gateway can connect to a number of Access Manager authorization servers or dispatcher servers using connection sets (connection groups). A connection set consists of a globally configured set of servers that API Gateway connects to. API Gateway round-robins between groups of external servers, providing a high degree of failover. If one of the servers becomes unavailable, API Gateway can use one of the other servers in the group.
You can deploy multiple Access Manager authorization servers for load-balancing purposes. In this case, API Gateway first connects to a dispatcher server that returns a list of active authorization servers. If the first dispatcher server in the connection group is not available, API Gateway attempts to connect to the dispatcher server with the next highest priority in the group. If a dispatcher server has not been deployed,API Gateway can connect directly to an authorization server. API Gateway then attempts to connect to one of the authorization servers.
API Gateway attempts to connect to the listed servers according to the priorities assigned to them. For example, a connection group could include two high-priority servers, one medium-priority server, and one low-priority server configured. If API Gateway can successfully connect to the two high-priority servers, it alternates requests only between these two servers, and the other servers in the group are not used. However, if both high-priority servers are unavailable, API Gateway attempts to connect to the medium-priority server. Only if the medium-priority server fails as well, API Gateway connects to the low-priority server.
- An end user attempts to access a resource protected with RSA Access Manager on API Gateway.
- API Gateway authenticates the end user against the RSA Access Manager authentication repository.
- API Gateway requests RSA Access Manager to make the security decision for the user.
- RSA Access Manager makes the security decision based on the user information, and returns the decision to API Gateway.
- API Gateway enforces the security decision.
- On success, API Gateway routes the message on to a configured target system.
- On failure, API Gateway blocks the message and returns an error to the end user.
Before you start, you must have the following:
- API Gateway installed
- RSA Access Manager v6.2 installed and configured
This guide provides a simple policy to demonstrate how API Gateway integrates with RSA Access Manager to authenticate and authorize users to specific resources. The example policy uses HTTP Basic to authenticate the end user, but you can replace it with another authentication mechanism, if required.
The following steps are required to integrate API Gateway with RSA Access Manager:
- Add RSA Access Manager binaries to API Gateway
- Configure RSA Access Manager connection
- Configure an RSA Access Manager authentication repository
- Configure API Gateway policy
Add RSA Access Manager binaries to API Gateway
You must copy RSA Access Manager libraries to API Gateway, so you must have RSA Access Manager installed on a server.
- Copy the following files from the
libdirectory on your RSA Access Manager installation:
- Add the files to the
INSTALL_DIR/apigateway/ext/libdirectory on API Gateway:
- Restart the gateway.
Configure RSA Access Manager connection
This section describes how to configure a RSA Access Manager connection in Policy Studio.
The RSA Access Manager connection is configured as a connection set. A connection set consists of a globally configured set of servers that API Gateway connects to. You can reuse these global sets when configuring policies in Policy Studio.
NoteAll servers in the connection set must be of the same type (authorization servers or dispatcher servers).
- In the node tree, click Environment Configuration > External Connections > Connection Sets.
- Select RSA Access Manager Connection Sets, and click Add a Connection Set.
- Enter a name for the connection set (for example,
Dispatch), and click Add to add a server.
- Enter the host name and port the server is listening on.
- Select the security type for the server connection. The security type (Clear, SSL (Anonymous), or SSL Authentication) you select must match the security requirement of the server.
- If you selected SSL Authentication, click Signing Key, and select the certificate you want to use, then select OK.
- To change the priority of a server in the set, select the server, and click Up or Down.
- Repeat for all the servers you want to include in the connection set, and click OK.
To later view or edit your connection sets, click Environment Configuration > External Connections > Connection Sets, double-click RSA Access Manager Connection Sets, and select the connection you want.
For more details on the fields and options in this configuration window, see Configure a connection group.
Configure an RSA Access Manager authentication repository
This section describes how to configure an RSA Access Manager authentication repository in Policy Studio.
- In the node tree, click Environment Configuration > External Connections > Authentication Repositories.
- Select RSA Access Manager Repositories, and click Add a new Repository.
- Enter a name for the repository (for example,
RSA Access Manager Repository).
- Select which server type API Gateway connects to (Authorization Server or Dispatch Server).
- Select the connection group that API Gateway connects to.
- Select the authentication type you plan to use, and click OK.
For more details on the fields and options in this configuration window, see RSA Access Manager repositories.
Configure API Gateway policy
This section describes how to configure a policy for RSA Access Manager integration in Policy Studio.
The RSA Access Manager authentication repository is available from all authentication filters. Here, the example policy uses the HTTP Basic authentication filter to authenticate a client against a RSA Access Manager repository using a user name and password combination. You can configure a different authentication mechanism as required.
To start, add a new policy named, for example,
RSA Access Manager.
- Open the Authentication category in the palette, and drag a HTTP Basic filter onto the policy canvas.
- Set the following, and click Finish:
- Credential Format:
- Allow client challenge: Select this
- Repository Name: The repository you configured (
RSA Access Manager Repository)
- Credential Format:
- Right click the filter, and select Set as Start.
- Open the Authorization category in the palette, and drag an Access Manager filter onto the policy canvas.
- Select which server type API Gateway connects to (Authorization Server or Dispatch Server), and select the connection group.
- In Server, enter the name of the server that hosts the requested resource. The name entered must correspond to a preconfigured server name in RSA Access Manager.
- In Resource, enter the name of the requested resource, and click Finish. The resource must be preconfigured in RSA Access Manager.
- Connect the filters with a success path.
- Click on the Add Relative Path icon to create a new relative path (for example,
/rsa) that links to this policy.
- Deploy the new configuration to API Gateway.
The policy looks like this:
The policy has the following flow:
- API Gateway authenticates the end user using HTTP Basic.
- API Gateway passes the end user’s credentials to RSA Access Manager.
- RSA Access Manager authenticates the end user, authorizes the end user for the particular resource, and sends a response to API Gateway.
- API Gateway relays the response to the end user.