# YubiKey Authentication Source: https://apereo.github.io/cas/development/mfa/YubiKey-Authentication.html Yubico is a cloud-based service that enables strong, easy-to-use and affordable two-factor authentication with one-time passwords through their flagship product, YubiKey. Once Yubico `client-id` and `secret-key` are obtained, then the configuration options available to use YubiKey devices as a primary authentication source that CAS server could use to authenticate users. To configure YubiKey accounts and obtain API keys, [refer to the documentation](https://upgrade.yubico.com/getapikey/). [YubiKey](https://www.yubico.com/products) authentication components are enabled by including the following dependencies in the WAR overlay: ```groovy 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-yubikey" } ``` ## Actuator Endpoints The following endpoints are provided by CAS: `yubikeyAccountRepository` CAS endpoint · 6 operations · Not exposed by default base path `/cas/actuator/` **GET** `yubikeyAccountRepository`: Get all Yubikey accounts. (no params) Response - **Returns**: `Collection` - **Produces**: `application/json` - **Java method**: `load()` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -H "Accept: application/json" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository" ``` **DELETE** `yubikeyAccountRepository`: Delete all Yubikey accounts. (no params) Response - **Returns**: nothing - **Produces**: `application/json` - **Java method**: `deleteAll()` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -X DELETE \ -H "Accept: application/json" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository" ``` **GET** `yubikeyAccountRepository/export`: Export all Yubikey accounts as a zip file. (no params) Response - **Returns**: `ResponseEntity` - **Produces**: `application/octet-stream` - **Java method**: `export()` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -H "Accept: application/octet-stream" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository/export" ``` **POST** `yubikeyAccountRepository/import`: Import a Yubikey account as a JSON document. (no params) Response - **Returns**: `ResponseEntity` - **Consumes**: `application/json` - **Java method**: `importAccount(jakarta.servlet.http.HttpServletRequest) ` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -X POST \ -H "Content-Type: application/json" \ -H "Accept: application/json" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository/import" ``` **GET** `yubikeyAccountRepository/{username}`: Get Yubikey account for username. (1 param) Parameters | Name | In | Type | Description | | --- | --- | --- | --- | | `username`required | query | – | The username to look up | Response - **Returns**: `YubiKeyAccount` - **Produces**: `application/json` - **Java method**: `get(String)` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -H "Accept: application/json" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository/{username}?username=..." ``` **DELETE** `yubikeyAccountRepository/{username}`: Delete Yubikey account for username. (1 param) Parameters | Name | In | Type | Description | | --- | --- | --- | --- | | `username`required | query | – | The username to delete | Response - **Returns**: nothing - **Produces**: `application/json` - **Java method**: `delete(String)` - **Defined in**: `YubiKeyAccountRegistryEndpoint` Example request ```bash curl -u "casuser:password" \ -X DELETE \ -H "Accept: application/json" \ "https://sso.example.org/cas/actuator/yubikeyAccountRepository/{username}?username=..." ``` **Enable & expose** Turn the endpoint on and expose it over the web. One entry covers every operation. By default only `info`, `health` and `status` are exposed. ```properties management.endpoint.yubikeyAccountRepository.access=UNRESTRICTED management.endpoints.web.exposure.include=yubikeyAccountRepository ``` Endpoints may be mapped to other paths. For example, to serve `health` at `healthcheck`: ```properties management.endpoints.web.path-mapping.health=healthcheck ``` **Security** Once exposed, every call goes through [Spring Security](https://spring.io/projects/spring-security), and CAS decides access per endpoint. Without a rule, the special `defaults` endpoint applies, which denies access. Who may call it *Authenticated* ```properties cas.monitor.endpoints.endpoint.yubikeyAccountRepository.access=AUTHENTICATED ``` *Role* ```properties cas.monitor.endpoints.endpoint.yubikeyAccountRepository.access=ROLE cas.monitor.endpoints.endpoint.yubikeyAccountRepository.required-roles=ADMIN ``` *IP address* ```properties cas.monitor.endpoints.endpoint.yubikeyAccountRepository.access=IP_ADDRESS cas.monitor.endpoints.endpoint.yubikeyAccountRepository.required-ip-addresses=127.0.0.1 ``` *Anyone* ```properties cas.monitor.endpoints.endpoint.yubikeyAccountRepository.access=PERMIT ``` Where credentials are checked *Basic* A single user defined in CAS settings. If the name and password are left undefined, CAS generates them at startup. - `spring.security.user.name` (Third party; type `String`; default `user`): Default user name. - `spring.security.user.password` (Third party; type `String`): Password for the default user name. - `spring.security.user.roles` (Third party; type `List`): Granted roles for the default user name. *JAAS* - `cas.monitor.endpoints.jaas.login-config` (Optional; type `Resource`): JAAS login resource file. - `cas.monitor.endpoints.jaas.login-context-name` (Optional; type `String`): The login context name should coincide with a given index in the login config specified. This name is used as the index to the configuration specified in the login config property. ``` JAASTest { org.springframework.security.authentication.jaas.TestLoginModule required; }; ``` In the above example, `JAASTest` should be set as the context name. - `cas.monitor.endpoints.jaas.refresh-configuration-on-startup` (Optional; type `Boolean`; default `true`): If set, a call to `Configuration#refresh()` will be made by `#configureJaas(Resource)` method. *LDAP* - `cas.monitor.endpoints.ldap.base-dn` (Required; type `String`): Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: `subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net`. - `cas.monitor.endpoints.ldap.bind-credential` (Required; type `String`): The bind credential to use when connecting to LDAP. - `cas.monitor.endpoints.ldap.bind-dn` (Required; type `String`): The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters: - `bindDn/bindCredential` provided - Use the provided credentials to bind when initializing connections. - `bindDn/bindCredential` set to `*` - Use a fast-bind strategy to initialize the pool. - `bindDn/bindCredential` set to blank - Skip connection initializing; perform operations anonymously. - SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections. - `cas.monitor.endpoints.ldap.ldap-url` (Required; type `String`): The LDAP url to the server. More than one may be specified, separated by space and/or comma. - `cas.monitor.endpoints.ldap.search-filter` (Required; type `String`): User filter to use for searching. Syntax is `cn={user}` or `cn={0}`. You may also provide an external groovy script in the syntax of `file:/path/to/GroovyScript.groovy` to fully build the final filter template dynamically. - `cas.monitor.endpoints.ldap.type` (Required; type `AbstractLdapAuthenticationProperties.AuthenticationTypes`; default `AUTHENTICATED`): The authentication type. - `AD` - Users authenticate with `sAMAccountName`. - `AUTHENTICATED` - Manager bind/search type of authentication. If {@code} principalAttributePassword} is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given `principalAttributePassword` using the `SHA` encrypted value of it. - `ANONYMOUS`: Similar semantics as `AUTHENTICATED` except no `bindDn` and `bindCredential` may be specified to initialize the connection. If `principalAttributePassword` is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given `principalAttributePassword` using the `SHA` encrypted value of it. - DIRECT: Direct Bind - Compute user DN from format string and perform simple bind. This is relevant when no search is required to compute the DN needed for a bind operation. Use cases for this type are: 1) All users are under a single branch in the directory, `e.g. ou=Users,dc=example,dc=org.` 2) The username provided on the CAS login form is part of the DN, e.g. `uid=%s,ou=Users,dc=example,dc=org`. Available values are as follows: - `AD`: Active Directory. - `AUTHENTICATED`: Authenticated Search. - `DIRECT`: Direct Bind. - `ANONYMOUS`: Anonymous Search. - `cas.monitor.endpoints.ldap.allow-multiple-dns` (Optional; type `Boolean`; default `false`): Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result. - `cas.monitor.endpoints.ldap.allow-multiple-entries` (Optional; type `Boolean`; default `false`): Set if multiple Entries are allowed. - `cas.monitor.endpoints.ldap.binary-attributes` (Optional; type `List`): Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver. - `cas.monitor.endpoints.ldap.block-wait-time` (Optional; type `String`; default `PT3S`): The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created - `cas.monitor.endpoints.ldap.connect-timeout` (Optional; type `String`; default `PT5S`): Sets the maximum amount of time that connects will block. - `cas.monitor.endpoints.ldap.connection-strategy` (Optional; type `String`): If multiple URLs are provided as the ldapURL this describes how each URL will be processed. - `ACTIVE_PASSIVE` First LDAP will be used for every request unless it fails and then the next shall be used. - `ROUND_ROBIN` For each new connection the next url in the list will be used. - `RANDOM` For each new connection a random LDAP url will be selected. - `DNS_SRV` LDAP urls based on DNS SRV records of the configured/given LDAP url will be used. - `cas.monitor.endpoints.ldap.deref-aliases` (Optional; type `String`): Define how aliases are de-referenced. Accepted values are: - `NEVER` - `SEARCHING`: dereference when searching the entries beneath the starting point but not when searching for the starting entry. - `FINDING`: dereference when searching for the starting entry but not when searching the entries beneath the starting point. - `ALWAYS`: dereference when searching for the starting entry and when searching the entries beneath the starting point. - `cas.monitor.endpoints.ldap.disable-pooling` (Optional; type `Boolean`; default `false`): Whether to use a pooled connection factory in components. - `cas.monitor.endpoints.ldap.dn-format` (Optional; type `String`): Specify the dn format accepted by the AD authenticator, etc. Example format might be `uid=%s,ou=people,dc=example,dc=org`. - `cas.monitor.endpoints.ldap.enhance-with-entry-resolver` (Optional; type `Boolean`; default `true`): Whether specific search entry resolvers need to be set on the authenticator, or the default should be used. - `cas.monitor.endpoints.ldap.fail-fast` (Optional; type `Boolean`; default `true`): Attempt to populate the connection pool early on startup and fail quickly if something goes wrong. - `cas.monitor.endpoints.ldap.follow-referrals` (Optional; type `Boolean`; default `true`): Set if search referrals should be followed. - `cas.monitor.endpoints.ldap.hostname-verifier` (Optional; type `AbstractLdapProperties.LdapHostnameVerifierOptions`; default `DEFAULT`): Hostname verification options. Available values are as follows: - `DEFAULT`: Default option, forcing verification. - `ANY`: Skip hostname verification and allow all. - `cas.monitor.endpoints.ldap.idle-time` (Optional; type `String`; default `PT10M`): Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount. - `cas.monitor.endpoints.ldap.keystore` (Optional; type `String`): Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. - `cas.monitor.endpoints.ldap.keystore-password` (Optional; type `String`): Keystore password. - `cas.monitor.endpoints.ldap.keystore-type` (Optional; type `String`): The type of keystore. `PKCS12` or `JKS`. If left blank, defaults to the default keystore type indicated by the underlying Java platform. - `cas.monitor.endpoints.ldap.ldap-authz.allow-multiple-results` (Optional; type `Boolean`; default `false`): Indicate whether the LDAP search query is allowed to return multiple entries. - `cas.monitor.endpoints.ldap.ldap-authz.base-dn` (Optional; type `String`): Base DN to start the search. - `cas.monitor.endpoints.ldap.ldap-authz.group-attribute` (Optional; type `String`): Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with `#groupPrefix`. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group. - `cas.monitor.endpoints.ldap.ldap-authz.group-base-dn` (Optional; type `String`): Base DN to start the search looking for groups. - `cas.monitor.endpoints.ldap.ldap-authz.group-filter` (Optional; type `String`): Search filter to begin looking for groups. - `cas.monitor.endpoints.ldap.ldap-authz.group-prefix` (Optional; type `String`): A prefix that is prepended to the group attribute value to construct an authorized role. - `cas.monitor.endpoints.ldap.ldap-authz.role-attribute` (Optional; type `String`; default `uugid`): Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with `#rolePrefix`. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute. - `cas.monitor.endpoints.ldap.ldap-authz.role-prefix` (Optional; type `String`; default `ROLE_`): Prefix for the role. - `cas.monitor.endpoints.ldap.ldap-authz.search-filter` (Optional; type `String`): LDAP search filter to locate accounts. - `cas.monitor.endpoints.ldap.max-pool-size` (Optional; type `Integer`; default `10`): Maximum LDAP connection pool size which the pool can use to grow. - `cas.monitor.endpoints.ldap.min-pool-size` (Optional; type `Integer`; default `3`): Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to - `cas.monitor.endpoints.ldap.name` (Optional; type `String`): Name of the LDAP handler. - `cas.monitor.endpoints.ldap.page-size` (Optional; type `Integer`; default `0`): Request that the server return results in batches of a specific size. See [RFC 2696](http://www.ietf.org/rfc/rfc2696.txt). This control is often used to work around server result size limits. A negative/zero value disables paged requests. - `cas.monitor.endpoints.ldap.pool-passivator` (Optional; type `String`; default `BIND`): You may receive unexpected LDAP failures, when CAS is configured to authenticate using `DIRECT` or `AUTHENTICATED` types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are: - `NONE`: No passivation takes place. - `BIND`: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP. - `cas.monitor.endpoints.ldap.principal-attribute-password` (Optional; type `String`): If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it. - `cas.monitor.endpoints.ldap.prune-period` (Optional; type `String`; default `PT2H`): Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval. - `cas.monitor.endpoints.ldap.resolve-from-attribute` (Optional; type `String`): If this attribute is set, the value found in the first attribute value will be used in place of the DN. - `cas.monitor.endpoints.ldap.response-timeout` (Optional; type `String`; default `PT5S`): Duration of time to wait for responses. - `cas.monitor.endpoints.ldap.sasl-authorization-id` (Optional; type `String`): SASL authorization id. - `cas.monitor.endpoints.ldap.sasl-mechanism` (Optional; type `String`): The SASL mechanism. - `cas.monitor.endpoints.ldap.sasl-mutual-auth` (Optional; type `Boolean`): Whether SASL mutual authentication is enabled. - `cas.monitor.endpoints.ldap.sasl-quality-of-protection` (Optional; type `String`): SASL quality of protected. - `cas.monitor.endpoints.ldap.sasl-realm` (Optional; type `String`): The SASL realm. - `cas.monitor.endpoints.ldap.sasl-security-strength` (Optional; type `String`): SASL security strength. - `cas.monitor.endpoints.ldap.search-entry-handlers` (Optional; type `List`): Search handlers. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-name-case-change` (Optional; type `String`): The Attribute name case change. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-names` (Optional; type `List`): The Attribute names. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.attribute-value-case-change` (Optional; type `String`): The Attribute value case change. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].case-change.dn-case-change` (Optional; type `String`): The Dn case change. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.add-if-exists` (Optional; type `boolean`): The Add if exists. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name` (Optional; type `String`; default `entryDN`): The Dn attribute name. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.attribute-names` (Optional; type `List`): The Attribute names. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name` (Optional; type `String`): The Merge attribute name. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.base-dn` (Optional; type `String`): The Base dn. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].primary-group-id.group-filter` (Optional; type `String`; default `(&(objectClass=group)(objectSid={0}))`): The Group filter. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.merge-attributes` (Optional; type `List`): The Merge attributes. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].recursive.search-attribute` (Optional; type `String`): The Search attribute. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].search-referral.limit` (Optional; type `int`; default `10`): The default referral limit. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].search-result.limit` (Optional; type `int`; default `10`): The default referral limit. - `cas.monitor.endpoints.ldap.search-entry-handlers[0].type` (Optional; type `LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes`): The type of search entry handler to choose. Available values are as follows: - `FOLLOW_SEARCH_REFERRAL`: Provides handling of an ldap referral for search operations. - `FOLLOW_SEARCH_RESULT_REFERENCE`: Provides handling of an ldap continuation reference for search operations. - `ACTIVE_DIRECTORY`: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc. - `OBJECT_GUID`: Object guid search entry handler. Handles the `objectGUID` attribute fetching and conversion. - `OBJECT_SID`: Object sid search entry handler. Handles the `objectSid` attribute fetching and conversion. - `CASE_CHANGE`: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values. - `DN_ATTRIBUTE_ENTRY`: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020. - `MERGE`: Merge search entry handler. Merges the values of one or more attributes into a single attribute. - `PRIMARY_GROUP`: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the `memberOf` attribute of the original search entry. - `RANGE_ENTRY`: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches. - `RECURSIVE_ENTRY`: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry. - `MERGE_ENTRIES`: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact. - `cas.monitor.endpoints.ldap.subtree-search` (Optional; type `Boolean`; default `true`): Whether subtree searching is allowed. - `cas.monitor.endpoints.ldap.trust-certificates` (Optional; type `String`): Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used. - `cas.monitor.endpoints.ldap.trust-manager` (Optional; type `String`): Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: - `DEFAULT`: Enable and force the default JVM trust managers. - `ANY`: Trust any client or server. - `cas.monitor.endpoints.ldap.trust-store` (Optional; type `String`): Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used. - `cas.monitor.endpoints.ldap.trust-store-password` (Optional; type `String`): Password needed to open the truststore. - `cas.monitor.endpoints.ldap.trust-store-type` (Optional; type `String`): The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically `PKCS12` or `JKS`. If left blank, defaults to the default keystore type indicated by the underlying Java platform. - `cas.monitor.endpoints.ldap.use-start-tls` (Optional; type `Boolean`; default `false`): Whether TLS should be used and enabled when establishing the connection. - `cas.monitor.endpoints.ldap.validate-on-checkout` (Optional; type `Boolean`; default `true`): Whether connections should be validated when loaned out from the pool. - `cas.monitor.endpoints.ldap.validate-period` (Optional; type `String`; default `PT5M`): Period at which pool should be validated. - `cas.monitor.endpoints.ldap.validate-periodically` (Optional; type `Boolean`; default `true`): Whether connections should be validated periodically when the pool is idle. - `cas.monitor.endpoints.ldap.validate-timeout` (Optional; type `String`; default `PT5S`): Period at which validation operations may time out. - `cas.monitor.endpoints.ldap.validator.attribute-name` (Optional; type `String`; default `objectClass`): Attribute name to use for the compare validator. - `cas.monitor.endpoints.ldap.validator.attribute-value` (Optional; type `String`; default `top`): Attribute values to use for the compare validator. - `cas.monitor.endpoints.ldap.validator.base-dn` (Optional; type `String`): Base DN to use for the search request of the search validator. - `cas.monitor.endpoints.ldap.validator.dn` (Optional; type `String`): DN to compare to use for the compare validator. - `cas.monitor.endpoints.ldap.validator.scope` (Optional; type `String`; default `OBJECT`): Search scope to use for the search request of the search validator. - `cas.monitor.endpoints.ldap.validator.search-filter` (Optional; type `String`; default `(objectClass=*)`): Search filter to use for the search request of the search validator. - `cas.monitor.endpoints.ldap.validator.type` (Optional; type `String`; default `search`): Determine the LDAP validator type. The following LDAP validators can be used to test connection health status: - `search`: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero. - `none`: No validation takes place. - `compare`: Validates a connection is healthy by performing a compare operation. **LDAP & Active Directory** **LDAP Scriptable Search Filter** LDAP search filters can point to an external Groovy script to dynamically construct the final filter template. The script itself may be designed as: ```groovy import org.ldaptive.* import org.springframework.context.* def run(Object[] args) { def (filter,parameters,applicationContext,logger) = args logger.info("Configuring LDAP filter") filter.setFilter("uid=something") } ``` The following parameters are passed to the script: | Parameter | Description | | --- | --- | | `filter` | `FilterTemplate` to be updated by the script and used for the LDAP query. | | `parameters` | Map of query parameters which may be used to construct the final filter. | | `applicationContext` | Reference to the Spring `ApplicationContext` reference. | | `logger` | The object responsible for issuing log messages such as `logger.info(...)`. | To prepare CAS to support and integrate with Apache Groovy, please [review this guide](https://apereo.github.io/cas/development//integration/Apache-Groovy-Scripting.html). *JDBC* - `cas.monitor.endpoints.jdbc.driver-class` (Required; type `String`; default `org.hsqldb.jdbcDriver`): The JDBC driver used to connect to the database. - `cas.monitor.endpoints.jdbc.password` (Required; type `String`): The database connection password. - `cas.monitor.endpoints.jdbc.password-encoder.encoding-algorithm` (Required; type `String`): 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.monitor.endpoints.jdbc.password-encoder.type` (Required; type `String`; default `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} or {SSHA} 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.monitor.endpoints.jdbc.url` (Required; type `String`; default `jdbc:hsqldb:mem:cas-hsql-database`): The database connection URL. - `cas.monitor.endpoints.jdbc.user` (Required; type `String`; default `sa`): The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed. - `cas.monitor.endpoints.jdbc.autocommit` (Optional; type `Boolean`; default `false`): The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction. - `cas.monitor.endpoints.jdbc.batch-size` (Optional; type `Integer`; default `100`): A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30. - `cas.monitor.endpoints.jdbc.connection-timeout` (Optional; type `String`; default `PT30S`): Indicates the maximum number of milliseconds that the service can wait to obtain a connection. - `cas.monitor.endpoints.jdbc.data-source-name` (Optional; type `String`): Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is. - `cas.monitor.endpoints.jdbc.ddl-auto` (Optional; type `String`; default `update`): Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to `validate` or `none` may be more desirable for production, but any of the following options can be used: - `validate`: Validate the schema, but make no changes to the database. - `update`: Update the schema. - `create`: Create the schema, destroying previous data. - `create-drop`: Drop the schema at the end of the session. - `none`: Do nothing. Note that during a version migration where any schema has changed `create-drop` will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. `validate` or `none` settings are likely the only safe options for production use. For more info, [see this](http://docs.spring.io/spring-framework/docs/current/javadoc-api). - `cas.monitor.endpoints.jdbc.default-catalog` (Optional; type `String`): Qualifies unqualified table names with the given catalog in generated SQL. - `cas.monitor.endpoints.jdbc.default-schema` (Optional; type `String`): Qualify unqualified table names with the given schema/tablespace in generated SQL. - `cas.monitor.endpoints.jdbc.dialect` (Optional; type `String`; default `org.hibernate.dialect.HSQLDialect`): The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML. - `cas.monitor.endpoints.jdbc.fail-fast-timeout` (Optional; type `Long`; default `1`): Set the pool initialization failure timeout. - Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a `PoolInitializationException` will be thrown. - A value of zero will *not* prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the `connectionTestQuery` and `connectionInitSql` are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the pool will start and continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. - A value less than zero will *not* bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the `connectionTimeout` or `validationTimeout`; they will be honored before this timeout is applied. The default value is one millisecond. - `cas.monitor.endpoints.jdbc.fetch-size` (Optional; type `Integer`; default `100`): Used to specify number of rows to be fetched in a select query. - `cas.monitor.endpoints.jdbc.generate-statistics` (Optional; type `Boolean`; default `false`): Allow hibernate to generate query statistics. - `cas.monitor.endpoints.jdbc.health-query` (Optional; type `String`): The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 `Connection.isValid()` API. - `cas.monitor.endpoints.jdbc.idle-timeout` (Optional; type `String`; default `PT10M`): Controls the maximum amount of time that a connection is allowed to sit idle in the pool. - `cas.monitor.endpoints.jdbc.isolate-internal-queries` (Optional; type `Boolean`; default `false`): This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if `#autocommit` is disabled. - `cas.monitor.endpoints.jdbc.isolation-level-name` (Optional; type `String`; default `ISOLATION_READ_COMMITTED`): Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition - `cas.monitor.endpoints.jdbc.leak-threshold` (Optional; type `String`; default `PT6S`): Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. - `cas.monitor.endpoints.jdbc.password-encoder.character-encoding` (Optional; type `String`; default `UTF-8`): The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is `DEFAULT`. - `cas.monitor.endpoints.jdbc.password-encoder.hash-length` (Optional; type `Integer`; default `16`): When used by `PasswordEncoderTypes#ARGON2`, it indicates the hash strength/length. - `cas.monitor.endpoints.jdbc.password-encoder.iterations` (Optional; type `Integer`; default `310000`): When used by `PasswordEncoderTypes#PBKDF2`, it indicates the required number of iterations. - `cas.monitor.endpoints.jdbc.password-encoder.secret` (Optional; type `String`): Secret to use with `PasswordEncoderTypes#STANDARD`, `PasswordEncoderTypes#PBKDF2`, `PasswordEncoderTypes#BCRYPT`, `PasswordEncoderTypes#GLIBC_CRYPT` password encoders. Secret usually is an optional setting. - `cas.monitor.endpoints.jdbc.password-encoder.strength` (Optional; type `Integer`; default `16`): Strength 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.monitor.endpoints.jdbc.physical-naming-strategy-class-name` (Optional; type `String`; default `org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy`): Fully-qualified name of the class that can control the physical naming strategy of hibernate. - `cas.monitor.endpoints.jdbc.pool.keep-alive-time` (Optional; type `String`; default `0`): This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. - `cas.monitor.endpoints.jdbc.pool.max-size` (Optional; type `Integer`; default `18`): Controls the maximum number of connections to keep in the pool, including both idle and in-use connections. - `cas.monitor.endpoints.jdbc.pool.max-wait` (Optional; type `String`; default `PT2S`): Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. - `cas.monitor.endpoints.jdbc.pool.maximum-lifetime` (Optional; type `String`; default `PT10M`): This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. - `cas.monitor.endpoints.jdbc.pool.min-size` (Optional; type `Integer`; default `6`): Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections. - `cas.monitor.endpoints.jdbc.pool.name` (Optional; type `String`): Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration. - `cas.monitor.endpoints.jdbc.pool.suspension` (Optional; type `Boolean`; default `false`): Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it. - `cas.monitor.endpoints.jdbc.pool.timeout-millis` (Optional; type `Long`; default `1000`): The maximum number of milliseconds that the pool will wait for a connection to be validated as alive. - `cas.monitor.endpoints.jdbc.propagation-behavior-name` (Optional; type `String`; default `PROPAGATION_REQUIRED`): Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition - `cas.monitor.endpoints.jdbc.properties` (Optional; type `Map`): Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs. - `cas.monitor.endpoints.jdbc.query` (Optional; type `String`): Query to execute in order to authenticate users via JDBC. Example: `SELECT username,password,enabled FROM users WHERE username=?` - `cas.monitor.endpoints.jdbc.read-only` (Optional; type `Boolean`; default `false`): Configures the Connections to be added to the pool as read-only Connections. - `cas.monitor.endpoints.jdbc.role-prefix` (Optional; type `String`): Prefix to add to the role. **Hibernate & JDBC** Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries. - `cas.jdbc.gen-ddl` (Optional; type `Boolean`; default `true`): Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. - `cas.jdbc.physical-table-names` (Optional; type `Map`): Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. - `cas.jdbc.show-sql` (Optional; type `Boolean`; default `false`): Whether SQL queries should be displayed in the console/logs. **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: ```java 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: ```groovy 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](https://apereo.github.io/cas/development//integration/Apache-Groovy-Scripting.html). *JSON* A static list of users, passwords and roles in a JSON file. Supported password encodings are `{sha512}`, `{sha256}`, `{bcrypt}`, `{noop}`, `{pbkdf2}`, `{scrypt}` and `{argon2}`. ```json [ { "username": "casuser", "password": "{sha512}", "authorities": [ "ROLE_ADMIN" ] } ] ``` - `cas.monitor.endpoints.json.location` (Required; type `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`. **Settings** - `cas.monitor.endpoints.endpoint.yubikeyAccountRepository.access` (Optional; type `ActuatorEndpointProperties.EndpointAccessLevel`; default `DENY`): Define the security access level of the endpoint. Available values are as follows: - `PERMIT`: Allow open access to the endpoint. - `ANONYMOUS`: Allow anonymous access to the endpoint. - `DENY`: Block access to the endpoint. - `AUTHENTICATED`: Require authenticated access to the endpoint. - `ROLE`: Require authenticated access to the endpoint along with a role requirement. - `AUTHORITY`: Require authenticated access to the endpoint along with an authority requirement. - `IP_ADDRESS`: Require authenticated access to the endpoint using a collection of IP addresses. - `cas.monitor.endpoints.endpoint.yubikeyAccountRepository.required-authorities` (Optional; type `List`): Required user authorities. - `cas.monitor.endpoints.endpoint.yubikeyAccountRepository.required-ip-addresses` (Optional; type `List`): Required IP addresses. CIDR ranges are accepted. - `cas.monitor.endpoints.endpoint.yubikeyAccountRepository.required-roles` (Optional; type `List`): Required user roles. - `cas.monitor.endpoints.form-login-enabled` (Optional; type `Boolean`; default `false`): Control whether access to endpoints can be controlled via form-based login over the web via a special admin login endpoint. **Spring Boot settings** - `management.endpoint.health.access` (Third party; type `Access`; default `unrestricted`): Permitted level of access for the health endpoint. - `management.endpoint.health.cache.time-to-live` (Third party; type `Duration`; default `0ms`): Maximum time that a response can be cached. - `management.endpoint.health.group` (Third party; type `Map`): Health endpoint groups. - `management.endpoint.health.logging.slow-indicator-threshold` (Third party; type `Duration`; default `10s`): Threshold after which a warning will be logged for slow health indicators. - `management.endpoint.health.probes.add-additional-paths` (Third party; type `Boolean`; default `false`): Whether to make the liveness and readiness health groups available on the main server port. - `management.endpoint.health.probes.enabled` (Third party; type `Boolean`; default `true`): Whether to enable liveness and readiness probes. - `management.endpoint.health.roles` (Third party; type `Set`): Roles used to determine whether a user is authorized to be shown details. When empty, all authenticated users are authorized. - `management.endpoint.health.show-components` (Third party; type `Show`): When to show components. If not specified the 'show-details' setting will be used. - `management.endpoint.health.show-details` (Third party; type `Show`; default `never`): When to show full health details. - `management.endpoint.health.status.http-mapping` (Third party; type `Map`): Mapping of health statuses to HTTP status codes. By default, registered health statuses map to sensible defaults (for example, UP maps to 200). - `management.endpoint.health.status.order` (Third party; type `List`; default `["DOWN", "OUT_OF_SERVICE", "UP", "UNKNOWN"]`): List of health statuses in order of severity. - `management.endpoint.health.validate-group-membership` (Third party; type `Boolean`; default `true`): Whether to validate health group membership on startup. Validation fails if a group includes or excludes a health contributor that does not exist. - `management.endpoints.access.default` (Third party; type `Access`): Default access level for all endpoints. - `management.endpoints.access.max-permitted` (Third party; default `unrestricted`): Maximum level of endpoint access that is permitted. Caps an endpoint's individual access level (management.endpoint.\.access) and the default access (management.endpoints.access.default).' - `management.endpoints.enabled-by-default` (Third party; type `Boolean`; deprecation `WARNING`, replaced by `management.endpoints.access.default`): Whether to enable or disable all endpoints by default. - `management.endpoints.jackson.isolated-json-mapper` (Third party; type `Boolean`; default `true`): Whether to use an isolated JsonMapper to serialize endpoint JSON. - `management.endpoints.jackson2.isolated-object-mapper` (Third party; type `Boolean`; deprecation `WARNING`, no replacement; default `true`): Whether to use an isolated object mapper to serialize endpoint JSON. - `management.endpoints.jmx.domain` (Third party; type `String`; default `org.springframework.boot`): Endpoints JMX domain name. Fallback to 'spring.jmx.default-domain' if set. - `management.endpoints.jmx.exposure.exclude` (Third party; type `Set`): Endpoint IDs that should be excluded or '*' for all. - `management.endpoints.jmx.exposure.include` (Third party; type `Set`; default `health`): Endpoint IDs that should be included or '*' for all. - `management.endpoints.jmx.static-names` (Third party; type `Properties`): Additional static properties to append to all ObjectNames of MBeans representing Endpoints. - `management.endpoints.jmx.unique-names` (Third party; type `Boolean`; deprecation `ERROR`, replaced by `spring.jmx.unique-names`): Whether unique runtime object names should be ensured. - `management.endpoints.migrate-legacy-ids` (Third party; type `Boolean`; default `false`): Whether to transparently migrate legacy endpoint IDs. - `management.endpoints.web.base-path` (Third party; type `String`; default `/actuator`): Base path for Web endpoints. Relative to the servlet context path (server.servlet.context-path) or WebFlux base path (spring.webflux.base-path) when the management server is sharing the main server port. Relative to the management server base path (management.server.base-path) when a separate management server port (management.server.port) is configured. - `management.endpoints.web.cors.allow-credentials` (Third party; type `Boolean`): Whether credentials are supported. When not set, credentials are not supported. - `management.endpoints.web.cors.allowed-headers` (Third party; type `List`): List of headers to allow in a request. '*' allows all headers. - `management.endpoints.web.cors.allowed-methods` (Third party; type `List`): List of methods to allow. '*' allows all methods. When not set, defaults to GET. - `management.endpoints.web.cors.allowed-origin-patterns` (Third party; type `List`): List of origin patterns to allow. Unlike allowed origins which only supports '*', origin patterns are more flexible (for example 'https://*.example.com') and can be used when credentials are allowed. When no allowed origin patterns or allowed origins are set, CORS support is disabled. - `management.endpoints.web.cors.allowed-origins` (Third party; type `List`): List of origins to allow. '*' allows all origins. When credentials are allowed, '*' cannot be used and origin patterns should be configured instead. When no allowed origins or allowed origin patterns are set, CORS support is disabled. - `management.endpoints.web.cors.exposed-headers` (Third party; type `List`): List of headers to include in a response. - `management.endpoints.web.cors.max-age` (Third party; type `Duration`; default `1800s`): How long the response from a pre-flight request can be cached by clients. If a duration suffix is not specified, seconds will be used. - `management.endpoints.web.discovery.enabled` (Third party; type `Boolean`; default `true`): Whether the discovery page is enabled. - `management.endpoints.web.exposure.exclude` (Third party; type `Set`): Endpoint IDs that should be excluded or '*' for all. - `management.endpoints.web.exposure.include` (Third party; type `Set`; default `["health"]`): Endpoint IDs that should be included or '*' for all. - `management.endpoints.web.path-mapping` (Third party; type `Map`): Mapping between endpoint IDs and the path that should expose them. - `management.health.binders.enabled` (Third party; type `Boolean`; default `true`): Allows to enable/disable binder's' health indicators. If you want to disable health indicator completely, then set it to `false`. - `management.health.db.enabled` (Third party; type `Boolean`; default `true`): Whether to enable database health check. - `management.health.db.ignore-routing-data-sources` (Third party; type `Boolean`; default `false`): Whether to ignore AbstractRoutingDataSources when creating database health indicators. - `management.health.defaults.enabled` (Third party; type `Boolean`; default `true`): Whether to enable default health indicators. - `management.health.diskspace.enabled` (Third party; type `Boolean`; default `true`): Whether to enable disk space health check. - `management.health.diskspace.path` (Third party; type `File`): Path used to compute the available disk space. - `management.health.diskspace.threshold` (Third party; type `DataSize`; default `10MB`): Minimum disk space that should be available. - `management.health.influxdb.enabled` (Third party; type `Boolean`; deprecation `ERROR`, no replacement) - `management.health.livenessstate.enabled` (Third party; type `Boolean`; default `false`): Whether to enable liveness state health check. - `management.health.mail.enabled` (Third party; type `Boolean`; default `true`): Whether to enable Mail health check. - `management.health.mongo.enabled` (Third party; deprecation `ERROR`, replaced by `management.health.mongodb.enabled`) - `management.health.mongodb.enabled` (Third party; type `Boolean`; default `true`): Whether to enable MongoDB health check. - `management.health.ping.enabled` (Third party; type `Boolean`; default `true`): Whether to enable ping health check. - `management.health.probes.enabled` (Third party; type `Boolean`; deprecation `ERROR`, replaced by `management.endpoint.health.probes.enabled`; default `false`): Whether to enable liveness and readiness probes. - `management.health.pubsub.enabled` (Third party; type `Boolean`; default `true`): Whether to enable the Pub/Sub health indicator when used with Spring Boot Actuator. - `management.health.rabbit.enabled` (Third party; type `Boolean`; default `true`): Whether to enable RabbitMQ health check. - `management.health.readinessstate.enabled` (Third party; type `Boolean`; default `false`): Whether to enable readiness state health check. - `management.health.redis.enabled` (Third party; type `Boolean`; default `true`): Whether to enable Redis health check. - `management.health.refresh.enabled` (Third party; type `Boolean`; default `true`): Enable the health endpoint for the refresh scope. - `management.health.ssl.certificate-validity-warning-threshold` (Third party; type `Duration`; default `14d`): If an SSL Certificate will be invalid within the time span defined by this threshold, it should trigger a warning. - `management.health.ssl.enabled` (Third party; type `Boolean`; default `true`): Whether to enable SSL certificate health check. - `management.health.zookeeper.enabled` (Third party; type `Boolean`; default `true`): Enable the health endpoint for zookeeper. **Troubleshooting** - `404`: the endpoint is not enabled or not exposed; check the *Enable & expose* tab. - `401` or `403`: the access rule or the credentials rejected the call; check the *Security* tab. For more detail, raise these log levels in the log4j configuration: ```xml ``` ## Configuration The following settings and properties are available from the CAS configuration catalog: - `cas.authn.mfa.yubikey.bypass.groovy.location` (Required; type `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.mfa.yubikey.bypass.rest.url` (Required; type `String`): The endpoint URL to contact and retrieve attributes. - `cas.authn.mfa.yubikey.client-id` (Required; type `Integer`; default `0`): Yubikey client id. - `cas.authn.mfa.yubikey.crypto.encryption.key` (Required; type `String`): The encryption key is a string whose length is defined by the encryption key size setting. - `cas.authn.mfa.yubikey.crypto.signing.key` (Required; type `String`): The signing key is a string whose length is defined by the signing key size setting. - `cas.authn.mfa.yubikey.dynamo-db.credential-access-key` (Required; type `String`): Use access-key provided by AWS to authenticate. - `cas.authn.mfa.yubikey.dynamo-db.credential-secret-key` (Required; type `String`): Use secret key provided by AWS to authenticate. - `cas.authn.mfa.yubikey.dynamo-db.dax.url` (Required; type `String`): Cluster url. For example, `dax://my-cluster.l6fzcv.dax-clusters.us-east-1.amazonaws.com`. - `cas.authn.mfa.yubikey.dynamo-db.endpoint` (Required; type `String`): AWS custom endpoint. - `cas.authn.mfa.yubikey.dynamo-db.region` (Required; type `String`): AWS region used. - `cas.authn.mfa.yubikey.jpa.driver-class` (Required; type `String`; default `org.hsqldb.jdbcDriver`): The JDBC driver used to connect to the database. - `cas.authn.mfa.yubikey.jpa.password` (Required; type `String`): The database connection password. - `cas.authn.mfa.yubikey.jpa.url` (Required; type `String`; default `jdbc:hsqldb:mem:cas-hsql-database`): The database connection URL. - `cas.authn.mfa.yubikey.jpa.user` (Required; type `String`; default `sa`): The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed. - `cas.authn.mfa.yubikey.mongo.client-uri` (Required; type `String`): 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.mfa.yubikey.mongo.collection` (Required; type `String`): MongoDb database collection name to fetch and/or create. - `cas.authn.mfa.yubikey.mongo.database-name` (Required; type `String`): MongoDb database instance name. - `cas.authn.mfa.yubikey.mongo.host` (Required; type `String`; default `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.mfa.yubikey.mongo.password` (Required; type `String`): MongoDb database password for authentication. - `cas.authn.mfa.yubikey.mongo.port` (Required; type `Integer`; default `27017`): MongoDb database port. - `cas.authn.mfa.yubikey.mongo.user-id` (Required; type `String`): MongoDb database user for authentication. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].host` (Required; type `String`): Server's host address. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].port` (Required; type `int`): Server's port number. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].replica-of` (Required; type `String`): Set the id of the master node. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].type` (Required; type `String`): Indicate the type/role of this node. Accepted values are: `MASTER, REPLICA`. - `cas.authn.mfa.yubikey.redis.cluster.password` (Required; type `String`): The cluster connection's password. - `cas.authn.mfa.yubikey.redis.cluster.username` (Required; type `String`): The cluster connection's username. - `cas.authn.mfa.yubikey.redis.database` (Required; type `Integer`; default `0`): Database index used by the connection factory. - `cas.authn.mfa.yubikey.redis.enabled` (Required; type `Boolean`; default `true`): Whether the module is enabled or not, defaults to true. - `cas.authn.mfa.yubikey.redis.host` (Required; type `String`; default `localhost`): Redis server host. - `cas.authn.mfa.yubikey.redis.password` (Required; type `String`): Login password of the redis server. - `cas.authn.mfa.yubikey.redis.pool.enabled` (Required; type `Boolean`; default `false`): Enable the pooling configuration. - `cas.authn.mfa.yubikey.redis.port` (Required; type `Integer`; default `6379`): Redis server port. - `cas.authn.mfa.yubikey.redis.sentinel.master` (Required; type `String`): Name of Redis server. - `cas.authn.mfa.yubikey.redis.username` (Required; type `String`): Login username of the redis server. - `cas.authn.mfa.yubikey.rest.url` (Required; type `String`): The endpoint URL to contact and retrieve attributes. - `cas.authn.mfa.yubikey.secret-key` (Required; type `String`): Yubikey secret key. - `cas.authn.mfa.yubikey.allowed-devices` (Optional; type `Map`): Collection of allowed devices allowed per user. This is done using a key-value structure where the key is the user the value is the allowed collection of yubikey device ids. - `cas.authn.mfa.yubikey.api-urls` (Optional; type `List`): YubiKey API urls to contact for verification of credentials. - `cas.authn.mfa.yubikey.bypass.authentication-attribute-name` (Optional; type `String`): Skip multifactor authentication based on designated authentication attribute names. - `cas.authn.mfa.yubikey.bypass.authentication-attribute-value` (Optional; type `String`): Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.authentication-handler-name` (Optional; type `String`): Skip multifactor authentication depending on form of primary authentication execution. Specifically, skip multifactor if the a particular authentication handler noted by its name successfully is able to authenticate credentials in the primary factor. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.authentication-method-name` (Optional; type `String`): Skip multifactor authentication depending on method/form of primary authentication execution. Specifically, skip multifactor if the authentication method attribute collected as part of authentication metadata matches a certain value. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.credential-class-type` (Optional; type `String`): Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type. - `cas.authn.mfa.yubikey.bypass.http-request-headers` (Optional; type `String`): Skip multifactor authentication if the http request contains the defined header names. Header names may be comma-separated and can be regular expressions; values are ignored. - `cas.authn.mfa.yubikey.bypass.http-request-remote-address` (Optional; type `String`): Skip multifactor authentication if the http request's remote address or host matches the value defined here. The value may be specified as a regular expression. - `cas.authn.mfa.yubikey.bypass.principal-attribute-name` (Optional; type `String`): Skip multifactor authentication based on designated principal attribute names. - `cas.authn.mfa.yubikey.bypass.principal-attribute-value` (Optional; type `String`): Optionally, skip multifactor authentication based on designated principal attribute values. - `cas.authn.mfa.yubikey.bypass.rest.basic-auth-password` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the password for authentication. - `cas.authn.mfa.yubikey.bypass.rest.basic-auth-username` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the username for authentication. - `cas.authn.mfa.yubikey.bypass.rest.headers` (Optional; type `Map`): Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value. - `cas.authn.mfa.yubikey.bypass.rest.maximum-retry-attempts` (Optional; type `Integer`; default `3`): When attempting to reach the endpoint, this setting controls the number of **retry attempts** that CAS should execute Setting this value to a zero or negative value will disable the retry policy. - `cas.authn.mfa.yubikey.bypass.rest.method` (Optional; type `String`; default `GET`): HTTP method to use when contacting the rest endpoint. Examples include `GET, POST`, etc. - `cas.authn.mfa.yubikey.crypto.alg` (Optional; type `String`): The signing/encryption algorithm to use. - `cas.authn.mfa.yubikey.crypto.enabled` (Optional; type `Boolean`; default `true`): Whether crypto operations are enabled. - `cas.authn.mfa.yubikey.crypto.encryption.key-size` (Optional; type `Integer`; default `512`): The encryption key size. - `cas.authn.mfa.yubikey.crypto.signing.key-size` (Optional; type `Integer`; default `512`): The signing key size. - `cas.authn.mfa.yubikey.crypto.strategy-type` (Optional; type `String`; default `ENCRYPT_AND_SIGN`): Control the cipher sequence of operations. The accepted values are: - `ENCRYPT_AND_SIGN`: Encrypt the value first, and then sign. - `SIGN_AND_ENCRYPT`: Sign the value first, and then encrypt. - `cas.authn.mfa.yubikey.dynamo-db.billing-mode` (Optional; type `AbstractDynamoDbProperties.BillingMode`; default `PROVISIONED`): Billing mode specifies how you are charged for read and write throughput and how you manage capacity. Available values are as follows: - `PROVISIONED`: Provisioned mode means that you specify the number of reads and writes per second that you expect your application to use. Provisioned mode is a good option if any of the following are true: - You have predictable application traffic. - You run applications whose traffic is consistent or ramps gradually. - You can forecast capacity requirements to control costs. You can use auto scaling to automatically adjust capacity based on the specified utilization rate to ensure application performance while reducing costs. `PAY_PER_REQUEST`: Pay-per-request or on-demand billing means that you're charged for only the read/write requests that you use. On-demand mode is a good option if any of the following are true: You create new tables with unknown workloads. You have unpredictable application traffic. You prefer the ease of paying for only what you use. Tables using on-demand mode support all DynamoDB features (such as encryption at rest, point-in-time recovery, global tables, and so on) with the exception of auto scaling, which is not applicable with this mode. - `cas.authn.mfa.yubikey.dynamo-db.client-execution-timeout` (Optional; type `String`; default `PT10S`): Client execution timeout. - `cas.authn.mfa.yubikey.dynamo-db.connection-timeout` (Optional; type `String`; default `PT5S`): Connection timeout. - `cas.authn.mfa.yubikey.dynamo-db.dax.connect-timeout` (Optional; type `String`; default `PT5S`): Connection timeout, calculated in milliseconds. - `cas.authn.mfa.yubikey.dynamo-db.dax.connection-ttl` (Optional; type `String`; default `PT0S`): How long should connections be kept alive, calculated in milliseconds. - `cas.authn.mfa.yubikey.dynamo-db.dax.idle-timeout` (Optional; type `String`; default `PT15S`): Connection idle timeout, calculated in milliseconds. - `cas.authn.mfa.yubikey.dynamo-db.dax.max-concurrency` (Optional; type `Integer`; default `1000`): Determines the maximum number of concurrent requests that can be made to the DAX cluster. - `cas.authn.mfa.yubikey.dynamo-db.dax.read-retries` (Optional; type `Integer`; default `2`): Number of read retry attempts. - `cas.authn.mfa.yubikey.dynamo-db.dax.request-timeout` (Optional; type `String`; default `PT5S`): Request execution timeout, calculated in milliseconds. - `cas.authn.mfa.yubikey.dynamo-db.dax.write-retries` (Optional; type `Integer`; default `2`): Number of write retry attempts. - `cas.authn.mfa.yubikey.dynamo-db.drop-tables-on-startup` (Optional; type `Boolean`; default `false`): Flag that indicates whether to drop tables on start up. - `cas.authn.mfa.yubikey.dynamo-db.local-address` (Optional; type `String`): Local address. - `cas.authn.mfa.yubikey.dynamo-db.local-instance` (Optional; type `Boolean`; default `false`): Indicates that the database instance is local to the deployment that does not require or use any credentials or other configuration other than host and region. This is mostly used during development and testing. - `cas.authn.mfa.yubikey.dynamo-db.max-connections` (Optional; type `Integer`; default `10`): Maximum connections setting. - `cas.authn.mfa.yubikey.dynamo-db.prevent-table-creation-on-startup` (Optional; type `Boolean`; default `false`): Flag that indicates whether to prevent CAS from creating tables. - `cas.authn.mfa.yubikey.dynamo-db.profile-name` (Optional; type `String`): Profile name to use. - `cas.authn.mfa.yubikey.dynamo-db.profile-path` (Optional; type `String`): Profile path. - `cas.authn.mfa.yubikey.dynamo-db.proxy-host` (Optional; type `String`): Optionally specifies the proxy host to connect through. - `cas.authn.mfa.yubikey.dynamo-db.proxy-password` (Optional; type `String`): Optionally specifies the proxy password to connect through. - `cas.authn.mfa.yubikey.dynamo-db.proxy-username` (Optional; type `String`): Optionally specifies the proxy username to connect through. - `cas.authn.mfa.yubikey.dynamo-db.read-capacity` (Optional; type `Long`; default `10`): Read capacity. - `cas.authn.mfa.yubikey.dynamo-db.retry-mode` (Optional; type `String`; default `STANDARD`): Outline the requested retry mode. Accepted values are `STANDARD, LEGACY`. - `cas.authn.mfa.yubikey.dynamo-db.socket-timeout` (Optional; type `String`; default `PT5S`): Socket timeout. - `cas.authn.mfa.yubikey.dynamo-db.table-name` (Optional; type `String`; default `DynamoDbYubiKeyDevices`): The table name used and created by CAS to hold devices in DynamoDb. - `cas.authn.mfa.yubikey.dynamo-db.time-offset` (Optional; type `Integer`; default `0`): Time offset. - `cas.authn.mfa.yubikey.dynamo-db.use-reaper` (Optional; type `Boolean`; default `false`): Flag that indicates whether to use reaper. - `cas.authn.mfa.yubikey.dynamo-db.write-capacity` (Optional; type `Long`; default `10`): Write capacity. - `cas.authn.mfa.yubikey.failure-mode` (Optional; type `BaseMultifactorAuthenticationProviderProperties.MultifactorAuthenticationProviderFailureModes`; default `CLOSED`): The failure mode policy for this MFA provider. The authentication policy by default supports fail-closed mode, which means that if you attempt to exercise a particular provider available to CAS and the provider cannot be reached, authentication will be stopped and an error will be displayed. You can of course change this behavior so that authentication proceeds without exercising the provider functionality, if that provider cannot respond. Each defined multifactor authentication provider can set its own failure mode policy. Failure modes set at this location will override the global failure mode, but defer to any failure mode set by the registered service. Available values are as follows: - `OPEN`: Disallow MFA, proceed with authentication but don't communicate MFA to the RP. - `CLOSED`: Disallow MFA, block with authentication. - `PHANTOM`: Disallow MFA, proceed with authentication and communicate MFA to the RP. - `NONE`: Do not check for failure at all. - `UNDEFINED`: The default one indicating that no failure mode is set at all. - `cas.authn.mfa.yubikey.id` (Optional; type `String`): The identifier for the multifactor provider. In most cases, this need not be configured explicitly, unless multiple instances of the same provider type are configured in CAS. - `cas.authn.mfa.yubikey.jpa.autocommit` (Optional; type `Boolean`; default `false`): The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction. - `cas.authn.mfa.yubikey.jpa.batch-size` (Optional; type `Integer`; default `100`): A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30. - `cas.authn.mfa.yubikey.jpa.connection-timeout` (Optional; type `String`; default `PT30S`): Indicates the maximum number of milliseconds that the service can wait to obtain a connection. - `cas.authn.mfa.yubikey.jpa.data-source-name` (Optional; type `String`): Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is. - `cas.authn.mfa.yubikey.jpa.ddl-auto` (Optional; type `String`; default `update`): Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to `validate` or `none` may be more desirable for production, but any of the following options can be used: - `validate`: Validate the schema, but make no changes to the database. - `update`: Update the schema. - `create`: Create the schema, destroying previous data. - `create-drop`: Drop the schema at the end of the session. - `none`: Do nothing. Note that during a version migration where any schema has changed `create-drop` will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. `validate` or `none` settings are likely the only safe options for production use. For more info, [see this](http://docs.spring.io/spring-framework/docs/current/javadoc-api). - `cas.authn.mfa.yubikey.jpa.default-catalog` (Optional; type `String`): Qualifies unqualified table names with the given catalog in generated SQL. - `cas.authn.mfa.yubikey.jpa.default-schema` (Optional; type `String`): Qualify unqualified table names with the given schema/tablespace in generated SQL. - `cas.authn.mfa.yubikey.jpa.dialect` (Optional; type `String`; default `org.hibernate.dialect.HSQLDialect`): The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML. - `cas.authn.mfa.yubikey.jpa.fail-fast-timeout` (Optional; type `Long`; default `1`): Set the pool initialization failure timeout. - Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a `PoolInitializationException` will be thrown. - A value of zero will *not* prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the `connectionTestQuery` and `connectionInitSql` are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the pool will start and continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. - A value less than zero will *not* bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to `DataSource#getConnection()` may encounter exceptions. Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the `connectionTimeout` or `validationTimeout`; they will be honored before this timeout is applied. The default value is one millisecond. - `cas.authn.mfa.yubikey.jpa.fetch-size` (Optional; type `Integer`; default `100`): Used to specify number of rows to be fetched in a select query. - `cas.authn.mfa.yubikey.jpa.generate-statistics` (Optional; type `Boolean`; default `false`): Allow hibernate to generate query statistics. - `cas.authn.mfa.yubikey.jpa.health-query` (Optional; type `String`): The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 `Connection.isValid()` API. - `cas.authn.mfa.yubikey.jpa.idle-timeout` (Optional; type `String`; default `PT10M`): Controls the maximum amount of time that a connection is allowed to sit idle in the pool. - `cas.authn.mfa.yubikey.jpa.isolate-internal-queries` (Optional; type `Boolean`; default `false`): This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if `#autocommit` is disabled. - `cas.authn.mfa.yubikey.jpa.isolation-level-name` (Optional; type `String`; default `ISOLATION_READ_COMMITTED`): Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition - `cas.authn.mfa.yubikey.jpa.leak-threshold` (Optional; type `String`; default `PT6S`): Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. - `cas.authn.mfa.yubikey.jpa.physical-naming-strategy-class-name` (Optional; type `String`; default `org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy`): Fully-qualified name of the class that can control the physical naming strategy of hibernate. - `cas.authn.mfa.yubikey.jpa.pool.keep-alive-time` (Optional; type `String`; default `0`): This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. - `cas.authn.mfa.yubikey.jpa.pool.max-size` (Optional; type `Integer`; default `18`): Controls the maximum number of connections to keep in the pool, including both idle and in-use connections. - `cas.authn.mfa.yubikey.jpa.pool.max-wait` (Optional; type `String`; default `PT2S`): Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. - `cas.authn.mfa.yubikey.jpa.pool.maximum-lifetime` (Optional; type `String`; default `PT10M`): This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. - `cas.authn.mfa.yubikey.jpa.pool.min-size` (Optional; type `Integer`; default `6`): Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections. - `cas.authn.mfa.yubikey.jpa.pool.name` (Optional; type `String`): Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration. - `cas.authn.mfa.yubikey.jpa.pool.suspension` (Optional; type `Boolean`; default `false`): Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it. - `cas.authn.mfa.yubikey.jpa.pool.timeout-millis` (Optional; type `Long`; default `1000`): The maximum number of milliseconds that the pool will wait for a connection to be validated as alive. - `cas.authn.mfa.yubikey.jpa.propagation-behavior-name` (Optional; type `String`; default `PROPAGATION_REQUIRED`): Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition - `cas.authn.mfa.yubikey.jpa.properties` (Optional; type `Map`): Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs. - `cas.authn.mfa.yubikey.jpa.read-only` (Optional; type `Boolean`; default `false`): Configures the Connections to be added to the pool as read-only Connections. - `cas.authn.mfa.yubikey.json` (Optional; type `YubiKeyJsonMultifactorProperties`): Keep device registration records inside a static JSON resource. - `cas.authn.mfa.yubikey.mongo.authentication-database-name` (Optional; type `String`): Name of the database to use for authentication. - `cas.authn.mfa.yubikey.mongo.drop-collection` (Optional; type `Boolean`; default `false`): Whether collections should be dropped on startup and re-created. - `cas.authn.mfa.yubikey.mongo.pool.idle-time` (Optional) - `cas.authn.mfa.yubikey.mongo.pool.life-time` (Optional) - `cas.authn.mfa.yubikey.mongo.pool.max-size` (Optional) - `cas.authn.mfa.yubikey.mongo.pool.max-wait-time` (Optional) - `cas.authn.mfa.yubikey.mongo.pool.min-size` (Optional; type `Integer`; default `1`): Minimum number of connections to keep around. - `cas.authn.mfa.yubikey.mongo.read-concern` (Optional; type `String`; default `AVAILABLE`): Read concern. Accepted values are: - `LOCAL` - `MAJORITY` - `LINEARIZABLE` - `SNAPSHOT` - `AVAILABLE` - `cas.authn.mfa.yubikey.mongo.read-preference` (Optional; type `String`; default `PRIMARY`): Read preference. Accepted values are: - `PRIMARY` - `SECONDARY` - `SECONDARY_PREFERRED` - `PRIMARY_PREFERRED` - `NEAREST` - `cas.authn.mfa.yubikey.mongo.replica-set` (Optional; type `String`): 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.mfa.yubikey.mongo.retry-writes` (Optional; type `Boolean`; default `false`): Sets whether writes should be retried if they fail due to a network error. - `cas.authn.mfa.yubikey.mongo.ssl-enabled` (Optional; type `Boolean`; default `false`): Whether connections require SSL. - `cas.authn.mfa.yubikey.mongo.timeout` (Optional; type `String`; default `PT5S`): MongoDb database connection timeout. - `cas.authn.mfa.yubikey.mongo.write-concern` (Optional; type `String`; default `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.mfa.yubikey.multiple-device-registration-enabled` (Optional; type `Boolean`; default `false`): When enabled, allows the user/system to accept multiple accounts and device registrations per user, allowing one to switch between or register new devices/accounts automatically. - `cas.authn.mfa.yubikey.name` (Optional; type `String`): The name of the authentication handler used to verify credentials in MFA. Remember that if you have more than one authentication handler of the same type, the names must be defined uniquely for each authentication scheme. Failing to do so may force CAS to not register authentication handlers with a duplicate name. - `cas.authn.mfa.yubikey.order` (Optional; type `Integer`): The order of the authentication handler in the chain. - `cas.authn.mfa.yubikey.rank` (Optional; type `Integer`; default `0`): At times, CAS needs to determine the correct provider when step-up authentication is required. Consider for a moment that CAS already has established an SSO session with/without a provider and has reached a level of authentication. Another incoming request attempts to exercise that SSO session with a different and often competing authentication requirement that may differ from the authentication level CAS has already established. Concretely, examples may be: - CAS has achieved an SSO session, but a separate request now requires step-up authentication with DuoSecurity. - CAS has achieved an SSO session with an authentication level satisfied by DuoSecurity, but a separate request now requires step-up authentication with YubiKey. In certain scenarios, CAS will attempt to rank authentication levels and compare them with each other. If CAS already has achieved a level that is higher than what the incoming request requires, no step-up authentication will be performed. If the opposite is true, CAS will route the authentication flow to the required authentication level and upon success, will adjust the SSO session with the new higher authentication level now satisfied. Ranking of authentication methods is done per provider via specific properties for each. Note that the higher the rank value is, the higher on the security scale it remains. A provider that ranks higher with a larger weight value trumps and override others with a lower value. - `cas.authn.mfa.yubikey.redis.certificate-file` (Optional; type `File`): May be used when making SSL connections to build the trust manager. Sets the certificate file to use for client authentication. This is typically an `X.509` certificate file (or chain file) in PEM format. - `cas.authn.mfa.yubikey.redis.cluster.dynamic-refresh-sources` (Optional; type `Boolean`; default `true`): Whether to discover and query all cluster nodes for obtaining the cluster topology. When set to false, only the initial seed nodes are used as sources for topology discovery. - `cas.authn.mfa.yubikey.redis.cluster.max-redirects` (Optional; type `Integer`; default `0`): The max number of redirects to follow. - `cas.authn.mfa.yubikey.redis.cluster.nodes` (Optional; type `List`): List of nodes available in the redis cluster. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].id` (Optional; type `String`): Identifier of this node. - `cas.authn.mfa.yubikey.redis.cluster.nodes[0].name` (Optional; type `String`): Name of this node. - `cas.authn.mfa.yubikey.redis.cluster.topology-refresh-period` (Optional; type `String`): Enables periodic refresh of cluster topology and sets the refresh period. - `cas.authn.mfa.yubikey.redis.connect-timeout` (Optional; type `String`; default `PT10S`): Connection timeout. - `cas.authn.mfa.yubikey.redis.keep-alive-count` (Optional; type `Integer`; default `0`): The maximum number of keepalive probes TCP should send before dropping the connection. By default, leaving this number at zero disables keepalive. - `cas.authn.mfa.yubikey.redis.keep-alive-idle-timeout` (Optional; type `String`; default `PT2H`): The time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled. - `cas.authn.mfa.yubikey.redis.keep-alive-interval` (Optional; type `String`; default `PT60S`): The time the connection needs to remain idle before TCP starts sending keepalive probes. - `cas.authn.mfa.yubikey.redis.key-certificate-chain-file` (Optional; type `File`): May be used when making SSL connections to build the key manager. Sets the key certificate file to use for client authentication. This is typically an `X.509` certificate file (or chain file) in PEM format. - `cas.authn.mfa.yubikey.redis.key-file` (Optional; type `File`): May be used when making SSL connections. Sets the key file for client authentication. The key is reloaded on each connection attempt that allows CAS to replace certificates during runtime. This is typically a `PKCS#8` private key file in PEM format. - `cas.authn.mfa.yubikey.redis.key-password` (Optional; type `String`): The password of the `#keyFile`, or `null` if it's not password-protected. - `cas.authn.mfa.yubikey.redis.pool.fairness` (Optional; type `Boolean`; default `false`): Returns whether or not the pool serves threads waiting to borrow objects fairly. True means that waiting threads are served as if waiting in a FIFO queue. - `cas.authn.mfa.yubikey.redis.pool.lifo` (Optional; type `Boolean`; default `true`): Returns whether the pool has LIFO (last in, first out) behaviour with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool. - `cas.authn.mfa.yubikey.redis.pool.max-active` (Optional; type `Integer`; default `8`): Max number of connections that can be allocated by the pool at a given time. Use a negative value for no limit. - `cas.authn.mfa.yubikey.redis.pool.max-idle` (Optional; type `Integer`; default `8`): Max number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections. - `cas.authn.mfa.yubikey.redis.pool.max-wait` (Optional; type `String`; default `PT5S`): Maximum amount of time (in milliseconds) a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely. - `cas.authn.mfa.yubikey.redis.pool.min-evictable-idle-time-millis` (Optional; type `Long`; default `0`): Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)). When non-positive, no objects will be evicted from the pool due to idle time alone. - `cas.authn.mfa.yubikey.redis.pool.min-idle` (Optional; type `Integer`; default `0`): Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive. - `cas.authn.mfa.yubikey.redis.pool.num-tests-per-eviction-run` (Optional; type `Integer`; default `0`): Sets the maximum number of objects to examine during each run (if any) of the idle object evictor thread. When positive, the number of tests performed for a run will be the minimum of the configured value and the number of idle instances in the pool. When negative, the number of tests performed will be ceil(getNumIdle()/ abs(getNumTestsPerEvictionRun())) which means that when the value is -n roughly one nth of the idle objects will be tested per run. - `cas.authn.mfa.yubikey.redis.pool.soft-min-evictable-idle-time-millis` (Optional; type `Long`; default `0`): Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTimeMillis() (that is, if getMinEvictableIdleTimeMillis() is positive, then getSoftMinEvictableIdleTimeMillis() is ignored). - `cas.authn.mfa.yubikey.redis.pool.test-on-borrow` (Optional; type `Boolean`; default `false`): Returns whether objects borrowed from the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed, and a new attempt will be made to borrow an object from the pool. - `cas.authn.mfa.yubikey.redis.pool.test-on-create` (Optional; type `Boolean`; default `false`): Returns whether objects created for the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, then borrowObject() will fail. - `cas.authn.mfa.yubikey.redis.pool.test-on-return` (Optional; type `Boolean`; default `false`): Returns whether objects borrowed from the pool will be validated when they are returned to the pool via the returnObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. Returning objects that fail validation are destroyed rather then being returned the pool. - `cas.authn.mfa.yubikey.redis.pool.test-while-idle` (Optional; type `Boolean`; default `false`): Returns whether objects sitting idle in the pool will be validated by the idle object evictor ( if any - see setTimeBetweenEvictionRunsMillis(long)). Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed. - `cas.authn.mfa.yubikey.redis.pool.time-between-eviction-runs-millis` (Optional; type `Long`; default `-1`): Sets the amount of time (in milliseconds) between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run. If positive, the idle object evictor thread will run at least once every timeBetweenEvictionRunsMillis milliseconds, and will attempt to evict objects from the pool that are idle longer than getMinEvictableIdleTimeMillis() (if positive) or getSoftMinEvictableIdleTimeMillis() (if positive). - `cas.authn.mfa.yubikey.redis.protocol-version` (Optional; type `String`; default `RESP3`): Redis protocol version. - `cas.authn.mfa.yubikey.redis.read-from` (Optional; type `BaseRedisProperties.RedisReadFromTypes`): Setting that describes how Lettuce routes read operations to replica nodes. Note that modes referencing MASTER/SLAVE are deprecated (but still supported) in the Lettuce redis client dependency so migrate config to UPSTREAM/REPLICA. Available values are as follows: - `UPSTREAM`: Read from the current upstream node. - `UPSTREAMPREFERRED`: Read from the upstream node, but if it is unavailable, read from replica nodes. - `MASTER`: Read from the current upstream node. - `MASTERPREFERRED`: Read from the upstream node, but if it is unavailable, read from replica nodes. - `SLAVE`: Read from replica nodes. - `SLAVEPREFERRED`: Read from the replica nodes, but if none is unavailable, read from the upstream node. - `REPLICA`: Read from replica nodes. - `REPLICAPREFERRED`: Read from the replica nodes, but if none is unavailable, read from the upstream node. - `ANY`: Read from any node of the cluster. - `ANYREPLICA`: Read from any replica node of the cluster. - `NEAREST`: Read from the nearest node. - `cas.authn.mfa.yubikey.redis.sentinel.node` (Optional; type `List`): list of host:port pairs. - `cas.authn.mfa.yubikey.redis.sentinel.password` (Optional; type `String`): Login password of the sentinel server. - `cas.authn.mfa.yubikey.redis.share-native-connections` (Optional; type `Boolean`): The shared native connection is never closed by Lettuce connection, therefore it is not validated by default when connections are retrieved. If this setting is `true`, a shared connection will be used for regular operations and a connection provider will be used to select a connection for blocking and tx operations only, which should not share a connection. If native connection sharing is disabled, new (or pooled) connections will be used for all operations. By default, multiple connections share a single thread-safe native connection. If you enable connection pooling, then native connection sharing will be disabled and the connection pool will be used for all operations. You may however explicitly control connection sharing via this setting as an override. - `cas.authn.mfa.yubikey.redis.start-tls` (Optional; type `Boolean`; default `false`): Start mutual TLS. In order to support TLS, Redis should be configured with a X.509 certificate and a private key. In addition, it is necessary to specify a CA certificate bundle file or path to be used as a trusted root when validating certificates. - `cas.authn.mfa.yubikey.redis.timeout` (Optional; type `String`; default `PT60S`): Command timeout. - `cas.authn.mfa.yubikey.redis.uri` (Optional; type `String`): Database URI. - `cas.authn.mfa.yubikey.redis.use-ssl` (Optional; type `Boolean`; default `false`): Whether or not to use SSL for connection factory. - `cas.authn.mfa.yubikey.redis.verify-peer` (Optional; type `Boolean`; default `true`): Control how peer verification is handled with redis connections. Peer verification is a security feature that checks if the host you're connecting to is who it says it is. This is often done by checking a digital certificate. - `cas.authn.mfa.yubikey.rest.basic-auth-password` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the password for authentication. - `cas.authn.mfa.yubikey.rest.basic-auth-username` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the username for authentication. - `cas.authn.mfa.yubikey.rest.headers` (Optional; type `Map`): Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value. - `cas.authn.mfa.yubikey.rest.maximum-retry-attempts` (Optional; type `Integer`; default `3`): When attempting to reach the endpoint, this setting controls the number of **retry attempts** that CAS should execute Setting this value to a zero or negative value will disable the retry policy. - `cas.authn.mfa.yubikey.rest.method` (Optional; type `String`; default `GET`): HTTP method to use when contacting the rest endpoint. Examples include `GET, POST`, etc. - `cas.authn.mfa.yubikey.trusted-device-enabled` (Optional; type `Boolean`; default `false`): Indicates whether this provider should support trusted devices. - `cas.authn.mfa.yubikey.validator` (Optional; type `YubiKeyMultifactorAuthenticationProperties.YubiKeyDeviceValidationOptions`; default `VERIFY`): Define the strategy that controls how devices should be validated. Available values are as follows: - `VERIFY`: Verify yubikey devices via YubiKey APIs. - `SKIP`: Skip all validations checks and accept all devices. - `REJECT`: Reject all devices. **Signing & encryption** This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys. Note that if you are asked to create a [JWK](https://tools.ietf.org/html/rfc7517) of a certain size for the key, you are to use the following set of commands to generate the token: ```bash wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar java -jar jwk-gen.jar -t oct -s [size] ``` The outcome would be similar to: ```json { "kty": "oct", "kid": "...", "k": "..." } ``` The generated value for `k` needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (`AES`) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology. --- **Hibernate & JDBC** Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries. - `cas.jdbc.gen-ddl` (Optional; type `Boolean`; default `true`): Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. - `cas.jdbc.physical-table-names` (Optional; type `Map`): Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. - `cas.jdbc.show-sql` (Optional; type `Boolean`; default `false`): Whether SQL queries should be displayed in the console/logs. **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](https://apereo.github.io/cas/development/integration/Apache-Groovy-Scripting.html) to configure your build. By default, all YubiKey accounts for users are allowed to authenticate. Devices that need to be authorized for authentication need to have followed an out-of-band registration process where the record for them is found in one of the following storage backends. Upon authentication, CAS will begin to search the configured registration database for matching record for the authenticated user and device in order to allow for a successful authentication event. | Storage | Description | | --- | --- | | JSON | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-JSON.html). | | REST | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-Rest.html). | | Permissive | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-Permissive.html). | | JPA | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-JPA.html). | | Redis | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-Redis.html). | | DynamoDb | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-DynamoDb.html). | | MongoDb | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-MongoDb.html). | | Custom | [See this guide](https://apereo.github.io/cas/development/mfa/YubiKey-Authentication-Registration-Custom.html). | ### Bypass The following settings and properties are available from the CAS configuration catalog: - `cas.authn.mfa.yubikey.bypass.groovy.location` (Required; type `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.mfa.yubikey.bypass.rest.url` (Required; type `String`): The endpoint URL to contact and retrieve attributes. - `cas.authn.mfa.yubikey.bypass.authentication-attribute-name` (Optional; type `String`): Skip multifactor authentication based on designated authentication attribute names. - `cas.authn.mfa.yubikey.bypass.authentication-attribute-value` (Optional; type `String`): Optionally, skip multifactor authentication based on designated authentication attribute values. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.authentication-handler-name` (Optional; type `String`): Skip multifactor authentication depending on form of primary authentication execution. Specifically, skip multifactor if the a particular authentication handler noted by its name successfully is able to authenticate credentials in the primary factor. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.authentication-method-name` (Optional; type `String`): Skip multifactor authentication depending on method/form of primary authentication execution. Specifically, skip multifactor if the authentication method attribute collected as part of authentication metadata matches a certain value. Multiple values may be separated by a comma. - `cas.authn.mfa.yubikey.bypass.credential-class-type` (Optional; type `String`): Skip multifactor authentication depending on form of primary credentials. Value must equal the fully qualified class name of the credential type. - `cas.authn.mfa.yubikey.bypass.http-request-headers` (Optional; type `String`): Skip multifactor authentication if the http request contains the defined header names. Header names may be comma-separated and can be regular expressions; values are ignored. - `cas.authn.mfa.yubikey.bypass.http-request-remote-address` (Optional; type `String`): Skip multifactor authentication if the http request's remote address or host matches the value defined here. The value may be specified as a regular expression. - `cas.authn.mfa.yubikey.bypass.principal-attribute-name` (Optional; type `String`): Skip multifactor authentication based on designated principal attribute names. - `cas.authn.mfa.yubikey.bypass.principal-attribute-value` (Optional; type `String`): Optionally, skip multifactor authentication based on designated principal attribute values. - `cas.authn.mfa.yubikey.bypass.rest.basic-auth-password` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the password for authentication. - `cas.authn.mfa.yubikey.bypass.rest.basic-auth-username` (Optional; type `String`): If REST endpoint is protected via basic authentication, specify the username for authentication. - `cas.authn.mfa.yubikey.bypass.rest.headers` (Optional; type `Map`): Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value. - `cas.authn.mfa.yubikey.bypass.rest.maximum-retry-attempts` (Optional; type `Integer`; default `3`): When attempting to reach the endpoint, this setting controls the number of **retry attempts** that CAS should execute Setting this value to a zero or negative value will disable the retry policy. - `cas.authn.mfa.yubikey.bypass.rest.method` (Optional; type `String`; default `GET`): HTTP method to use when contacting the rest endpoint. Examples include `GET, POST`, etc. **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](https://apereo.github.io/cas/development/integration/Apache-Groovy-Scripting.html) to configure your build. ## Device/Account Validation In the event that a new YubiKey should be registered, it may be desirable to execute additional validation processes before the account is registered with the underlying store. By default, the device registration step only verifies the device token. If you wish to extend this behavior, you can design your own validator that cross-checks the account against alternative sources and databases for validity and authorization: ```java package org.apereo.cas.support.yubikey; @AutoConfiguration @EnableConfigurationProperties(CasConfigurationProperties.class) public class MyYubiKeyConfiguration { @Bean public YubiKeyAccountValidator yubiKeyAccountValidator() { ... } } ``` [See this guide](https://apereo.github.io/cas/development/configuration/Configuration-Management-Extensions.html) to learn more about how to register configurations into the CAS runtime. ## REST Protocol Credential Extraction In the event that the [CAS REST Protocol](https://apereo.github.io/cas/development/protocol/REST-Protocol.html) is turned on, a special credential extractor is injected into the REST authentication engine in order to recognize YubiKey credentials and authenticate them as part of the REST request. The expected parameter name in the request body is `yubikeyotp`.