LDAP Service Registry
Service registry implementation which stores the services in a LDAP Directory
and attempts to map service records to LDAP entries in order to configure
settings for retrieval, search and persistence of service definitions. By default,
entries are assigned the objectclass
that is casRegisteredService
attribute and are looked up by the uid
attribute.
Support is enabled by adding the following module into the overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-ldap-service-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-ldap-service-registry:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-ldap-service-registry"
}
1
2
3
4
5
6
7
8
9
10
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-ldap-service-registry"
}
Configuration
The default mapper has support for the following optional items:
Field | Default Value |
---|---|
objectClass |
casRegisteredService |
serviceDefinitionAttribute |
description |
idAttribute |
uid |
Service definitions are by default stored inside the serviceDefinitionAttribute
attribute as
JSON objects. The format and syntax of the JSON is identical to that of
JSON Service Registry. That’s all, as far as the schema goes.
The following settings and properties are available from the CAS configuration catalog:
- Required
- Optional
- Signing & Encryption
- Hibernate & JDBC
- Email Servers
- Groovy Scripting
- LDAP & Active Directory
- Authentication
- Password Encoding
- Principal Transformation
- Password Policy
- Notes
cas.service-registry.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:
CAS Property:
|
1 |
cas.service-registry.ldap.base-dn=... |
1
cas:
service-registry:
ldap:
base-dn: "..."
1
java -Dcas.service-registry.ldap.base-dn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_BASE_DN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.base-dn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.bind-credential=
The bind credential to use when connecting to LDAP.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.bind-credential
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.bind-credential=...
1
cas:
service-registry:
ldap:
bind-credential: "..."
1
java -Dcas.service-registry.ldap.bind-credential="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_BIND_CREDENTIAL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.bind-credential="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.bind-dn
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.bind-dn=...
1
cas:
service-registry:
ldap:
bind-dn: "..."
1
java -Dcas.service-registry.ldap.bind-dn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_BIND_DN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.bind-dn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.ldap-url
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.ldap-url=...
1
cas:
service-registry:
ldap:
ldap-url: "..."
1
java -Dcas.service-registry.ldap.ldap-url="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_LDAP_URL="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.ldap-url="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-filter=
User filter to use for searching. Syntax is cn={user}
or cn={0}
.
file:/path/to/GroovyScript.groovy
to fully build the final filter template dynamically.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.search-filter
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-filter=...
1
cas:
service-registry:
ldap:
search-filter: "..."
1
java -Dcas.service-registry.ldap.search-filter="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_FILTER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-filter="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=
The Attribute name case change.
CAS Property:
|
1 |
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=... |
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
case-change:
attribute-name-case-change: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAME_CASE_CHANGE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-name-case-change="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-names=
The Attribute names.
org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].case-change.attribute-names
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-names=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
case-change:
attribute-names: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-names="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_NAMES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-names="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=
The Attribute value case change.
org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].case-change.attribute-value-case-change
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
case-change:
attribute-value-case-change: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_ATTRIBUTE_VALUE_CASE_CHANGE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-value-case-change="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].case-change.dn-case-change=
The Dn case change.
org.apereo.cas.configuration.model.support.ldap.CaseChangeSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].case-change.dn-case-change
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].case-change.dn-case-change=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
case-change:
dn-case-change: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].case-change.dn-case-change="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_CASE_CHANGE_DN_CASE_CHANGE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].case-change.dn-case-change="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=
The Add if exists.
org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].dn-attribute.add-if-exists
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
dn-attribute:
add-if-exists: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_ADD_IF_EXISTS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.add-if-exists="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN
The Dn attribute name.
org.apereo.cas.configuration.model.support.ldap.DnAttributeSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].dn-attribute.dn-attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
dn-attribute:
dn-attribute-name: "entryDN"
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_DN_ATTRIBUTE_DN_ATTRIBUTE_NAME="entryDN"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name="entryDN"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.attribute-names=
The Attribute names.
org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].merge-attribute.attribute-names
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.attribute-names=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
merge-attribute:
attribute-names: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_ATTRIBUTE_NAMES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.attribute-names="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=
The Merge attribute name.
org.apereo.cas.configuration.model.support.ldap.MergeAttributesSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].merge-attribute.merge-attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
merge-attribute:
merge-attribute-name: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_MERGE_ATTRIBUTE_MERGE_ATTRIBUTE_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.base-dn=
The Base dn.
org.apereo.cas.configuration.model.support.ldap.PrimaryGroupIdSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].primary-group-id.base-dn
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.base-dn=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
primary-group-id:
base-dn: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].primary-group-id.base-dn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_BASE_DN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.base-dn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].primary-group-id.group-filter
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
primary-group-id:
group-filter: "(&(objectClass=group)(objectSid={0}))"
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_PRIMARY_GROUP_ID_GROUP_FILTER="(&(objectClass=group)(objectSid={0}))"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.group-filter="(&(objectClass=group)(objectSid={0}))"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].recursive.merge-attributes=
The Merge attributes.
org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].recursive.merge-attributes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].recursive.merge-attributes=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
recursive:
merge-attributes: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].recursive.merge-attributes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_MERGE_ATTRIBUTES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].recursive.merge-attributes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].recursive.search-attribute=
The Search attribute.
org.apereo.cas.configuration.model.support.ldap.RecursiveSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].recursive.search-attribute
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].recursive.search-attribute=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
recursive:
search-attribute: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].recursive.search-attribute="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_RECURSIVE_SEARCH_ATTRIBUTE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].recursive.search-attribute="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].search-referral.limit=10
The default referral limit.
org.apereo.cas.configuration.model.support.ldap.FollowReferralSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].search-referral.limit
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].search-referral.limit=10
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
search-referral:
limit: "10"
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].search-referral.limit="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_REFERRAL_LIMIT="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].search-referral.limit="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers[0].search-result.limit=10
The default referral limit.
org.apereo.cas.configuration.model.support.ldap.FollowResultSearchEntryHandlersProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].search-result.limit
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].search-result.limit=10
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
search-result:
limit: "10"
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].search-result.limit="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_SEARCH_RESULT_LIMIT="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].search-result.limit="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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 theobjectGUID
attribute fetching and conversion. -
OBJECT_SID
: Object sid search entry handler. Handles theobjectSid
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 thememberOf
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.
CAS Property: cas.service-registry.ldap.search-entry-handlers[].type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers[0].type=...
1
cas:
service-registry:
ldap:
search-entry-handlers[0]:
type: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers[0].type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS[0]_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers[0].type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validator.attribute-name=objectClass
Attribute name to use for the compare validator.
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.
CAS Property: cas.service-registry.ldap.validator.attribute-name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.attribute-name=objectClass
1
cas:
service-registry:
ldap:
validator:
attribute-name: "objectClass"
1
java -Dcas.service-registry.ldap.validator.attribute-name="objectClass" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_ATTRIBUTE_NAME="objectClass"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.attribute-name="objectClass"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validator.attribute-value=top
Attribute values to use for the compare validator.
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.
CAS Property: cas.service-registry.ldap.validator.attribute-value
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.attribute-value=top
1
cas:
service-registry:
ldap:
validator:
attribute-value: "top"
1
java -Dcas.service-registry.ldap.validator.attribute-value="top" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_ATTRIBUTE_VALUE="top"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.attribute-value="top"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validator.base-dn=
Base DN to use for the search request of the search validator.
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.
CAS Property: cas.service-registry.ldap.validator.base-dn
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.base-dn=...
1
cas:
service-registry:
ldap:
validator:
base-dn: "..."
1
java -Dcas.service-registry.ldap.validator.base-dn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_BASE_DN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.base-dn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validator.dn=
DN to compare to use for the compare validator.
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.
CAS Property: cas.service-registry.ldap.validator.dn
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.dn=...
1
cas:
service-registry:
ldap:
validator:
dn: "..."
1
java -Dcas.service-registry.ldap.validator.dn="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_DN="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.dn="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validator.scope=OBJECT
Search scope to use for the search request of the search validator.
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.
CAS Property: cas.service-registry.ldap.validator.scope
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.scope=OBJECT
1
cas:
service-registry:
ldap:
validator:
scope: "OBJECT"
1
java -Dcas.service-registry.ldap.validator.scope="OBJECT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_SCOPE="OBJECT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.scope="OBJECT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.
CAS Property: cas.service-registry.ldap.validator.search-filter
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.search-filter=(objectClass=*)
1
cas:
service-registry:
ldap:
validator:
search-filter: "(objectClass=*)"
1
java -Dcas.service-registry.ldap.validator.search-filter="(objectClass=*)" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_SEARCH_FILTER="(objectClass=*)"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.search-filter="(objectClass=*)"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.
CAS Property: cas.service-registry.ldap.validator.type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validator.type=search
1
cas:
service-registry:
ldap:
validator:
type: "search"
1
java -Dcas.service-registry.ldap.validator.type="search" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATOR_TYPE="search"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validator.type="search"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.allow-multiple-dns
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.allow-multiple-dns=...
1
cas:
service-registry:
ldap:
allow-multiple-dns: "..."
1
java -Dcas.service-registry.ldap.allow-multiple-dns="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_ALLOW_MULTIPLE_DNS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.allow-multiple-dns="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.allow-multiple-entries=false
Set if multiple Entries are allowed.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.allow-multiple-entries
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.allow-multiple-entries=...
1
cas:
service-registry:
ldap:
allow-multiple-entries: "..."
1
java -Dcas.service-registry.ldap.allow-multiple-entries="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_ALLOW_MULTIPLE_ENTRIES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.allow-multiple-entries="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.binary-attributes
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.binary-attributes=...
1
cas:
service-registry:
ldap:
binary-attributes: "..."
1
java -Dcas.service-registry.ldap.binary-attributes="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_BINARY_ATTRIBUTES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.binary-attributes="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.block-wait-time
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.block-wait-time=PT3S
1
cas:
service-registry:
ldap:
block-wait-time: "PT3S"
1
java -Dcas.service-registry.ldap.block-wait-time="PT3S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_BLOCK_WAIT_TIME="PT3S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.block-wait-time="PT3S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.connect-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.connect-timeout=PT5S
1
cas:
service-registry:
ldap:
connect-timeout: "PT5S"
1
java -Dcas.service-registry.ldap.connect-timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_CONNECT_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.connect-timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.connection-strategy
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.connection-strategy=...
1
cas:
service-registry:
ldap:
connection-strategy: "..."
1
java -Dcas.service-registry.ldap.connection-strategy="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_CONNECTION_STRATEGY="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.connection-strategy="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.disable-pooling=false
Whether to use a pooled connection factory in components.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.disable-pooling
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.disable-pooling=...
1
cas:
service-registry:
ldap:
disable-pooling: "..."
1
java -Dcas.service-registry.ldap.disable-pooling="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_DISABLE_POOLING="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.disable-pooling="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.fail-fast
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.fail-fast=true
1
cas:
service-registry:
ldap:
fail-fast: "true"
1
java -Dcas.service-registry.ldap.fail-fast="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_FAIL_FAST="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.fail-fast="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.follow-referrals=true
Set if search referrals should be followed.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.follow-referrals
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.follow-referrals=true
1
cas:
service-registry:
ldap:
follow-referrals: "true"
1
java -Dcas.service-registry.ldap.follow-referrals="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_FOLLOW_REFERRALS="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.follow-referrals="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.hostname-verifier
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.hostname-verifier=DEFAULT
1
cas:
service-registry:
ldap:
hostname-verifier: "DEFAULT"
1
java -Dcas.service-registry.ldap.hostname-verifier="DEFAULT" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_HOSTNAME_VERIFIER="DEFAULT"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.hostname-verifier="DEFAULT"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.id-attribute=uid
ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.id-attribute
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.id-attribute=uid
1
cas:
service-registry:
ldap:
id-attribute: "uid"
1
java -Dcas.service-registry.ldap.id-attribute="uid" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_ID_ATTRIBUTE="uid"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.id-attribute="uid"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.idle-time
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.idle-time=PT10M
1
cas:
service-registry:
ldap:
idle-time: "PT10M"
1
java -Dcas.service-registry.ldap.idle-time="PT10M" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_IDLE_TIME="PT10M"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.idle-time="PT10M"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.keystore
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.keystore=...
1
cas:
service-registry:
ldap:
keystore: "..."
1
java -Dcas.service-registry.ldap.keystore="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_KEYSTORE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.keystore="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.keystore-password=
Keystore password.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.keystore-password
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.keystore-password=...
1
cas:
service-registry:
ldap:
keystore-password: "..."
1
java -Dcas.service-registry.ldap.keystore-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_KEYSTORE_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.keystore-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.keystore-type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.keystore-type=...
1
cas:
service-registry:
ldap:
keystore-type: "..."
1
java -Dcas.service-registry.ldap.keystore-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_KEYSTORE_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.keystore-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.load-filter=(objectClass=%s)
The load filter used to load entries by the #objectClass
. This is typically used to load all definitions that might be mapped to a service definition. The search filter used to load entries by the #idAttribute
. This is typically used to load a specific service definition by its id during search operations.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.load-filter
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.load-filter=(objectClass=%s)
1
cas:
service-registry:
ldap:
load-filter: "(objectClass=%s)"
1
java -Dcas.service-registry.ldap.load-filter="(objectClass=%s)" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_LOAD_FILTER="(objectClass=%s)"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.load-filter="(objectClass=%s)"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.max-pool-size
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.max-pool-size=10
1
cas:
service-registry:
ldap:
max-pool-size: "10"
1
java -Dcas.service-registry.ldap.max-pool-size="10" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_MAX_POOL_SIZE="10"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.max-pool-size="10"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.min-pool-size
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.min-pool-size=3
1
cas:
service-registry:
ldap:
min-pool-size: "3"
1
java -Dcas.service-registry.ldap.min-pool-size="3" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_MIN_POOL_SIZE="3"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.min-pool-size="3"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.name=
Name of the LDAP handler.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.name
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.name=...
1
cas:
service-registry:
ldap:
name: "..."
1
java -Dcas.service-registry.ldap.name="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_NAME="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.name="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.object-class=casRegisteredService
Object class used for the registered service entry in LDAP.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.object-class
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.object-class=casRegisteredService
1
cas:
service-registry:
ldap:
object-class: "casRegisteredService"
1
java -Dcas.service-registry.ldap.object-class="casRegisteredService" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_OBJECT_CLASS="casRegisteredService"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.object-class="casRegisteredService"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.page-size
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.page-size=0
1
cas:
service-registry:
ldap:
page-size: "0"
1
java -Dcas.service-registry.ldap.page-size="0" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_PAGE_SIZE="0"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.page-size="0"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.pool-passivator
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.pool-passivator=BIND
1
cas:
service-registry:
ldap:
pool-passivator: "BIND"
1
java -Dcas.service-registry.ldap.pool-passivator="BIND" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_POOL_PASSIVATOR="BIND"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.pool-passivator="BIND"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.prune-period
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.prune-period=PT2H
1
cas:
service-registry:
ldap:
prune-period: "PT2H"
1
java -Dcas.service-registry.ldap.prune-period="PT2H" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_PRUNE_PERIOD="PT2H"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.prune-period="PT2H"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.response-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.response-timeout=PT5S
1
cas:
service-registry:
ldap:
response-timeout: "PT5S"
1
java -Dcas.service-registry.ldap.response-timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_RESPONSE_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.response-timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-authorization-id=
SASL authorization id.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-authorization-id
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-authorization-id=...
1
cas:
service-registry:
ldap:
sasl-authorization-id: "..."
1
java -Dcas.service-registry.ldap.sasl-authorization-id="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_AUTHORIZATION_ID="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-authorization-id="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-mechanism=
The SASL mechanism.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-mechanism
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-mechanism=...
1
cas:
service-registry:
ldap:
sasl-mechanism: "..."
1
java -Dcas.service-registry.ldap.sasl-mechanism="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_MECHANISM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-mechanism="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-mutual-auth=
SASL mutual auth is enabled?
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-mutual-auth
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-mutual-auth=...
1
cas:
service-registry:
ldap:
sasl-mutual-auth: "..."
1
java -Dcas.service-registry.ldap.sasl-mutual-auth="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_MUTUAL_AUTH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-mutual-auth="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-quality-of-protection=
SASL quality of protected.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-quality-of-protection
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-quality-of-protection=...
1
cas:
service-registry:
ldap:
sasl-quality-of-protection: "..."
1
java -Dcas.service-registry.ldap.sasl-quality-of-protection="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_QUALITY_OF_PROTECTION="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-quality-of-protection="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-realm=
The SASL realm.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-realm
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-realm=...
1
cas:
service-registry:
ldap:
sasl-realm: "..."
1
java -Dcas.service-registry.ldap.sasl-realm="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_REALM="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-realm="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.sasl-security-strength=
SASL security strength.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.sasl-security-strength
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.sasl-security-strength=...
1
cas:
service-registry:
ldap:
sasl-security-strength: "..."
1
java -Dcas.service-registry.ldap.sasl-security-strength="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SASL_SECURITY_STRENGTH="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.sasl-security-strength="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.search-entry-handlers=
Search handlers.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.search-entry-handlers
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.search-entry-handlers=...
1
cas:
service-registry:
ldap:
search-entry-handlers: "..."
1
java -Dcas.service-registry.ldap.search-entry-handlers="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SEARCH_ENTRY_HANDLERS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.search-entry-handlers="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.service-definition-attribute=description
Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.service-definition-attribute
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.service-definition-attribute=description
1
cas:
service-registry:
ldap:
service-definition-attribute: "description"
1
java -Dcas.service-registry.ldap.service-definition-attribute="description" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SERVICE_DEFINITION_ATTRIBUTE="description"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.service-definition-attribute="description"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.subtree-search=true
Whether subtree searching is allowed.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.subtree-search
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.subtree-search=true
1
cas:
service-registry:
ldap:
subtree-search: "true"
1
java -Dcas.service-registry.ldap.subtree-search="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_SUBTREE_SEARCH="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.subtree-search="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.trust-certificates
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.trust-certificates=...
1
cas:
service-registry:
ldap:
trust-certificates: "..."
1
java -Dcas.service-registry.ldap.trust-certificates="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_TRUST_CERTIFICATES="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.trust-certificates="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.trust-manager
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.trust-manager=...
1
cas:
service-registry:
ldap:
trust-manager: "..."
1
java -Dcas.service-registry.ldap.trust-manager="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_TRUST_MANAGER="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.trust-manager="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.trust-store
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.trust-store=...
1
cas:
service-registry:
ldap:
trust-store: "..."
1
java -Dcas.service-registry.ldap.trust-store="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_TRUST_STORE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.trust-store="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.trust-store-password=
Password needed to open the truststore.
This setting supports the Spring Expression Language.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.trust-store-password
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.trust-store-password=...
1
cas:
service-registry:
ldap:
trust-store-password: "..."
1
java -Dcas.service-registry.ldap.trust-store-password="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_TRUST_STORE_PASSWORD="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.trust-store-password="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.trust-store-type
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.trust-store-type=...
1
cas:
service-registry:
ldap:
trust-store-type: "..."
1
java -Dcas.service-registry.ldap.trust-store-type="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_TRUST_STORE_TYPE="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.trust-store-type="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.use-start-tls=false
Whether TLS should be used and enabled when establishing the connection.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.use-start-tls
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.use-start-tls=...
1
cas:
service-registry:
ldap:
use-start-tls: "..."
1
java -Dcas.service-registry.ldap.use-start-tls="..." -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_USE_START_TLS="..."
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.use-start-tls="..."
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validate-on-checkout=true
Whether connections should be validated when loaned out from the pool.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.validate-on-checkout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validate-on-checkout=true
1
cas:
service-registry:
ldap:
validate-on-checkout: "true"
1
java -Dcas.service-registry.ldap.validate-on-checkout="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATE_ON_CHECKOUT="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validate-on-checkout="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.validate-period
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validate-period=PT5M
1
cas:
service-registry:
ldap:
validate-period: "PT5M"
1
java -Dcas.service-registry.ldap.validate-period="PT5M" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATE_PERIOD="PT5M"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validate-period="PT5M"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.ldap.validate-periodically=true
Whether connections should be validated periodically when the pool is idle.
org.apereo.cas.configuration.model.support.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.validate-periodically
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validate-periodically=true
1
cas:
service-registry:
ldap:
validate-periodically: "true"
1
java -Dcas.service-registry.ldap.validate-periodically="true" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATE_PERIODICALLY="true"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validate-periodically="true"
cas.war
with an embedded server container and can be found in the build/libs
directory.
cas.service-registry.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.ldap.serviceregistry.LdapServiceRegistryProperties.
CAS Property: cas.service-registry.ldap.validate-timeout
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
.properties
files:
1
cas.service-registry.ldap.validate-timeout=PT5S
1
cas:
service-registry:
ldap:
validate-timeout: "PT5S"
1
java -Dcas.service-registry.ldap.validate-timeout="PT5S" -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory. Note the placement of the system property which must be
specified before the CAS web application is launched.
1
2
3
export CAS_SERVICE_REGISTRY_LDAP_VALIDATE_TIMEOUT="PT5S"
java -jar build/libs/cas.war
cas.war
with an embedded server container and can be found in the build/libs
directory.
1
java -jar build/libs/cas.war --cas.service-registry.ldap.validate-timeout="PT5S"
cas.war
with an embedded server container and can be found in the build/libs
directory.
LDAP Scriptable Search Filter
LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.
The script itself may be designed as:
1
2
3
4
5
6
7
8
9
import org.ldaptive.*
import org.springframework.context.*
def run(Object[] args) {
def (filter,parameters,applicationContext,logger) = args
logger.info("Configuring LDAP filter")
filter.setFilter("uid=something")
}
The following parameters are passed to the script:
Parameter | Description |
---|---|
filter |
FilterTemplate to be updated by the script and used for the LDAP query. |
parameters |
Map of query parameters which may be used to construct the final filter. |
applicationContext |
Reference to the Spring ApplicationContext reference. |
logger |
The object responsible for issuing log messages such as logger.info(...) . |
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Auto Initialization
Upon startup and configuration permitting, the registry is able to auto initialize itself from default JSON service definitions available to CAS. See this guide for more info.