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
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-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.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.
|
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.
|
cas.authn.mongo.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
|
cas.authn.mongo.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
|
cas.authn.mongo.attributes=
Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).
|