MongoDb Authentication

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

implementation "org.apereo.cas:cas-server-support-mongo:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-mongo</artifactId>
  <version>${cas.version}</version>
</dependency>
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.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.

  • 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.encoding-algorithm=
  • The encoding algorithm to use such as 'MD5'. Relevant when the type used is 'DEFAULT' or 'GLIBC_CRYPT'.

  • 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.

  • 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.

    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.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:

    • LOCAL
    • MAJORITY
    • LINEARIZABLE
    • SNAPSHOT
    • AVAILABLE

  • cas.authn.mongo.read-preference=PRIMARY
  • Read preference. Accepted values are:

    • PRIMARY
    • SECONDARY
    • SECONDARY_PREFERRED
    • PRIMARY_PREFERRED
    • NEAREST

  • 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.

  • 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 java.time.Duration syntax. The format of the value will be PTnHnMnS, where n is the relevant hours, minutes or seconds part of the duration. Any fractional seconds are placed after a decimal point in the seconds section. If a section has a zero value, it is omitted. The hours, minutes and seconds will all have the same sign. Example values could be in the form of PT20S, PT15M, PT10H, PT6D, P2DT3H4M. If the value is set to 0 or never, the duration will be set to zero. If the value is blank, set to -1, or infinite, the value will effectively represent an unending duration.
  • 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=30000
  • 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.

  • cas.authn.mongo.pool.life-time=60000
  • 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.

  • cas.authn.mongo.pool.max-size=10
  • Maximum number of connections to keep around.

  • cas.authn.mongo.pool.max-wait-time=60000
  • The maximum time that a thread may wait for a connection to become available.

  • 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.

  • 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'.

  • cas.authn.mongo.password-encoder.secret=
  • Secret to use with STANDARD, PBKDF2, BCRYPT, GLIBC_CRYPT password encoders. Secret usually is an optional setting.

  • 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.

  • 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=
  • 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.

  • 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.

    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
    13
    14
    15
    16
    17
    18
    19
    20
    
    import java.util.*
    
    byte[] run(final Object... args) {
        def rawPassword = args[0]
        def generatedSalt = args[1]
        def logger = args[2]
        def casApplicationContext = args[3]
    
        logger.debug("Encoding password...")
        return ...
    }
    
    Boolean matches(final Object... args) {
        def rawPassword = args[0]
        def encodedPassword = args[1]
        def logger = args[2]
        def casApplicationContext = args[3]
    
       logger.debug("Does match or not ?");
       return ...
    

    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
    5
    
    def String run(final Object... args) {
        def providedUsername = args[0]
        def logger = args[1]
        return providedUsername.concat("SomethingElse")
    }
    

    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 below 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. When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.S ettings 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, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. 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"
    }