JAAS Authentication
JAAS is a Java standard authentication and authorization API. JAAS is configured via externalized plain text configuration file. Using JAAS with CAS allows modification of the authentication process without having to rebuild and redeploy CAS and allows for PAM-style multi-module “stacked” authentication.
Configuration
JAAS components are provided in the CAS core module and require no additional dependencies to use. The JAAS handler delegates to the built-in JAAS subsystem to perform authentication according to the directives in the JAAS config file.
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.jaas[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
CAS Property:
|
1 |
cas.authn.jaas[0].password-encoder.encoding-algorithm=... |
1
cas:
authn:
jaas[0]:
password-encoder:
encoding-algorithm: "..."
1
java -Dcas.authn.jaas[0].password-encoder.encoding-algorithm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.encoding-algorithm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or NONE
to disable password encoding.
It may also refer to a fully-qualified class name that implements
the Spring Security's PasswordEncoder
interface
if you wish you define your own encoder.
-
NONE
: No password encoding (i.e. plain-text) takes place. -
DEFAULT
: Use theDefaultPasswordEncoder
of CAS. For message-digest algorithms viacharacter-encoding
andencoding-algorithm
. -
BCRYPT
: Use theBCryptPasswordEncoder
based on the strength provided and an optional secret. -
SCRYPT
: Use theSCryptPasswordEncoder
. -
PBKDF2
: Use thePbkdf2PasswordEncoder
based on the strength provided and an optional secret. -
STANDARD
: Use theStandardPasswordEncoder
based on the secret provided. -
SSHA
: Use theLdapShaPasswordEncoder
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 theGlibcCryptPasswordEncoder
based on theencoding-algorithm
, strength provided and an optional secret. -
org.example.MyEncoder
: An implementation ofPasswordEncoder
of your own choosing. -
file:///path/to/script.groovy
: Path to a Groovy script charged with handling password encoding operations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.type=NONE
1
cas:
authn:
jaas[0]:
password-encoder:
type: "NONE"
1
java -Dcas.authn.jaas[0].password-encoder.type="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_TYPE="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.type="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].realm=
JAAS realm to use.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].realm
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].realm=...
1
cas:
authn:
jaas[0]:
realm: "..."
1
java -Dcas.authn.jaas[0].realm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_REALM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].realm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.groovy.location=
Handle password policy via Groovy script. The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.
In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify
instances.
On Linux, you may need to add the following line to /etc/sysctl.conf
:
fs.inotify.max_user_instances = 256
.
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances
.
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
.
org.apereo.cas.configuration.model.SpringResourceProperties.
CAS Property: cas.authn.jaas[].password-policy.groovy.location
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.groovy.location=...
1
cas:
authn:
jaas[0]:
password-policy:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].password-policy.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.groovy.location=
Transform usernames using a Groovy 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, specially if the script set to reload on changes, you may need to adjust the total number ofinotify
instances.
On Linux, you may need to add the following line to /etc/sysctl.conf
:
fs.inotify.max_user_instances = 256
.
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances
.
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
.
org.apereo.cas.configuration.model.SpringResourceProperties.
CAS Property: cas.authn.jaas[].principal-transformation.groovy.location
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.groovy.location=...
1
cas:
authn:
jaas[0]:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.groovy.location=
Transform usernames using a Groovy 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, specially if the script set to reload on changes, you may need to adjust the total number ofinotify
instances.
On Linux, you may need to add the following line to /etc/sysctl.conf
:
fs.inotify.max_user_instances = 256
.
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances
.
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
.
org.apereo.cas.configuration.model.SpringResourceProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.groovy.location
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.groovy.location=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas=
Collection of settings related to JAAS authentication. These settings are required to be indexed (i.e. jaas[0].xyz).
CAS Property:
|
1 |
cas.authn.jaas=... |
1
cas:
authn:
jaas: "..."
1
java -Dcas.authn.jaas="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].credential-criteria=
A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
- 1) A regular expression pattern that is tested against the credential identifier.
- 2) A fully qualified class name of your own design that implements
Predicate
. - 3) Path to an external Groovy script that implements the same interface.
This settings supports regular expression patterns. [?].
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].credential-criteria
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].credential-criteria=...
1
cas:
authn:
jaas[0]:
credential-criteria: "..."
1
java -Dcas.authn.jaas[0].credential-criteria="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_CREDENTIAL_CRITERIA="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].credential-criteria="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].kerberos-kdc-system-property=
Typically, the default realm and the KDC for that realm are indicated in the Kerberos krb5.conf
configuration file.
However, if you like, you can instead specify the realm value by setting this following system property value.
krb5.conf
file is also provided from which the additional information required for cross-realm authentication
may be obtained.
If you set values for these properties, then they override the default realm and KDC values specified
in krb5.conf
(if such a file is found). The krb5.conf
file is still consulted if values for items
other than the default realm and KDC are needed. If no krb5.conf
file is found,
then the default values used for these items are implementation-specific.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].kerberos-kdc-system-property
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].kerberos-kdc-system-property=...
1
cas:
authn:
jaas[0]:
kerberos-kdc-system-property: "..."
1
java -Dcas.authn.jaas[0].kerberos-kdc-system-property="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_KERBEROS_KDC_SYSTEM_PROPERTY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].kerberos-kdc-system-property="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].kerberos-realm-system-property=
Typically, the default realm and the KDC for that realm are indicated in the Kerberos krb5.conf
configuration file.
However, if you like, you can instead specify the realm value by setting this following system property value.
krb5.conf
file is also provided from which the additional information required for cross-realm authentication
may be obtained.
If you set values for these properties, then they override the default realm and KDC values specified
in krb5.conf
(if such a file is found). The krb5.conf
file is still consulted if values for items
other than the default realm and KDC are needed. If no krb5.conf
file is found,
then the default values used for these items are implementation-specific.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].kerberos-realm-system-property
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].kerberos-realm-system-property=...
1
cas:
authn:
jaas[0]:
kerberos-realm-system-property: "..."
1
java -Dcas.authn.jaas[0].kerberos-realm-system-property="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_KERBEROS_REALM_SYSTEM_PROPERTY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].kerberos-realm-system-property="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].login-config-type=
Typically set to JavaLoginConfig
which is the default Configuration implementation
from the SUN provider. This type accepts a URI/path to a configuration file as a valid parameter type specified via #loginConfigurationFile
.
If this parameter is not specified, then the configuration information is loaded from the sources described
in the ConfigFile class specification. If this parameter is specified, the configuration information is loaded solely from the specified URI.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].login-config-type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].login-config-type=...
1
cas:
authn:
jaas[0]:
login-config-type: "..."
1
java -Dcas.authn.jaas[0].login-config-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_LOGIN_CONFIG_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].login-config-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].login-configuration-file=
Path to the location of configuration file (i.e. jaas.conf) that contains the realms and login modules.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].login-configuration-file
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].login-configuration-file=...
1
cas:
authn:
jaas[0]:
login-configuration-file: "..."
1
java -Dcas.authn.jaas[0].login-configuration-file="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_LOGIN_CONFIGURATION_FILE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].login-configuration-file="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].name=
Name of the authentication handler.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].name=...
1
cas:
authn:
jaas[0]:
name: "..."
1
java -Dcas.authn.jaas[0].name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].order=2147483647
Order of the authentication handler in the chain.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].order
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].order=2147483647
1
cas:
authn:
jaas[0]:
order: "2147483647"
1
java -Dcas.authn.jaas[0].order="2147483647" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_ORDER="2147483647"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].order="2147483647"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'.
Relevant when the type used is DEFAULT
.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.character-encoding
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.character-encoding=UTF-8
1
cas:
authn:
jaas[0]:
password-encoder:
character-encoding: "UTF-8"
1
java -Dcas.authn.jaas[0].password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.character-encoding="UTF-8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.hash-length=16
When used by PasswordEncoderTypes#ARGON2
, it indicates the hash strength/length.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.hash-length
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.hash-length=16
1
cas:
authn:
jaas[0]:
password-encoder:
hash-length: "16"
1
java -Dcas.authn.jaas[0].password-encoder.hash-length="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_HASH_LENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.hash-length="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.iterations=310000
When used by PasswordEncoderTypes#PBKDF2
, it indicates the required number of iterations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.iterations
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.iterations=310000
1
cas:
authn:
jaas[0]:
password-encoder:
iterations: "310000"
1
java -Dcas.authn.jaas[0].password-encoder.iterations="310000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_ITERATIONS="310000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.iterations="310000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.secret=
Secret to use with PasswordEncoderTypes#STANDARD
, PasswordEncoderTypes#PBKDF2
,
PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#GLIBC_CRYPT
password encoders.
Secret usually is an optional setting.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.secret
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.secret=...
1
cas:
authn:
jaas[0]:
password-encoder:
secret: "..."
1
java -Dcas.authn.jaas[0].password-encoder.secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.strength=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.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.strength
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.strength=16
1
cas:
authn:
jaas[0]:
password-encoder:
strength: "16"
1
java -Dcas.authn.jaas[0].password-encoder.strength="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_STRENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.strength="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true
Indicates whether account state handling should be enabled to process warnings or errors reported back from the authentication response, produced by the source.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.account-state-handling-enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true
1
cas:
authn:
jaas[0]:
password-policy:
account-state-handling-enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.account-state-handling-enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ACCOUNT_STATE_HANDLING_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.account-state-handling-enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.display-warning-on-match=true
Indicates if warning should be displayed, when the ldap attribute value
matches the #warningAttributeValue
.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.display-warning-on-match
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.display-warning-on-match=true
1
cas:
authn:
jaas[0]:
password-policy:
display-warning-on-match: "true"
1
java -Dcas.authn.jaas[0].password-policy.display-warning-on-match="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_DISPLAY_WARNING_ON_MATCH="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.display-warning-on-match="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.enabled=true
Whether password policy should be enabled.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.enabled=true
1
cas:
authn:
jaas[0]:
password-policy:
enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.login-failures=5
When dealing with FreeIPA, indicates the number of allows login failures.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.login-failures
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.login-failures=5
1
cas:
authn:
jaas[0]:
password-policy:
login-failures: "5"
1
java -Dcas.authn.jaas[0].password-policy.login-failures="5" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_LOGIN_FAILURES="5"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.login-failures="5"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.policy-attributes=
Key-value structure (Map) that indicates a list of boolean attributes as keys.
If either attribute value is true, indicating an account state is flagged,
the corresponding error can be thrown.
Example accountLocked=javax.security.auth.login.AccountLockedException
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.policy-attributes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.policy-attributes=...
1
cas:
authn:
jaas[0]:
password-policy:
policy-attributes: "..."
1
java -Dcas.authn.jaas[0].password-policy.policy-attributes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_POLICY_ATTRIBUTES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.policy-attributes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.strategy=DEFAULT
Decide how authentication should handle password policy changes. Available values are as follows:
-
DEFAULT
: Default option to handle policy changes. -
GROOVY
: Handle account password policies via Groovy. -
REJECT_RESULT_CODE
: Strategy to only activate password policy if the authentication response code is not blocked.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.strategy
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.strategy=DEFAULT
1
cas:
authn:
jaas[0]:
password-policy:
strategy: "DEFAULT"
1
java -Dcas.authn.jaas[0].password-policy.strategy="DEFAULT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_STRATEGY="DEFAULT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.strategy="DEFAULT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warn-all=
Always display the password expiration warning regardless.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warn-all
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warn-all=...
1
cas:
authn:
jaas[0]:
password-policy:
warn-all: "..."
1
java -Dcas.authn.jaas[0].password-policy.warn-all="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARN_ALL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warn-all="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-name=
Used by an account state handling policy that only calculates account warnings in case the entry carries this attribute.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-name=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-name: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-value=
Used by an account state handling policy that only calculates account warnings
in case the entry carries an attribute #warningAttributeName
whose value matches this field.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-value
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-value=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-value: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-days=30
This is used to calculate a warning period to see if account expiry is within the calculated window.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-days
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-days=30
1
cas:
authn:
jaas[0]:
password-policy:
warning-days: "30"
1
java -Dcas.authn.jaas[0].password-policy.warning-days="30" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_DAYS="30"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-days="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.blocking-pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.blocking-pattern=...
1
cas:
authn:
jaas[0]:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.case-conversion
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.case-conversion=NONE
1
cas:
authn:
jaas[0]:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.jaas[0].principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.pattern=...
1
cas:
authn:
jaas[0]:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.prefix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.prefix=...
1
cas:
authn:
jaas[0]:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.suffix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.suffix=...
1
cas:
authn:
jaas[0]:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.active-attribute-repository-ids=*
Activated attribute repository identifiers that should be used for fetching attributes if attribute resolution is enabled. The list here may include identifiers separated by comma.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.active-attribute-repository-ids
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.active-attribute-repository-ids=*
1
cas:
authn:
jaas[0]:
principal:
active-attribute-repository-ids: "*"
1
java -Dcas.authn.jaas[0].principal.active-attribute-repository-ids="*" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_ACTIVE_ATTRIBUTE_REPOSITORY_IDS="*"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.active-attribute-repository-ids="*"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.attribute-repository-selection=
Control the behavior of the attribute repository selection by authentication method or handler. The map here is keyed by the authentication handler name, and the value is the attribute repository identifiers separated by comma. When the authentication handler is executed, the attribute repositories assigned to this handler will be selected to fetch attributes. Note that the resolution engine will always favor attribute repositories assigned to the service definition, if any and as part of its authentication policy, over this global setting.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.attribute-repository-selection
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.attribute-repository-selection=...
1
cas:
authn:
jaas[0]:
principal:
attribute-repository-selection: "..."
1
java -Dcas.authn.jaas[0].principal.attribute-repository-selection="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_ATTRIBUTE_REPOSITORY_SELECTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.attribute-repository-selection="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.attribute-resolution-enabled=UNDEFINED
Whether attribute repositories should be contacted to fetch person attributes. Defaults to true if not set. Available values are as follows:
-
TRUE
: Constant to represent the true state. -
FALSE
: Constant to represent the false state. -
UNDEFINED
: Constant to represent the undefined state.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.attribute-resolution-enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.attribute-resolution-enabled=UNDEFINED
1
cas:
authn:
jaas[0]:
principal:
attribute-resolution-enabled: "UNDEFINED"
1
java -Dcas.authn.jaas[0].principal.attribute-resolution-enabled="UNDEFINED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_ATTRIBUTE_RESOLUTION_ENABLED="UNDEFINED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.attribute-resolution-enabled="UNDEFINED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-attribute=
Attribute name to use to indicate the identifier of the principal constructed. If the attribute is blank or has no values, the default principal id will be used determined by the underlying authentication engine. The principal id attribute usually is removed from the collection of attributes collected, though this behavior depends on the schematics of the underlying authentication strategy.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.principal-attribute
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-attribute=...
1
cas:
authn:
jaas[0]:
principal:
principal-attribute: "..."
1
java -Dcas.authn.jaas[0].principal.principal-attribute="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_ATTRIBUTE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-attribute="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-resolution-conflict-strategy=last
In the event that the principal resolution engine resolves
more than one principal, (specially if such principals in the chain
have different identifiers), this setting determines strategy by which
the principal id would be chosen from the chain.
Accepted values are: last
, first
.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.principal-resolution-conflict-strategy
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-resolution-conflict-strategy=last
1
cas:
authn:
jaas[0]:
principal:
principal-resolution-conflict-strategy: "last"
1
java -Dcas.authn.jaas[0].principal.principal-resolution-conflict-strategy="last" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_RESOLUTION_CONFLICT_STRATEGY="last"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-resolution-conflict-strategy="last"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-resolution-failure-fatal=UNDEFINED
When true, throws an error back indicating that principal resolution has failed and no principal can be found based on the authentication requirements. Otherwise, logs the condition as an error without raising a catastrophic error. Available values are as follows:
-
TRUE
: Constant to represent the true state. -
FALSE
: Constant to represent the false state. -
UNDEFINED
: Constant to represent the undefined state.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.principal-resolution-failure-fatal
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-resolution-failure-fatal=UNDEFINED
1
cas:
authn:
jaas[0]:
principal:
principal-resolution-failure-fatal: "UNDEFINED"
1
java -Dcas.authn.jaas[0].principal.principal-resolution-failure-fatal="UNDEFINED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_RESOLUTION_FAILURE_FATAL="UNDEFINED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-resolution-failure-fatal="UNDEFINED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.blocking-pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.blocking-pattern=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.case-conversion
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.case-conversion=NONE
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.jaas[0].principal.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.pattern=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.prefix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.prefix=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.suffix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.suffix=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.return-null=UNDEFINED
Return a null principal object if no attributes can be found for the principal. Available values are as follows:
-
TRUE
: Constant to represent the true state. -
FALSE
: Constant to represent the false state. -
UNDEFINED
: Constant to represent the undefined state.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.return-null
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.return-null=UNDEFINED
1
cas:
authn:
jaas[0]:
principal:
return-null: "UNDEFINED"
1
java -Dcas.authn.jaas[0].principal.return-null="UNDEFINED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_RETURN_NULL="UNDEFINED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.return-null="UNDEFINED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.use-existing-principal-id=UNDEFINED
Uses an existing principal id that may have already been established in order to run person directory queries. This is generally useful in situations where authentication is delegated to an external identity provider and a principal is first established to then query an attribute source. Available values are as follows:
-
TRUE
: Constant to represent the true state. -
FALSE
: Constant to represent the false state. -
UNDEFINED
: Constant to represent the undefined state.
org.apereo.cas.configuration.model.core.authentication.PersonDirectoryPrincipalResolverProperties.
CAS Property: cas.authn.jaas[].principal.use-existing-principal-id
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.use-existing-principal-id=UNDEFINED
1
cas:
authn:
jaas[0]:
principal:
use-existing-principal-id: "UNDEFINED"
1
java -Dcas.authn.jaas[0].principal.use-existing-principal-id="UNDEFINED" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_USE_EXISTING_PRINCIPAL_ID="UNDEFINED"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.use-existing-principal-id="UNDEFINED"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].state=ACTIVE
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. Available values are as follows:
-
ACTIVE
: Active authentication handler, and is invoked by default automatically to verify credentials globally. -
STANDBY
: Authentication handler is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for.
org.apereo.cas.configuration.model.support.jaas.JaasAuthenticationProperties.
CAS Property: cas.authn.jaas[].state
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].state=ACTIVE
1
cas:
authn:
jaas[0]:
state: "ACTIVE"
1
java -Dcas.authn.jaas[0].state="ACTIVE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_STATE="ACTIVE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].state="ACTIVE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
CAS Property:
|
1 |
cas.authn.jaas[0].password-encoder.encoding-algorithm=... |
1
cas:
authn:
jaas[0]:
password-encoder:
encoding-algorithm: "..."
1
java -Dcas.authn.jaas[0].password-encoder.encoding-algorithm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.encoding-algorithm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or NONE
to disable password encoding.
It may also refer to a fully-qualified class name that implements
the Spring Security's PasswordEncoder
interface
if you wish you define your own encoder.
-
NONE
: No password encoding (i.e. plain-text) takes place. -
DEFAULT
: Use theDefaultPasswordEncoder
of CAS. For message-digest algorithms viacharacter-encoding
andencoding-algorithm
. -
BCRYPT
: Use theBCryptPasswordEncoder
based on the strength provided and an optional secret. -
SCRYPT
: Use theSCryptPasswordEncoder
. -
PBKDF2
: Use thePbkdf2PasswordEncoder
based on the strength provided and an optional secret. -
STANDARD
: Use theStandardPasswordEncoder
based on the secret provided. -
SSHA
: Use theLdapShaPasswordEncoder
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 theGlibcCryptPasswordEncoder
based on theencoding-algorithm
, strength provided and an optional secret. -
org.example.MyEncoder
: An implementation ofPasswordEncoder
of your own choosing. -
file:///path/to/script.groovy
: Path to a Groovy script charged with handling password encoding operations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.type=NONE
1
cas:
authn:
jaas[0]:
password-encoder:
type: "NONE"
1
java -Dcas.authn.jaas[0].password-encoder.type="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_TYPE="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.type="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'.
Relevant when the type used is DEFAULT
.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.character-encoding
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.character-encoding=UTF-8
1
cas:
authn:
jaas[0]:
password-encoder:
character-encoding: "UTF-8"
1
java -Dcas.authn.jaas[0].password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.character-encoding="UTF-8"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.hash-length=16
When used by PasswordEncoderTypes#ARGON2
, it indicates the hash strength/length.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.hash-length
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.hash-length=16
1
cas:
authn:
jaas[0]:
password-encoder:
hash-length: "16"
1
java -Dcas.authn.jaas[0].password-encoder.hash-length="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_HASH_LENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.hash-length="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.iterations=310000
When used by PasswordEncoderTypes#PBKDF2
, it indicates the required number of iterations.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.iterations
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.iterations=310000
1
cas:
authn:
jaas[0]:
password-encoder:
iterations: "310000"
1
java -Dcas.authn.jaas[0].password-encoder.iterations="310000" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_ITERATIONS="310000"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.iterations="310000"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.secret=
Secret to use with PasswordEncoderTypes#STANDARD
, PasswordEncoderTypes#PBKDF2
,
PasswordEncoderTypes#BCRYPT
, PasswordEncoderTypes#GLIBC_CRYPT
password encoders.
Secret usually is an optional setting.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.secret
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.secret=...
1
cas:
authn:
jaas[0]:
password-encoder:
secret: "..."
1
java -Dcas.authn.jaas[0].password-encoder.secret="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_SECRET="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.secret="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-encoder.strength=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.
org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.
CAS Property: cas.authn.jaas[].password-encoder.strength
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-encoder.strength=16
1
cas:
authn:
jaas[0]:
password-encoder:
strength: "16"
1
java -Dcas.authn.jaas[0].password-encoder.strength="16" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_ENCODER_STRENGTH="16"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-encoder.strength="16"
cas.war
with an embedded server container and can be found in the build/libs
directory.
If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
package org.example.cas;
import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;
public class MyEncoder extends AbstractPasswordEncoder {
@Override
protected byte[] encode(CharSequence rawPassword, byte[] salt) {
return ...
}
}
If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
12
import java.util.*
byte[] run(final Object... args) {
def (rawPassword,generatedSalt,logger,applicationContext) = args
logger.debug("Encoding password...")
return ...
}
Boolean matches(final Object... args) {
def (rawPassword,encodedPassword,logger,applicationContext) = args
logger.debug("Does match or not ?");
return ...
cas.authn.jaas[0].password-policy.groovy.location=
Handle password policy via Groovy script. The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances.
On Linux, you may need to add the following line to /etc/sysctl.conf :
fs.inotify.max_user_instances = 256 .
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
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 Property:
|
1 |
cas.authn.jaas[0].password-policy.groovy.location=... |
1
cas:
authn:
jaas[0]:
password-policy:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].password-policy.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true
Indicates whether account state handling should be enabled to process warnings or errors reported back from the authentication response, produced by the source.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.account-state-handling-enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true
1
cas:
authn:
jaas[0]:
password-policy:
account-state-handling-enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.account-state-handling-enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ACCOUNT_STATE_HANDLING_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.account-state-handling-enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.display-warning-on-match=true
Indicates if warning should be displayed, when the ldap attribute value
matches the #warningAttributeValue
.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.display-warning-on-match
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.display-warning-on-match=true
1
cas:
authn:
jaas[0]:
password-policy:
display-warning-on-match: "true"
1
java -Dcas.authn.jaas[0].password-policy.display-warning-on-match="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_DISPLAY_WARNING_ON_MATCH="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.display-warning-on-match="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.enabled=true
Whether password policy should be enabled.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.enabled=true
1
cas:
authn:
jaas[0]:
password-policy:
enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.login-failures=5
When dealing with FreeIPA, indicates the number of allows login failures.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.login-failures
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.login-failures=5
1
cas:
authn:
jaas[0]:
password-policy:
login-failures: "5"
1
java -Dcas.authn.jaas[0].password-policy.login-failures="5" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_LOGIN_FAILURES="5"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.login-failures="5"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.policy-attributes=
Key-value structure (Map) that indicates a list of boolean attributes as keys.
If either attribute value is true, indicating an account state is flagged,
the corresponding error can be thrown.
Example accountLocked=javax.security.auth.login.AccountLockedException
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.policy-attributes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.policy-attributes=...
1
cas:
authn:
jaas[0]:
password-policy:
policy-attributes: "..."
1
java -Dcas.authn.jaas[0].password-policy.policy-attributes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_POLICY_ATTRIBUTES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.policy-attributes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.strategy=DEFAULT
Decide how authentication should handle password policy changes. Available values are as follows:
-
DEFAULT
: Default option to handle policy changes. -
GROOVY
: Handle account password policies via Groovy. -
REJECT_RESULT_CODE
: Strategy to only activate password policy if the authentication response code is not blocked.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.strategy
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.strategy=DEFAULT
1
cas:
authn:
jaas[0]:
password-policy:
strategy: "DEFAULT"
1
java -Dcas.authn.jaas[0].password-policy.strategy="DEFAULT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_STRATEGY="DEFAULT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.strategy="DEFAULT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warn-all=
Always display the password expiration warning regardless.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warn-all
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warn-all=...
1
cas:
authn:
jaas[0]:
password-policy:
warn-all: "..."
1
java -Dcas.authn.jaas[0].password-policy.warn-all="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARN_ALL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warn-all="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-name=
Used by an account state handling policy that only calculates account warnings in case the entry carries this attribute.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-name=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-name: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-value=
Used by an account state handling policy that only calculates account warnings
in case the entry carries an attribute #warningAttributeName
whose value matches this field.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-value
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-value=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-value: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-days=30
This is used to calculate a warning period to see if account expiry is within the calculated window.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-days
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-days=30
1
cas:
authn:
jaas[0]:
password-policy:
warning-days: "30"
1
java -Dcas.authn.jaas[0].password-policy.warning-days="30" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_DAYS="30"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-days="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
Password Policy Strategies
If the password policy strategy is to be handed off to a Groovy script, the outline of the script may be as follows:
1
2
3
4
5
6
7
8
9
10
11
12
13
import java.util.*
import org.ldaptive.auth.*
import org.apereo.cas.*
import org.apereo.cas.authentication.*
import org.apereo.cas.authentication.support.*
List<MessageDescriptor> run(final Object... args) {
def (response,configuration,logger,applicationContext) = args
logger.info("Handling password policy [{}] via ${configuration.getAccountStateHandler()}", response)
def accountStateHandler = configuration.getAccountStateHandler()
return accountStateHandler.handle(response, configuration)
}
The parameters passed are as follows:
Parameter | Description |
---|---|
response |
The LDAP authentication response of type org.ldaptive.auth.AuthenticationResponse
|
configuration |
The LDAP password policy configuration carrying the account state handler defined. |
logger |
The object responsible for issuing log messages such as logger.info(...) . |
applicationContext |
The Spring ApplicationContext that allows one to interact with the runtime. |
cas.authn.jaas[0].principal-transformation.groovy.location=
Transform usernames using a Groovy 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, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances.
On Linux, you may need to add the following line to /etc/sysctl.conf :
fs.inotify.max_user_instances = 256 .
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
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 Property:
|
1 |
cas.authn.jaas[0].principal-transformation.groovy.location=... |
1
cas:
authn:
jaas[0]:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.groovy.location=
Transform usernames using a Groovy 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, specially if the script set to reload on changes, you may need to adjust the total number ofinotify
instances.
On Linux, you may need to add the following line to /etc/sysctl.conf
:
fs.inotify.max_user_instances = 256
.
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances
.
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
.
org.apereo.cas.configuration.model.SpringResourceProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.groovy.location
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.groovy.location=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.blocking-pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.blocking-pattern=...
1
cas:
authn:
jaas[0]:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.case-conversion
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.case-conversion=NONE
1
cas:
authn:
jaas[0]:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.jaas[0].principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.pattern=...
1
cas:
authn:
jaas[0]:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.prefix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.prefix=...
1
cas:
authn:
jaas[0]:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal-transformation.suffix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal-transformation.suffix=...
1
cas:
authn:
jaas[0]:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.jaas[0].principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.blocking-pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.blocking-pattern=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
blocking-pattern: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.blocking-pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
-
NONE
: No conversion. -
LOWERCASE
: Lowercase conversion. -
UPPERCASE
: Uppercase conversion.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.case-conversion
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.case-conversion=NONE
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
case-conversion: "NONE"
1
java -Dcas.authn.jaas[0].principal.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.case-conversion="NONE"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.pattern
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.pattern=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
pattern: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.pattern="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_PATTERN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.pattern="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.prefix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.prefix=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
prefix: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.prefix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_PREFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.prefix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].principal.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.
CAS Property: cas.authn.jaas[].principal.principal-transformation.suffix
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].principal.principal-transformation.suffix=...
1
cas:
authn:
jaas[0]:
principal:
principal-transformation:
suffix: "..."
1
java -Dcas.authn.jaas[0].principal.principal-transformation.suffix="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PRINCIPAL_PRINCIPAL_TRANSFORMATION_SUFFIX="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].principal.principal-transformation.suffix="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
String run(final Object... args) {
def (providedUsername,logger) = args
return providedUsername.concat("SomethingElse")
}
Certain authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
- A regular expression pattern that is tested against the credential identifier.
- A fully qualified class name of your own design that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import java.util.function.Predicate;
import org.apereo.cas.authentication.Credential;
public class PredicateExample implements Predicate<Credential> {
@Override
public boolean test(final Credential credential) {
// Examine the credential and return true/false
}
}
- Path to an external Groovy script that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import org.apereo.cas.authentication.Credential
import java.util.function.Predicate
class PredicateExample implements Predicate<Credential> {
@Override
boolean test(final Credential credential) {
// test and return result
}
}
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Password Policy
JAAS authentication components have limited support for detecting account status and password policy settings defined via CAS settings.
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.authn.jaas[0].password-policy.groovy.location=
Handle password policy via Groovy script. The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances.
On Linux, you may need to add the following line to /etc/sysctl.conf :
fs.inotify.max_user_instances = 256 .
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
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 Property:
|
1 |
cas.authn.jaas[0].password-policy.groovy.location=... |
1
cas:
authn:
jaas[0]:
password-policy:
groovy:
location: "..."
1
java -Dcas.authn.jaas[0].password-policy.groovy.location="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_GROOVY_LOCATION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.groovy.location="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true
Indicates whether account state handling should be enabled to process warnings or errors reported back from the authentication response, produced by the source.
CAS Property:
|
1 |
cas.authn.jaas[0].password-policy.account-state-handling-enabled=true |
1
cas:
authn:
jaas[0]:
password-policy:
account-state-handling-enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.account-state-handling-enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ACCOUNT_STATE_HANDLING_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.account-state-handling-enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.display-warning-on-match=true
Indicates if warning should be displayed, when the ldap attribute value
matches the #warningAttributeValue
.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.display-warning-on-match
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.display-warning-on-match=true
1
cas:
authn:
jaas[0]:
password-policy:
display-warning-on-match: "true"
1
java -Dcas.authn.jaas[0].password-policy.display-warning-on-match="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_DISPLAY_WARNING_ON_MATCH="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.display-warning-on-match="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.enabled=true
Whether password policy should be enabled.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.enabled
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.enabled=true
1
cas:
authn:
jaas[0]:
password-policy:
enabled: "true"
1
java -Dcas.authn.jaas[0].password-policy.enabled="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_ENABLED="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.enabled="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.login-failures=5
When dealing with FreeIPA, indicates the number of allows login failures.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.login-failures
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.login-failures=5
1
cas:
authn:
jaas[0]:
password-policy:
login-failures: "5"
1
java -Dcas.authn.jaas[0].password-policy.login-failures="5" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_LOGIN_FAILURES="5"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.login-failures="5"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.policy-attributes=
Key-value structure (Map) that indicates a list of boolean attributes as keys.
If either attribute value is true, indicating an account state is flagged,
the corresponding error can be thrown.
Example accountLocked=javax.security.auth.login.AccountLockedException
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.policy-attributes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.policy-attributes=...
1
cas:
authn:
jaas[0]:
password-policy:
policy-attributes: "..."
1
java -Dcas.authn.jaas[0].password-policy.policy-attributes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_POLICY_ATTRIBUTES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.policy-attributes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.strategy=DEFAULT
Decide how authentication should handle password policy changes. Available values are as follows:
-
DEFAULT
: Default option to handle policy changes. -
GROOVY
: Handle account password policies via Groovy. -
REJECT_RESULT_CODE
: Strategy to only activate password policy if the authentication response code is not blocked.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.strategy
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.strategy=DEFAULT
1
cas:
authn:
jaas[0]:
password-policy:
strategy: "DEFAULT"
1
java -Dcas.authn.jaas[0].password-policy.strategy="DEFAULT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_STRATEGY="DEFAULT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.strategy="DEFAULT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warn-all=
Always display the password expiration warning regardless.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warn-all
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warn-all=...
1
cas:
authn:
jaas[0]:
password-policy:
warn-all: "..."
1
java -Dcas.authn.jaas[0].password-policy.warn-all="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARN_ALL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warn-all="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-name=
Used by an account state handling policy that only calculates account warnings in case the entry carries this attribute.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-name=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-name: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-attribute-value=
Used by an account state handling policy that only calculates account warnings
in case the entry carries an attribute #warningAttributeName
whose value matches this field.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-attribute-value
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-attribute-value=...
1
cas:
authn:
jaas[0]:
password-policy:
warning-attribute-value: "..."
1
java -Dcas.authn.jaas[0].password-policy.warning-attribute-value="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_ATTRIBUTE_VALUE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-attribute-value="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.warning-days=30
This is used to calculate a warning period to see if account expiry is within the calculated window.
org.apereo.cas.configuration.model.core.authentication.PasswordPolicyProperties.
CAS Property: cas.authn.jaas[].password-policy.warning-days
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.authn.jaas[0].password-policy.warning-days=30
1
cas:
authn:
jaas[0]:
password-policy:
warning-days: "30"
1
java -Dcas.authn.jaas[0].password-policy.warning-days="30" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_AUTHN_JAAS[0]_PASSWORD_POLICY_WARNING_DAYS="30"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.authn.jaas[0].password-policy.warning-days="30"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.authn.jaas[0].password-policy.groovy.location=
Handle password policy via Groovy script. The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances.
On Linux, you may need to add the following line to /etc/sysctl.conf :
fs.inotify.max_user_instances = 256 .
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
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 .
|