APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Spring Cloud Configuration Server - GCP Secret Manager

CAS is also able to use Google Cloud Secret Manager to locate properties and settings. This functionality is delivered to CAS via Spring Cloud GCP.

Support is provided via the following dependency in the WAR overlay:



1
2
3
4
5



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





1



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





1
2
3
4
5
6
7
8
9



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

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





1
2
3
4
5
6
7
8
9
10



dependencies {
    /*
        The following platform references are included automatically and are listed 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-gcp-secretsmanager"
}
:information_source: Usage

The configuration modules provided here may also be used verbatim inside a CAS server overlay and do not exclusively belong to a Spring Cloud Configuration server. While this module is primarily useful when inside the Spring Cloud Configuration server, it nonetheless may also be used inside a CAS server overlay directly to fetch settings from a source.

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

spring.cloud.gcp.secretmanager.allow-default-secretWhether the secret manager will allow a default secret value when accessing a non-existing secret.
false
Third party

Whether the secret manager will allow a default secret value when accessing a non-existing secret.

When set to false, the secret manager will throw a com.google.api.gax.rpc.NotFoundException.

Type
Boolean
Default
false
Defined by
GcpSecretManagerProperties
spring.cloud.gcp.secretmanager.credentials.default-scopes
no default
Third party
Type
String[]
Default
none
Defined by
Credentials
spring.cloud.gcp.secretmanager.enabledAuto-configure GCP Secret Manager support components.
true
Third party

Auto-configure GCP Secret Manager support components.

Type
Boolean
Default
true
spring.cloud.gcp.secretmanager.project-idOverrides the GCP Project ID specified in the Core module.
no default
Third party

Overrides the GCP Project ID specified in the Core module.

Type
String
Default
none
Defined by
GcpSecretManagerProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Notes on configuration

Configuration Metadata

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

Be Selective

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

YAGNI

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

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_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.

:information_source: Note

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

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

Validation

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

Indexed Settings

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

Secret Manager Config Data Resource

The functionality presented here enables you to use Secret Manager as an external config data resource which means it allows you to specify and load secrets from Google Cloud Secret Manager as properties into the application context using Spring Boot’s Config Data API.

The Secret Manager config data resource uses the following syntax to specify secrets:



1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18



# 1. Long form - specify the project ID, secret ID, and version
sm@projects/<project-id>/secrets/<secret-id>/versions/<version-id>}                           

# 2.  Long form - specify project ID, secret ID, and use latest version
sm@projects/<project-id>/secrets/<secret-id>

# 3. Short form - specify project ID, secret ID, and version
sm@<project-id>/<secret-id>/<version-id>

# 4. Short form - default project; specify secret + version
#
# The project is inferred from the spring.cloud.gcp.secretmanager.project-id setting
# in your bootstrap.properties (see Configuration) or from application-default credentials if
# this is not set.
sm@<secret-id>/<version>

# 5. Shortest form - specify secret ID, use default project and latest version.
sm@<secret-id>

You can use this syntax in your CAS configuration:



1
2
3
4
5



# This may be optional
# spring.config.import=sm@

# Example of the project-secret long-form syntax.
cas.some.property=${sm@projects/<project-id>/secrets/cas_some_property}