APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Mongo Service Registry

This registry uses a MongoDb instance to load and persist service definitions. Support is enabled by adding the following module into the overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



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





1



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





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed 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-mongo-service-registry"
}

Configuration

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

cas.service-registry.mongo.client-uriThe connection uri to the mongodb instance.
no default
Required

The connection uri to the mongodb instance. This typically takes on the form of mongodb://user:psw@ds135522.somewhere.com:35522/db. If not specified, will fallback onto other individual settings. If specified, takes over all other settings where applicable.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.collectionMongoDb database collection name to fetch and/or create.
no default
Required

MongoDb database collection name to fetch and/or create.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.database-nameMongoDb database instance name.
no default
Required

MongoDb database instance name.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.hostMongoDb database host for authentication.
localhost
Required

MongoDb database host for authentication. Multiple host addresses may be defined, separated by comma. If more than one host is defined, it is assumed that each host contains the port as well, if any. Otherwise the configuration may fallback onto the port defined.

Type
String
Default
localhost
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.passwordMongoDb database password for authentication.
no default
Required

MongoDb database password for authentication.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.portMongoDb database port.
27017
Required

MongoDb database port.

Type
Integer
Default
27017
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.user-idMongoDb database user for authentication.
no default
Required

MongoDb database user for authentication.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.authentication-database-nameName of the database to use for authentication.
no default

Name of the database to use for authentication.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.change-stream.enabledWatch the service registry collection through a MongoDb change stream and reload service definitions as soon as they change, on every CAS node.
true

Watch the service registry collection through a MongoDb change stream and reload service definitions as soon as they change, on every CAS node. This only takes effect when a replica set is defined, either with the replica-set setting or in the client-uri, and the server confirms that it is a member of a replica set. The scheduled reload of service definitions remains in place as a fallback.

Type
Boolean
Default
true
Defined by
MongoDbServiceRegistryChangeStreamProperties
cas.service-registry.mongo.change-stream.quiet-periodHow long to wait after the last observed change before reloading service definitions, so that a burst of changes, such as a bulk import, results in a single reload.
PT2S
Duration

How long to wait after the last observed change before reloading service definitions, so that a burst of changes, such as a bulk import, results in a single reload.

Type
String
Default
PT2S
Defined by
MongoDbServiceRegistryChangeStreamProperties
cas.service-registry.mongo.drop-collectionWhether collections should be dropped on startup and re-created.
false

Whether collections should be dropped on startup and re-created.

Type
Boolean
Default
false
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.orderThe execution order of this registry which will determine its position in a chain in case multiple registries are defined.
no default

The execution order of this registry which will determine its position in a chain in case multiple registries are defined.

Type
Integer
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.pool.idle-timeThe maximum idle time of a pooled connection.
PT5M
Duration

The maximum idle time of a pooled connection. A zero value indicates no limit to the idle time. A pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection. Keep this below any idle timeout enforced by firewalls or load balancers between CAS and MongoDb.

Type
String
Default
PT5M
Defined by
MongoDbConnectionPoolProperties
cas.service-registry.mongo.pool.life-timeThe maximum time a pooled connection can live for.
PT30M
Duration

The maximum time a pooled connection can live for. A zero value indicates no limit to the life time. A pooled connection that has exceeded its life time will be closed and replaced when necessary by a new connection. Every replacement repeats the TLS handshake and authentication, so a short life time adds latency under load; a finite value still lets connections move to new servers after topology or DNS changes.

Type
String
Default
PT30M
Defined by
MongoDbConnectionPoolProperties
cas.service-registry.mongo.pool.max-sizeMaximum number of connections to keep around.
100

Maximum number of connections to keep around. Connections are opened on demand up to this limit, and a single login makes several requests to the ticket registry.

Type
Integer
Default
100
Defined by
MongoDbConnectionPoolProperties
cas.service-registry.mongo.pool.max-wait-timeThe maximum time that a thread may wait for a connection to become available.
PT10S
Duration

The maximum time that a thread may wait for a connection to become available. When the pool is exhausted, the request fails once this time passes rather than holding the thread.

Type
String
Default
PT10S
Defined by
MongoDbConnectionPoolProperties
cas.service-registry.mongo.pool.min-sizeMinimum number of connections to keep around.
1

Minimum number of connections to keep around.

Type
Integer
Default
1
Defined by
MongoDbConnectionPoolProperties
cas.service-registry.mongo.read-concernRead concern.
AVAILABLE
Read concern. Accepted values are:
  • LOCAL
  • MAJORITY
  • LINEARIZABLE
  • SNAPSHOT
  • AVAILABLE
Type
String
Default
AVAILABLE
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.read-preferenceRead preference.
PRIMARY
Read preference. Accepted values are:
  • PRIMARY
  • SECONDARY
  • SECONDARY_PREFERRED
  • PRIMARY_PREFERRED
  • NEAREST
Type
String
Default
PRIMARY
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.replica-setA replica set in MongoDB is a group of mongod processes that maintain the same data set.
no default

A replica set in MongoDB is a group of mongod processes that maintain the same data set. Replica sets provide redundancy and high availability, and are the basis for all production deployments.

Type
String
Default
none
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.retry-writesSets whether writes should be retried if they fail due to a network error.
false

Sets whether writes should be retried if they fail due to a network error.

Type
Boolean
Default
false
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.ssl-enabledWhether connections require SSL.
false

Whether connections require SSL.

Type
Boolean
Default
false
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.timeoutMongoDb database connection timeout.
PT5S
Duration

MongoDb database connection timeout.

Type
String
Default
PT5S
Defined by
MongoDbServiceRegistryProperties
cas.service-registry.mongo.write-concernWrite concern describes the level of acknowledgement requested from MongoDB for write operations to a standalone mongo db or to replica sets or to sharded clusters.
ACKNOWLEDGED

Write concern describes the level of acknowledgement requested from MongoDB for write operations to a standalone mongo db or to replica sets or to sharded clusters. In sharded clusters, mongo db instances will pass the write concern on to the shards.

Type
String
Default
ACKNOWLEDGED
Defined by
MongoDbServiceRegistryProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

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.

:information_source: Note

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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. 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.

Change Streams

When MongoDb runs as a replica set, CAS watches the service registry collection through a change stream and reloads service definitions shortly after they change, on every CAS node. Changes made by another CAS node, or directly in MongoDb, are picked up in seconds instead of at the next scheduled reload.

Change streams are used only when both of the following hold:

  • A replica set is defined: the replica-set setting is set, or the client-uri names one with its replicaSet option or uses the mongodb+srv scheme.
  • The server confirms that it is a member of a replica set. Otherwise, such as for a standalone server or a sharded cluster reached through mongos, CAS logs this once and relies on the scheduled reload alone.

Changes that arrive close together, such as a bulk import, result in a single reload once no change has been seen for the configured quiet period; under a steady stream of changes, CAS still reloads at least once every ten quiet periods. A configuration refresh restarts the change stream with the refreshed settings. If the stream is interrupted, CAS resumes it where it left off; when that is no longer possible, it reloads all service definitions and starts a new stream. The database user needs the changeStream and find privileges on the collection, both of which the built-in read role grants. Each CAS node keeps one long-running request open against the replica set, which holds one connection from the pool while it waits.

:information_source: Scheduled Reloads

Keep the scheduled reload enabled as a safety net, since it also covers changes made while a node could not reach MongoDb. With change streams in place, its interval can be much longer than the default. Disabling the scheduler instead makes CAS consult the registry for every request that matches no cached definition.

Auto Initialization

Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.