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.

To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.

MongoDb Authentication

Verify and authenticate credentials against a MongoDb instance. Support is enabled by including the following dependency in the WAR overlay:

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

implementation "org.apereo.cas:cas-server-support-mongo:${project.'cas.version'}"

dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-mongo"
}

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.authn.mongo.password-encoder.encoding-algorithm=` The encoding algorithm to use such as `MD5`. Relevant when the type used is `DEFAULT` or `GLIBC_CRYPT`. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.authn.mongo.password-encoder.type=NONE` Define the password encoder type to use. Type may be specified as blank or `NONE` to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's `PasswordEncoder` interface if you wish you define your own encoder. The following types may be used: `NONE`: No password encoding (i.e. plain-text) takes place. `DEFAULT`: Use the `DefaultPasswordEncoder` of CAS. For message-digest algorithms via `character-encoding` and `encoding-algorithm`. `BCRYPT`: Use the `BCryptPasswordEncoder` based on the strength provided and an optional secret. `SCRYPT`: Use the `SCryptPasswordEncoder`. `PBKDF2`: Use the `Pbkdf2PasswordEncoder` based on the strength provided and an optional secret. `STANDARD`: Use the `StandardPasswordEncoder` based on the secret provided. `SSHA`: Use the `LdapShaPasswordEncoder` supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA</code> or {SSHA</code> prepended to the encoded hash. `GLIBC_CRYPT`: Use the `GlibcCryptPasswordEncoder` based on the `encoding-algorithm`, strength provided and an optional secret. `org.example.MyEncoder`: An implementation of `PasswordEncoder` of your own choosing. `file:///path/to/script.groovy`: Path to a Groovy script charged with handling password encoding operations. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`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 of `inotify` 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`. `org.apereo.cas.configuration.model.core.authentication.GroovyPrincipalTransformationProperties.`
`cas.authn.mongo.client-uri=` 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. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.collection=` MongoDb database collection name to fetch and/or create. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.database-name=` MongoDb database instance name. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`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. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.password=` MongoDb database password for authentication. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.port=27017` MongoDb database port. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.user-id=` MongoDb database user for authentication. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`

_{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.authn.mongo.password-encoder.character-encoding=UTF-8` The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is `DEFAULT`. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.authn.mongo.password-encoder.secret=` Secret to use with `STANDARD`, `PBKDF2`, `BCRYPT`, `GLIBC_CRYPT` password encoders. Secret usually is an optional setting. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`cas.authn.mongo.password-encoder.strength=16` Strength or number of iterations to use for password hashing. Usually relevant when dealing with `PBKDF2` or `BCRYPT` encoders. Used by `GLIBC_CRYPT` encoders as well. `org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.`
`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. `org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.`
`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: `NONE`: No conversion. `LOWERCASE`: Lowercase conversion. `UPPERCASE`: Uppercase conversion. `org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.`
`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. `org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.`
`cas.authn.mongo.principal-transformation.prefix=` Prefix to add to the principal id prior to authentication. `org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.`
`cas.authn.mongo.principal-transformation.suffix=` Suffix to add to the principal id prior to authentication. `org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.`
`cas.authn.mongo.attributes=` Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior). `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.authentication-database-name=` Name of the database to use for authentication. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.drop-collection=false` Whether collections should be dropped on startup and re-created. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.name=` Name of the authentication handler. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.order=` Order of authentication handler in chain. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.password-attribute=password` Attribute that holds the password. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.principal-id-attribute=` Attribute that would be used to establish the authenticated profile. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.read-concern=AVAILABLE` Read concern. Accepted values are: `LOCAL` `MAJORITY` `LINEARIZABLE` `SNAPSHOT` `AVAILABLE` `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.read-preference=PRIMARY` Read preference. Accepted values are: `PRIMARY` `SECONDARY` `SECONDARY_PREFERRED` `PRIMARY_PREFERRED` `NEAREST` `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.replica-set=` 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. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.retry-writes=false` Sets whether writes should be retried if they fail due to a network error. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.socket-keep-alive=false` Whether the database socket connection should be tagged with keep-alive. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.ssl-enabled=false` Whether connections require SSL. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.timeout=PT5S` MongoDb database connection timeout. This settings supports the `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`cas.authn.mongo.username-attribute=username` Attributes that holds the username. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`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. `org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties.`
`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 `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`
`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 `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`
`cas.authn.mongo.pool.max-size=10` Maximum number of connections to keep around. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`
`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 `java.time.Duration` syntax ^[?]. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`
`cas.authn.mongo.pool.min-size=1` Minimum number of connections to keep around. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`
`cas.authn.mongo.pool.per-host=10` Total number of connections allowed per host. `org.apereo.cas.configuration.model.support.mongo.MongoDbConnectionPoolProperties.`