Couchbase Ticket Registry

Couchbase integration is enabled by including the following dependency in the WAR overlay:

Usage

This feature is deprecated and is scheduled to be removed in the future.

1
2
3
4
5

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-couchbase-ticket-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

1

implementation "org.apereo.cas:cas-server-support-couchbase-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-couchbase-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-couchbase-ticket-registry"
}

Couchbase is a highly available, open source NoSQL database server based on Erlang/OTP and its mnesia database. The intention of this registry is to leverage the capability of Couchbase server to provide high availability to CAS.

Configuration

The following settings and properties are available from the CAS configuration catalog:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.ticket.registry.couchbase.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.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.signing.key=

    • The signing key is a JWT whose length is defined by the signing key size setting.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.addresses=

    • Node addresses.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.bucket=testbucket

    • Bucket name.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.cluster-password=

    • Cluster password.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.cluster-username=

    • Cluster username.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your configuration if you need to modify the default value.

  • cas.ticket.registry.couchbase.crypto.alg=AES

    • The signing/encryption algorithm to use.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.enabled=true

    • Whether crypto operations are enabled.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.encryption.key-size=16

    • Encryption key size.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.signing.key-size=512

    • The signing key size.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.connection-timeout=PT60S

    • String representation of connection timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.idle-connection-timeout=PT60S

    • String representation of idle connection timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.kv-timeout=PT30S

    • String representation of KV timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.max-http-connections=5

    • Maximum number of connections made to the cluster.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.max-num-requests-in-retry=32768

    • Allows to customize the maximum number of requests allowed in the retry timer.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.max-parallelism=0

    • Maximum number of parallel threads made for queries.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.query-timeout=PT30S

    • String representation of query timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.scan-consistency=NOT_BOUNDED

    • Query scan consistency.

    By default, the query engine will return whatever is currently in the index at the time of query (this mode is also called NOT_BOUNDED). If you need to include everything that has just been written, a different scan consistency must be chosen. If REQUEST_PLUS is chosen, it will likely take a bit longer to return the results but the query engine will make sure that it is as up-to-date as possible.

    Accepted values are: NOT_BOUNDED, REQUEST_PLUS.

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.scan-wait-timeout=PT30S

    • String representation of scan timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.search-timeout=PT30S

    • String representation of search timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.view-timeout=PT30S

    • String representation of view timeout.

    This settings supports the java.time.Duration syntax [?].

    org.apereo.cas.configuration.model.support.couchbase.ticketregistry.CouchbaseTicketRegistryProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.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.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.signing.key=

    • The signing key is a JWT whose length is defined by the signing key size setting.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.alg=AES

    • The signing/encryption algorithm to use.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.enabled=true

    • Whether crypto operations are enabled.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedSigningJwtCryptographyProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.encryption.key-size=16

    • Encryption key size.

    org.apereo.cas.configuration.model.core.util.EncryptionRandomizedCryptoProperties.

    How can I configure this property?

  • cas.ticket.registry.couchbase.crypto.signing.key-size=512

    • The signing key size.

    org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

    How can I configure this property?

    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.

    The Couchbase integration currently assumes that the ticket registries are stored in their own buckets. You may optionally set passwords for the buckets and optionally configure redundancy and replication as per normal Couchbase configuration.

    The only truly mandatory setting is the list of nodes. The other settings are optional, but this is designed to store data in buckets so in reality the bucket property must also be set.

    Expiration Policy

    You will need to remember that every document in Couchbase contains the expiry property. An expiration time-to-live value of 0 means that no expiration is set at all. The expiration time starts when the document has been successfully stored on the server, not when the document was created on the CAS server. In practice, the delta should be very very negligible. Any expiration time larger than 30 days in seconds is considered absolute (as in a Unix time stamp) and anything smaller is considered relative in seconds.

    Troubleshooting

    To enable additional logging, configure the log4j configuration file to add the following levels:

    1
2
3
4
5
6

    ...
<Logger name="com.couchbase" level="debug" additivity="false">
    <AppenderRef ref="console"/>
    <AppenderRef ref="file"/>
</Logger>
...