X.509 Authentication
CAS X.509 authentication components provide a mechanism to authenticate users who present client certificates during
the SSL/TLS handshake process. The X.509 components require configuration outside the CAS application since the
SSL handshake happens outside the servlet layer where the CAS application resides. There is no particular requirement
on deployment architecture (i.e. Apache reverse proxy, load balancer SSL termination) other than any client
certificate presented in the SSL handshake be accessible to the servlet container as a request attribute named
javax.servlet.request.X509Certificate. This happens naturally for configurations that terminate SSL connections
directly at the servlet container and when using Apache/mod_jk; for other architectures it may be necessary to do
additional work.
CAS can be configured to extract an X509 certificate from a header created by a proxy running in front of CAS.
Overview
Certificates are exchanged as part of the SSL (also called TLS) initialization that
occurs when any browser connects to an https website.
A certain number of public CA certificates are preinstalled in each browser. It is assumed that:
- Your organization is already able to generate and distribute certificates that a user can install in their browser
- Somewhere in that certificate there is a field that contains the Principal name or can be easily mapped to the Principal name that CAS can use.
The remaining problem is to make sure that the browsers, servers and Java are all prepared to support these institutional certificates and, ideally, that these institutional certificates will be the only ones exchanged when a browser connects to CAS.
Flow
When a browser connects to CAS over an https: URL, the server identifies itself by sending its own certificate. The browser must already have installed a certificate identifying and trusting the CA that issued the CAS Server certificate. If the browser is not already prepared to trust the CAS server, then an error message pops up saying the server is not trusted.
After the Server sends the certificate that identifies itself, it then can then send a list of names of Certificate Authorities from which it is willing to accept certificates. Ideally, this list will include only one name; the name of the internal institutional CA that issues internal intranet-only certificates that internally contain a field with the CAS Principal name.
A user may install any number of certificates into the browser from any number of CA’s. If only one of these certificates comes from a CA named in the list of acceptable CA’s sent by the server, then most browsers will automatically send that one certificate without asking, and some can be configured in to not ask when there is only one possible choice. This presents a user experience where CAS becomes transparent to the user after some initial setup and the login happens automatically. However, if the server hosting CAS sends more than one CA name in the list and that matches more than one certificate on the browser, then the user will get prompted to choose a Certificate from the list. A user interaction defeats much of the purpose of certificates in CAS.
Note that CAS does not control this exchange. It is handled by the underlying server. You may not have the control to require the server to vend only one CA name when a browser visits CAS. So if you want to use X.509 certificates in CAS, you should consider this requirement when choosing the hosting environment. The ideal situation is to select a server that can identify itself with a public certificate issued by something like VeriSign or InCommon but then require the client certificate only be issued by the internal corporate/campus authority.
When CAS gets control, a user certificate may have been presented by the browser and be stored in the request. The CAS X.509 authentication machinery examines that certificate and verifies that it was issued by the trusted institutional authority. Then CAS searches through the fields of the certificate to identify one or more fields that can be turned into the principal identifier that the applications expect.
While an institution can have one certificate authority that issues certificates to employees, clients, machines, services, and devices, it is more common for the institution to have a single “root” certificate authority that in its entire existence only issues a handful of certificates. Each of these certificates identifies a secondary Certificate Authority that issues a particular category of certificates (to students, staff, servers, etc.). It is possible to configure CAS to trust the root Authority and, implicitly, all the secondary authorities that it creates. This, however, makes CAS only as secure as the least reliable secondary Certificate Authority created by the institution. At some point in the future, some manager will buy a product that requires a new class of certificates. He will ask to create a Certificate Authority that vends these certificates to the machines running this new product. He will then turn administration of this mess over to a junior programmer or consultant. If CAS trusts any certificate issued by any Authority created by the root, it will trust a fraudulent certificate forged by someone who has acquired control of what was intended to be a special purpose, isolated CA. Therefore, it is better to configure CAS to only accept certificates from the one secondary CA specifically expected to issue credentials to individuals, instead of trusting the institutional root CA.
Configuration
X.509 support is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-x509-webflow</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-x509-webflow:${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-x509-webflow"
}
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-x509-webflow"
}
The X.509 handler technically performs additional checks after the real SSL client authentication process performed by the Web server terminating the SSL connection. Since an SSL peer may be configured to accept a wide range of certificates, the CAS X.509 handler provides a number of properties that place additional restrictions on acceptable client certificates.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.principal-transformation.groovy.location=
The location of the resource. Resources can be URLS, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.
|
cas.authn.x509.principal.principal-transformation.groovy.location=
The location of the resource. Resources can be URLS, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.
|
cas.authn.x509.principal-type=SUBJECT_DN
Indicates the type of principal resolution for X509. Available values are as follows:
|
cas.authn.x509.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
|
cas.authn.x509.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.x509.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
|
cas.authn.x509.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
|
cas.authn.x509.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.active-attribute-repository-ids=
Activated attribute repository identifiers that should be used for fetching attributes if attribute resolution is enabled. The list here may include identifiers separated by comma.
|
cas.authn.x509.principal.attribute-resolution-enabled=
Whether attribute repositories should be contacted to fetch person attributes. Defaults to true if not set.
|
cas.authn.x509.principal.principal-attribute=
Attribute name to use to indicate the identifier of the principal constructed. If the attribute is blank or has no values, the default principal id will be used determined by the underlying authentication engine. The principal id attribute usually is removed from the collection of attributes collected, though this behavior depends on the schematics of the underlying authentication strategy.
|
cas.authn.x509.principal.principal-resolution-conflict-strategy=last
In the event that the principal resolution engine resolves more than one principal, (specially if such principals in the chain have different identifiers), this setting determines strategy by which the principal id would be chosen from the chain. Accepted values are:
|
cas.authn.x509.principal.principal-resolution-failure-fatal=
When true, throws an error back indicating that principal resolution has failed and no principal can be found based on the authentication requirements. Otherwise, logs the condition as an error without raising a catastrophic error.
|
cas.authn.x509.principal.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
|
cas.authn.x509.principal.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.x509.principal.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
|
cas.authn.x509.principal.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.return-null=
Return a null principal object if no attributes can be found for the principal.
|
cas.authn.x509.principal.use-existing-principal-id=
Uses an existing principal id that may have already been established in order to run person directory queries. This is generally useful in situations where authentication is delegated to an external identity provider and a principal is first established to then query an attribute source.
|
cas.authn.x509.cache-disk-overflow=false
When CRLs are cached, indicate whether cache should overflow to disk.
|
cas.authn.x509.cache-disk-size=100MB
Size of cache on disk.
|
cas.authn.x509.cache-eternal=false
When CRLs are cached, indicate if cache items should be eternal.
|
cas.authn.x509.cache-max-elements-in-memory=1000
When CRLs are cached, indicate maximum number of elements kept in memory.
|
cas.authn.x509.cache-time-to-live-seconds=4
When CRLs are cached, indicate the time-to-live of cache items.
|
cas.authn.x509.check-all=false
Whether revocation checking should check all resources, or stop at first one.
|
cas.authn.x509.check-key-usage=false
Deployer supplied setting to check the KeyUsage extension.
|
cas.authn.x509.cn-edipi.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
cas.authn.x509.cn-edipi.extract-edipi-as-attribute=false
Whether to extract EDIPI as an attribute, regardless of principal resolver type.
|
cas.authn.x509.crl-expired-policy=DENY
If the CRL has expired, activate the this policy. Activated if
|
cas.authn.x509.crl-fetcher=RESOURCE
Options to describe how to fetch CRL resources. To fetch CRLs, the following options are available:
|
cas.authn.x509.crl-resource-expired-policy=DENY
If the CRL resource has expired, activate the this policy. Activated if
|
cas.authn.x509.crl-resource-unavailable-policy=DENY
If the CRL resource is unavailable, activate the this policy. Activated if
|
cas.authn.x509.crl-resources=
List of CRL resources to use for fetching.
|
cas.authn.x509.crl-unavailable-policy=DENY
If the CRL is unavailable, activate the this policy. Activated if
|
cas.authn.x509.extract-cert=false
Whether to extract certificate from request. The default implementation extracts certificate from header via Tomcat SSLValve parsing logic and using the
|
cas.authn.x509.max-path-length=1
Deployer supplied setting for maximum pathLength in a SUPPLIED certificate.
|
cas.authn.x509.max-path-length-allow-unspecified=false
Deployer supplied setting to allow unlimited pathLength in a SUPPLIED certificate.
|
cas.authn.x509.mixed-mode=true
Determine whether X509 authentication should allow other forms of authentication such as username/password. If this setting is turned off, typically the ability to view the login form as the primary form of authentication is turned off.
|
cas.authn.x509.name=
The authentication handler name.
|
cas.authn.x509.order=
The order of the authentication handler in the chain.
|
cas.authn.x509.principal-descriptor=
The principal descriptor used for principal resolution when type is set to
|
cas.authn.x509.refresh-interval-seconds=3600
The refresh interval of the internal scheduler in cases where CRL revocation checking is done via resources.
|
cas.authn.x509.reg-ex-subject-dn-pattern=.+
The pattern that authorizes an acceptable certificate by its subject dn.
|
cas.authn.x509.reg-ex-trusted-issuer-dn-pattern=
The compiled pattern supplied by the deployer.
|
cas.authn.x509.require-key-usage=false
Deployer supplied setting to force require the correct KeyUsage extension.
|
cas.authn.x509.revocation-checker=NONE
Revocation certificate checking can be carried out in one of the following ways:
|
cas.authn.x509.revocation-policy-threshold=172800
Threshold value if expired CRL revocation policy is to be handled via threshold.
|
cas.authn.x509.rfc822-email.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
cas.authn.x509.serial-no-dn.serial-number-prefix=SERIALNUMBER=
The serial number prefix used for principal resolution when type is set to
|
cas.authn.x509.serial-no-dn.value-delimiter=,
Value delimiter used for principal resolution when type is set to
|
cas.authn.x509.serial-no.principal-hex-s-n-zero-padding=false
If radix hex padding should be used when
|
cas.authn.x509.serial-no.principal-s-n-radix=0
Radix used when
|
cas.authn.x509.ssl-header-name=ssl_client_cert
The name of the header to consult for an X509 cert (e.g. when behind proxy).
|
cas.authn.x509.subject-alt-name.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
cas.authn.x509.subject-dn.format=DEFAULT
Format of subject DN to use. Available values are as follows:
|
cas.authn.x509.throw-on-fetch-failure=false
When CRL revocation checking is done via distribution points, decide if fetch failures should throw errors.
|
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
5
String run(final Object... args) {
def providedUsername = args[0]
def logger = args[1]
return providedUsername.concat("SomethingElse")
}
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
X509 Certificate Extraction
These settings can be used to turn on and configure CAS to extract an X509 certificate from a base64 encoded certificate on a HTTP request header (placed there by a proxy in front of CAS). If this is set to true, it is important that the proxy cannot be bypassed by users and that the proxy ensures the header never originates from the browser.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.extract-cert=false
Whether to extract certificate from request. The default implementation extracts certificate from header via Tomcat SSLValve parsing logic and using the
|
cas.authn.x509.ssl-header-name=ssl_client_cert
The name of the header to consult for an X509 cert (e.g. when behind proxy).
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
The specific parsing logic for the certificate is compatible
with the Apache Tomcat SSLValve which can work with headers set by
Apache HTTPD, Nginx, Haproxy, BigIP F5, etc.
X509 Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.principal-transformation.groovy.location=
The location of the resource. Resources can be URLS, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.
|
cas.authn.x509.principal.principal-transformation.groovy.location=
The location of the resource. Resources can be URLS, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256. You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.
|
cas.authn.x509.principal-type=SUBJECT_DN
Indicates the type of principal resolution for X509. Available values are as follows:
|
cas.authn.x509.principal-type=SUBJECT_DN
Indicates the type of principal resolution for X509. Available values are as follows:
|
cas.authn.x509.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
|
cas.authn.x509.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.x509.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
|
cas.authn.x509.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
|
cas.authn.x509.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.active-attribute-repository-ids=
Activated attribute repository identifiers that should be used for fetching attributes if attribute resolution is enabled. The list here may include identifiers separated by comma.
|
cas.authn.x509.principal.attribute-resolution-enabled=
Whether attribute repositories should be contacted to fetch person attributes. Defaults to true if not set.
|
cas.authn.x509.principal.principal-attribute=
Attribute name to use to indicate the identifier of the principal constructed. If the attribute is blank or has no values, the default principal id will be used determined by the underlying authentication engine. The principal id attribute usually is removed from the collection of attributes collected, though this behavior depends on the schematics of the underlying authentication strategy.
|
cas.authn.x509.principal.principal-resolution-conflict-strategy=last
In the event that the principal resolution engine resolves more than one principal, (specially if such principals in the chain have different identifiers), this setting determines strategy by which the principal id would be chosen from the chain. Accepted values are:
|
cas.authn.x509.principal.principal-resolution-failure-fatal=
When true, throws an error back indicating that principal resolution has failed and no principal can be found based on the authentication requirements. Otherwise, logs the condition as an error without raising a catastrophic error.
|
cas.authn.x509.principal.principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
|
cas.authn.x509.principal.principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.x509.principal.principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
|
cas.authn.x509.principal.principal-transformation.prefix=
Prefix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.principal-transformation.suffix=
Suffix to add to the principal id prior to authentication.
|
cas.authn.x509.principal.return-null=
Return a null principal object if no attributes can be found for the principal.
|
cas.authn.x509.principal.use-existing-principal-id=
Uses an existing principal id that may have already been established in order to run person directory queries. This is generally useful in situations where authentication is delegated to an external identity provider and a principal is first established to then query an attribute source.
|
cas.authn.x509.principal-descriptor=
The principal descriptor used for principal resolution when type is set to
|
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
5
String run(final Object... args) {
def providedUsername = args[0]
def logger = args[1]
return providedUsername.concat("SomethingElse")
}
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
SUBJECT_DN Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.subject-dn.format=DEFAULT
Format of subject DN to use. Available values are as follows:
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
CN_EDIPI Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.cn-edipi.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
cas.authn.x509.cn-edipi.extract-edipi-as-attribute=false
Whether to extract EDIPI as an attribute, regardless of principal resolver type.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
RFC822_EMAIL Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.rfc822-email.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
SERIAL_NO Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.serial-no-dn.serial-number-prefix=SERIALNUMBER=
The serial number prefix used for principal resolution when type is set to
|
cas.authn.x509.serial-no-dn.value-delimiter=,
Value delimiter used for principal resolution when type is set to
|
cas.authn.x509.serial-no.principal-hex-s-n-zero-padding=false
If radix hex padding should be used when
|
cas.authn.x509.serial-no.principal-s-n-radix=0
Radix used when
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
SERIAL_NO_DN Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.serial-no-dn.serial-number-prefix=SERIALNUMBER=
The serial number prefix used for principal resolution when type is set to
|
cas.authn.x509.serial-no-dn.value-delimiter=,
Value delimiter used for principal resolution when type is set to
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
SUBJECT_ALT_NAME Principal Resolution
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.subject-alt-name.alternate-principal-attribute=
Attribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present. This only applies to principal resolvers that are looking for attributes in the certificate that are not common to all certificates. (e.g. subjectDn rather than null where null would allow falling through to another authentication mechanism. Currently supported values are: subjectDn, sigAlgOid, subjectX500Principal.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
X509 CRL Fetching / Revocation
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.crl-expired-policy=DENY
If the CRL has expired, activate the this policy. Activated if
|
cas.authn.x509.crl-fetcher=RESOURCE
Options to describe how to fetch CRL resources. To fetch CRLs, the following options are available:
|
cas.authn.x509.crl-resource-expired-policy=DENY
If the CRL resource has expired, activate the this policy. Activated if
|
cas.authn.x509.crl-resource-unavailable-policy=DENY
If the CRL resource is unavailable, activate the this policy. Activated if
|
cas.authn.x509.crl-resources=
List of CRL resources to use for fetching.
|
cas.authn.x509.crl-unavailable-policy=DENY
If the CRL is unavailable, activate the this policy. Activated if
|
cas.authn.x509.revocation-checker=NONE
Revocation certificate checking can be carried out in one of the following ways:
|
cas.authn.x509.cache-disk-overflow=false
When CRLs are cached, indicate whether cache should overflow to disk.
|
cas.authn.x509.cache-disk-size=100MB
Size of cache on disk.
|
cas.authn.x509.cache-eternal=false
When CRLs are cached, indicate if cache items should be eternal.
|
cas.authn.x509.cache-max-elements-in-memory=1000
When CRLs are cached, indicate maximum number of elements kept in memory.
|
cas.authn.x509.cache-time-to-live-seconds=4
When CRLs are cached, indicate the time-to-live of cache items.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
X509 LDAP Integration
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.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.authn.x509.ldap.bind-credential=
The bind credential to use when connecting to LDAP.
|
cas.authn.x509.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:
|
cas.authn.x509.ldap.ldap-url=
The LDAP url to the server. More than one may be specified, separated by space and/or comma.
|
cas.authn.x509.ldap.search-filter=
User filter to use for searching. Syntax is file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.
|
cas.authn.x509.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=
The Attribute name case change.
|
cas.authn.x509.ldap.search-entry-handlers[0].case-change.attribute-names=
The Attribute names.
|
cas.authn.x509.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=
The Attribute value case change.
|
cas.authn.x509.ldap.search-entry-handlers[0].case-change.dn-case-change=
The Dn case change.
|
cas.authn.x509.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=
The Add if exists.
|
cas.authn.x509.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN
The Dn attribute name.
|
cas.authn.x509.ldap.search-entry-handlers[0].merge-attribute.attribute-names=
The Attribute names.
|
cas.authn.x509.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=
The Merge attribute name.
|
cas.authn.x509.ldap.search-entry-handlers[0].primary-group-id.base-dn=
The Base dn.
|
cas.authn.x509.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
The Group filter.
|
cas.authn.x509.ldap.search-entry-handlers[0].recursive.merge-attributes=
The Merge attributes.
|
cas.authn.x509.ldap.search-entry-handlers[0].recursive.search-attribute=
The Search attribute.
|
cas.authn.x509.ldap.search-entry-handlers[0].search-referral.limit=10
The default referral limit.
|
cas.authn.x509.ldap.search-entry-handlers[0].search-result.limit=10
The default referral limit.
|
cas.authn.x509.ldap.search-entry-handlers[0].type=
The type of search entry handler to choose. Available values are as follows:
|
cas.authn.x509.ldap.validator.attribute-name=objectClass
Attribute name to use for the compare validator.
|
cas.authn.x509.ldap.validator.attribute-value=top
Attribute values to use for the compare validator.
|
cas.authn.x509.ldap.validator.base-dn=
Base DN to use for the search request of the search validator.
|
cas.authn.x509.ldap.validator.dn=
DN to compare to use for the compare validator.
|
cas.authn.x509.ldap.validator.scope=OBJECT
Search scope to use for the search request of the search validator.
|
cas.authn.x509.ldap.validator.search-filter=(objectClass=*)
Search filter to use for the search request of the search validator.
|
cas.authn.x509.ldap.validator.type=search
Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:
|
cas.authn.x509.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.
|
cas.authn.x509.ldap.allow-multiple-entries=false
Set if multiple Entries are allowed.
|
cas.authn.x509.ldap.binary-attributes=
Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
|
cas.authn.x509.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
|
cas.authn.x509.ldap.certificate-attribute=certificateRevocationList
The LDAP attribute that holds the certificate revocation list.
|
cas.authn.x509.ldap.connect-timeout=PT5S
Sets the maximum amount of time that connects will block. This settings supports the
|
cas.authn.x509.ldap.connection-strategy=
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
|
cas.authn.x509.ldap.disable-pooling=false
Whether to use a pooled connection factory in components.
|
cas.authn.x509.ldap.fail-fast=true
Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
|
cas.authn.x509.ldap.follow-referrals=true
Set if search referrals should be followed.
|
cas.authn.x509.ldap.hostname-verifier=DEFAULT
Hostname verification options. Available values are as follows:
|
cas.authn.x509.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
|
cas.authn.x509.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.
|
cas.authn.x509.ldap.keystore-password=
Keystore password. This setting supports the Spring Expression Language.
|
cas.authn.x509.ldap.keystore-type=
The type of keystore.
|
cas.authn.x509.ldap.max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow.
|
cas.authn.x509.ldap.min-pool-size=3
Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to
|
cas.authn.x509.ldap.name=
Name of the LDAP handler.
|
cas.authn.x509.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.
|
cas.authn.x509.ldap.pool-passivator=BIND
You may receive unexpected LDAP failures, when CAS is configured to authenticate using
|
cas.authn.x509.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
|
cas.authn.x509.ldap.response-timeout=PT5S
Duration of time to wait for responses. This settings supports the
|
cas.authn.x509.ldap.sasl-authorization-id=
SASL authorization id.
|
cas.authn.x509.ldap.sasl-mechanism=
The SASL mechanism.
|
cas.authn.x509.ldap.sasl-mutual-auth=
SASL mutual auth is enabled?
|
cas.authn.x509.ldap.sasl-quality-of-protection=
SASL quality of protected.
|
cas.authn.x509.ldap.sasl-realm=
The SASL realm.
|
cas.authn.x509.ldap.sasl-security-strength=
SASL security strength.
|
cas.authn.x509.ldap.search-entry-handlers=
Search handlers.
|
cas.authn.x509.ldap.subtree-search=true
Whether subtree searching is allowed.
|
cas.authn.x509.ldap.trust-certificates=
Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.
|
cas.authn.x509.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: *
|
cas.authn.x509.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.
|
cas.authn.x509.ldap.trust-store-password=
Password needed to open the truststore. This setting supports the Spring Expression Language.
|
cas.authn.x509.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
|
cas.authn.x509.ldap.use-start-tls=false
Whether TLS should be used and enabled when establishing the connection.
|
cas.authn.x509.ldap.validate-on-checkout=true
Whether connections should be validated when loaned out from the pool.
|
cas.authn.x509.ldap.validate-period=PT5M
Period at which pool should be validated. This settings supports the
|
cas.authn.x509.ldap.validate-periodically=true
Whether connections should be validated periodically when the pool is idle.
|
cas.authn.x509.ldap.validate-timeout=PT5S
Period at which validation operations may time out. This settings supports the
|
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
10
11
12
import org.ldaptive.*
import org.springframework.context.*
def run(Object[] args) {
def filter = (FilterTemplate) args[0]
def parameters = (Map) args[1]
def applicationContext = (ApplicationContext) args[2]
def logger = args[3]
logger.info("Configuring LDAP filter")
filter.setFilter("uid=something")
}
The following parameters are passed to the script:
| Parameter | Description |
|---|---|
filter |
FilterTemplate to be updated by the script and used for the LDAP query. |
parameters |
Map of query parameters which may be used to construct the final filter. |
applicationContext |
Reference to the Spring ApplicationContext reference. |
logger |
The object responsible for issuing log messages such as logger.info(...). |
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
You may also fetch additional LDAP attributes using the principal extracted from the X509 certificate:
The following settings and properties are available from the CAS configuration catalog:
cas.authn.attribute-repository.ldap[0].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.authn.attribute-repository.ldap[0].bind-credential=
The bind credential to use when connecting to LDAP.
|
cas.authn.attribute-repository.ldap[0].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:
|
cas.authn.attribute-repository.ldap[0].ldap-url=
The LDAP url to the server. More than one may be specified, separated by space and/or comma.
|
cas.authn.attribute-repository.ldap[0].search-filter=
User filter to use for searching.
Syntax is file:/path/to/GroovyScript.groovy
to fully build the final filter template dynamically.
|
cas.authn.attribute-repository.ldap=
Retrieve attributes from multiple LDAP servers.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-name-case-change=
The Attribute name case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-names=
The Attribute names.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-value-case-change=
The Attribute value case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.dn-case-change=
The Dn case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.dn-attribute.add-if-exists=
The Add if exists.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name=entryDN
The Dn attribute name.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.merge-attribute.attribute-names=
The Attribute names.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name=
The Merge attribute name.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.primary-group-id.base-dn=
The Base dn.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
The Group filter.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.recursive.merge-attributes=
The Merge attributes.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.recursive.search-attribute=
The Search attribute.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.search-referral.limit=10
The default referral limit.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.search-result.limit=10
The default referral limit.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.type=
The type of search entry handler to choose. Available values are as follows:
|
cas.authn.attribute-repository.ldap[0].validator.attribute-name=objectClass
Attribute name to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.attribute-value=top
Attribute values to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.base-dn=EMPTY
Base DN to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.dn=EMPTY
DN to compare to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.scope=OBJECT
Search scope to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.search-filter=(objectClass=*)
Search filter to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.type=search
Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:
|
cas.authn.attribute-repository.ldap[0].allow-multiple-dns=
Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
|
cas.authn.attribute-repository.ldap[0].allow-multiple-entries=
Set if multiple Entries are allowed.
|
cas.authn.attribute-repository.ldap[0].attributes=
Map of attributes to fetch from the source. Attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the data source and the value is the attribute name CAS should use for virtual renames. Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute. To fetch and resolve attributes that carry tags/options, consider tagging the mapped attribute as such:affiliation=affiliation.
|
cas.authn.attribute-repository.ldap[0].binary-attributes=
Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
|
cas.authn.attribute-repository.ldap[0].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
|
cas.authn.attribute-repository.ldap[0].connect-timeout=PT5S
Sets the maximum amount of time that connects will block. This settings supports the
|
cas.authn.attribute-repository.ldap[0].connection-strategy=
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
|
cas.authn.attribute-repository.ldap[0].disable-pooling=
Whether to use a pooled connection factory in components.
|
cas.authn.attribute-repository.ldap[0].fail-fast=true
Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
|
cas.authn.attribute-repository.ldap[0].follow-referrals=true
Set if search referrals should be followed.
|
cas.authn.attribute-repository.ldap[0].hostname-verifier=DEFAULT
Hostname verification options. Available values are as follows:
|
cas.authn.attribute-repository.ldap[0].id=
A value can be assigned to this field to uniquely identify this resolver.
|
cas.authn.attribute-repository.ldap[0].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
|
cas.authn.attribute-repository.ldap[0].keystore=
Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].keystore-password=
Keystore password. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].keystore-type=
The type of keystore.
|
cas.authn.attribute-repository.ldap[0].max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow.
|
cas.authn.attribute-repository.ldap[0].min-pool-size=3
Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to
|
cas.authn.attribute-repository.ldap[0].name=
Name of the LDAP handler.
|
cas.authn.attribute-repository.ldap[0].order=
The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.
|
cas.authn.attribute-repository.ldap[0].page-size=
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.
|
cas.authn.attribute-repository.ldap[0].pool-passivator=BIND
You may receive unexpected LDAP failures, when CAS is configured to authenticate
using
|
cas.authn.attribute-repository.ldap[0].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
|
cas.authn.attribute-repository.ldap[0].query-attributes=
Define a
|
cas.authn.attribute-repository.ldap[0].response-timeout=PT5S
Duration of time to wait for responses. This settings supports the
|
cas.authn.attribute-repository.ldap[0].sasl-authorization-id=
SASL authorization id.
|
cas.authn.attribute-repository.ldap[0].sasl-mechanism=
The SASL mechanism.
|
cas.authn.attribute-repository.ldap[0].sasl-mutual-auth=
SASL mutual auth is enabled?
|
cas.authn.attribute-repository.ldap[0].sasl-quality-of-protection=
SASL quality of protected.
|
cas.authn.attribute-repository.ldap[0].sasl-realm=
The SASL realm.
|
cas.authn.attribute-repository.ldap[0].sasl-security-strength=
SASL security strength.
|
cas.authn.attribute-repository.ldap[0].state=ACTIVE
Whether attribute resolution based on this source is enabled.
|
cas.authn.attribute-repository.ldap[0].subtree-search=true
Whether subtree searching is allowed.
|
cas.authn.attribute-repository.ldap[0].trust-certificates=
Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.
|
cas.authn.attribute-repository.ldap[0].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: *
|
cas.authn.attribute-repository.ldap[0].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.
|
cas.authn.attribute-repository.ldap[0].trust-store-password=
Password needed to open the truststore. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].trust-store-type=
The type of trust keystore that determines which certificates or certificate authorities are trusted.
Types depend on underlying java platform, typically
|
cas.authn.attribute-repository.ldap[0].use-all-query-attributes=true
Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.
|
cas.authn.attribute-repository.ldap[0].use-start-tls=
Whether TLS should be used and enabled when establishing the connection.
|
cas.authn.attribute-repository.ldap[0].validate-on-checkout=true
Whether connections should be validated when loaned out from the pool.
|
cas.authn.attribute-repository.ldap[0].validate-period=PT5M
Period at which pool should be validated. This settings supports the
|
cas.authn.attribute-repository.ldap[0].validate-periodically=true
Whether connections should be validated periodically when the pool is idle.
|
cas.authn.attribute-repository.ldap[0].validate-timeout=PT5S
Period at which validation operations may time out. This settings supports the
|
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
10
11
12
import org.ldaptive.*
import org.springframework.context.*
def run(Object[] args) {
def filter = (FilterTemplate) args[0]
def parameters = (Map) args[1]
def applicationContext = (ApplicationContext) args[2]
def logger = args[3]
logger.info("Configuring LDAP filter")
filter.setFilter("uid=something")
}
The following parameters are passed to the script:
| Parameter | Description |
|---|---|
filter |
FilterTemplate to be updated by the script and used for the LDAP query. |
parameters |
Map of query parameters which may be used to construct the final filter. |
applicationContext |
Reference to the Spring ApplicationContext reference. |
logger |
The object responsible for issuing log messages such as logger.info(...). |
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
Web Server Configuration
X.509 configuration requires substantial configuration outside the CAS Web application. The configuration of Web server SSL components varies dramatically with software and is outside the scope of this document. We offer some general advice for SSL configuration:
- Configuring SSL components for optional client certificate behavior generally provides better user experience. Requiring client certificates prevents SSL negotiation in cases where the certificate is not present, which prevents user-friendly server-side error messages.
- Accept certificates only from trusted issuers, generally those within your PKI.
- Specify all certificates in the certificate chain(s) of allowed issuers.
Embedded Web Server
While instructions here generally apply to an external server deployment such as Apache Tomcat, that is not a hard requirement. X.509 authentication can be achieved with an embedded Apache Tomcat container that ships with CAS and can be potentially simplify the configuration and automation steps quite a bit, depending on use case and behavior. The configuration of certificate and trust stores as well as behavior and enforcement of client authentication can also be managed directly by CAS.
The following settings and properties are available from the CAS configuration catalog:
server.ssl.certificate=
Path to a PEM-encoded SSL certificate file.
|
server.ssl.certificate-private-key=
Path to a PEM-encoded private key file for the SSL certificate.
|
server.ssl.ciphers=
|
server.ssl.client-auth=
Client authentication mode. Requires a trust store.
|
server.ssl.enabled=true
Whether to enable SSL support.
|
server.ssl.enabled-protocols=
|
server.ssl.key-alias=
Alias that identifies the key in the key store.
|
server.ssl.key-password=
Password used to access the key in the key store.
|
server.ssl.key-store=
Path to the key store that holds the SSL certificate (typically a jks file).
|
server.ssl.key-store-password=
Password used to access the key store.
|
server.ssl.key-store-provider=
Provider for the key store.
|
server.ssl.key-store-type=
|
server.ssl.protocol=TLS
|
server.ssl.trust-certificate=
Path to a PEM-encoded SSL certificate authority file.
|
server.ssl.trust-certificate-private-key=
Path to a PEM-encoded private key file for the SSL certificate authority.
|
server.ssl.trust-store=
Trust store that holds SSL certificates.
|
server.ssl.trust-store-password=
Password used to access the trust store.
|
server.ssl.trust-store-provider=
Provider for the trust store.
|
server.ssl.trust-store-type=
Type of the trust store.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
Optional (Mixed) Authentication
When using an embedded Apache Tomcat container, it may be required to allow the user to select either X.509 authentication or the usual CAS login flow without first being prompted. In this scenario, the user is allowed the option to select a login flow via X.509 at which time the browser would present a dialog prompt asking for a certificate selection and then passing it onto CAS to proceed.
This behavior is achieved by exposing a dedicated port for the embedded Apache Tomcat container that may forcefully require X.509 authentication for login and access. Doing so should automatically allow for an extra login option in the user interface to trigger the browser for X.509.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.webflow.port=0
Port that is used to enact x509 client authentication as a separate connector. Configuration of a separate server connector and port allows the separation of client-auth functionality from the rest of the server, allowing for opt-in behavior. To activate, a non-zero port must be specified.
|
cas.authn.x509.webflow.client-auth=want
Indicate the strategy that should be used to enforce client x509 authentication. Accepted values are
|
cas.authn.x509.webflow.enabled=true
Whether webflow auto-configuration should be enabled.
|
cas.authn.x509.webflow.order=0
The order in which the webflow is configured.
|
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. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION that should be set to true. 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.
External Apache Tomcat
Anything said here extends the Apache Tomcat reference for SSL.
The Tomcat server is configured in $CATALINA_HOME/conf/server.xml with one or more <Connector> elements. Each of these elements
defines one port number on which Tomcat will listen for requests. Connectors that support SSL are configured with one or two files
that represent a collection of X.509 certificates.
-
The
keystoreFileis a collection of X.509 certificates one of which Tomcat will use to identify itself to browsers. This certificate contains the DNS name of the server on which Tomcat is running which the HTTP client will have used as the server name part of the URL. It is possible to use a file that contains multiple certificates (in which case Tomcat will use the certificate stored under the alias “Tomcat” or, if that is not found, will use the first certificate it finds that also has an associated private key). However, to assure that no mistakes are made it is sensible practice to use a file that has only the one host certificate, plus of course its private key and chain of parent Certificate Authorities. -
The
truststoreFileis a collection of X.509 certificates representing Certificate Authorities from which Tomcat is willing to accept user certificates. Since thekeystoreFilecontains the CA that issued the certificate identifying the server, thetruststoreFileandkeystoreFilecould be the same in a CAS configuration where the URL (actually the port) that uses X.509 authentication is not the well know widely recognized URL for interactive (userid/password form) login, and therefore the only CA that it trusts is the institutional internal CA.
One strategy if you are planning to support both X.509 and userid/password validation through the same port is to put a
public (VeriSign, Thawte) certificate for this server in the keystoreFile, but then put only the institutional
internal CA certificate in the truststoreFile. Logically and in all the documentation,
the Certificate Authority that issues the certificate to the
server which the browser trusts is completely and logically independent of the Certificate Authority that issues the
certificate to the user which the server then trusts. Java keeps them separate, Tomcat keeps them separate, and browsers
should not be confused if, during SSL negotiation, the server requests a user certificate from a CA other than the
one that issued the server’s own identifying certificate. In this configuration, the Server issues a public certificate
every browser will accept and the browser is strongly urged to send only a private institutional
certificate that can be mapped to a Principal name.
If you previously configured CAS without
X.509 authentication, then you probably have the keystoreFile already configured and
loaded with a certificate identifying this server. All you need to add is the truststoreFile part.
The configured connector will look something like:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<!-- Define a SSL HTTP/1.1 Connector on port 443 -->
<!-- if you do not specify a truststoreFile, then the default java "cacerts" truststore will be used-->
<Connector port="443"
maxHttpHeaderSize="8192"
maxThreads="150"
minSpareThreads="25"
maxSpareThreads="75"
enableLookups="false"
disableUploadTimeout="true"
acceptCount="100"
scheme="https"
secure="true"
clientAuth="want"
sslProtocol="TLS"
keystoreFile="/path/to/keystore.jks"
keystorePass="secret"
truststoreFile="/path/to/myTrustStore.jks"
truststorePass="secret" />
The clientAuth="want" tells Tomcat to request that the browser provide a user certificate if one is available. If
you want to force the use of user certificates, replace "want" with "true".
If you specify "want" and the browser does not have a certificate, then CAS may forward the request to the login form.
The keystore can be in JKS or PKCS12 format when using Tomcat. When using both PKCS12 and JKS keystore types
then you should specify the type of each keystore by using the keystoreType and truststoreType attributes.
You may import the certificate of the institutional Certificate Authority (the one that issues User certificates) using the command:
1
2
3
4
5
# Create a blank keystore to start from scratch if needed
# keytool -genkey -keyalg RSA -alias "selfsigned" -keystore myTrustStore.jks -storepass "secret" -validity 360
# keytool -delete -alias "selfsigned" -keystore myTrustStore.jks
keytool -import -alias myAlias -keystore /path/to/myTrustStore.jks -file certificateForInstitutionalCA.crt