X.509 Authentication - Principal Resolution
X.509 authentication is about rules and conditions that would allow CAS to extract a subject identifier from the client certificate presented during the SSL/TLS handshake process and turning into a CAS principal. This is a critical step in the authentication process to ensure that the principal identifier extracted from the certificate is meaningful and can be used to locate and identify the user for attributes later on.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.principal-typeIndicates the type of principal resolution for X509.
SUBJECT_DN-
CN_EDIPI: Create principal by common name and EDIPI. -
RFC822_EMAIL: Create principal from the RFC822 type name (aka email address) in the subject alternative name field. The subject alternative name field contains a list of various types of names, one type is RFC822 e-mail address. This will return the first e-mail address that is found (if there are more than one). -
SERIAL_NO: Create principal by serial no. Resolve the principal by the serial number with a configurable radix, ranging from 2 to 36. Ifradixis16, then the serial number could be filled with leading zeros to even the number of digits. -
SERIAL_NO_DN: Create principal by serial no and DN. -
SUBJECT: Create principal by subject. Resolve the principal by extracting one or more attribute values from the certificate subject DN and combining them with intervening delimiters. -
SUBJECT_ALT_NAME: Create principal by subject alternative name. Resolve the principal by the subject alternative name extension. (type: otherName). -
SUBJECT_DN: Create principal by subject DN.
cas.authn.x509.principal.principal-transformation.groovy.locationThe location of the resource.
The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.
In the event the configured resource is a Groovy script, especially if the script is set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.
In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.
cas.authn.x509.principal.active-attribute-repository-idsActivated attribute repository identifiers that should be used for fetching attributes if attribute resolution is enabled.
*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-repository-selectionControl the behavior of the attribute repository selection by authentication method or handler.
Control the behavior of the attribute repository selection by authentication method or handler. The map here is keyed by the authentication handler name, and the value is the attribute repository identifiers separated by comma. When the authentication handler is executed, the attribute repositories assigned to this handler will be selected to fetch attributes. Note that the resolution engine will always favor attribute repositories assigned to the service definition, if any and as part of its authentication policy, over this global setting.
cas.authn.x509.principal.attribute-resolution-enabledWhether attribute repositories should be contacted to fetch person attributes.
undefined-
TRUE: Constant to represent the true state. -
FALSE: Constant to represent the false state. -
UNDEFINED: Constant to represent the undefined state.
cas.authn.x509.principal.principal-attributeAttribute name to use to indicate the identifier of the principal constructed.
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-strategyIn the event that the principal resolution engine resolves more than one principal, (especially if such principals in the chain have different identifiers), this setting determines strategy by which the principal id w...
lastIn the event that the principal resolution engine resolves more than one principal, (especially if such principals in the chain have different identifiers), this setting determines strategy by which the principal id would be chosen from the chain. Accepted values are: last, first.
cas.authn.x509.principal.principal-resolution-failure-fatalWhen true, throws an error back indicating that principal resolution has failed and no principal can be found based on the authentication requirements.
undefined-
TRUE: Constant to represent the true state. -
FALSE: Constant to represent the false state. -
UNDEFINED: Constant to represent the undefined state.
cas.authn.x509.principal.principal-transformation.blocking-patternA regular expression that will be used against the username to match for blocking/forbidden values.
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-conversionIndicate whether the principal identifier should be transformed into upper-case, lower-case, etc.
NONE-
NONE: No conversion. -
LOWERCASE: Lowercase conversion. -
UPPERCASE: Uppercase conversion.
cas.authn.x509.principal.principal-transformation.patternA regular expression that will be used against the provided username for username extractions.
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.prefixPrefix to add to the principal id prior to authentication.
Prefix to add to the principal id prior to authentication.
cas.authn.x509.principal.principal-transformation.suffixSuffix to add to the principal id prior to authentication.
Suffix to add to the principal id prior to authentication.
cas.authn.x509.principal.return-nullReturn a null principal object if no attributes can be found for the principal.
undefined-
TRUE: Constant to represent the true state. -
FALSE: Constant to represent the false state. -
UNDEFINED: Constant to represent the undefined state.
cas.authn.x509.principal.use-existing-principal-idUses an existing principal id that may have already been established in order to run person directory queries.
undefined-
TRUE: Constant to represent the true state. -
FALSE: Constant to represent the false state. -
UNDEFINED: Constant to represent the undefined state.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Groovy scripting
CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.
Please review this guide to configure your build.
Principal transformation
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
String run(final Object... args) {
def (providedUsername,logger) = args
return providedUsername.concat("SomethingElse")
}
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
Notes on configuration
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
Note
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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.
Principal Resolution Types
The following principal resolution types are available.
-
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.subject-dn.formatFormat of subject DN to use.DEFAULTFormat of subject DN to use. Available values are as follows:-
DEFAULT: Denigrated result of calling certificate.getSubjectDN() method. Javadocs designate this method as "denigrated" for not being portable and/or not being well defined. It is what has been used by CAS for a long time so it remains the default. -
RFC1779: RFC 1779 String format of Distinguished Names. CallsX500Principal.getName("RFC1779")which emits a subject DN with the attribute keywords defined in RFC 1779 (CN, L, ST, O, OU, C, STREET). Any other attribute type is emitted as an OID. -
RFC2253: RFC 2253 String format of Distinguished Names. CallsX500Principal.getName("RFC2253")which emits a subject DN with the attribute keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC, UID). Any other attribute type is emitted as an OID. -
CANONICAL: Canonical String format of Distinguished Names. Calls X500Principal.getName("CANONICAL" which emits a subject DN that starts with RFC 2253 and applies additional canonicalization described in the javadoc.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks. -
-
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.cn-edipi.alternate-principal-attributeAttribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present.no defaultAttribute 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.
SUBJECT_ALT_NAME,CN_EDIPI)This assumes you would rather get something like the
subjectDnrather thannullwherenullwould allow falling through to another authentication mechanism.Currently supported values are:
subjectDn,sigAlgOid,subjectX500Principal.cas.authn.x509.cn-edipi.extract-edipi-as-attributeWhether to extract EDIPI as an attribute, regardless of principal resolver type.falseWhether to extract EDIPI as an attribute, regardless of principal resolver type.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks. -
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.rfc822-email.alternate-principal-attributeAttribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present.no defaultAttribute 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.
SUBJECT_ALT_NAME,CN_EDIPI)This assumes you would rather get something like the
subjectDnrather thannullwherenullwould allow falling through to another authentication mechanism.Currently supported values are:
subjectDn,sigAlgOid,subjectX500Principal.Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks. -
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.serial-no-dn.serial-number-prefixThe serial number prefix used for principal resolution when type is set to X509Properties.PrincipalTypes#SERIAL_NO_DN .SERIALNUMBER=The serial number prefix used for principal resolution when type is set to
X509Properties.PrincipalTypes#SERIAL_NO_DN.cas.authn.x509.serial-no-dn.value-delimiterValue delimiter used for principal resolution when type is set to X509Properties.PrincipalTypes#SERIAL_NO_DN .,Value delimiter used for principal resolution when type is set to
X509Properties.PrincipalTypes#SERIAL_NO_DN.cas.authn.x509.serial-no.principal-hex-s-n-zero-paddingIf radix hex padding should be used when X509Properties#getPrincipalType() is X509Properties.PrincipalTypes#SERIAL_NO .falseIf radix hex padding should be used when
X509Properties#getPrincipalType()isX509Properties.PrincipalTypes#SERIAL_NO.cas.authn.x509.serial-no.principal-s-n-radixRadix used when X509Properties#getPrincipalType() is X509Properties.PrincipalTypes#SERIAL_NO .0Radix used when
X509Properties#getPrincipalType()isX509Properties.PrincipalTypes#SERIAL_NO.Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks. -
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.serial-no-dn.serial-number-prefixThe serial number prefix used for principal resolution when type is set to X509Properties.PrincipalTypes#SERIAL_NO_DN .SERIALNUMBER=The serial number prefix used for principal resolution when type is set to
X509Properties.PrincipalTypes#SERIAL_NO_DN.cas.authn.x509.serial-no-dn.value-delimiterValue delimiter used for principal resolution when type is set to X509Properties.PrincipalTypes#SERIAL_NO_DN .,Value delimiter used for principal resolution when type is set to
X509Properties.PrincipalTypes#SERIAL_NO_DN.Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks. -
The following settings and properties are available from the CAS configuration catalog:
cas.authn.x509.subject-alt-name.alternate-principal-attributeAttribute name that will be used by X509 principal resolvers if the main attribute in the certificate is not present.no defaultAttribute 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.
SUBJECT_ALT_NAME,CN_EDIPI)This assumes you would rather get something like the
subjectDnrather thannullwherenullwould allow falling through to another authentication mechanism.Currently supported values are:
subjectDn,sigAlgOid,subjectX500Principal.Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Notes on configuration
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_propertyare all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. Note 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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as
cas.some.setting[0]=value. The index[0]is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.