WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
MongoDb Authentication
Verify and authenticate credentials against a MongoDb instance. Support 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-mongo</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-mongo:${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"
}
1
2
3
4
5
6
dependencies {
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"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.mongo.password-encoder.encoding-algorithm=
The encoding algorithm to use such as |
cas.authn.mongo.password-encoder.type=NONE
Define the password encoder type to use. Type may be specified as blank or
|
cas.authn.mongo.principal-transformation.groovy.location=
The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf : fs.inotify.max_user_instances = 256 . You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
|
cas.authn.mongo.client-uri=
The connection uri to the mongodb instance. This typically takes on the form of |
cas.authn.mongo.collection=
MongoDb database collection name to fetch and/or create. |
cas.authn.mongo.database-name=
MongoDb database instance name. |
cas.authn.mongo.host=localhost
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. |
cas.authn.mongo.password=
MongoDb database password for authentication. |
cas.authn.mongo.port=27017
MongoDb database port. |
cas.authn.mongo.user-id=
MongoDb database user for authentication. |
cas.authn.mongo.password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is |
cas.authn.mongo.password-encoder.hash-length=16
When used by |
cas.authn.mongo.password-encoder.iterations=310000
When used by |
cas.authn.mongo.password-encoder.secret=
Secret to use with |
cas.authn.mongo.password-encoder.strength=16
Strength or number of iterations to use for password hashing. Usually relevant when dealing with |
cas.authn.mongo.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail. This setting supports the Spring Expression Language. |
cas.authn.mongo.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.mongo.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username. This setting supports the Spring Expression Language. |
cas.authn.mongo.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. This setting supports the Spring Expression Language. |
cas.authn.mongo.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. This setting supports the Spring Expression Language. |
cas.authn.mongo.attributes=
Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior). |
cas.authn.mongo.authentication-database-name=
Name of the database to use for authentication. |
cas.authn.mongo.drop-collection=false
Whether collections should be dropped on startup and re-created. |
cas.authn.mongo.name=
Name of the authentication handler. |
cas.authn.mongo.order=
Order of authentication handler in chain. |
cas.authn.mongo.password-attribute=password
Attribute that holds the password. |
cas.authn.mongo.principal-id-attribute=
Attribute that would be used to establish the authenticated profile. |
cas.authn.mongo.read-concern=AVAILABLE
Read concern. Accepted values are:
|
cas.authn.mongo.read-preference=PRIMARY
Read preference. Accepted values are:
|
cas.authn.mongo.replica-set=
A replica set in MongoDB is a group of |
cas.authn.mongo.retry-writes=false
Sets whether writes should be retried if they fail due to a network error. |
cas.authn.mongo.socket-keep-alive=false
Whether the database socket connection should be tagged with keep-alive. |
cas.authn.mongo.ssl-enabled=false
Whether connections require SSL. |
cas.authn.mongo.timeout=PT5S
MongoDb database connection timeout. This settings supports the
|
cas.authn.mongo.username-attribute=username
Attributes that holds the username. |
cas.authn.mongo.write-concern=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. |
cas.authn.mongo.pool.idle-time=PT30S
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. This settings supports the
|
cas.authn.mongo.pool.life-time=PT60S
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. This settings supports the
|
cas.authn.mongo.pool.max-size=10
Maximum number of connections to keep around. |
cas.authn.mongo.pool.max-wait-time=PT60S
The maximum time that a thread may wait for a connection to become available. This settings supports the
|
cas.authn.mongo.pool.min-size=1
Minimum number of connections to keep around. |
cas.authn.mongo.pool.per-host=10
Total number of connections allowed per host. |