WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Amazon Cloud Directory Authentication

Amazon Cloud Directory is a highly available multi-tenant directory-based store in AWS. These directories scale automatically to hundreds of millions of objects as needed for applications. This lets operation’s staff focus on developing and deploying applications that drive the business, not managing directory infrastructure.

To learn more, please see this guide.

Configuration

Support is enabled by including the following dependency in the WAR overlay:

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

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

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

dependencies {
    implementation "org.apereo.cas:cas-server-support-cloud-directory-authentication"
}

dependencies {
    /*
        The following platform references should be included automatically and are listed here for reference only.

        implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
        implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
        
    */
    implementation "org.apereo.cas:cas-server-support-cloud-directory-authentication"
}

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

cas.authn.cloud-directory.password-encoder.encoding-algorithm=

The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT. When used with PasswordEncoderTypes#PBKDF2, it should be one of PBKDF2WithHmacSHA1, PBKDF2WithHmacSHA256 or PBKDF2WithHmacSHA512.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value. The only possible exception to this rule is when naming actuator endpoints; The name of the actuator endpoints (i.e. ssoSessions) MUST remain in camelCase mode.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.encoding-algorithm=...

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        encoding-algorithm: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as 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.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.encoding-algorithm="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.type=NONE

Define the password encoder type to use. Type may be specified as blank or NONE to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder interface if you wish you define your own encoder.

The following types may be used:

NONE: No password encoding (i.e. plain-text) takes place.
DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
SCRYPT: Use the SCryptPasswordEncoder.
PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
STANDARD: Use the StandardPasswordEncoder based on the secret provided.
SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash.
GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.type=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        type: "NONE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.type="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_TYPE="NONE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.type="NONE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.principal-transformation.groovy.location=

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

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.core.authentication.GroovyPrincipalTransformationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.groovy.location=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        groovy: 
          location: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.groovy.location="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.groovy.location="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.credential-access-key=

Use access-key provided by AWS to authenticate.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.credential-access-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      credential-access-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.credential-access-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_CREDENTIAL_ACCESS_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.credential-access-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.credential-secret-key=

Use secret key provided by AWS to authenticate.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.credential-secret-key=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      credential-secret-key: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.credential-secret-key="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_CREDENTIAL_SECRET_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.credential-secret-key="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.directory-arn=

Directory ARN.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.directory-arn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      directory-arn: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.directory-arn="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_DIRECTORY_ARN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.directory-arn="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.endpoint=

AWS custom endpoint.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.endpoint=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      endpoint: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.endpoint="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_ENDPOINT="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.endpoint="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-attribute-name=

Password attribute to choose on the entry to compare.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-attribute-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-attribute-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ATTRIBUTE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-attribute-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.region=

AWS region used.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.region=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      region: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.region="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_REGION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.region="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.schema-arn=

Schema ARN.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.schema-arn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      schema-arn: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.schema-arn="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_SCHEMA_ARN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.schema-arn="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.username-attribute-name=

Username attribute to choose when locating accounts.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.username-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      username-attribute-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.username-attribute-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_USERNAME_ATTRIBUTE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.username-attribute-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.character-encoding=UTF-8

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        character-encoding: "UTF-8"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.character-encoding="UTF-8"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.hash-length=16

When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.hash-length=16

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        hash-length: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.hash-length="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_HASH_LENGTH="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.hash-length="16"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.iterations=310000

When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.iterations=310000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        iterations: "310000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.iterations="310000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_ITERATIONS="310000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.iterations="310000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.secret=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        secret: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.secret="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_SECRET="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.secret="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.strength=16

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        strength: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.strength="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_STRENGTH="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.strength="16"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.blocking-pattern=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        blocking-pattern: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.blocking-pattern="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.case-conversion=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        case-conversion: "NONE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.case-conversion="NONE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.pattern=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        pattern: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.pattern="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_PATTERN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.pattern="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.prefix=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        prefix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.prefix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_PREFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.prefix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.suffix=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        suffix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.suffix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_SUFFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.suffix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.client-execution-timeout=10000

Client execution timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.client-execution-timeout=10000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      client-execution-timeout: "10000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.client-execution-timeout="10000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_CLIENT_EXECUTION_TIMEOUT="10000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.client-execution-timeout="10000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.connection-timeout=5000

Connection timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.connection-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      connection-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.connection-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_CONNECTION_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.connection-timeout="5000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.facet-name=

Facet name.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.facet-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      facet-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.facet-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_FACET_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.facet-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.local-address=

Local address.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.local-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      local-address: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.local-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_LOCAL_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.local-address="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.max-connections=10

Maximum connections setting.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.max-connections=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      max-connections: "10"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.max-connections="10" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_MAX_CONNECTIONS="10"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.max-connections="10"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.name=

The name of the authentication handler.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.order=

The order of this authentication handler in the chain.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.order=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      order: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.order="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_ORDER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.order="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.profile-name=

Profile name to use.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.profile-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      profile-name: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.profile-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PROFILE_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.profile-name="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.profile-path=

Profile path.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.profile-path=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      profile-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.profile-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PROFILE_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.profile-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.proxy-host=

Optionally specifies the proxy host to connect through.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.proxy-host=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      proxy-host: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.proxy-host="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PROXY_HOST="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.proxy-host="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.proxy-password=

Optionally specifies the proxy password to connect through.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.proxy-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      proxy-password: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.proxy-password="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PROXY_PASSWORD="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.proxy-password="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.proxy-username=

Optionally specifies the proxy username to connect through.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.proxy-username=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      proxy-username: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.proxy-username="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PROXY_USERNAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.proxy-username="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.retry-mode=STANDARD

Outline the requested retry mode. Accepted values are STANDARD, LEGACY.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.retry-mode=STANDARD

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      retry-mode: "STANDARD"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.retry-mode="STANDARD" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_RETRY_MODE="STANDARD"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.retry-mode="STANDARD"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.socket-timeout=5000

Socket timeout.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.socket-timeout=5000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      socket-timeout: "5000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.socket-timeout="5000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_SOCKET_TIMEOUT="5000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.socket-timeout="5000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.use-reaper=false

Flag that indicates whether to use reaper.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.use-reaper=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      use-reaper: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.use-reaper="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_USE_REAPER="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.use-reaper="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.username-index-path=

Username index path.

org.apereo.cas.configuration.model.support.clouddirectory.AmazonCloudDirectoryProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.username-index-path=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      username-index-path: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.username-index-path="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_USERNAME_INDEX_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.username-index-path="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

# The encoding algorithm to use such as 'UTF-8'.
# cas.authn.cloud-directory.password-encoder.character-encoding=UTF-8

# When used by {@link PasswordEncoderTypes#ARGON2}, it indicates the hash strength/length.
# cas.authn.cloud-directory.password-encoder.hash-length=16

# When used by {@link PasswordEncoderTypes#PBKDF2}, it indicates the required number of iterations.
# cas.authn.cloud-directory.password-encoder.iterations=310000

# Secret to use with {@link PasswordEncoderTypes#STANDARD}, {@link PasswordEncoderTypes#PBKDF2}, {@link PasswordEncoderTypes#BCRYPT}, {@link PasswordEncoderTypes#GLIBC_CRYPT} password encoders.
# cas.authn.cloud-directory.password-encoder.secret=

# Strength or number of iterations to use for password hashing.
# cas.authn.cloud-directory.password-encoder.strength=16

# A regular expression that will be used against the username to match for blocking/forbidden values.
# cas.authn.cloud-directory.principal-transformation.blocking-pattern=

# Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc.
# cas.authn.cloud-directory.principal-transformation.case-conversion=NONE

# A regular expression that will be used against the provided username for username extractions.
# cas.authn.cloud-directory.principal-transformation.pattern=

# Prefix to add to the principal id prior to authentication.
# cas.authn.cloud-directory.principal-transformation.prefix=

# Suffix to add to the principal id prior to authentication.
# cas.authn.cloud-directory.principal-transformation.suffix=

# Client execution timeout.
# cas.authn.cloud-directory.client-execution-timeout=10000

# Connection timeout.
# cas.authn.cloud-directory.connection-timeout=5000

# Facet name.
# cas.authn.cloud-directory.facet-name=

# Local address.
# cas.authn.cloud-directory.local-address=

# Maximum connections setting.
# cas.authn.cloud-directory.max-connections=10

# The name of the authentication handler.
# cas.authn.cloud-directory.name=

# The order of this authentication handler in the chain.
# cas.authn.cloud-directory.order=

# Profile name to use.
# cas.authn.cloud-directory.profile-name=

# Profile path.
# cas.authn.cloud-directory.profile-path=

# Optionally specifies the proxy host to connect through.
# cas.authn.cloud-directory.proxy-host=

# Optionally specifies the proxy password to connect through.
# cas.authn.cloud-directory.proxy-password=

# Optionally specifies the proxy username to connect through.
# cas.authn.cloud-directory.proxy-username=

# Outline the requested retry mode.
# cas.authn.cloud-directory.retry-mode=STANDARD

# Socket timeout.
# cas.authn.cloud-directory.socket-timeout=5000

# Flag that indicates whether to use reaper.
# cas.authn.cloud-directory.use-reaper=false

# Username index path.
# cas.authn.cloud-directory.username-index-path=

CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.

Please review this guide to configure your build.

cas.authn.cloud-directory.password-encoder.encoding-algorithm=

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.encoding-algorithm=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        encoding-algorithm: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.encoding-algorithm="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_ENCODING_ALGORITHM="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.encoding-algorithm="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.type=NONE

The following types may be used:

NONE: No password encoding (i.e. plain-text) takes place.
DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
SCRYPT: Use the SCryptPasswordEncoder.
PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
STANDARD: Use the StandardPasswordEncoder based on the secret provided.
SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA} or {SSHA} prepended to the encoded hash.
GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.type=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        type: "NONE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.type="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_TYPE="NONE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.type="NONE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.character-encoding=UTF-8

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        character-encoding: "UTF-8"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.character-encoding="UTF-8" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_CHARACTER_ENCODING="UTF-8"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.character-encoding="UTF-8"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.hash-length=16

When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.hash-length=16

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        hash-length: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.hash-length="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_HASH_LENGTH="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.hash-length="16"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.iterations=310000

When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.iterations=310000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        iterations: "310000"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.iterations="310000" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_ITERATIONS="310000"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.iterations="310000"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.secret=

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.secret=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        secret: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.secret="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_SECRET="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.secret="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.password-encoder.strength=16

org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.password-encoder.strength=16

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      password-encoder: 
        strength: "16"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.password-encoder.strength="16" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PASSWORD_ENCODER_STRENGTH="16"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.password-encoder.strength="16"

The above example assumes that the CAS web application is packaged as 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:

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:

import java.util.*

byte[] run(final Object... args) {
    def (rawPassword,generatedSalt,logger,applicationContext) = args
    logger.debug("Encoding password...")
    return ...
}

Boolean matches(final Object... args) {
    def (rawPassword,encodedPassword,logger,applicationContext) = args
    logger.debug("Does match or not ?");
    return ...

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

cas.authn.cloud-directory.principal-transformation.groovy.location=

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

org.apereo.cas.configuration.model.core.authentication.GroovyPrincipalTransformationProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.groovy.location=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        groovy: 
          location: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.groovy.location="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_GROOVY_LOCATION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.groovy.location="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.blocking-pattern=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        blocking-pattern: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.blocking-pattern="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_BLOCKING_PATTERN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.blocking-pattern="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.case-conversion=NONE

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        case-conversion: "NONE"

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.case-conversion="NONE" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_CASE_CONVERSION="NONE"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.case-conversion="NONE"

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.pattern=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        pattern: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.pattern="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_PATTERN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.pattern="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.prefix=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        prefix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.prefix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_PREFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.prefix="..."

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

cas.authn.cloud-directory.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.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.authn.cloud-directory.principal-transformation.suffix=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    cloud-directory: 
      principal-transformation: 
        suffix: "..."

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.authn.cloud-directory.principal-transformation.suffix="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUTHN_CLOUD_DIRECTORY_PRINCIPAL_TRANSFORMATION_SUFFIX="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.authn.cloud-directory.principal-transformation.suffix="..."

The above example assumes that the CAS web application is packaged as 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:

String run(final Object... args) {
    def (providedUsername,logger) = args
    return providedUsername.concat("SomethingElse")
}

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

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.

AWS credentials are fetched from the following sources automatically, where relevant and made possible via CAS configuration:

EC2 instance metadata linked to the IAM role.
External properties file that contains accessKey and secretKey as property keys.
AWS profile path and profile name.
System properties that include aws.accessKeyId, aws.secretKey and aws.sessionToken
Environment variables that include AWS_ACCESS_KEY_ID, AWS_SECRET_KEY and AWS_SESSION_TOKEN.
Properties file on the classpath as awscredentials.properties that contains accessKey and secretKey as property keys.
Static credentials for access key and secret provided directly by the configuration at hand (logging, etc).

Troubleshooting

To enable additional logging, configure the log4j configuration file to add the following levels:

```xml …

…