Configuring an AWS DynamoDB for persistent authentication sessions
Set up an Amazon Web Services (AWS) DynamoDB so that PingFederate can store persistent authentication sessions in the DynamoDB NoSQL database.
Before you begin
Ensure that your server is configured to access DynamoDB.
About this task
PingFederate requires specific tables to store persistent authentication sessions on your DynamoDB server. Table-setup scripts are provided for this purpose.
PingFederate supports the use of global multi-region tables for DynamoDB. However, these tables are managed entirely by AWS. Learn more about configuring global tables in Amazon DynamoDB global tables in the AWS documentation. |
Steps
-
To create a table in DynamoDB to contain authentication sessions, run the commands in the
<pf_install>/pingfederate/server/default/conf/authentication-session/nosql-scripts/authentication-session-dynamodb.txt
file.This file contains basic commands to create the table, with sample values for read and write throughput, as well as the command to enable
ExpiryTime
as the Time-to-Live (TTL) attribute.-
Optional: To rename the table and index names, edit the
table-name
and\"IndexName\"
values in the table script in theauthentication-session-dynamodb.txt
file.
-
-
Optional: If authentication sessions are not already enabled in PingFederate, go to Authentication → Policies → Sessions to configure them. For more information, see Configuring authentication sessions.
-
Edit the
<pf_install>/pingfederate/server/default/conf/service-points.conf
file:-
Locate the
SessionStorageManager
service point:
# Service for storing Authentication Sessions. # Supported classes: # org.sourceid.saml20.service.session.data.impl.SessionStorageManagerJdbcImpl : Use this service-point for a Jdbc implementation. # org.sourceid.saml20.service.session.data.impl.SessionStorageManagerLdapImpl : Use this service-point for an LDAP implementation. # org.sourceid.saml20.service.session.data.impl.SessionStorageManagerDynamoDBImpl : Use this service-point for a DynamoDB implementation. session.storage.manager=org.sourceid.saml20.service.session.data.impl.SessionStorageManagerJdbcImpl
-
Update the value of the service point to
org.sourceid.saml20.service.session.data.impl.SessionStorageManagerDynamoDBImpl
. -
Save the file.
For a clustered PingFederate environment, you must edit the
service-points.conf
file on each node manually because cluster replication can’t replicate this change to other nodes.
-
-
Optional: If you modified the default table and index names in the
authentication-session-dynamodb.txt
file in step 1, edit the<pf_install>/pingfederate/server/default/data/config-store/org.sourceid.saml20.service.session.data.impl.SessionStorageManagerDynamoDBImpl.xml
file to match your customized configuration.If you ran the script commands from the
authentication-session-dynamodb.txt
as is and did not change the default names in the commands, you do not need to edit the<pf_install>/pingfederate/server/default/data/config-store/org.sourceid.saml20.service.session.data.impl.SessionStorageManagerDynamoDBImpl.xml
file.-
Replace the
<c:item name="SessionGroupTableName"/>
,<c:item name="UserIdTableName"/>
,<c:item name="HashedSessionIdIndexName"/>
,<c:item name="SessionUserIdGroupIdIndexName"/>
element values with the customized names created during your initial DynamoDB setup. -
Save the file.
The following table describes the preconfigured PingFederate variables in the
<pf_install>/pingfederate/server/default/data/config-store/org.sourceid.saml20.service.session.data.impl.SessionStorageManagerDynamoDBImpl.xml
file.
DynamoDB Session Storage Manager Variables Variable Description PingFederateAuthenticationSessionHashedSessionId-index
The name of the hashed session ID index.
This is the default value.
PingFederateAuthenticationSessionUserIdGroupId-index
The name of the user ID and group ID index.
This is the default value.
EndpointOverride
An optional endpoint URL which should not be used in production but allows for testing with a local development DynamoDB instance.
By default, this value is empty. To test DynamoDB running locally, specify
EndpointOverride
to point to a local endpoint. For example,<c:item name="EndpointOverride">http://localhost:8000</c:item>
. For more information, see DynamoDB local usage notes in the AWS DynamoDB documentation.dynamoDbBatchSize
Number of records to request when performing batch operations against DynamoDB. The minimum allowed value is one, the maximum allowed value is 100, and the default value is 50.
ApiCallTimeout
The amount of time in milliseconds to allow the client to complete the execution of the API call. The default value is 10000.
ApiCallAttemptTimeout
The amount of time in milliseconds to wait for the HTTP request to complete before giving up and timing out. The default value is 1000.
-
-
Start or restart the PingFederate service.
For a clustered PingFederate, replicate this new configuration to other engine nodes on System → Server → Cluster Management. Start or restart the PingFederate service on each engine node to active the change.
Result
PingFederate relies on the DynamoDB TTL attribute to remove expired authentication sessions from the database. For more information on TTL, see Expiring items by using DynamoDB Time to Live (TTL) in the AWS DynamoDB documentation.