Security Configuration

There are several levels of configuration that control the security configuration of objects that are signed, encrypted, etc. These configurations include things like the keys to use, preferred/default algorithms, and algorithms to allow, enforce or reject.

The configurations are generally determined based on the following order:

Service provider metadata
Per-service configuration overrides
Global CAS default settings
OpenSAML initial defaults

In almost all cases, you should leave the defaults in place.

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

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

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

cas.authn.saml-idp.algs.override-allowed-algorithms=

The Override white listed algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

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

cas.authn.saml-idp.algs.override-allowed-algorithms=...

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

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-allowed-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-allowed-algorithms="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_ALLOWED_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-allowed-algorithms="..."

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

cas.authn.saml-idp.algs.override-allowed-signature-signing-algorithms=

The Override allowed signature signing algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-allowed-signature-signing-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-allowed-signature-signing-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-allowed-signature-signing-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_ALLOWED_SIGNATURE_SIGNING_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-allowed-signature-signing-algorithms="..."

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

cas.authn.saml-idp.algs.override-blocked-encryption-algorithms=

The Override black listed encryption algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-blocked-encryption-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-blocked-encryption-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-blocked-encryption-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_BLOCKED_ENCRYPTION_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-blocked-encryption-algorithms="..."

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

cas.authn.saml-idp.algs.override-blocked-signature-signing-algorithms=

The Override blocked signature signing algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-blocked-signature-signing-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-blocked-signature-signing-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-blocked-signature-signing-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_BLOCKED_SIGNATURE_SIGNING_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-blocked-signature-signing-algorithms="..."

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

cas.authn.saml-idp.algs.override-data-encryption-algorithms=

The Override data encryption algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-data-encryption-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-data-encryption-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-data-encryption-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_DATA_ENCRYPTION_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-data-encryption-algorithms="..."

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

cas.authn.saml-idp.algs.override-key-encryption-algorithms=

The Override key encryption algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-key-encryption-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-key-encryption-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-key-encryption-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_KEY_ENCRYPTION_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-key-encryption-algorithms="..."

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

cas.authn.saml-idp.algs.override-signature-algorithms=

The Override signature algorithms.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-signature-algorithms=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-signature-algorithms: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-signature-algorithms="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_SIGNATURE_ALGORITHMS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-signature-algorithms="..."

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

cas.authn.saml-idp.algs.override-signature-canonicalization-algorithm=

The Override signature canonicalization algorithm.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-signature-canonicalization-algorithm=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-signature-canonicalization-algorithm: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-signature-canonicalization-algorithm="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_SIGNATURE_CANONICALIZATION_ALGORITHM="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-signature-canonicalization-algorithm="..."

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

cas.authn.saml-idp.algs.override-signature-reference-digest-methods=

The Override signature reference digest methods.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.override-signature-reference-digest-methods=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        override-signature-reference-digest-methods: "..."

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

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

java -Dcas.authn.saml-idp.algs.override-signature-reference-digest-methods="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_OVERRIDE_SIGNATURE_REFERENCE_DIGEST_METHODS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.override-signature-reference-digest-methods="..."

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

cas.authn.saml-idp.algs.private-key-alg-name=RSA

Algorithm name to use when generating or locating private key for signing operations..

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPAlgorithmsProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.algs.private-key-alg-name=RSA

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      algs: 
        private-key-alg-name: "RSA"

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

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

java -Dcas.authn.saml-idp.algs.private-key-alg-name="RSA" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_ALGS_PRIVATE_KEY_ALG_NAME="RSA"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.algs.private-key-alg-name="RSA"

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

cas.authn.saml-idp.logout.force-signed-logout-requests=true

Whether SLO logout requests are required to be signed.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPLogoutProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.logout.force-signed-logout-requests=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      logout: 
        force-signed-logout-requests: "true"

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

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

java -Dcas.authn.saml-idp.logout.force-signed-logout-requests="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_LOGOUT_FORCE_SIGNED_LOGOUT_REQUESTS="true"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.logout.force-signed-logout-requests="true"

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

cas.authn.saml-idp.logout.logout-response-binding=

Whether SLO logout responses should be sent using a forced binding. Accepted values are:

urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST
urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect

If no binding is defined, all available SLO endpoints found in the metadata will be consulted for logout responses.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPLogoutProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.logout.logout-response-binding=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      logout: 
        logout-response-binding: "..."

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

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

java -Dcas.authn.saml-idp.logout.logout-response-binding="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_LOGOUT_LOGOUT_RESPONSE_BINDING="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.logout.logout-response-binding="..."

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

cas.authn.saml-idp.logout.send-logout-response=true

Whether SLO logout responses should be sent to service providers.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPLogoutProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.logout.send-logout-response=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      logout: 
        send-logout-response: "true"

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

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

java -Dcas.authn.saml-idp.logout.send-logout-response="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_LOGOUT_SEND_LOGOUT_RESPONSE="true"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.logout.send-logout-response="true"

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

cas.authn.saml-idp.logout.sign-logout-response=false

Whether SLO logout responses are required to be signed.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPLogoutProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.logout.sign-logout-response=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      logout: 
        sign-logout-response: "..."

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

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

java -Dcas.authn.saml-idp.logout.sign-logout-response="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_LOGOUT_SIGN_LOGOUT_RESPONSE="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.logout.sign-logout-response="..."

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

cas.authn.saml-idp.logout.single-logout-callbacks-disabled=false

Whether SAML SLO is enabled and processed.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPLogoutProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.logout.single-logout-callbacks-disabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      logout: 
        single-logout-callbacks-disabled: "..."

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

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

java -Dcas.authn.saml-idp.logout.single-logout-callbacks-disabled="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_LOGOUT_SINGLE_LOGOUT_CALLBACKS_DISABLED="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.logout.single-logout-callbacks-disabled="..."

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

cas.authn.saml-idp.profile.slo.url-decode-redirect-request=false

Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.

org.apereo.cas.configuration.model.support.saml.idp.profile.SamlIdPSLOProfileProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.profile.slo.url-decode-redirect-request=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      profile: 
        slo: 
          url-decode-redirect-request: "..."

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

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

java -Dcas.authn.saml-idp.profile.slo.url-decode-redirect-request="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_PROFILE_SLO_URL_DECODE_REDIRECT_REQUEST="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.profile.slo.url-decode-redirect-request="..."

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

cas.authn.saml-idp.profile.sso-post-simple-sign.url-decode-redirect-request=false

Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.

org.apereo.cas.configuration.model.support.saml.idp.profile.SamlIdPSSOSimpleSignProfileProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.profile.sso-post-simple-sign.url-decode-redirect-request=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      profile: 
        sso-post-simple-sign: 
          url-decode-redirect-request: "..."

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

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

java -Dcas.authn.saml-idp.profile.sso-post-simple-sign.url-decode-redirect-request="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_PROFILE_SSO_POST_SIMPLE_SIGN_URL_DECODE_REDIRECT_REQUEST="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.profile.sso-post-simple-sign.url-decode-redirect-request="..."

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

cas.authn.saml-idp.profile.sso.url-decode-redirect-request=false

Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.

org.apereo.cas.configuration.model.support.saml.idp.profile.SamlIdPSSOProfileProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.profile.sso.url-decode-redirect-request=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      profile: 
        sso: 
          url-decode-redirect-request: "..."

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

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

java -Dcas.authn.saml-idp.profile.sso.url-decode-redirect-request="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_PROFILE_SSO_URL_DECODE_REDIRECT_REQUEST="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.profile.sso.url-decode-redirect-request="..."

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

cas.authn.saml-idp.response.attribute-name-formats=

Each individual attribute can be mapped to a particular name-format. Example: attributeName->basic|uri|unspecified|custom-format-etc,....

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.attribute-name-formats=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        attribute-name-formats: "..."

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

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

java -Dcas.authn.saml-idp.response.attribute-name-formats="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_ATTRIBUTE_NAME_FORMATS="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.attribute-name-formats="..."

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

cas.authn.saml-idp.response.credential-type=X509

Indicate the encoding type of the credential used when rendering the saml response. Available values are as follows:

BASIC: DER-Encoded format.
X509: PEM-encoded X509 format.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.credential-type=X509

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        credential-type: "X509"

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

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

java -Dcas.authn.saml-idp.response.credential-type="X509" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_CREDENTIAL_TYPE="X509"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.credential-type="X509"

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

cas.authn.saml-idp.response.default-attribute-name-format=uri

Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.default-attribute-name-format=uri

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        default-attribute-name-format: "uri"

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

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

java -Dcas.authn.saml-idp.response.default-attribute-name-format="uri" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_DEFAULT_ATTRIBUTE_NAME_FORMAT="uri"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.default-attribute-name-format="uri"

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

cas.authn.saml-idp.response.default-authentication-context-class=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport

The default authentication context class to include in the response if none is specified via the service.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.default-authentication-context-class=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        default-authentication-context-class: "urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"

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

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

java -Dcas.authn.saml-idp.response.default-authentication-context-class="urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_DEFAULT_AUTHENTICATION_CONTEXT_CLASS="urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.default-authentication-context-class="urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"

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

cas.authn.saml-idp.response.sign-error=false

Whether error responses should be signed.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.sign-error=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        sign-error: "..."

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

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

java -Dcas.authn.saml-idp.response.sign-error="..." -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_SIGN_ERROR="..."

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.sign-error="..."

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

cas.authn.saml-idp.response.skew-allowance=PT30S

Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.

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

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPResponseProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.response.skew-allowance=PT30S

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      response: 
        skew-allowance: "PT30S"

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

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

java -Dcas.authn.saml-idp.response.skew-allowance="PT30S" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_RESPONSE_SKEW_ALLOWANCE="PT30S"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.response.skew-allowance="PT30S"

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

cas.authn.saml-idp.ticket.attribute-query.time-to-kill-in-seconds=8

Number of seconds after which this ticket becomes invalid.

org.apereo.cas.configuration.model.support.saml.idp.AttributeQueryTicketProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.ticket.attribute-query.time-to-kill-in-seconds=8

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      ticket: 
        attribute-query: 
          time-to-kill-in-seconds: "8"

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

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

java -Dcas.authn.saml-idp.ticket.attribute-query.time-to-kill-in-seconds="8" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_TICKET_ATTRIBUTE_QUERY_TIME_TO_KILL_IN_SECONDS="8"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.ticket.attribute-query.time-to-kill-in-seconds="8"

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

cas.authn.saml-idp.ticket.saml-artifacts-cache-storage-name=samlArtifactsCache

name that should be given to the saml artifact cache storage name.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPTicketProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.ticket.saml-artifacts-cache-storage-name=samlArtifactsCache

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      ticket: 
        saml-artifacts-cache-storage-name: "samlArtifactsCache"

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

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

java -Dcas.authn.saml-idp.ticket.saml-artifacts-cache-storage-name="samlArtifactsCache" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_TICKET_SAML_ARTIFACTS_CACHE_STORAGE_NAME="samlArtifactsCache"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.ticket.saml-artifacts-cache-storage-name="samlArtifactsCache"

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

cas.authn.saml-idp.ticket.saml-attribute-query-cache-storage-name=samlAttributeQueryCache

The name that should be given to the saml attribute query cache storage name.

org.apereo.cas.configuration.model.support.saml.idp.SamlIdPTicketProperties.

_{How can I configure this property?}

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

:information_source: Note

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

cas.authn.saml-idp.ticket.saml-attribute-query-cache-storage-name=samlAttributeQueryCache

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      ticket: 
        saml-attribute-query-cache-storage-name: "samlAttributeQueryCache"

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

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

java -Dcas.authn.saml-idp.ticket.saml-attribute-query-cache-storage-name="samlAttributeQueryCache" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_TICKET_SAML_ATTRIBUTE_QUERY_CACHE_STORAGE_NAME="samlAttributeQueryCache"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.ticket.saml-attribute-query-cache-storage-name="samlAttributeQueryCache"

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

# The Override white listed algorithms.
# cas.authn.saml-idp.algs.override-allowed-algorithms=

# The Override allowed signature signing algorithms.
# cas.authn.saml-idp.algs.override-allowed-signature-signing-algorithms=

# The Override black listed encryption algorithms.
# cas.authn.saml-idp.algs.override-blocked-encryption-algorithms=

# The Override blocked signature signing algorithms.
# cas.authn.saml-idp.algs.override-blocked-signature-signing-algorithms=

# The Override data encryption algorithms.
# cas.authn.saml-idp.algs.override-data-encryption-algorithms=

# The Override key encryption algorithms.
# cas.authn.saml-idp.algs.override-key-encryption-algorithms=

# The Override signature algorithms.
# cas.authn.saml-idp.algs.override-signature-algorithms=

# The Override signature canonicalization algorithm.
# cas.authn.saml-idp.algs.override-signature-canonicalization-algorithm=

# The Override signature reference digest methods.
# cas.authn.saml-idp.algs.override-signature-reference-digest-methods=

# Algorithm name to use when generating or locating private key for signing operations..
# cas.authn.saml-idp.algs.private-key-alg-name=RSA

# Whether SLO logout requests are required to be signed.
# cas.authn.saml-idp.logout.force-signed-logout-requests=true

# Whether SLO logout responses should be sent using a forced binding.
# cas.authn.saml-idp.logout.logout-response-binding=

# Whether SLO logout responses should be sent to service providers.
# cas.authn.saml-idp.logout.send-logout-response=true

# Whether SLO logout responses are required to be signed.
# cas.authn.saml-idp.logout.sign-logout-response=false

# Whether SAML SLO is enabled and processed.
# cas.authn.saml-idp.logout.single-logout-callbacks-disabled=false

# Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.
# cas.authn.saml-idp.profile.slo.url-decode-redirect-request=false

# Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.
# cas.authn.saml-idp.profile.sso-post-simple-sign.url-decode-redirect-request=false

# Whether the initial request should be explicitly url-decoded before it's consumed by the decoder.
# cas.authn.saml-idp.profile.sso.url-decode-redirect-request=false

# Each individual attribute can be mapped to a particular name-format.
# cas.authn.saml-idp.response.attribute-name-formats=

# Indicate the encoding type of the credential used when rendering the saml response.
# cas.authn.saml-idp.response.credential-type=X509

# Indicates the default name-format for all attributes in case the individual attribute is not individually mapped.
# cas.authn.saml-idp.response.default-attribute-name-format=uri

# The default authentication context class to include in the response if none is specified via the service.
# cas.authn.saml-idp.response.default-authentication-context-class=urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport

# Whether error responses should be signed.
# cas.authn.saml-idp.response.sign-error=false

# Time unit in seconds used to skew authentication dates such as valid-from and valid-until elements.
# cas.authn.saml-idp.response.skew-allowance=PT30S

# Number of seconds after which this ticket becomes invalid.
# cas.authn.saml-idp.ticket.attribute-query.time-to-kill-in-seconds=8

# name that should be given to the saml artifact cache storage name.
# cas.authn.saml-idp.ticket.saml-artifacts-cache-storage-name=samlArtifactsCache

# The name that should be given to the saml attribute query cache storage name.
# cas.authn.saml-idp.ticket.saml-attribute-query-cache-storage-name=samlAttributeQueryCache

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.

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.

Encryption

The following examples demonstrate encryption security configuration overrides per service provider.

CBC

The following example demonstrates how to configure CAS to use CBC encryption for a particular service provider:

{
  "@class": "org.apereo.cas.support.saml.services.SamlRegisteredService",
  "serviceId": "sp.example.org",
  "name": "SAML",
  "id": 1,
  "metadataLocation": "/path/to/sp-metadata.xml",
  "encryptionDataAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2001/04/xmlenc#aes128-cbc"
    ]
  ],
  "encryptionKeyAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"
    ]
  ]
}

GCM

The following example demonstrates how to configure CAS to use GCM encryption for a particular service provider:

{
  "@class": "org.apereo.cas.support.saml.services.SamlRegisteredService",
  "serviceId": "sp.example.org",
  "name": "SAML",
  "id": 1,
  "metadataLocation": "/path/to/sp-metadata.xml",
  "encryptionDataAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2009/xmlenc11#aes128-gcm"
    ]
  ],
  "encryptionKeyAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"
    ]
  ]
}

Signing

The following examples demonstrate signing security configuration overrides per service provider.

SHA-1

The following example demonstrates how to configure CAS to use SHA-1 signing and digest algorithms for a particular service provider:

{
  "@class": "org.apereo.cas.support.saml.services.SamlRegisteredService",
  "serviceId": "sp.example.org",
  "name": "SAML",
  "id": 1,
  "metadataLocation": "/path/to/sp-metadata.xml",
  "signingSignatureAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2000/09/xmldsig#rsa-sha1",
      "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha1"
    ]
  ],
  "signingSignatureReferenceDigestMethods": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2000/09/xmldsig#sha1"
    ]
  ]
}

SHA-256

The following example demonstrates how to configure CAS to use SHA-256 signing and digest algorithms for a particular service provider:

{
  "@class": "org.apereo.cas.support.saml.services.SamlRegisteredService",
  "serviceId": "sp.example.org",
  "name": "SAML",
  "id": 1,
  "metadataLocation": "/path/to/sp-metadata.xml",
  "signingSignatureAlgorithms": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256",
      "http://www.w3.org/2001/04/xmldsig-more#ecdsa-sha256"
    ]
  ],
  "signingSignatureReferenceDigestMethods": [
    "java.util.ArrayList",
    [
      "http://www.w3.org/2001/04/xmlenc#sha256"
    ]
  ]
}

Troubleshooting

To enable additional logging, modify the logging configuration file to add the following:

<Logger name="org.opensaml" level="debug" additivity="false">
    <AppenderRef ref="console"/>
    <AppenderRef ref="file"/>
</Logger>

<Logger name="PROTOCOL_MESSAGE" level="debug" additivity="false">
    <AppenderRef ref="console"/>
    <AppenderRef ref="file"/>
</Logger>