WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

SAML2 Metadata Management

The following CAS endpoints handle the generation of SAML2 metadata:

/idp/metadata
/idp/metadata/signingCertificate
/idp/metadata/encryptionCertificate

This endpoint will display the CAS IdP SAML2 metadata upon receiving a GET request. If metadata is already available and generated, it will be displayed. If metadata is absent, one will be generated automatically. CAS configuration below dictates where metadata files/keys will be generated and stored.

Note that the endpoint can accept a service parameter either by entity id or numeric identifier. This parameter is matched against the CAS service registry allowing the endpoint to calculate and combine any identity provider metadata overrides that may have been specified.

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. In other words, you should only include this field in your
configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.}

cas.authn.saml-idp.metadata.core.cache-expiration=PT24H

How long should metadata be cached.

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

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

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

cas.authn.saml-idp.metadata.core.cache-expiration=PT24H

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: 
      metadata: 
        core: 
          cache-expiration: "PT24H"

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.metadata.core.cache-expiration="PT24H" -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_METADATA_CORE_CACHE_EXPIRATION="PT24H"

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.metadata.core.cache-expiration="PT24H"

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.metadata.core.cache-maximum-size=10000

Specifies the maximum number of entries the cache may contain. Note that the cache may evict an entry before this limit is exceeded or temporarily exceed the threshold while evicting. As the cache size grows close to the maximum, the cache evicts entries that are less likely to be used again. For example, the cache may evict an entry because it hasn't been used recently or very often.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.cache-maximum-size=10000

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          cache-maximum-size: "10000"

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.metadata.core.cache-maximum-size="10000" -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_METADATA_CORE_CACHE_MAXIMUM_SIZE="10000"

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.metadata.core.cache-maximum-size="10000"

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.metadata.core.certificate-algorithm=SHA512withRSA

The algorithm type/name that is used when generating certificates for the SAML2 identity provider. This setting is only relevant when artifacts needs to be generated.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.certificate-algorithm=SHA512withRSA

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          certificate-algorithm: "SHA512withRSA"

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.metadata.core.certificate-algorithm="SHA512withRSA" -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_METADATA_CORE_CERTIFICATE_ALGORITHM="SHA512withRSA"

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.metadata.core.certificate-algorithm="SHA512withRSA"

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.metadata.core.fail-fast=true

Whether invalid metadata should eagerly fail quickly on startup once the resource is parsed.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.fail-fast=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          fail-fast: "true"

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

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

java -Dcas.authn.saml-idp.metadata.core.fail-fast="true" -jar build/libs/cas.war

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

export CAS_AUTHN_SAML_IDP_METADATA_CORE_FAIL_FAST="true"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.fail-fast="true"

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

cas.authn.saml-idp.metadata.core.key-size=4096

This is the key size that is used when generating the initial keypair that would hold the private/public key for the SAML2 metadata. This setting is only relevant when artifacts needs to be generated.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.key-size=4096

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          key-size: "4096"

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.metadata.core.key-size="4096" -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_METADATA_CORE_KEY_SIZE="4096"

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.metadata.core.key-size="4096"

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.metadata.core.maximum-retry-attempts=3

When attempting to resolve metadata from sources, particularly URLs, this setting controls the number of retry attempts that CAS should execute when metadata resolution fails. Setting this value to a zero or negative value will disable the retry policy.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.maximum-retry-attempts=3

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          maximum-retry-attempts: "3"

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

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

java -Dcas.authn.saml-idp.metadata.core.maximum-retry-attempts="3" -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_METADATA_CORE_MAXIMUM_RETRY_ATTEMPTS="3"

java -jar build/libs/cas.war

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

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

java -jar build/libs/cas.war --cas.authn.saml-idp.metadata.core.maximum-retry-attempts="3"

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

cas.authn.saml-idp.metadata.core.require-valid-metadata=true

Whether valid metadata is required.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.require-valid-metadata=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          require-valid-metadata: "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.metadata.core.require-valid-metadata="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_METADATA_CORE_REQUIRE_VALID_METADATA="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.metadata.core.require-valid-metadata="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.metadata.core.slo-service-post-binding-enabled=true

Whether metadata generation process should support SLO service POST binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          slo-service-post-binding-enabled: "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.metadata.core.slo-service-post-binding-enabled="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_METADATA_CORE_SLO_SERVICE_POST_BINDING_ENABLED="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.metadata.core.slo-service-post-binding-enabled="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.metadata.core.slo-service-redirect-binding-enabled=true

Whether metadata generation process should support SLO service REDIRECT binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          slo-service-redirect-binding-enabled: "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.metadata.core.slo-service-redirect-binding-enabled="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_METADATA_CORE_SLO_SERVICE_REDIRECT_BINDING_ENABLED="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.metadata.core.slo-service-redirect-binding-enabled="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.metadata.core.sso-service-post-binding-enabled=true

Whether metadata generation process should support SSO service POST binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-post-binding-enabled: "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.metadata.core.sso-service-post-binding-enabled="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_METADATA_CORE_SSO_SERVICE_POST_BINDING_ENABLED="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.metadata.core.sso-service-post-binding-enabled="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.metadata.core.sso-service-post-simple-sign-binding-enabled=true

Whether metadata generation process should support SSO service POST SimpleSign binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-post-simple-sign-binding-enabled: "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.metadata.core.sso-service-post-simple-sign-binding-enabled="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_METADATA_CORE_SSO_SERVICE_POST_SIMPLE_SIGN_BINDING_ENABLED="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.metadata.core.sso-service-post-simple-sign-binding-enabled="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.metadata.core.sso-service-redirect-binding-enabled=true

Whether metadata generation process should support SSO service REDIRECT binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-redirect-binding-enabled: "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.metadata.core.sso-service-redirect-binding-enabled="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_METADATA_CORE_SSO_SERVICE_REDIRECT_BINDING_ENABLED="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.metadata.core.sso-service-redirect-binding-enabled="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.metadata.core.sso-service-soap-binding-enabled=true

Whether metadata generation process should support SSO service SOAP binding.

org.apereo.cas.configuration.model.support.saml.idp.metadata.CoreSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        core: 
          sso-service-soap-binding-enabled: "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.metadata.core.sso-service-soap-binding-enabled="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_METADATA_CORE_SSO_SERVICE_SOAP_BINDING_ENABLED="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.metadata.core.sso-service-soap-binding-enabled="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.

# How long should metadata be cached.
# cas.authn.saml-idp.metadata.core.cache-expiration=PT24H

# Specifies the maximum number of entries the cache may contain.
# cas.authn.saml-idp.metadata.core.cache-maximum-size=10000

# The algorithm type/name that is used when generating certificates for the SAML2 identity provider.
# cas.authn.saml-idp.metadata.core.certificate-algorithm=SHA512withRSA

# Whether invalid metadata should eagerly fail quickly on startup once the resource is parsed.
# cas.authn.saml-idp.metadata.core.fail-fast=true

# This is the key size that is used when generating the initial keypair that would hold the private/public key for the SAML2 metadata.
# cas.authn.saml-idp.metadata.core.key-size=4096

# When attempting to resolve metadata from sources, particularly URLs, this setting controls the number of retry attempts that CAS should execute when metadata resolution fails.
# cas.authn.saml-idp.metadata.core.maximum-retry-attempts=3

# Whether valid metadata is required.
# cas.authn.saml-idp.metadata.core.require-valid-metadata=true

# Whether metadata generation process should support SLO service POST binding.
# cas.authn.saml-idp.metadata.core.slo-service-post-binding-enabled=true

# Whether metadata generation process should support SLO service REDIRECT binding.
# cas.authn.saml-idp.metadata.core.slo-service-redirect-binding-enabled=true

# Whether metadata generation process should support SSO service POST binding.
# cas.authn.saml-idp.metadata.core.sso-service-post-binding-enabled=true

# Whether metadata generation process should support SSO service POST SimpleSign binding.
# cas.authn.saml-idp.metadata.core.sso-service-post-simple-sign-binding-enabled=true

# Whether metadata generation process should support SSO service REDIRECT binding.
# cas.authn.saml-idp.metadata.core.sso-service-redirect-binding-enabled=true

# Whether metadata generation process should support SSO service SOAP binding.
# cas.authn.saml-idp.metadata.core.sso-service-soap-binding-enabled=true

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc.

Note

Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

You may use this service to experiment with the metadata generation process and produce an example metadata for review and study.

Metadata Management

Identity provider metadata can also be managed using the following strategies.

File System

SAML2 identity provider metadata by default is generated on disk. The contents of the generated or found artifacts such as signing and/or encryption keys may be encrypted via CAS configuration security outlined here.

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

cas.authn.saml-idp.metadata.file-system.location=file:/etc/cas/saml

Directory location of SAML metadata and signing/encryption keys. This directory will be used to hold the configuration files.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.support.saml.idp.metadata.FileSystemSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.file-system.location=file:/etc/cas/saml

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        file-system: 
          location: "file:/etc/cas/saml"

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.metadata.file-system.location="file:/etc/cas/saml" -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_METADATA_FILE_SYSTEM_LOCATION="file:/etc/cas/saml"

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.metadata.file-system.location="file:/etc/cas/saml"

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.metadata.file-system.sign-metadata=false

Whether metadata generated on disk should be digitally signed. Signing operations use the saml2 identity provider's signing certificate and signing key.

org.apereo.cas.configuration.model.support.saml.idp.metadata.FileSystemSamlMetadataProperties.

_{How can I configure this property?}

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

Note

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

cas.authn.saml-idp.metadata.file-system.sign-metadata=...

CAS properties can be specified using the YAML syntax:

cas: 
  authn: 
    saml-idp: 
      metadata: 
        file-system: 
          sign-metadata: "..."

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.metadata.file-system.sign-metadata="..." -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_METADATA_FILE_SYSTEM_SIGN_METADATA="..."

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.metadata.file-system.sign-metadata="..."

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.

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Note

Validation

Indexed Settings

Per Service

Identity provider metadata, certificates and keys can also be defined on a per-service basis to override the global defaults. Metadata artifacts that would be applicable to a specific service definition and managed via the file system need to be stored in a directory location named after the service definition’s name and numeric identifier inside the canonical metadata directory. For example, if global metadata artifacts are managed on disk at /etc/cas/config/saml/metadata, then metadata applicable to a service definition whose name is configured as SampleService with an id of 1000 are expected to be found at /etc/cas/config/saml/metadata/SampleService-1000.

Advanced

Service provider or identity provider metadata can also be managed using any one of the following strategies.

Storage	Description
Metadata Query Protocol	See this guide.
HTTP/HTTPS	See this guide.
REST	See this guide.
Git	See this guide.
MongoDb	See this guide.
Redis	See this guide.
JPA	See this guide.
Groovy	See this guide.
Amazon S3	See this guide.

SAML Services

Please see this guide to learn more about how to configure SAML2 service providers.