CouchDB Ticket Registry

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

implementation "org.apereo.cas:cas-server-support-couchdb-ticket-registry:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-couchdb-ticket-registry</artifactId>
  <version>${cas.version}</version>
</dependency>
dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-couchdb-ticket-registry"
}

CouchDB 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 multi-master, multi-datacenter capabilities of CouchDB 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 is not strictly necessary in the end-user CAS configuration, because a default value may be assigned or the feature in question may not be immediately intended for use. You may want to own the setting and update it assigned value, assuming the intended feature controlled by the setting is utilized.

  • cas.ticket.registry.couch-db.db-name=
  • Database name.

  • cas.ticket.registry.couch-db.password=
  • Password for connection.

  • cas.ticket.registry.couch-db.url=http://localhost:5984
  • Connection url.

  • cas.ticket.registry.couch-db.username=
  • Username for connection.

    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.

  • cas.ticket.registry.couch-db.caching=false
  • Use a local cache to reduce fetches..

  • cas.ticket.registry.couch-db.cleanup-idle-connections=true
  • Remove idle connections from pool.

  • cas.ticket.registry.couch-db.connection-timeout=1000
  • TCP connection timeout.

  • cas.ticket.registry.couch-db.create-if-not-exists=true
  • Create the database if it doesn't exist.

  • cas.ticket.registry.couch-db.enable-ssl=false
  • Use TLS. Only needed if not specified by URL.

  • cas.ticket.registry.couch-db.max-cache-entries=1000
  • Max entries in local cache.

  • cas.ticket.registry.couch-db.max-connections=20
  • Maximum connections to CouchDB.

  • cas.ticket.registry.couch-db.max-object-size-bytes=8192
  • Largest allowable serialized object.

  • cas.ticket.registry.couch-db.proxy-host=
  • Proxy host.

  • cas.ticket.registry.couch-db.proxy-port=-1
  • proxy port.

  • cas.ticket.registry.couch-db.relaxed-ssl-settings=false
  • Relax TLS settings–like certificate verification.

  • cas.ticket.registry.couch-db.retries=5
  • Retries for update conflicts.

  • cas.ticket.registry.couch-db.socket-timeout=10000
  • Socket idle timeout.

  • cas.ticket.registry.couch-db.use-expect-continue=true
  • Expect HTTP 100 Continue during connection.


    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. Over time and with community contributions, the accuracy and volume of the documentation should improve over time.

    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 below 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.S ettings 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.

    Time Unit of Measure

    All CAS settings that deal with time units, unless noted otherwise, should support the duration syntax for full clarity on unit of measure: PT20S, PT15M, PT10H, PT6D, P2DT3H4M.

    The only truly mandatory setting is the URL. However, CouchDB should not be used in admin party mode in production, so username and password are needed as well.

    Caveat

    The trade off for multi-master replication across multiple datacenters if CouchDB does not fully delete records. Depending on deployment scale, usage, and available storage, the database may need regular cleaning through normal CouchDB techniques.

    Troubleshooting

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

    1
    2
    3
    4
    5
    6
    
    ...
    <Logger name="org.apache.couchdb" level="debug" additivity="false">
        <AppenderRef ref="console"/>
        <AppenderRef ref="file"/>
    </Logger>
    ...