Configuration Security - Vault

You can also store sensitive settings inside Vault. Vault can store your existing secrets, or it can dynamically generate new secrets to control access to third-party resources or provide time-limited credentials for your infrastructure. To learn more about Vault and its installation process, please visit the project website.

Once vault is accessible and configured inside CAS, support is provided via the following dependency:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-configuration-cloud-vault</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-configuration-cloud-vault:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-configuration-cloud-vault"
}

dependencies {
    /*
    The following platform references should be included automatically and are listed here for reference only.
            
    implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
    implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
    */

    implementation "org.apereo.cas:cas-server-support-configuration-cloud-vault"
}

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.}

_{The configuration settings listed below are tagged as Third Party in the CAS configuration metadata. This flag indicates that the configuration setting is not controlled, owned or managed by the CAS ecosystem, and affects functionality that is offered by a third-party library, such as Spring Boot or Spring Cloud to CAS. For additional info, you might have to visit the third-party source to find more details.}

spring.cloud.vault.app-id.app-id-path=app-id

Mount path of the AppId authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{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:

spring.cloud.vault.app-id.app-id-path=app-id

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:

spring: 
  cloud: 
    vault: 
      app-id: 
        app-id-path: "app-id"

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 -Dspring.cloud.vault.app-id.app-id-path="app-id" -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 SPRING_CLOUD_VAULT_APP_ID_APP_ID_PATH="app-id"

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 --spring.cloud.vault.app-id.app-id-path="app-id"

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.

spring.cloud.vault.app-id.network-interface=

Network interface hint for the "MAC_ADDRESS" UserId mechanism.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{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:

spring.cloud.vault.app-id.network-interface=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-id: 
        network-interface: "..."

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 -Dspring.cloud.vault.app-id.network-interface="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ID_NETWORK_INTERFACE="..."

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 --spring.cloud.vault.app-id.network-interface="..."

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.

spring.cloud.vault.app-id.user-id=MAC_ADDRESS

UserId mechanism. Can be either "MAC_ADDRESS", "IP_ADDRESS", a string or a class name.

org.springframework.cloud.vault.config.VaultProperties$AppIdProperties.

_{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:

spring.cloud.vault.app-id.user-id=MAC_ADDRESS

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-id: 
        user-id: "MAC_ADDRESS"

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 -Dspring.cloud.vault.app-id.user-id="MAC_ADDRESS" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ID_USER_ID="MAC_ADDRESS"

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 --spring.cloud.vault.app-id.user-id="MAC_ADDRESS"

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.

spring.cloud.vault.app-role.app-role-path=approle

Mount path of the AppRole authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{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:

spring.cloud.vault.app-role.app-role-path=approle

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        app-role-path: "approle"

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 -Dspring.cloud.vault.app-role.app-role-path="approle" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_APP_ROLE_PATH="approle"

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 --spring.cloud.vault.app-role.app-role-path="approle"

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.

spring.cloud.vault.app-role.role=

Name of the role, optional, used for pull-mode.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{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:

spring.cloud.vault.app-role.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        role: "..."

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 -Dspring.cloud.vault.app-role.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_ROLE="..."

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 --spring.cloud.vault.app-role.role="..."

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.

spring.cloud.vault.app-role.role-id=

The RoleId.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{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:

spring.cloud.vault.app-role.role-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        role-id: "..."

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 -Dspring.cloud.vault.app-role.role-id="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_ROLE_ID="..."

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 --spring.cloud.vault.app-role.role-id="..."

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.

spring.cloud.vault.app-role.secret-id=

The SecretId.

org.springframework.cloud.vault.config.VaultProperties$AppRoleProperties.

_{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:

spring.cloud.vault.app-role.secret-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      app-role: 
        secret-id: "..."

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 -Dspring.cloud.vault.app-role.secret-id="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APP_ROLE_SECRET_ID="..."

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 --spring.cloud.vault.app-role.secret-id="..."

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.

spring.cloud.vault.application-name=application

Application name for AppId authentication.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.application-name=application

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      application-name: "application"

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 -Dspring.cloud.vault.application-name="application" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_APPLICATION_NAME="application"

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 --spring.cloud.vault.application-name="application"

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.

spring.cloud.vault.authentication=

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.authentication=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      authentication: "..."

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 -Dspring.cloud.vault.authentication="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AUTHENTICATION="..."

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 --spring.cloud.vault.authentication="..."

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.

spring.cloud.vault.aws-ec2.aws-ec2-path=aws-ec2

Mount path of the AWS-EC2 authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AwsEc2Properties.

_{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:

spring.cloud.vault.aws-ec2.aws-ec2-path=aws-ec2

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-ec2: 
        aws-ec2-path: "aws-ec2"

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 -Dspring.cloud.vault.aws-ec2.aws-ec2-path="aws-ec2" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_EC2_AWS_EC2_PATH="aws-ec2"

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 --spring.cloud.vault.aws-ec2.aws-ec2-path="aws-ec2"

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.

spring.cloud.vault.aws-ec2.identity-document=http://169.254.169.254/latest/dynamic/instance-identity/pkcs7

URL of the AWS-EC2 PKCS7 identity document.

org.springframework.cloud.vault.config.VaultProperties$AwsEc2Properties.

_{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:

spring.cloud.vault.aws-ec2.identity-document=http://169.254.169.254/latest/dynamic/instance-identity/pkcs7

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-ec2: 
        identity-document: "http://169.254.169.254/latest/dynamic/instance-identity/pkcs7"

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 -Dspring.cloud.vault.aws-ec2.identity-document="http://169.254.169.254/latest/dynamic/instance-identity/pkcs7" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_EC2_IDENTITY_DOCUMENT="http://169.254.169.254/latest/dynamic/instance-identity/pkcs7"

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 --spring.cloud.vault.aws-ec2.identity-document="http://169.254.169.254/latest/dynamic/instance-identity/pkcs7"

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.

spring.cloud.vault.aws-ec2.nonce=

Nonce used for AWS-EC2 authentication. An empty nonce defaults to nonce generation.

org.springframework.cloud.vault.config.VaultProperties$AwsEc2Properties.

_{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:

spring.cloud.vault.aws-ec2.nonce=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-ec2: 
        nonce: "..."

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 -Dspring.cloud.vault.aws-ec2.nonce="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_EC2_NONCE="..."

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 --spring.cloud.vault.aws-ec2.nonce="..."

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.

spring.cloud.vault.aws-ec2.role=

Name of the role, optional.

org.springframework.cloud.vault.config.VaultProperties$AwsEc2Properties.

_{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:

spring.cloud.vault.aws-ec2.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-ec2: 
        role: "..."

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 -Dspring.cloud.vault.aws-ec2.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_EC2_ROLE="..."

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 --spring.cloud.vault.aws-ec2.role="..."

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.

spring.cloud.vault.aws-iam.aws-path=aws

Mount path of the AWS authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AwsIamProperties.

_{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:

spring.cloud.vault.aws-iam.aws-path=aws

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-iam: 
        aws-path: "aws"

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 -Dspring.cloud.vault.aws-iam.aws-path="aws" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_IAM_AWS_PATH="aws"

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 --spring.cloud.vault.aws-iam.aws-path="aws"

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.

spring.cloud.vault.aws-iam.endpoint-uri=

STS server URI. @since 2.2

org.springframework.cloud.vault.config.VaultProperties$AwsIamProperties.

_{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:

spring.cloud.vault.aws-iam.endpoint-uri=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-iam: 
        endpoint-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 -Dspring.cloud.vault.aws-iam.endpoint-uri="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_IAM_ENDPOINT_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 --spring.cloud.vault.aws-iam.endpoint-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.

spring.cloud.vault.aws-iam.region=

Name of the region, optional. Inferred by AWS defaults if not set. @since 4.0.1

org.springframework.cloud.vault.config.VaultProperties$AwsIamProperties.

_{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:

spring.cloud.vault.aws-iam.region=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-iam: 
        region: "..."

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 -Dspring.cloud.vault.aws-iam.region="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_IAM_REGION="..."

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 --spring.cloud.vault.aws-iam.region="..."

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.

spring.cloud.vault.aws-iam.role=

Name of the role, optional. Defaults to the friendly IAM name if not set.

org.springframework.cloud.vault.config.VaultProperties$AwsIamProperties.

_{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:

spring.cloud.vault.aws-iam.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-iam: 
        role: "..."

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 -Dspring.cloud.vault.aws-iam.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_IAM_ROLE="..."

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 --spring.cloud.vault.aws-iam.role="..."

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.

spring.cloud.vault.aws-iam.server-name=

Name of the server used to set X-Vault-AWS-IAM-Server-ID header in the headers of login requests.

org.springframework.cloud.vault.config.VaultProperties$AwsIamProperties.

_{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:

spring.cloud.vault.aws-iam.server-name=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      aws-iam: 
        server-name: "..."

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 -Dspring.cloud.vault.aws-iam.server-name="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AWS_IAM_SERVER_NAME="..."

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 --spring.cloud.vault.aws-iam.server-name="..."

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.

spring.cloud.vault.azure-msi.azure-path=azure

Mount path of the Azure MSI authentication backend.

org.springframework.cloud.vault.config.VaultProperties$AzureMsiProperties.

_{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:

spring.cloud.vault.azure-msi.azure-path=azure

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      azure-msi: 
        azure-path: "azure"

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 -Dspring.cloud.vault.azure-msi.azure-path="azure" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AZURE_MSI_AZURE_PATH="azure"

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 --spring.cloud.vault.azure-msi.azure-path="azure"

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.

spring.cloud.vault.azure-msi.identity-token-service=

Identity token service URI. @since 3.0

org.springframework.cloud.vault.config.VaultProperties$AzureMsiProperties.

_{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:

spring.cloud.vault.azure-msi.identity-token-service=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      azure-msi: 
        identity-token-service: "..."

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 -Dspring.cloud.vault.azure-msi.identity-token-service="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AZURE_MSI_IDENTITY_TOKEN_SERVICE="..."

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 --spring.cloud.vault.azure-msi.identity-token-service="..."

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.

spring.cloud.vault.azure-msi.metadata-service=

Instance metadata service URI. @since 3.0

org.springframework.cloud.vault.config.VaultProperties$AzureMsiProperties.

_{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:

spring.cloud.vault.azure-msi.metadata-service=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      azure-msi: 
        metadata-service: "..."

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 -Dspring.cloud.vault.azure-msi.metadata-service="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AZURE_MSI_METADATA_SERVICE="..."

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 --spring.cloud.vault.azure-msi.metadata-service="..."

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.

spring.cloud.vault.azure-msi.role=

Name of the role.

org.springframework.cloud.vault.config.VaultProperties$AzureMsiProperties.

_{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:

spring.cloud.vault.azure-msi.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      azure-msi: 
        role: "..."

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 -Dspring.cloud.vault.azure-msi.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_AZURE_MSI_ROLE="..."

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 --spring.cloud.vault.azure-msi.role="..."

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.

spring.cloud.vault.config.lifecycle.enabled=true

Enable lifecycle management.

org.springframework.cloud.vault.config.VaultProperties$ConfigLifecycle.

_{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:

spring.cloud.vault.config.lifecycle.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        lifecycle: 
          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 -Dspring.cloud.vault.config.lifecycle.enabled="true" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_LIFECYCLE_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 --spring.cloud.vault.config.lifecycle.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.

spring.cloud.vault.config.lifecycle.expiry-threshold=

The expiry threshold. Lease is renewed the given Duration before it expires. @since 2.2

org.springframework.cloud.vault.config.VaultProperties$ConfigLifecycle.

_{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:

spring.cloud.vault.config.lifecycle.expiry-threshold=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        lifecycle: 
          expiry-threshold: "..."

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 -Dspring.cloud.vault.config.lifecycle.expiry-threshold="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_LIFECYCLE_EXPIRY_THRESHOLD="..."

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 --spring.cloud.vault.config.lifecycle.expiry-threshold="..."

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.

spring.cloud.vault.config.lifecycle.lease-endpoints=

Set the LeaseEndpoints to delegate renewal/revocation calls to. LeaseEndpoints encapsulates differences between Vault versions that affect the location of renewal/revocation endpoints. Can be LeaseEndpoints#SysLeases for version 0.8 or above of Vault or LeaseEndpoints#Legacy for older versions (the default). @since 2.2

org.springframework.cloud.vault.config.VaultProperties$ConfigLifecycle.

_{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:

spring.cloud.vault.config.lifecycle.lease-endpoints=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        lifecycle: 
          lease-endpoints: "..."

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 -Dspring.cloud.vault.config.lifecycle.lease-endpoints="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_LIFECYCLE_LEASE_ENDPOINTS="..."

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 --spring.cloud.vault.config.lifecycle.lease-endpoints="..."

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.

spring.cloud.vault.config.lifecycle.lease-strategy=

Sets the LeaseStrategy to be used with org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy) to retain or drop tokens on renewal errors. @since 4.1

org.springframework.cloud.vault.config.VaultProperties$ConfigLifecycle.

_{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:

spring.cloud.vault.config.lifecycle.lease-strategy=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        lifecycle: 
          lease-strategy: "..."

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 -Dspring.cloud.vault.config.lifecycle.lease-strategy="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_LIFECYCLE_LEASE_STRATEGY="..."

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 --spring.cloud.vault.config.lifecycle.lease-strategy="..."

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.

spring.cloud.vault.config.lifecycle.min-renewal=

The time period that is at least required before renewing a lease. @since 2.2

org.springframework.cloud.vault.config.VaultProperties$ConfigLifecycle.

_{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:

spring.cloud.vault.config.lifecycle.min-renewal=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        lifecycle: 
          min-renewal: "..."

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 -Dspring.cloud.vault.config.lifecycle.min-renewal="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_LIFECYCLE_MIN_RENEWAL="..."

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 --spring.cloud.vault.config.lifecycle.min-renewal="..."

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.

spring.cloud.vault.config.order=0

Used to set a org.springframework.core.env.PropertySource priority. This is useful to use Vault as an override on other property sources. @see org.springframework.core.PriorityOrdered

org.springframework.cloud.vault.config.VaultProperties$Config.

_{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:

spring.cloud.vault.config.order=0

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      config: 
        order: "0"

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 -Dspring.cloud.vault.config.order="0" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONFIG_ORDER="0"

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 --spring.cloud.vault.config.order="0"

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.

Deprecation status is WARNINGwithout a replacement setting.

spring.cloud.vault.connection-timeout=5000

Connection timeout.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.connection-timeout=5000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      connection-timeout: "5000"

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 -Dspring.cloud.vault.connection-timeout="5000" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_CONNECTION_TIMEOUT="5000"

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 --spring.cloud.vault.connection-timeout="5000"

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.

spring.cloud.vault.discovery.enabled=false

Flag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery).

org.springframework.cloud.vault.config.VaultProperties$Discovery.

_{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:

spring.cloud.vault.discovery.enabled=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      discovery: 
        enabled: "..."

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 -Dspring.cloud.vault.discovery.enabled="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_DISCOVERY_ENABLED="..."

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 --spring.cloud.vault.discovery.enabled="..."

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.

spring.cloud.vault.discovery.service-id=vault

Service id to locate Vault.

org.springframework.cloud.vault.config.VaultProperties$Discovery.

_{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:

spring.cloud.vault.discovery.service-id=vault

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      discovery: 
        service-id: "vault"

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 -Dspring.cloud.vault.discovery.service-id="vault" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_DISCOVERY_SERVICE_ID="vault"

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 --spring.cloud.vault.discovery.service-id="vault"

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.

spring.cloud.vault.enabled=true

Enable Vault config server.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      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 -Dspring.cloud.vault.enabled="true" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_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 --spring.cloud.vault.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.

spring.cloud.vault.fail-fast=false

Fail fast if data cannot be obtained from Vault.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.fail-fast=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      fail-fast: "..."

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 -Dspring.cloud.vault.fail-fast="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_FAIL_FAST="..."

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 --spring.cloud.vault.fail-fast="..."

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.

spring.cloud.vault.gcp-gce.gcp-path=gcp

Mount path of the Kubernetes authentication backend.

org.springframework.cloud.vault.config.VaultProperties$GcpGceProperties.

_{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:

spring.cloud.vault.gcp-gce.gcp-path=gcp

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-gce: 
        gcp-path: "gcp"

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 -Dspring.cloud.vault.gcp-gce.gcp-path="gcp" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_GCE_GCP_PATH="gcp"

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 --spring.cloud.vault.gcp-gce.gcp-path="gcp"

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.

spring.cloud.vault.gcp-gce.role=

Name of the role against which the login is being attempted.

org.springframework.cloud.vault.config.VaultProperties$GcpGceProperties.

_{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:

spring.cloud.vault.gcp-gce.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-gce: 
        role: "..."

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 -Dspring.cloud.vault.gcp-gce.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_GCE_ROLE="..."

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 --spring.cloud.vault.gcp-gce.role="..."

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.

spring.cloud.vault.gcp-gce.service-account=

Optional service account id. Using the default id if left unconfigured.

org.springframework.cloud.vault.config.VaultProperties$GcpGceProperties.

_{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:

spring.cloud.vault.gcp-gce.service-account=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-gce: 
        service-account: "..."

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 -Dspring.cloud.vault.gcp-gce.service-account="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_GCE_SERVICE_ACCOUNT="..."

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 --spring.cloud.vault.gcp-gce.service-account="..."

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.

spring.cloud.vault.gcp-iam.credentials.encoded-key=

The base64 encoded contents of an OAuth2 account private key in JSON format.

org.springframework.cloud.vault.config.VaultProperties$GcpCredentials.

_{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:

spring.cloud.vault.gcp-iam.credentials.encoded-key=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        credentials: 
          encoded-key: "..."

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 -Dspring.cloud.vault.gcp-iam.credentials.encoded-key="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_CREDENTIALS_ENCODED_KEY="..."

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 --spring.cloud.vault.gcp-iam.credentials.encoded-key="..."

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.

spring.cloud.vault.gcp-iam.credentials.location=

Location of the OAuth2 credentials private key.

Since this is a Resource, the private key can be in a multitude of locations, such as a local file system, classpath, URL, etc.

org.springframework.cloud.vault.config.VaultProperties$GcpCredentials.

_{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:

spring.cloud.vault.gcp-iam.credentials.location=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        credentials: 
          location: "..."

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 -Dspring.cloud.vault.gcp-iam.credentials.location="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_CREDENTIALS_LOCATION="..."

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 --spring.cloud.vault.gcp-iam.credentials.location="..."

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.

spring.cloud.vault.gcp-iam.gcp-path=gcp

Mount path of the Kubernetes authentication backend.

org.springframework.cloud.vault.config.VaultProperties$GcpIamProperties.

_{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:

spring.cloud.vault.gcp-iam.gcp-path=gcp

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        gcp-path: "gcp"

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 -Dspring.cloud.vault.gcp-iam.gcp-path="gcp" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_GCP_PATH="gcp"

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 --spring.cloud.vault.gcp-iam.gcp-path="gcp"

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.

spring.cloud.vault.gcp-iam.jwt-validity=15m

Validity of the JWT token.

org.springframework.cloud.vault.config.VaultProperties$GcpIamProperties.

_{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:

spring.cloud.vault.gcp-iam.jwt-validity=15m

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        jwt-validity: "15m"

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 -Dspring.cloud.vault.gcp-iam.jwt-validity="15m" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_JWT_VALIDITY="15m"

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 --spring.cloud.vault.gcp-iam.jwt-validity="15m"

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.

spring.cloud.vault.gcp-iam.project-id=

Overrides the GCP project Id.

org.springframework.cloud.vault.config.VaultProperties$GcpIamProperties.

_{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:

spring.cloud.vault.gcp-iam.project-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        project-id: "..."

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 -Dspring.cloud.vault.gcp-iam.project-id="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_PROJECT_ID="..."

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 --spring.cloud.vault.gcp-iam.project-id="..."

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.

spring.cloud.vault.gcp-iam.role=

Name of the role against which the login is being attempted.

org.springframework.cloud.vault.config.VaultProperties$GcpIamProperties.

_{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:

spring.cloud.vault.gcp-iam.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        role: "..."

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 -Dspring.cloud.vault.gcp-iam.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_ROLE="..."

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 --spring.cloud.vault.gcp-iam.role="..."

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.

spring.cloud.vault.gcp-iam.service-account-id=

Overrides the GCP service account Id.

org.springframework.cloud.vault.config.VaultProperties$GcpIamProperties.

_{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:

spring.cloud.vault.gcp-iam.service-account-id=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      gcp-iam: 
        service-account-id: "..."

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 -Dspring.cloud.vault.gcp-iam.service-account-id="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_GCP_IAM_SERVICE_ACCOUNT_ID="..."

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 --spring.cloud.vault.gcp-iam.service-account-id="..."

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.

spring.cloud.vault.host=localhost

Vault server host.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.host=localhost

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      host: "localhost"

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 -Dspring.cloud.vault.host="localhost" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_HOST="localhost"

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 --spring.cloud.vault.host="localhost"

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.

spring.cloud.vault.kubernetes.kubernetes-path=kubernetes

Mount path of the Kubernetes authentication backend.

org.springframework.cloud.vault.config.VaultProperties$KubernetesProperties.

_{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:

spring.cloud.vault.kubernetes.kubernetes-path=kubernetes

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kubernetes: 
        kubernetes-path: "kubernetes"

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 -Dspring.cloud.vault.kubernetes.kubernetes-path="kubernetes" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KUBERNETES_KUBERNETES_PATH="kubernetes"

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 --spring.cloud.vault.kubernetes.kubernetes-path="kubernetes"

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.

spring.cloud.vault.kubernetes.role=

Name of the role against which the login is being attempted.

org.springframework.cloud.vault.config.VaultProperties$KubernetesProperties.

_{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:

spring.cloud.vault.kubernetes.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kubernetes: 
        role: "..."

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 -Dspring.cloud.vault.kubernetes.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KUBERNETES_ROLE="..."

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 --spring.cloud.vault.kubernetes.role="..."

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.

spring.cloud.vault.kubernetes.service-account-token-file=/var/run/secrets/kubernetes.io/serviceaccount/token

Path to the service account token file.

org.springframework.cloud.vault.config.VaultProperties$KubernetesProperties.

_{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:

spring.cloud.vault.kubernetes.service-account-token-file=/var/run/secrets/kubernetes.io/serviceaccount/token

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kubernetes: 
        service-account-token-file: "/var/run/secrets/kubernetes.io/serviceaccount/token"

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 -Dspring.cloud.vault.kubernetes.service-account-token-file="/var/run/secrets/kubernetes.io/serviceaccount/token" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KUBERNETES_SERVICE_ACCOUNT_TOKEN_FILE="/var/run/secrets/kubernetes.io/serviceaccount/token"

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 --spring.cloud.vault.kubernetes.service-account-token-file="/var/run/secrets/kubernetes.io/serviceaccount/token"

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.

spring.cloud.vault.kv.application-name=application

Application name to be used for the context.

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.application-name=application

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        application-name: "application"

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 -Dspring.cloud.vault.kv.application-name="application" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_APPLICATION_NAME="application"

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 --spring.cloud.vault.kv.application-name="application"

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.

spring.cloud.vault.kv.backend=secret

Name of the default backend.

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.backend=secret

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        backend: "secret"

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 -Dspring.cloud.vault.kv.backend="secret" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_BACKEND="secret"

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 --spring.cloud.vault.kv.backend="secret"

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.

spring.cloud.vault.kv.backend-version=2

Key-Value backend version. Currently supported versions are:

Version 1 (unversioned key-value backend).
Version 2 (versioned key-value backend).

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.backend-version=2

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        backend-version: "2"

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 -Dspring.cloud.vault.kv.backend-version="2" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_BACKEND_VERSION="2"

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 --spring.cloud.vault.kv.backend-version="2"

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.

Deprecation status is WARNINGwithout a replacement setting.

spring.cloud.vault.kv.default-context=application

Name of the default context.

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.default-context=application

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        default-context: "application"

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 -Dspring.cloud.vault.kv.default-context="application" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_DEFAULT_CONTEXT="application"

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 --spring.cloud.vault.kv.default-context="application"

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.

spring.cloud.vault.kv.enabled=true

Enable the key-value backend.

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        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 -Dspring.cloud.vault.kv.enabled="true" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_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 --spring.cloud.vault.kv.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.

spring.cloud.vault.kv.profile-separator=/

Profile-separator to combine application name and profile.

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.profile-separator=/

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        profile-separator: "/"

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 -Dspring.cloud.vault.kv.profile-separator="/" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_PROFILE_SEPARATOR="/"

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 --spring.cloud.vault.kv.profile-separator="/"

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.

spring.cloud.vault.kv.profiles=

List of active profiles. @since 3.0

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties.

_{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:

spring.cloud.vault.kv.profiles=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      kv: 
        profiles: "..."

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 -Dspring.cloud.vault.kv.profiles="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_KV_PROFILES="..."

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 --spring.cloud.vault.kv.profiles="..."

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.

spring.cloud.vault.namespace=

Vault namespace (requires Vault Enterprise).

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.namespace=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      namespace: "..."

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 -Dspring.cloud.vault.namespace="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_NAMESPACE="..."

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 --spring.cloud.vault.namespace="..."

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.

spring.cloud.vault.pcf.instance-certificate=

Path to the instance certificate (PEM). Defaults to CF_INSTANCE_CERT env variable.

org.springframework.cloud.vault.config.VaultProperties$PcfProperties.

_{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:

spring.cloud.vault.pcf.instance-certificate=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      pcf: 
        instance-certificate: "..."

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 -Dspring.cloud.vault.pcf.instance-certificate="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_PCF_INSTANCE_CERTIFICATE="..."

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 --spring.cloud.vault.pcf.instance-certificate="..."

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.

spring.cloud.vault.pcf.instance-key=

Path to the instance key (PEM). Defaults to CF_INSTANCE_KEY env variable.

org.springframework.cloud.vault.config.VaultProperties$PcfProperties.

_{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:

spring.cloud.vault.pcf.instance-key=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      pcf: 
        instance-key: "..."

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 -Dspring.cloud.vault.pcf.instance-key="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_PCF_INSTANCE_KEY="..."

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 --spring.cloud.vault.pcf.instance-key="..."

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.

spring.cloud.vault.pcf.pcf-path=pcf

Mount path of the Kubernetes authentication backend.

org.springframework.cloud.vault.config.VaultProperties$PcfProperties.

_{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:

spring.cloud.vault.pcf.pcf-path=pcf

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      pcf: 
        pcf-path: "pcf"

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 -Dspring.cloud.vault.pcf.pcf-path="pcf" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_PCF_PCF_PATH="pcf"

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 --spring.cloud.vault.pcf.pcf-path="pcf"

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.

spring.cloud.vault.pcf.role=

Name of the role against which the login is being attempted.

org.springframework.cloud.vault.config.VaultProperties$PcfProperties.

_{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:

spring.cloud.vault.pcf.role=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      pcf: 
        role: "..."

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 -Dspring.cloud.vault.pcf.role="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_PCF_ROLE="..."

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 --spring.cloud.vault.pcf.role="..."

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.

spring.cloud.vault.port=8200

Vault server port.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.port=8200

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      port: "8200"

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 -Dspring.cloud.vault.port="8200" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_PORT="8200"

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 --spring.cloud.vault.port="8200"

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.

spring.cloud.vault.reactive.enabled=true

Flag to indicate that reactive discovery is enabled

org.springframework.cloud.vault.config.VaultProperties$Reactive.

_{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:

spring.cloud.vault.reactive.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      reactive: 
        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 -Dspring.cloud.vault.reactive.enabled="true" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_REACTIVE_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 --spring.cloud.vault.reactive.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.

spring.cloud.vault.read-timeout=15000

Read timeout.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.read-timeout=15000

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      read-timeout: "15000"

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 -Dspring.cloud.vault.read-timeout="15000" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_READ_TIMEOUT="15000"

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 --spring.cloud.vault.read-timeout="15000"

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.

spring.cloud.vault.scheme=https

Protocol scheme. Can be either "http" or "https".

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.scheme=https

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      scheme: "https"

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 -Dspring.cloud.vault.scheme="https" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SCHEME="https"

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 --spring.cloud.vault.scheme="https"

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.

spring.cloud.vault.session.lifecycle.enabled=true

Enable session lifecycle management.

org.springframework.cloud.vault.config.VaultProperties$SessionLifecycle.

_{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:

spring.cloud.vault.session.lifecycle.enabled=true

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      session: 
        lifecycle: 
          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 -Dspring.cloud.vault.session.lifecycle.enabled="true" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SESSION_LIFECYCLE_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 --spring.cloud.vault.session.lifecycle.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.

spring.cloud.vault.session.lifecycle.expiry-threshold=7s

The expiry threshold for a LoginToken. The threshold represents a minimum TTL duration to consider a login token as valid. Tokens with a shorter TTL are considered expired and are not used anymore. Should be greater than refreshBeforeExpiry to prevent token expiry.

org.springframework.cloud.vault.config.VaultProperties$SessionLifecycle.

_{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:

spring.cloud.vault.session.lifecycle.expiry-threshold=7s

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      session: 
        lifecycle: 
          expiry-threshold: "7s"

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 -Dspring.cloud.vault.session.lifecycle.expiry-threshold="7s" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SESSION_LIFECYCLE_EXPIRY_THRESHOLD="7s"

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 --spring.cloud.vault.session.lifecycle.expiry-threshold="7s"

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.

spring.cloud.vault.session.lifecycle.refresh-before-expiry=5s

The time period that is at least required before renewing the LoginToken.

org.springframework.cloud.vault.config.VaultProperties$SessionLifecycle.

_{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:

spring.cloud.vault.session.lifecycle.refresh-before-expiry=5s

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      session: 
        lifecycle: 
          refresh-before-expiry: "5s"

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 -Dspring.cloud.vault.session.lifecycle.refresh-before-expiry="5s" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SESSION_LIFECYCLE_REFRESH_BEFORE_EXPIRY="5s"

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 --spring.cloud.vault.session.lifecycle.refresh-before-expiry="5s"

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.

spring.cloud.vault.ssl.cert-auth-path=cert

Mount path of the TLS cert authentication backend.

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.cert-auth-path=cert

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        cert-auth-path: "cert"

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 -Dspring.cloud.vault.ssl.cert-auth-path="cert" -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_CERT_AUTH_PATH="cert"

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 --spring.cloud.vault.ssl.cert-auth-path="cert"

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.

spring.cloud.vault.ssl.enabled-cipher-suites=

List of enabled SSL/TLS cipher suites. @since 3.0.2

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.enabled-cipher-suites=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        enabled-cipher-suites: "..."

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 -Dspring.cloud.vault.ssl.enabled-cipher-suites="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_ENABLED_CIPHER_SUITES="..."

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 --spring.cloud.vault.ssl.enabled-cipher-suites="..."

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.

spring.cloud.vault.ssl.enabled-protocols=

List of enabled SSL/TLS protocol. @since 3.0.2

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.enabled-protocols=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        enabled-protocols: "..."

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 -Dspring.cloud.vault.ssl.enabled-protocols="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_ENABLED_PROTOCOLS="..."

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 --spring.cloud.vault.ssl.enabled-protocols="..."

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.

spring.cloud.vault.ssl.key-store=

Trust store that holds certificates and private keys.

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.key-store=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        key-store: "..."

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 -Dspring.cloud.vault.ssl.key-store="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_KEY_STORE="..."

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 --spring.cloud.vault.ssl.key-store="..."

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.

spring.cloud.vault.ssl.key-store-password=

Password used to access the key store.

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.key-store-password=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        key-store-password: "..."

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 -Dspring.cloud.vault.ssl.key-store-password="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_KEY_STORE_PASSWORD="..."

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 --spring.cloud.vault.ssl.key-store-password="..."

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.

spring.cloud.vault.ssl.key-store-type=

Type of the key store. @since 3.0

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.key-store-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        key-store-type: "..."

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 -Dspring.cloud.vault.ssl.key-store-type="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_KEY_STORE_TYPE="..."

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 --spring.cloud.vault.ssl.key-store-type="..."

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.

spring.cloud.vault.ssl.trust-store=

Trust store that holds SSL certificates.

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.trust-store=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        trust-store: "..."

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 -Dspring.cloud.vault.ssl.trust-store="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_TRUST_STORE="..."

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 --spring.cloud.vault.ssl.trust-store="..."

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.

spring.cloud.vault.ssl.trust-store-password=

Password used to access the trust store.

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.trust-store-password=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        trust-store-password: "..."

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 -Dspring.cloud.vault.ssl.trust-store-password="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_TRUST_STORE_PASSWORD="..."

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 --spring.cloud.vault.ssl.trust-store-password="..."

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.

spring.cloud.vault.ssl.trust-store-type=

Type of the trust store. @since 3.0

org.springframework.cloud.vault.config.VaultProperties$Ssl.

_{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:

spring.cloud.vault.ssl.trust-store-type=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      ssl: 
        trust-store-type: "..."

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 -Dspring.cloud.vault.ssl.trust-store-type="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_SSL_TRUST_STORE_TYPE="..."

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 --spring.cloud.vault.ssl.trust-store-type="..."

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.

spring.cloud.vault.token=

Static vault token. Required if #authentication is TOKEN.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.token=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      token: "..."

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 -Dspring.cloud.vault.token="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_TOKEN="..."

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 --spring.cloud.vault.token="..."

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.

spring.cloud.vault.uri=

Vault URI. Can be set with scheme, host and port.

org.springframework.cloud.vault.config.VaultProperties.

_{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:

spring.cloud.vault.uri=...

CAS properties can be specified using the YAML syntax:

spring: 
  cloud: 
    vault: 
      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 -Dspring.cloud.vault.uri="..." -jar build/libs/cas.war

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

export SPRING_CLOUD_VAULT_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 --spring.cloud.vault.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.

# Mount path of the AppId authentication backend.
# spring.cloud.vault.app-id.app-id-path=app-id

# Network interface hint for the "MAC_ADDRESS" UserId mechanism.
# spring.cloud.vault.app-id.network-interface=

# UserId mechanism.
# spring.cloud.vault.app-id.user-id=MAC_ADDRESS

# Mount path of the AppRole authentication backend.
# spring.cloud.vault.app-role.app-role-path=approle

# Name of the role, optional, used for pull-mode.
# spring.cloud.vault.app-role.role=

# The RoleId.
# spring.cloud.vault.app-role.role-id=

# The SecretId.
# spring.cloud.vault.app-role.secret-id=

# Application name for AppId authentication.
# spring.cloud.vault.application-name=application

# 
# spring.cloud.vault.authentication=

# Mount path of the AWS-EC2 authentication backend.
# spring.cloud.vault.aws-ec2.aws-ec2-path=aws-ec2

# URL of the AWS-EC2 PKCS7 identity document.
# spring.cloud.vault.aws-ec2.identity-document=http://169.254.169.254/latest/dynamic/instance-identity/pkcs7

# Nonce used for AWS-EC2 authentication.
# spring.cloud.vault.aws-ec2.nonce=

# Name of the role, optional.
# spring.cloud.vault.aws-ec2.role=

# Mount path of the AWS authentication backend.
# spring.cloud.vault.aws-iam.aws-path=aws

# STS server URI.
# spring.cloud.vault.aws-iam.endpoint-uri=

# Name of the region, optional.
# spring.cloud.vault.aws-iam.region=

# Name of the role, optional.
# spring.cloud.vault.aws-iam.role=

# Name of the server used to set {@code X-Vault-AWS-IAM-Server-ID} header in the headers of login requests.
# spring.cloud.vault.aws-iam.server-name=

# Mount path of the Azure MSI authentication backend.
# spring.cloud.vault.azure-msi.azure-path=azure

# Identity token service URI.
# spring.cloud.vault.azure-msi.identity-token-service=

# Instance metadata service URI.
# spring.cloud.vault.azure-msi.metadata-service=

# Name of the role.
# spring.cloud.vault.azure-msi.role=

# Enable lifecycle management.
# spring.cloud.vault.config.lifecycle.enabled=true

# The expiry threshold.
# spring.cloud.vault.config.lifecycle.expiry-threshold=

# Set the {@link LeaseEndpoints} to delegate renewal/revocation calls to.
# spring.cloud.vault.config.lifecycle.lease-endpoints=

# Sets the {@link LeaseStrategy} to be used with {@link org.springframework.vault.core.lease.SecretLeaseContainer#setLeaseStrategy(LeaseStrategy)} to retain or drop tokens on renewal errors.
# spring.cloud.vault.config.lifecycle.lease-strategy=

# The time period that is at least required before renewing a lease.
# spring.cloud.vault.config.lifecycle.min-renewal=

# Used to set a {@link org.springframework.core.env.PropertySource} priority.
# spring.cloud.vault.config.order=0

# Connection timeout.
# spring.cloud.vault.connection-timeout=5000

# Flag to indicate that Vault server discovery is enabled (vault server URL will be looked up via discovery).
# spring.cloud.vault.discovery.enabled=false

# Service id to locate Vault.
# spring.cloud.vault.discovery.service-id=vault

# Enable Vault config server.
# spring.cloud.vault.enabled=true

# Fail fast if data cannot be obtained from Vault.
# spring.cloud.vault.fail-fast=false

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.gcp-gce.gcp-path=gcp

# Name of the role against which the login is being attempted.
# spring.cloud.vault.gcp-gce.role=

# Optional service account id.
# spring.cloud.vault.gcp-gce.service-account=

# The base64 encoded contents of an OAuth2 account private key in JSON format.
# spring.cloud.vault.gcp-iam.credentials.encoded-key=

# Location of the OAuth2 credentials private key.
# spring.cloud.vault.gcp-iam.credentials.location=

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.gcp-iam.gcp-path=gcp

# Validity of the JWT token.
# spring.cloud.vault.gcp-iam.jwt-validity=15m

# Overrides the GCP project Id.
# spring.cloud.vault.gcp-iam.project-id=

# Name of the role against which the login is being attempted.
# spring.cloud.vault.gcp-iam.role=

# Overrides the GCP service account Id.
# spring.cloud.vault.gcp-iam.service-account-id=

# Vault server host.
# spring.cloud.vault.host=localhost

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.kubernetes.kubernetes-path=kubernetes

# Name of the role against which the login is being attempted.
# spring.cloud.vault.kubernetes.role=

# Path to the service account token file.
# spring.cloud.vault.kubernetes.service-account-token-file=/var/run/secrets/kubernetes.io/serviceaccount/token

# Application name to be used for the context.
# spring.cloud.vault.kv.application-name=application

# Name of the default backend.
# spring.cloud.vault.kv.backend=secret

# Key-Value backend version.
# spring.cloud.vault.kv.backend-version=2

# Name of the default context.
# spring.cloud.vault.kv.default-context=application

# Enable the key-value backend.
# spring.cloud.vault.kv.enabled=true

# Profile-separator to combine application name and profile.
# spring.cloud.vault.kv.profile-separator=/

# List of active profiles.
# spring.cloud.vault.kv.profiles=

# Vault namespace (requires Vault Enterprise).
# spring.cloud.vault.namespace=

# Path to the instance certificate (PEM).
# spring.cloud.vault.pcf.instance-certificate=

# Path to the instance key (PEM).
# spring.cloud.vault.pcf.instance-key=

# Mount path of the Kubernetes authentication backend.
# spring.cloud.vault.pcf.pcf-path=pcf

# Name of the role against which the login is being attempted.
# spring.cloud.vault.pcf.role=

# Vault server port.
# spring.cloud.vault.port=8200

# Flag to indicate that reactive discovery is enabled
# spring.cloud.vault.reactive.enabled=true

# Read timeout.
# spring.cloud.vault.read-timeout=15000

# Protocol scheme.
# spring.cloud.vault.scheme=https

# Enable session lifecycle management.
# spring.cloud.vault.session.lifecycle.enabled=true

# The expiry threshold for a {@link LoginToken}.
# spring.cloud.vault.session.lifecycle.expiry-threshold=7s

# The time period that is at least required before renewing the {@link LoginToken}.
# spring.cloud.vault.session.lifecycle.refresh-before-expiry=5s

# Mount path of the TLS cert authentication backend.
# spring.cloud.vault.ssl.cert-auth-path=cert

# List of enabled SSL/TLS cipher suites.
# spring.cloud.vault.ssl.enabled-cipher-suites=

# List of enabled SSL/TLS protocol.
# spring.cloud.vault.ssl.enabled-protocols=

# Trust store that holds certificates and private keys.
# spring.cloud.vault.ssl.key-store=

# Password used to access the key store.
# spring.cloud.vault.ssl.key-store-password=

# Type of the key store.
# spring.cloud.vault.ssl.key-store-type=

# Trust store that holds SSL certificates.
# spring.cloud.vault.ssl.trust-store=

# Password used to access the trust store.
# spring.cloud.vault.ssl.trust-store-password=

# Type of the trust store.
# spring.cloud.vault.ssl.trust-store-type=

# Static vault token.
# spring.cloud.vault.token=

# Vault URI.
# spring.cloud.vault.uri=

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.

With CAS, secrets are picked up at startup of the application server. CAS uses the data and settings from the application name (i.e. cas) and active profiles to determine contexts paths in which secrets should be stored and later fetched.

These context paths typically are:

/secret/{application}/{profile}
/secret/{application}

As an example, you may write the following CAS setting to Vault:

vault write secret/cas/native <setting-name>=<value>

CAS will execute the equivalent of the following command to read settings later when needed:

vault read secret/cas/native

All settings and secrets that are stored inside Vault may be reloaded at any given time. To learn more about how CAS allows you to reload configuration changes, please review this guide. To learn more about how configuration is managed and profiled by CAS, please review this guide.

Troubleshooting

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

<Logger name="org.springframework.cloud.vault" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>