LDAP Surrogate Authentication

LDAP support for surrogate authentication is enabled by including the following dependencies in the WAR overlay:

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

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

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

dependencies {
    implementation "org.apereo.cas:cas-server-support-surrogate-authentication-ldap"
}

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-surrogate-authentication-ldap"
}

Surrogate accounts may also be retrieved from an LDAP instance. Such accounts are expected to be found in a configured attribute defined for the primary user in LDAP whose value(s) may be examined against a regular expression pattern of your own choosing to further narrow down the list of authorized surrogate accounts.

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.surrogate.ldap.base-dn=

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.base-dn=...

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: 
    surrogate: 
      ldap: 
        base-dn: "..."

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.surrogate.ldap.base-dn="..." -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_SURROGATE_LDAP_BASE_DN="..."

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.surrogate.ldap.base-dn="..."

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.surrogate.ldap.bind-credential=

The bind credential to use when connecting to LDAP.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.bind-credential=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        bind-credential: "..."

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.surrogate.ldap.bind-credential="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_BIND_CREDENTIAL="..."

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.surrogate.ldap.bind-credential="..."

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.surrogate.ldap.bind-dn=

The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:

bindDn/bindCredential provided - Use the provided credentials to bind when initializing connections.
bindDn/bindCredential set to * - Use a fast-bind strategy to initialize the pool.
bindDn/bindCredential set to blank - Skip connection initializing; perform operations anonymously.
SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.bind-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        bind-dn: "..."

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.surrogate.ldap.bind-dn="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_BIND_DN="..."

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.surrogate.ldap.bind-dn="..."

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.surrogate.ldap.ldap-url=

The LDAP url to the server. More than one may be specified, separated by space and/or comma.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.ldap-url=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        ldap-url: "..."

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.surrogate.ldap.ldap-url="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_LDAP_URL="..."

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.surrogate.ldap.ldap-url="..."

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.surrogate.ldap.member-attribute-name=

Attribute that must be found on the LDAP entry linked to the admin user that tags the account as authorized for impersonation. All attribute values are then compared against the pattern you specify in #getMemberAttributeValueRegex().

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.member-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        member-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.surrogate.ldap.member-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_SURROGATE_LDAP_MEMBER_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.surrogate.ldap.member-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.surrogate.ldap.search-filter=

User filter to use for searching. Syntax is cn={user} or cn={0}.

You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-filter: "..."

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.surrogate.ldap.search-filter="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_FILTER="..."

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.surrogate.ldap.search-filter="..."

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.surrogate.ldap.surrogate-search-filter=

LDAP search filter used to locate the surrogate account. The query is expected to determine whether the primary user is authorized to impersonate the given account. These fields may be referred to in the LDAP search query via {user} and {surrogate} placeholders. If the query result yields a value that points to an LDAP entry, impersonation is authorized for the given accounts.

An example might be

(&(uid={user})(xyzMemberOf=actAs:{surrogate}))

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.surrogate-search-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        surrogate-search-filter: "..."

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.surrogate.ldap.surrogate-search-filter="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SURROGATE_SEARCH_FILTER="..."

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.surrogate.ldap.surrogate-search-filter="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

The Attribute name case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-name-case-change: "..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAME_CASE_CHANGE="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-names: "..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-names="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAMES="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-names="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

The Attribute value case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            attribute-value-case-change: "..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_VALUE_CASE_CHANGE="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.dn-case-change=

The Dn case change.

org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].case-change.dn-case-change=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          case-change: 
            dn-case-change: "..."

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.surrogate.ldap.search-entry-handlers[0].case-change.dn-case-change="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_DN_CASE_CHANGE="..."

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.surrogate.ldap.search-entry-handlers[0].case-change.dn-case-change="..."

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

The Add if exists.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          dn-attribute: 
            add-if-exists: "..."

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_ADD_IF_EXISTS="..."

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..."

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

The Dn attribute name.

org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          dn-attribute: 
            dn-attribute-name: "entryDN"

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_DN_ATTRIBUTE_NAME="entryDN"

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.surrogate.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN"

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.surrogate.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

The Attribute names.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].merge-attribute.attribute-names=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          merge-attribute: 
            attribute-names: "..."

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.surrogate.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_ATTRIBUTE_NAMES="..."

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.surrogate.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..."

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.surrogate.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

The Merge attribute name.

org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          merge-attribute: 
            merge-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.surrogate.ldap.search-entry-handlers[0].merge-attribute.merge-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_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_MERGE_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.surrogate.ldap.search-entry-handlers[0].merge-attribute.merge-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.surrogate.ldap.search-entry-handlers[0].primary-group-id.base-dn=

The Base dn.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].primary-group-id.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          primary-group-id: 
            base-dn: "..."

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.surrogate.ldap.search-entry-handlers[0].primary-group-id.base-dn="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_BASE_DN="..."

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.surrogate.ldap.search-entry-handlers[0].primary-group-id.base-dn="..."

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.surrogate.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

The Group filter.

org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          primary-group-id: 
            group-filter: "(&(objectClass=group)(objectSid={0}))"

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.surrogate.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_GROUP_FILTER="(&(objectClass=group)(objectSid={0}))"

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.surrogate.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))"

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.surrogate.ldap.search-entry-handlers[0].recursive.merge-attributes=

The Merge attributes.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].recursive.merge-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          recursive: 
            merge-attributes: "..."

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.surrogate.ldap.search-entry-handlers[0].recursive.merge-attributes="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_MERGE_ATTRIBUTES="..."

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.surrogate.ldap.search-entry-handlers[0].recursive.merge-attributes="..."

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.surrogate.ldap.search-entry-handlers[0].recursive.search-attribute=

The Search attribute.

org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].recursive.search-attribute=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          recursive: 
            search-attribute: "..."

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.surrogate.ldap.search-entry-handlers[0].recursive.search-attribute="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_SEARCH_ATTRIBUTE="..."

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.surrogate.ldap.search-entry-handlers[0].recursive.search-attribute="..."

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.surrogate.ldap.search-entry-handlers[0].search-referral.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowReferralSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].search-referral.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          search-referral: 
            limit: "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.surrogate.ldap.search-entry-handlers[0].search-referral.limit="10" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_REFERRAL_LIMIT="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.surrogate.ldap.search-entry-handlers[0].search-referral.limit="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.surrogate.ldap.search-entry-handlers[0].search-result.limit=10

The default referral limit.

org.apereo.cas.configuration.model.support.ldap.FollowResultSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].search-result.limit=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          search-result: 
            limit: "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.surrogate.ldap.search-entry-handlers[0].search-result.limit="10" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_RESULT_LIMIT="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.surrogate.ldap.search-entry-handlers[0].search-result.limit="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.surrogate.ldap.search-entry-handlers[0].type=

The type of search entry handler to choose. Available values are as follows:

FOLLOW_SEARCH_REFERRAL: Provides handling of an ldap referral for search operations.
FOLLOW_SEARCH_RESULT_REFERENCE: Provides handling of an ldap continuation reference for search operations.
ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.
MERGE_ENTRIES: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.

org.apereo.cas.configuration.model.support.ldap.LdapSearchEntryHandlersProperties.

_{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.surrogate.ldap.search-entry-handlers[0].type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers[0]: 
          type: "..."

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.surrogate.ldap.search-entry-handlers[0].type="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS[0]_TYPE="..."

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.surrogate.ldap.search-entry-handlers[0].type="..."

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.surrogate.ldap.validator.attribute-name=objectClass

Attribute name to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.attribute-name=objectClass

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          attribute-name: "objectClass"

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.surrogate.ldap.validator.attribute-name="objectClass" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_ATTRIBUTE_NAME="objectClass"

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.surrogate.ldap.validator.attribute-name="objectClass"

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.surrogate.ldap.validator.attribute-value=top

Attribute values to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.attribute-value=top

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          attribute-value: "top"

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.surrogate.ldap.validator.attribute-value="top" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_ATTRIBUTE_VALUE="top"

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.surrogate.ldap.validator.attribute-value="top"

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.surrogate.ldap.validator.base-dn=

Base DN to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.base-dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          base-dn: "..."

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.surrogate.ldap.validator.base-dn="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_BASE_DN="..."

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.surrogate.ldap.validator.base-dn="..."

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.surrogate.ldap.validator.dn=

DN to compare to use for the compare validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.dn=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          dn: "..."

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.surrogate.ldap.validator.dn="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_DN="..."

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.surrogate.ldap.validator.dn="..."

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.surrogate.ldap.validator.scope=OBJECT

Search scope to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.scope=OBJECT

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          scope: "OBJECT"

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.surrogate.ldap.validator.scope="OBJECT" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_SCOPE="OBJECT"

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.surrogate.ldap.validator.scope="OBJECT"

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.surrogate.ldap.validator.search-filter=(objectClass=*)

Search filter to use for the search request of the search validator.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.search-filter=(objectClass=*)

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          search-filter: "(objectClass=*)"

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.surrogate.ldap.validator.search-filter="(objectClass=*)" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_SEARCH_FILTER="(objectClass=*)"

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.surrogate.ldap.validator.search-filter="(objectClass=*)"

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.surrogate.ldap.validator.type=search

Determine the LDAP validator type.

The following LDAP validators can be used to test connection health status:

search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
none: No validation takes place.
compare: Validates a connection is healthy by performing a compare operation.

org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

_{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.surrogate.ldap.validator.type=search

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validator: 
          type: "search"

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.surrogate.ldap.validator.type="search" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATOR_TYPE="search"

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.surrogate.ldap.validator.type="search"

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.surrogate.ldap.allow-multiple-dns=false

Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.allow-multiple-dns=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        allow-multiple-dns: "..."

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.surrogate.ldap.allow-multiple-dns="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_ALLOW_MULTIPLE_DNS="..."

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.surrogate.ldap.allow-multiple-dns="..."

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.surrogate.ldap.allow-multiple-entries=false

Set if multiple Entries are allowed.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.allow-multiple-entries=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        allow-multiple-entries: "..."

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.surrogate.ldap.allow-multiple-entries="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_ALLOW_MULTIPLE_ENTRIES="..."

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.surrogate.ldap.allow-multiple-entries="..."

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.surrogate.ldap.binary-attributes=

Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.binary-attributes=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        binary-attributes: "..."

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.surrogate.ldap.binary-attributes="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_BINARY_ATTRIBUTES="..."

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.surrogate.ldap.binary-attributes="..."

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.surrogate.ldap.block-wait-time=PT3S

The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.block-wait-time=PT3S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        block-wait-time: "PT3S"

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.surrogate.ldap.block-wait-time="PT3S" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_BLOCK_WAIT_TIME="PT3S"

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.surrogate.ldap.block-wait-time="PT3S"

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.surrogate.ldap.connect-timeout=PT5S

Sets the maximum amount of time that connects will block.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.connect-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        connect-timeout: "PT5S"

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.surrogate.ldap.connect-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_CONNECT_TIMEOUT="PT5S"

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.surrogate.ldap.connect-timeout="PT5S"

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.surrogate.ldap.connection-strategy=

If multiple URLs are provided as the ldapURL this describes how each URL will be processed.

ACTIVE_PASSIVE First LDAP will be used for every request unless it fails and then the next shall be used.
ROUND_ROBIN For each new connection the next url in the list will be used.
RANDOM For each new connection a random LDAP url will be selected.
DNS_SRV LDAP urls based on DNS SRV records of the configured/given LDAP url will be used.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.connection-strategy=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        connection-strategy: "..."

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.surrogate.ldap.connection-strategy="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_CONNECTION_STRATEGY="..."

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.surrogate.ldap.connection-strategy="..."

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.surrogate.ldap.disable-pooling=false

Whether to use a pooled connection factory in components.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.disable-pooling=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        disable-pooling: "..."

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.surrogate.ldap.disable-pooling="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_DISABLE_POOLING="..."

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.surrogate.ldap.disable-pooling="..."

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.surrogate.ldap.fail-fast=true

Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.fail-fast=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        fail-fast: "true"

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.surrogate.ldap.fail-fast="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_FAIL_FAST="true"

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.surrogate.ldap.fail-fast="true"

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.surrogate.ldap.follow-referrals=true

Set if search referrals should be followed.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.follow-referrals=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        follow-referrals: "true"

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.surrogate.ldap.follow-referrals="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_FOLLOW_REFERRALS="true"

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.surrogate.ldap.follow-referrals="true"

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.surrogate.ldap.hostname-verifier=DEFAULT

Hostname verification options. Available values are as follows:

DEFAULT: Default option, forcing verification.
ANY: Skip hostname verification and allow all.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.hostname-verifier=DEFAULT

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        hostname-verifier: "DEFAULT"

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.surrogate.ldap.hostname-verifier="DEFAULT" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_HOSTNAME_VERIFIER="DEFAULT"

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.surrogate.ldap.hostname-verifier="DEFAULT"

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.surrogate.ldap.idle-time=PT10M

Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.idle-time=PT10M

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        idle-time: "PT10M"

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.surrogate.ldap.idle-time="PT10M" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_IDLE_TIME="PT10M"

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.surrogate.ldap.idle-time="PT10M"

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.surrogate.ldap.keystore=

Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.keystore=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        keystore: "..."

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.surrogate.ldap.keystore="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_KEYSTORE="..."

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.surrogate.ldap.keystore="..."

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.surrogate.ldap.keystore-password=

Keystore password.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.keystore-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        keystore-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.surrogate.ldap.keystore-password="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_KEYSTORE_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.surrogate.ldap.keystore-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.surrogate.ldap.keystore-type=

The type of keystore. PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.keystore-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        keystore-type: "..."

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.surrogate.ldap.keystore-type="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_KEYSTORE_TYPE="..."

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.surrogate.ldap.keystore-type="..."

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.surrogate.ldap.max-pool-size=10

Maximum LDAP connection pool size which the pool can use to grow.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.max-pool-size=10

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        max-pool-size: "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.surrogate.ldap.max-pool-size="10" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_MAX_POOL_SIZE="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.surrogate.ldap.max-pool-size="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.surrogate.ldap.member-attribute-value-regex=

A pattern that is matched against the attribute value of the admin user, that allows for further authorization of the admin user and accounts qualified for impersonation. The regular expression pattern is expected to contain at least a single group whose value on a successful match indicates the qualified impersonated user by admin.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.member-attribute-value-regex=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        member-attribute-value-regex: "..."

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.surrogate.ldap.member-attribute-value-regex="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_MEMBER_ATTRIBUTE_VALUE_REGEX="..."

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.surrogate.ldap.member-attribute-value-regex="..."

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.surrogate.ldap.min-pool-size=3

Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.min-pool-size=3

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        min-pool-size: "3"

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.surrogate.ldap.min-pool-size="3" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_MIN_POOL_SIZE="3"

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.surrogate.ldap.min-pool-size="3"

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.surrogate.ldap.name=

Name of the LDAP handler.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        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.surrogate.ldap.name="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_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.surrogate.ldap.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.surrogate.ldap.page-size=0

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.page-size=0

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        page-size: "0"

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.surrogate.ldap.page-size="0" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_PAGE_SIZE="0"

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.surrogate.ldap.page-size="0"

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.surrogate.ldap.pool-passivator=BIND

You may receive unexpected LDAP failures, when CAS is configured to authenticate using DIRECT or AUTHENTICATED types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are:

NONE: No passivation takes place.
BIND: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.pool-passivator=BIND

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        pool-passivator: "BIND"

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.surrogate.ldap.pool-passivator="BIND" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_POOL_PASSIVATOR="BIND"

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.surrogate.ldap.pool-passivator="BIND"

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.surrogate.ldap.prune-period=PT2H

Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.prune-period=PT2H

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        prune-period: "PT2H"

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.surrogate.ldap.prune-period="PT2H" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_PRUNE_PERIOD="PT2H"

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.surrogate.ldap.prune-period="PT2H"

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.surrogate.ldap.response-timeout=PT5S

Duration of time to wait for responses.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.response-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        response-timeout: "PT5S"

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.surrogate.ldap.response-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_RESPONSE_TIMEOUT="PT5S"

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.surrogate.ldap.response-timeout="PT5S"

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.surrogate.ldap.sasl-authorization-id=

SASL authorization id.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-authorization-id=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-authorization-id: "..."

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.surrogate.ldap.sasl-authorization-id="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_AUTHORIZATION_ID="..."

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.surrogate.ldap.sasl-authorization-id="..."

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.surrogate.ldap.sasl-mechanism=

The SASL mechanism.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-mechanism=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-mechanism: "..."

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.surrogate.ldap.sasl-mechanism="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_MECHANISM="..."

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.surrogate.ldap.sasl-mechanism="..."

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.surrogate.ldap.sasl-mutual-auth=

SASL mutual auth is enabled?

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-mutual-auth=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-mutual-auth: "..."

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.surrogate.ldap.sasl-mutual-auth="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_MUTUAL_AUTH="..."

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.surrogate.ldap.sasl-mutual-auth="..."

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.surrogate.ldap.sasl-quality-of-protection=

SASL quality of protected.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-quality-of-protection=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-quality-of-protection: "..."

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.surrogate.ldap.sasl-quality-of-protection="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_QUALITY_OF_PROTECTION="..."

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.surrogate.ldap.sasl-quality-of-protection="..."

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.surrogate.ldap.sasl-realm=

The SASL realm.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-realm=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-realm: "..."

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.surrogate.ldap.sasl-realm="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_REALM="..."

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.surrogate.ldap.sasl-realm="..."

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.surrogate.ldap.sasl-security-strength=

SASL security strength.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.sasl-security-strength=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        sasl-security-strength: "..."

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.surrogate.ldap.sasl-security-strength="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SASL_SECURITY_STRENGTH="..."

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.surrogate.ldap.sasl-security-strength="..."

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.surrogate.ldap.search-entry-handlers=

Search handlers.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.search-entry-handlers=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        search-entry-handlers: "..."

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.surrogate.ldap.search-entry-handlers="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SEARCH_ENTRY_HANDLERS="..."

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.surrogate.ldap.search-entry-handlers="..."

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.surrogate.ldap.subtree-search=true

Whether subtree searching is allowed.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.subtree-search=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        subtree-search: "true"

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.surrogate.ldap.subtree-search="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SUBTREE_SEARCH="true"

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.surrogate.ldap.subtree-search="true"

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.surrogate.ldap.surrogate-validation-filter=

An optional LDAP validation filter that attempts to look for surrogate/impersonatee account in LDAP once authorization has been granted via #getSurrogateSearchFilter(). You can use this validation filter to ensure the surrogate/impersonatee does exist in LDAP. The LDAP filter may use {surrogate} as a placeholder in the filter to locate the surrogate account.

An example might be:

(&(uid={surrogate})(authorized=TRUE))}

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.surrogate-validation-filter=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        surrogate-validation-filter: "..."

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.surrogate.ldap.surrogate-validation-filter="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_SURROGATE_VALIDATION_FILTER="..."

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.surrogate.ldap.surrogate-validation-filter="..."

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.surrogate.ldap.trust-certificates=

Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.trust-certificates=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        trust-certificates: "..."

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.surrogate.ldap.trust-certificates="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_TRUST_CERTIFICATES="..."

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.surrogate.ldap.trust-certificates="..."

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.surrogate.ldap.trust-manager=

Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are: *

DEFAULT: Enable and force the default JVM trust managers.
ANY: Trust any client or server.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.trust-manager=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        trust-manager: "..."

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.surrogate.ldap.trust-manager="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_TRUST_MANAGER="..."

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.surrogate.ldap.trust-manager="..."

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.surrogate.ldap.trust-store=

Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.trust-store=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        trust-store: "..."

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.surrogate.ldap.trust-store="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_TRUST_STORE="..."

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.surrogate.ldap.trust-store="..."

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.surrogate.ldap.trust-store-password=

Password needed to open the truststore.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.trust-store-password=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        trust-store-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.surrogate.ldap.trust-store-password="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_TRUST_STORE_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.surrogate.ldap.trust-store-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.surrogate.ldap.trust-store-type=

The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.trust-store-type=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        trust-store-type: "..."

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.surrogate.ldap.trust-store-type="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_TRUST_STORE_TYPE="..."

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.surrogate.ldap.trust-store-type="..."

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.surrogate.ldap.use-start-tls=false

Whether TLS should be used and enabled when establishing the connection.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.use-start-tls=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        use-start-tls: "..."

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.surrogate.ldap.use-start-tls="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_USE_START_TLS="..."

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.surrogate.ldap.use-start-tls="..."

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.surrogate.ldap.validate-on-checkout=true

Whether connections should be validated when loaned out from the pool.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.validate-on-checkout=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validate-on-checkout: "true"

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.surrogate.ldap.validate-on-checkout="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATE_ON_CHECKOUT="true"

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.surrogate.ldap.validate-on-checkout="true"

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.surrogate.ldap.validate-period=PT5M

Period at which pool should be validated.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.validate-period=PT5M

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validate-period: "PT5M"

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.surrogate.ldap.validate-period="PT5M" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATE_PERIOD="PT5M"

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.surrogate.ldap.validate-period="PT5M"

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.surrogate.ldap.validate-periodically=true

Whether connections should be validated periodically when the pool is idle.

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.validate-periodically=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validate-periodically: "true"

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.surrogate.ldap.validate-periodically="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATE_PERIODICALLY="true"

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.surrogate.ldap.validate-periodically="true"

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.surrogate.ldap.validate-timeout=PT5S

Period at which validation operations may time out.

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

org.apereo.cas.configuration.model.support.surrogate.SurrogateLdapAuthenticationProperties.

_{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.surrogate.ldap.validate-timeout=PT5S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    surrogate: 
      ldap: 
        validate-timeout: "PT5S"

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.surrogate.ldap.validate-timeout="PT5S" -jar build/libs/cas.war

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

export CAS_AUTHN_SURROGATE_LDAP_VALIDATE_TIMEOUT="PT5S"

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.surrogate.ldap.validate-timeout="PT5S"

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 Attribute name case change.
# cas.authn.surrogate.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=

# The Attribute names.
# cas.authn.surrogate.ldap.search-entry-handlers[0].case-change.attribute-names=

# The Attribute value case change.
# cas.authn.surrogate.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=

# The Dn case change.
# cas.authn.surrogate.ldap.search-entry-handlers[0].case-change.dn-case-change=

# The Add if exists.
# cas.authn.surrogate.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=

# The Dn attribute name.
# cas.authn.surrogate.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN

# The Attribute names.
# cas.authn.surrogate.ldap.search-entry-handlers[0].merge-attribute.attribute-names=

# The Merge attribute name.
# cas.authn.surrogate.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=

# The Base dn.
# cas.authn.surrogate.ldap.search-entry-handlers[0].primary-group-id.base-dn=

# The Group filter.
# cas.authn.surrogate.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))

# The Merge attributes.
# cas.authn.surrogate.ldap.search-entry-handlers[0].recursive.merge-attributes=

# The Search attribute.
# cas.authn.surrogate.ldap.search-entry-handlers[0].recursive.search-attribute=

# The default referral limit.
# cas.authn.surrogate.ldap.search-entry-handlers[0].search-referral.limit=10

# The default referral limit.
# cas.authn.surrogate.ldap.search-entry-handlers[0].search-result.limit=10

# The type of search entry handler to choose.
# cas.authn.surrogate.ldap.search-entry-handlers[0].type=

# Attribute name to use for the compare validator.
# cas.authn.surrogate.ldap.validator.attribute-name=objectClass

# Attribute values to use for the compare validator.
# cas.authn.surrogate.ldap.validator.attribute-value=top

# Base DN to use for the search request of the search validator.
# cas.authn.surrogate.ldap.validator.base-dn=

# DN to compare to use for the compare validator.
# cas.authn.surrogate.ldap.validator.dn=

# Search scope to use for the search request of the search validator.
# cas.authn.surrogate.ldap.validator.scope=OBJECT

# Search filter to use for the search request of the search validator.
# cas.authn.surrogate.ldap.validator.search-filter=(objectClass=*)

# Determine the LDAP validator type.
# cas.authn.surrogate.ldap.validator.type=search

# Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
# cas.authn.surrogate.ldap.allow-multiple-dns=false

# Set if multiple Entries are allowed.
# cas.authn.surrogate.ldap.allow-multiple-entries=false

# Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
# cas.authn.surrogate.ldap.binary-attributes=

# The length of time the pool will block.
# cas.authn.surrogate.ldap.block-wait-time=PT3S

# Sets the maximum amount of time that connects will block.
# cas.authn.surrogate.ldap.connect-timeout=PT5S

# If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
# cas.authn.surrogate.ldap.connection-strategy=

# Whether to use a pooled connection factory in components.
# cas.authn.surrogate.ldap.disable-pooling=false

# Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
# cas.authn.surrogate.ldap.fail-fast=true

# Set if search referrals should be followed.
# cas.authn.surrogate.ldap.follow-referrals=true

# Hostname verification options.
# cas.authn.surrogate.ldap.hostname-verifier=DEFAULT

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.authn.surrogate.ldap.idle-time=PT10M

# Path to the keystore used for SSL connections.
# cas.authn.surrogate.ldap.keystore=

# Keystore password.
# cas.authn.surrogate.ldap.keystore-password=

# The type of keystore.
# cas.authn.surrogate.ldap.keystore-type=

# Maximum LDAP connection pool size which the pool can use to grow.
# cas.authn.surrogate.ldap.max-pool-size=10

# A pattern that is matched against the attribute value of the admin user, that allows for further authorization of the admin user and accounts qualified for impersonation.
# cas.authn.surrogate.ldap.member-attribute-value-regex=

# Minimum LDAP connection pool size.
# cas.authn.surrogate.ldap.min-pool-size=3

# Name of the LDAP handler.
# cas.authn.surrogate.ldap.name=

# Request that the server return results in batches of a specific size.
# cas.authn.surrogate.ldap.page-size=0

# You may receive unexpected LDAP failures, when CAS is configured to authenticate using {@code DIRECT} or {@code AUTHENTICATED} types and LDAP is locked down to not allow anonymous binds/searches.
# cas.authn.surrogate.ldap.pool-passivator=BIND

# Removes connections from the pool based on how long they have been idle in the available queue.
# cas.authn.surrogate.ldap.prune-period=PT2H

# Duration of time to wait for responses.
# cas.authn.surrogate.ldap.response-timeout=PT5S

# SASL authorization id.
# cas.authn.surrogate.ldap.sasl-authorization-id=

# The SASL mechanism.
# cas.authn.surrogate.ldap.sasl-mechanism=

# SASL mutual auth is enabled?
# cas.authn.surrogate.ldap.sasl-mutual-auth=

# SASL quality of protected.
# cas.authn.surrogate.ldap.sasl-quality-of-protection=

# The SASL realm.
# cas.authn.surrogate.ldap.sasl-realm=

# SASL security strength.
# cas.authn.surrogate.ldap.sasl-security-strength=

# Search handlers.
# cas.authn.surrogate.ldap.search-entry-handlers=

# Whether subtree searching is allowed.
# cas.authn.surrogate.ldap.subtree-search=true

# An optional LDAP validation filter that attempts to look for surrogate/impersonatee account in LDAP once authorization has been granted via {@link #getSurrogateSearchFilter()}.
# cas.authn.surrogate.ldap.surrogate-validation-filter=

# Path of the trust certificates to use for the SSL connection.
# cas.authn.surrogate.ldap.trust-certificates=

# Trust Manager options.
# cas.authn.surrogate.ldap.trust-manager=

# Path to the keystore used to determine which certificates or certificate authorities should be trusted.
# cas.authn.surrogate.ldap.trust-store=

# Password needed to open the truststore.
# cas.authn.surrogate.ldap.trust-store-password=

# The type of trust keystore that determines which certificates or certificate authorities are trusted.
# cas.authn.surrogate.ldap.trust-store-type=

# Whether TLS should be used and enabled when establishing the connection.
# cas.authn.surrogate.ldap.use-start-tls=false

# Whether connections should be validated when loaned out from the pool.
# cas.authn.surrogate.ldap.validate-on-checkout=true

# Period at which pool should be validated.
# cas.authn.surrogate.ldap.validate-period=PT5M

# Whether connections should be validated periodically when the pool is idle.
# cas.authn.surrogate.ldap.validate-periodically=true

# Period at which validation operations may time out.
# cas.authn.surrogate.ldap.validate-timeout=PT5S

LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.

The script itself may be designed as:

import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def (filter,parameters,applicationContext,logger) = args

    logger.info("Configuring LDAP filter")
    filter.setFilter("uid=something")
}

The following parameters are passed to the script:

Parameter	Description
`filter`	`FilterTemplate` to be updated by the script and used for the LDAP query.
`parameters`	Map of query parameters which may be used to construct the final filter.
`applicationContext`	Reference to the Spring `ApplicationContext` reference.
`logger`	The object responsible for issuing log messages such as `logger.info(...)`.

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.

Enterprise Identity for All Earthlings and Beyond

LDAP Surrogate Authentication

LDAP Scriptable Search Filter

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings