MongoDb Authentication
Verify usernames and passwords against user accounts stored in a MongoDB collection.
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 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"
}
The following settings and properties are available from the CAS configuration catalog:
cas.authn.mongo.client-uriThe connection uri to the mongodb instance.
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.
cas.authn.mongo.collectionMongoDb database collection name to fetch and/or create.
MongoDb database collection name to fetch and/or create.
cas.authn.mongo.database-nameMongoDb database instance name.
MongoDb database instance name.
cas.authn.mongo.hostMongoDb database host for authentication.
localhostMongoDb 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.passwordMongoDb database password for authentication.
MongoDb database password for authentication.
cas.authn.mongo.password-encoder.encoding-algorithmThe encoding algorithm to use such as MD5 .
The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT. When used with PasswordEncoderTypes#PBKDF2, it should be one of PBKDF2WithHmacSHA1, PBKDF2WithHmacSHA256 or PBKDF2WithHmacSHA512.
cas.authn.mongo.password-encoder.typeDefine the password encoder type to use.
NONEDefine 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.
-
NONE: No password encoding (i.e. plain-text) takes place. -
DEFAULT: Use theDefaultPasswordEncoderof CAS. For message-digest algorithms viacharacter-encodingandencoding-algorithm. -
BCRYPT: Use theBCryptPasswordEncoderbased on the strength provided and an optional secret. -
SCRYPT: Use theSCryptPasswordEncoder. -
PBKDF2: Use thePbkdf2PasswordEncoderbased on the strength provided and an optional secret. -
STANDARD: Use theStandardPasswordEncoderbased on the secret provided. -
SSHA: Use theLdapShaPasswordEncodersupports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash. -
GLIBC_CRYPT: Use theGlibcCryptPasswordEncoderbased on theencoding-algorithm, strength provided and an optional secret. -
org.example.MyEncoder: An implementation ofPasswordEncoderof your own choosing. -
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.
cas.authn.mongo.portMongoDb database port.
27017MongoDb database port.
cas.authn.mongo.principal-transformation.groovy.locationThe location of the resource.
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, especially if the script is 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.
In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.
cas.authn.mongo.user-idMongoDb database user for authentication.
MongoDb database user for authentication.
cas.authn.mongo.attributesAttributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).
Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).
cas.authn.mongo.authentication-database-nameName of the database to use for authentication.
Name of the database to use for authentication.
cas.authn.mongo.drop-collectionWhether collections should be dropped on startup and re-created.
falseWhether collections should be dropped on startup and re-created.
cas.authn.mongo.nameName of the authentication handler.
Name of the authentication handler.
cas.authn.mongo.orderOrder of authentication handler in chain.
Order of authentication handler in chain.
cas.authn.mongo.password-attributeAttribute that holds the password.
passwordAttribute that holds the password.
cas.authn.mongo.password-encoder.character-encodingThe encoding algorithm to use such as 'UTF-8'.
UTF-8The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.
cas.authn.mongo.password-encoder.hash-lengthWhen used by PasswordEncoderTypes#ARGON2 , it indicates the hash strength/length.
16When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.
cas.authn.mongo.password-encoder.iterationsWhen used by PasswordEncoderTypes#PBKDF2 , it indicates the required number of iterations.
310000When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.
cas.authn.mongo.password-encoder.secretSecret to use with PasswordEncoderTypes#STANDARD , PasswordEncoderTypes#PBKDF2 , PasswordEncoderTypes#BCRYPT , PasswordEncoderTypes#GLIBC_CRYPT password encoders.
Secret to use with PasswordEncoderTypes#STANDARD, PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#GLIBC_CRYPT password encoders. Secret usually is an optional setting.
cas.authn.mongo.password-encoder.strengthStrength or number of iterations to use for password hashing.
16Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#PBKDF2 or PasswordEncoderTypes#GLIBC_CRYPT. When used by PasswordEncoderTypes#ARGON2 or PasswordEncoderTypes#PBKDF2, it indicates the salt strength.
cas.authn.mongo.pool.idle-timeThe maximum idle time of a pooled connection.
PT5MThe 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.
cas.authn.mongo.pool.life-timeThe maximum time a pooled connection can live for.
PT30MThe 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.
cas.authn.mongo.pool.max-sizeMaximum number of connections to keep around.
100Maximum 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.
cas.authn.mongo.pool.max-wait-timeThe maximum time that a thread may wait for a connection to become available.
PT10SThe 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.
cas.authn.mongo.pool.min-sizeMinimum number of connections to keep around.
1Minimum number of connections to keep around.
cas.authn.mongo.principal-id-attributeAttribute that would be used to establish the authenticated profile.
Attribute that would be used to establish the authenticated profile.
cas.authn.mongo.principal-transformation.blocking-patternA regular expression that will be used against the username to match for blocking/forbidden values.
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-conversionIndicate whether the principal identifier should be transformed into upper-case, lower-case, etc.
NONE-
NONE: No conversion. -
LOWERCASE: Lowercase conversion. -
UPPERCASE: Uppercase conversion.
cas.authn.mongo.principal-transformation.patternA regular expression that will be used against the provided username for username extractions.
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.prefixPrefix to add to the principal id prior to authentication.
Prefix to add to the principal id prior to authentication.
cas.authn.mongo.principal-transformation.suffixSuffix to add to the principal id prior to authentication.
Suffix to add to the principal id prior to authentication.
cas.authn.mongo.read-concernRead concern.
AVAILABLELOCALMAJORITYLINEARIZABLESNAPSHOTAVAILABLE
cas.authn.mongo.read-preferenceRead preference.
PRIMARYPRIMARYSECONDARYSECONDARY_PREFERREDPRIMARY_PREFERREDNEAREST
cas.authn.mongo.replica-setA replica set in MongoDB is a group of mongod processes that maintain the same data 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.
cas.authn.mongo.retry-writesSets whether writes should be retried if they fail due to a network error.
falseSets whether writes should be retried if they fail due to a network error.
cas.authn.mongo.ssl-enabledWhether connections require SSL.
falseWhether connections require SSL.
cas.authn.mongo.timeoutMongoDb database connection timeout.
PT5SMongoDb database connection timeout.
cas.authn.mongo.username-attributeAttributes that holds the username.
usernameAttributes that holds the username.
cas.authn.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.
ACKNOWLEDGEDWrite 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.
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.
Groovy scripting
CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.
Please review this guide to configure your build.
Password encoding
If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
package org.example.cas;
import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;
public class MyEncoder extends AbstractPasswordEncoder {
@Override
protected byte[] encode(CharSequence rawPassword, byte[] salt) {
return ...
}
}
If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
12
import java.util.*
byte[] run(final Object... args) {
def (rawPassword,generatedSalt,logger,applicationContext) = args
logger.debug("Encoding password...")
return ...
}
Boolean matches(final Object... args) {
def (rawPassword,encodedPassword,logger,applicationContext) = args
logger.debug("Does match or not ?");
return ...
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
Principal transformation
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
String run(final Object... args) {
def (providedUsername,logger) = args
return providedUsername.concat("SomethingElse")
}
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
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.
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.
Accounts are expected to be found as such in collections:
1
2
3
4
5
6
{
"username": "casuser",
"password": "34598dfkjdjk3487jfdkh874395",
"first_name": "john",
"last_name": "smith"
}