DynamoDb Ticket Registry
DynamoDb ticket registry integration is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-dynamodb-ticket-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-dynamodb-ticket-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-dynamodb-ticket-registry"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references should be included automatically and are listed here for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-dynamodb-ticket-registry"
}
This registry stores tickets in DynamoDb instances. Each ticket type is linked to a distinct table.
Configuration
You will need to provide CAS with your AWS credentials. Also, to gain a better understanding of DynamoDb’s core components and concepts, please start with this guide first.
The following settings and properties are available from the CAS configuration catalog:
cas.ticket.registry.dynamo-db.crypto.encryption.key=
The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.
|
cas.ticket.registry.dynamo-db.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting.
|
cas.ticket.registry.dynamo-db.credential-access-key=
Use access-key provided by AWS to authenticate. This setting supports the Spring Expression Language.
|
cas.ticket.registry.dynamo-db.credential-secret-key=
Use secret key provided by AWS to authenticate. This setting supports the Spring Expression Language.
|
cas.ticket.registry.dynamo-db.endpoint=
AWS custom endpoint.
|
cas.ticket.registry.dynamo-db.region=
AWS region used.
|
cas.ticket.registry.dynamo-db.crypto.alg=AES
The signing/encryption algorithm to use.
|
cas.ticket.registry.dynamo-db.crypto.enabled=true
Whether crypto operations are enabled.
|
cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16
Encryption key size.
|
cas.ticket.registry.dynamo-db.crypto.signing.key-size=512
The signing key size.
|
cas.ticket.registry.dynamo-db.billing-mode=PROVISIONED
Billing mode specifies how you are charged for read and write throughput and how you manage capacity. Available values are as follows:
|
cas.ticket.registry.dynamo-db.client-execution-timeout=10000
Client execution timeout. This settings supports the
|
cas.ticket.registry.dynamo-db.connection-timeout=5000
Connection timeout. This settings supports the
|
cas.ticket.registry.dynamo-db.drop-tables-on-startup=false
Flag that indicates whether to drop tables on start up.
|
cas.ticket.registry.dynamo-db.local-address=
Local address.
|
cas.ticket.registry.dynamo-db.local-instance=false
Indicates that the database instance is local to the deployment that does not require or use any credentials or other configuration other than host and region. This is mostly used during development and testing.
|
cas.ticket.registry.dynamo-db.max-connections=10
Maximum connections setting.
|
cas.ticket.registry.dynamo-db.prevent-table-creation-on-startup=false
Flag that indicates whether to prevent CAS from creating tables.
|
cas.ticket.registry.dynamo-db.profile-name=
Profile name to use.
|
cas.ticket.registry.dynamo-db.profile-path=
Profile path.
|
cas.ticket.registry.dynamo-db.proxy-granting-tickets-table-name=proxyGrantingTicketsTable
The table name used and created by CAS to hold proxy ticket granting tickets in DynamoDb.
|
cas.ticket.registry.dynamo-db.proxy-host=
Optionally specifies the proxy host to connect through.
|
cas.ticket.registry.dynamo-db.proxy-password=
Optionally specifies the proxy password to connect through.
|
cas.ticket.registry.dynamo-db.proxy-tickets-table-name=proxyTicketsTable
The table name used and created by CAS to hold proxy tickets in DynamoDb.
|
cas.ticket.registry.dynamo-db.proxy-username=
Optionally specifies the proxy username to connect through.
|
cas.ticket.registry.dynamo-db.read-capacity=10
Read capacity.
|
cas.ticket.registry.dynamo-db.retry-mode=STANDARD
Outline the requested retry mode. Accepted values are
|
cas.ticket.registry.dynamo-db.service-tickets-table-name=serviceTicketsTable
The table name used and created by CAS to hold service tickets in DynamoDb.
|
cas.ticket.registry.dynamo-db.socket-timeout=5000
Socket timeout. This settings supports the
|
cas.ticket.registry.dynamo-db.ticket-granting-tickets-table-name=ticketGrantingTicketsTable
The table name used and created by CAS to hold ticket granting tickets in DynamoDb.
|
cas.ticket.registry.dynamo-db.time-offset=0
Time offset.
|
cas.ticket.registry.dynamo-db.transient-session-tickets-table-name=transientSessionTicketsTable
The table name used and created by CAS to hold transient session ticket tickets in DynamoDb.
|
cas.ticket.registry.dynamo-db.use-reaper=false
Flag that indicates whether to use reaper.
|
cas.ticket.registry.dynamo-db.write-capacity=10
Write capacity.
|
cas.ticket.registry.dynamo-db.crypto.encryption.key=
The encryption key. The encryption key by default and unless specified otherwise must be randomly-generated string whose length is defined by the encryption key size setting.
|
cas.ticket.registry.dynamo-db.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting.
|
cas.ticket.registry.dynamo-db.crypto.alg=AES
The signing/encryption algorithm to use.
|
cas.ticket.registry.dynamo-db.crypto.enabled=true
Whether crypto operations are enabled.
|
cas.ticket.registry.dynamo-db.crypto.encryption.key-size=16
Encryption key size.
|
cas.ticket.registry.dynamo-db.crypto.signing.key-size=512
The signing key size.
|
This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.
Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:
1
2
wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]
The outcome would be similar to:
1
2
3
4
5
{
"kty": "oct",
"kid": "...",
"k": "..."
}
The generated value for k
needs to be assigned to the relevant CAS settings. Note that keys generated via
the above algorithm are processed by CAS using the Advanced Encryption Standard (AES
) algorithm which is a
specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Troubleshooting
To enable additional logging, configure the log4j configuration file to add the following levels:
1
2
3
4
5
6
...
<Logger name="com.amazonaws" level="debug" additivity="false">
<AppenderRef ref="console"/>
<AppenderRef ref="file"/>
</Logger>
...