此版本仍在开发中，尚未被视为稳定版本。如需最新的稳定版本，请使用 Spring Cloud Vault 4.1.4！spring-doc.cn

秘密后端

键值后端

Spring Cloud Vault 支持键值秘密后端，即版本化（v2）和未版本化（v1）。键值后端允许将任意值存储为键值存储。单个上下文可以存储一个或多个键值元组。上下文可以按层次结构进行组织。 Spring Cloud Vault 会自行确定秘密是否正在使用版本控制，并将路径映射到其相应的 URL。 Spring Cloud Vault 允许将应用程序名称和默认上下文名称（）与活动配置文件结合使用。applicationspring-doc.cn

/secret/{application}/{profile}
/secret/{application}
/secret/{default-context}/{profile}
/secret/{default-context}

应用程序名称由以下属性确定：spring-doc.cn

spring.cloud.vault.kv.application-namespring-doc.cn
spring.cloud.vault.application-namespring-doc.cn
spring.application.namespring-doc.cn

配置文件由以下属性确定：spring-doc.cn

spring.cloud.vault.kv.profilesspring-doc.cn
spring.profiles.activespring-doc.cn

可以通过将 Secret 的路径添加到应用程序名称（以逗号分隔）来从 key-value backend 中的其他上下文中获取。例如，给定 application name ，将使用以下每个文件夹：usefulapp,mysql1,projectx/awsspring-doc.cn

/secret/usefulappspring-doc.cn
/secret/mysql1spring-doc.cn
/secret/projectx/awsspring-doc.cn

Spring Cloud Vault 将所有活动配置文件添加到可能的上下文路径列表中。任何活动配置文件都不会跳过访问具有配置文件名称的上下文。spring-doc.cn

属性的公开方式与存储时一样（即没有额外的前缀）。spring-doc.cn

Spring Cloud Vault 在挂载路径和实际上下文路径之间添加上下文，具体取决于挂载是否使用版本控制的键值后端。data/

spring.cloud.vault:
    kv:
        enabled: true
        backend: secret
        profile-separator: '/'
        default-context: application
        application-name: my-app
        profiles: local, cloud

enabled将此值设置为禁用 secret 后端配置使用falsespring-doc.cn
backend设置要使用的 secret 挂载的路径spring-doc.cn
default-context设置所有应用程序使用的上下文名称spring-doc.cn
application-name覆盖应用程序名称以在 key-value 后端中使用spring-doc.cn
profiles覆盖活动配置文件以在 key-value 后端中使用spring-doc.cn
profile-separator使用 Profiles 将 Profile 名称与 Property Sources 中的上下文分开spring-doc.cn

键值密钥后端可以在版本控制（v2）和非版本控制（v1）模式下运行。

另请参阅：spring-doc.cn

领事

Spring Cloud Vault 可以获取 HashiCorp Consul 的凭据。 Consul 集成需要 dependency。spring-cloud-vault-config-consulspring-doc.cn

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-vault-config-consul</artifactId>
        <version>4.2.0-RC1</version>
    </dependency>
</dependencies>

可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.consul.enabled=truefalsespring.cloud.vault.consul.role=…spring-doc.cn

获取的令牌存储在其中，因此使用 Spring Cloud Consul 无需进一步配置即可获取生成的凭据。您可以通过设置来配置属性名称。spring.cloud.consul.tokenspring.cloud.vault.consul.token-propertyspring-doc.cn

spring.cloud.vault:
    consul:
        enabled: true
        role: readonly
        backend: consul
        token-property: spring.cloud.consul.token

enabled将此值设置为启用 Consul 后端配置使用truespring-doc.cn
role设置 Consul 角色定义的角色名称spring-doc.cn
backend设置要使用的 Consul 挂载的路径spring-doc.cn
token-property设置存储 Consul ACL 令牌的属性名称spring-doc.cn

另请参阅：Vault 文档：使用 Vault 设置 Consul spring-doc.cn

RabbitMQ 函数

Spring Cloud Vault 可以获取 RabbitMQ 的凭据。spring-doc.cn

RabbitMQ 集成需要依赖项。spring-cloud-vault-config-rabbitmqspring-doc.cn

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-vault-config-rabbitmq</artifactId>
        <version>4.2.0-RC1</version>
    </dependency>
</dependencies>

可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.rabbitmq.enabled=truefalsespring.cloud.vault.rabbitmq.role=…spring-doc.cn

用户名和密码存储在其中，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.rabbitmq.usernamespring.rabbitmq.passwordspring.cloud.vault.rabbitmq.username-propertyspring.cloud.vault.rabbitmq.password-propertyspring-doc.cn

spring.cloud.vault:
    rabbitmq:
        enabled: true
        role: readonly
        backend: rabbitmq
        username-property: spring.rabbitmq.username
        password-property: spring.rabbitmq.password

enabled将此值设置为启用 RabbitMQ 后端配置使用truespring-doc.cn
role设置 RabbitMQ 角色定义的角色名称spring-doc.cn
backend设置要使用的 RabbitMQ 挂载的路径spring-doc.cn
username-property设置存储 RabbitMQ 用户名的属性名称spring-doc.cn
password-property设置存储 RabbitMQ 密码的属性名称spring-doc.cn

另见：Vault 文档：使用 Vault 设置 RabbitMQ spring-doc.cn

AWS

Spring Cloud Vault 可以获取 AWS 的凭证。spring-doc.cn

AWS 集成需要依赖项。spring-cloud-vault-config-awsspring-doc.cn

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-vault-config-aws</artifactId>
        <version>4.2.0-RC1</version>
    </dependency>
</dependencies>

可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.aws=truefalsespring.cloud.vault.aws.role=…spring-doc.cn

支持的 AWS 凭证类型：spring-doc.cn

iam_user （默认）spring-doc.cn
assumed_role （STS）spring-doc.cn
federation_token （STS）spring-doc.cn

访问密钥和密钥存储在和中。因此，使用 Spring Cloud，AWS 将获取生成的凭证，而无需进一步配置。cloud.aws.credentials.accessKeycloud.aws.credentials.secretKeyspring-doc.cn

您可以通过设置和来配置属性名称。spring.cloud.vault.aws.access-key-propertyspring.cloud.vault.aws.secret-key-propertyspring-doc.cn

对于 STS 安全令牌，您可以通过设置来配置属性名称。安全令牌存储在（defaults）下。spring.cloud.vault.aws.session-token-key-propertycloud.aws.credentials.sessionTokenspring-doc.cn

示例：iam_userspring-doc.cn

spring.cloud.vault:
    aws:
        enabled: true
        role: readonly
        backend: aws
        access-key-property: cloud.aws.credentials.accessKey
        secret-key-property: cloud.aws.credentials.secretKey

示例：assumed_role （STS）spring-doc.cn

spring.cloud.vault:
    aws:
        enabled: true
        role: sts-vault-role
        backend: aws
        credential-type: assumed_role
        access-key-property: cloud.aws.credentials.accessKey
        secret-key-property: cloud.aws.credentials.secretKey
        session-token-key-property: cloud.aws.credentials.sessionToken
        ttl: 3600s
        role-arn: arn:aws:iam::${AWS_ACCOUNT}:role/sts-app-role

enabled将此值设置为启用 AWS 后端配置使用truespring-doc.cn
role设置 AWS 角色定义的角色名称spring-doc.cn
backend设置要使用的 AWS 挂载的路径spring-doc.cn
access-key-property设置存储 AWS 访问密钥的属性名称spring-doc.cn
secret-key-property设置存储 AWS Secret Key 的属性名称spring-doc.cn
session-token-key-property设置存储 AWS STS 安全令牌的属性名称。spring-doc.cn
credential-type设置用于此后端的 AWS 凭证类型。默认为iam_userspring-doc.cn
ttl在使用或时设置 STS 令牌的 TTL。默认为 vault 角色指定的 ttl。最小值/最大值也仅限于 AWS 对 STS 的支持值。assumed_rolefederation_tokenspring-doc.cn
role-arn在使用 .assumed_rolespring-doc.cn

另请参阅：Vault 文档：使用 Vault 设置 AWS spring-doc.cn

数据库后端

Vault 支持多个数据库密钥后端，以根据配置的角色动态生成数据库凭证。这意味着需要访问数据库的服务不再需要配置凭证：它们可以从 Vault 请求凭证，并使用 Vault 的租赁机制更轻松地滚动密钥。spring-doc.cn

Spring Cloud Vault 与以下后端集成：spring-doc.cn

使用数据库密钥后端需要在配置和依赖项中启用后端。spring-cloud-vault-config-databasesspring-doc.cn

Vault 从 0.7.1 开始提供专用的秘密后端，允许通过插件集成数据库。您可以通过使用通用数据库后端来使用该特定后端。确保指定适当的后端路径，例如 .databasespring.cloud.vault.mysql.role.backend=databasespring-doc.cn

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-vault-config-databases</artifactId>
        <version>4.2.0-RC1</version>
    </dependency>
</dependencies>

启用多个符合 JDBC 标准的数据库将生成凭据，并默认将其存储在相同的属性键中，因此需要单独配置 JDBC 密钥的属性名称。

数据库

Spring Cloud Vault 可以获取 www.vaultproject.io/api/secret/databases/index.html 中列出的任何数据库的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.database.enabled=truefalsespring.cloud.vault.database.role=…spring-doc.cn

虽然数据库后端是通用的，但专门针对 JDBC 数据库。用户名和密码可从和 properties 获得因此，使用 Spring Boot 将为您获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.cloud.vault.databasespring.datasource.usernamespring.datasource.passwordDataSourcespring.cloud.vault.database.username-propertyspring.cloud.vault.database.password-propertyspring-doc.cn

spring.cloud.vault:
    database:
        enabled: true
        role: readonly
        backend: database
        username-property: spring.datasource.username
        password-property: spring.datasource.password

多个数据库

有时，单个数据库的凭据是不够的，因为应用程序可能会连接到两个或多个相同类型的数据库。从版本 3.0.5 开始， Spring Vault 支持在名称空间下配置多个数据库秘密后端。spring.cloud.vault.databases.*spring-doc.cn

该配置接受多个数据库后端，以将凭证具体化到指定的属性中。确保配置并适当。username-propertypassword-propertyspring-doc.cn

spring.cloud.vault:
    databases:
        primary:
            enabled: true
            role: readwrite
            backend: database
            username-property: spring.primary-datasource.username
            password-property: spring.primary-datasource.password
        other-database:
            enabled: true
            role: readonly
            backend: database
            username-property: spring.secondary-datasource.username
            password-property: spring.secondary-datasource.password

<name>数据库配置的描述性名称。spring-doc.cn
<name>.enabled将此值设置为 enable the Database backend config usagetruespring-doc.cn
<name>.role设置数据库角色定义的角色名称spring-doc.cn
<name>.backend设置要使用的 Database mount 的路径spring-doc.cn
<name>.username-property设置存储 Database username 的属性名称。确保使用唯一的属性名称以避免属性阴影。spring-doc.cn
<name>.password-property设置存储 Database 口令的属性名称确保使用唯一的属性名称以避免属性阴影。spring-doc.cn

另请参阅：Vault 文档：Database Secrets 后端 spring-doc.cn

Spring Cloud Vault 不支持在达到最大租约时间时获取新凭据并使用它们进行配置。也就是说，如果 Vault 中的 Database 角色设置为，则表示在应用程序启动 24 小时后，它将无法再向数据库进行身份验证。DataSourcemax_ttl24h

Apache Cassandra

后端在 Vault 0.7.1 中已弃用，建议使用后端并将其挂载为 .cassandradatabasecassandra

Spring Cloud Vault 可以获取 Apache Cassandra 的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.cassandra.enabled=truefalsespring.cloud.vault.cassandra.role=…spring-doc.cn

用户名和密码可从和 properties 获得，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.data.cassandra.usernamespring.data.cassandra.passwordspring.cloud.vault.cassandra.username-propertyspring.cloud.vault.cassandra.password-propertyspring-doc.cn

spring.cloud.vault:
    cassandra:
        enabled: true
        role: readonly
        backend: cassandra
        username-property: spring.data.cassandra.username
        password-property: spring.data.cassandra.password

enabled将此值设置为 Enable the Cassandra backend config usagetruespring-doc.cn
role设置 Cassandra 角色定义的角色名称spring-doc.cn
backend设置要使用的 Cassandra 挂载的路径spring-doc.cn
username-property设置存储 Cassandra 用户名的属性名称spring-doc.cn
password-property设置存储 Cassandra 密码的属性名称spring-doc.cn

另请参见：Vault 文档：使用 Vault 设置 Apache Cassandra spring-doc.cn

Couchbase 数据库

Spring Cloud Vault 可以获取 Couchbase 的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.couchbase.enabled=truefalsespring.cloud.vault.couchbase.role=…spring-doc.cn

用户名和密码可从和 properties 获得，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.couchbase.usernamespring.couchbase.passwordspring.cloud.vault.couchbase.username-propertyspring.cloud.vault.couchbase.password-propertyspring-doc.cn

spring.cloud.vault:
    couchbase:
        enabled: true
        role: readonly
        backend: database
        username-property: spring.couchbase.username
        password-property: spring.couchbase.password

enabled将此值设置为 Enable the Couchbase backend config usagetruespring-doc.cn
role设置 Couchbase 角色定义的角色名称spring-doc.cn
backend设置要使用的 Couchbase 挂载的路径spring-doc.cn
username-property设置存储 Couchbase 用户名的属性名称spring-doc.cn
password-property设置存储 Couchbase 密码的属性名称spring-doc.cn

另请参阅：Couchbase 数据库插件文档 spring-doc.cn

Elasticsearch

Spring Cloud Vault 可以从 3.0 版本开始获取 Elasticsearch 的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.elasticsearch.enabled=truefalsespring.cloud.vault.elasticsearch.role=…spring-doc.cn

用户名和密码可从和 properties 获得，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.elasticsearch.rest.usernamespring.elasticsearch.rest.passwordspring.cloud.vault.elasticsearch.username-propertyspring.cloud.vault.elasticsearch.password-propertyspring-doc.cn

spring.cloud.vault:
    elasticsearch:
        enabled: true
        role: readonly
        backend: mongodb
        username-property: spring.elasticsearch.rest.username
        password-property: spring.elasticsearch.rest.password

enabled将此值设置为 enable the Elasticsearch database backend config usagetruespring-doc.cn
role设置 Elasticsearch 角色定义的角色名称spring-doc.cn
backend设置要使用的 Elasticsearch 挂载的路径spring-doc.cn
username-property设置存储 Elasticsearch 用户名的属性名称spring-doc.cn
password-property设置存储 Elasticsearch 密码的属性名称spring-doc.cn

另请参阅：Vault 文档：使用 Vault 设置 Elasticsearch spring-doc.cn

MongoDB 数据库

后端在 Vault 0.7.1 中已弃用，建议使用后端并将其挂载为 .mongodbdatabasemongodb

Spring Cloud Vault 可以获取 MongoDB 的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.mongodb.enabled=truefalsespring.cloud.vault.mongodb.role=…spring-doc.cn

用户名和密码存储在其中，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.data.mongodb.usernamespring.data.mongodb.passwordspring.cloud.vault.mongodb.username-propertyspring.cloud.vault.mongodb.password-propertyspring-doc.cn

spring.cloud.vault:
    mongodb:
        enabled: true
        role: readonly
        backend: mongodb
        username-property: spring.data.mongodb.username
        password-property: spring.data.mongodb.password

enabled将此值设置为启用 MongoDB 后端配置使用truespring-doc.cn
role设置 MongoDB 角色定义的角色名称spring-doc.cn
backend设置要使用的 MongoDB 挂载的路径spring-doc.cn
username-property设置存储 MongoDB 用户名的属性名称spring-doc.cn
password-property设置存储 MongoDB 密码的属性名称spring-doc.cn

另见：Vault 文档：使用 Vault 设置 MongoDB spring-doc.cn

MySQL （MySQL的

后端在 Vault 0.7.1 中已弃用，建议使用后端并将其挂载为 . 的配置将在将来的版本中删除。mysqldatabasemysqlspring.cloud.vault.mysql

Spring Cloud Vault 可以获取 MySQL 的凭证。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.mysql.enabled=truefalsespring.cloud.vault.mysql.role=…spring-doc.cn

用户名和密码可从和 properties 获得，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.datasource.usernamespring.datasource.passwordspring.cloud.vault.mysql.username-propertyspring.cloud.vault.mysql.password-propertyspring-doc.cn

spring.cloud.vault:
    mysql:
        enabled: true
        role: readonly
        backend: mysql
        username-property: spring.datasource.username
        password-property: spring.datasource.password

enabled将此值设置为启用 MySQL 后端配置使用truespring-doc.cn
role设置 MySQL 角色定义的角色名称spring-doc.cn
backend设置要使用的 MySQL 挂载的路径spring-doc.cn
username-property设置存储 MySQL 用户名的属性名称spring-doc.cn
password-property设置存储 MySQL 密码的属性名称spring-doc.cn

另见：Vault 文档：使用 Vault 设置 MySQL spring-doc.cn

PostgreSQL 数据库

后端在 Vault 0.7.1 中已弃用，建议使用后端并将其挂载为 . 的配置将在将来的版本中删除。postgresqldatabasepostgresqlspring.cloud.vault.postgresql

Spring Cloud Vault 可以获取 PostgreSQL 的凭据。可以通过设置（default ）并为角色名称提供来启用集成。spring.cloud.vault.postgresql.enabled=truefalsespring.cloud.vault.postgresql.role=…spring-doc.cn

用户名和密码可从和 properties 获得，因此使用 Spring Boot 将获取生成的凭据，而无需进一步配置。您可以通过设置和来配置属性名称。spring.datasource.usernamespring.datasource.passwordspring.cloud.vault.postgresql.username-propertyspring.cloud.vault.postgresql.password-propertyspring-doc.cn

spring.cloud.vault:
    postgresql:
        enabled: true
        role: readonly
        backend: postgresql
        username-property: spring.datasource.username
        password-property: spring.datasource.password

enabled将此值设置为启用 PostgreSQL 后端配置使用truespring-doc.cn
role设置 PostgreSQL 角色定义的角色名称spring-doc.cn
backend设置要使用的 PostgreSQL 挂载的路径spring-doc.cn
username-property设置存储 PostgreSQL 用户名的属性名称spring-doc.cn
password-property设置存储 PostgreSQL 密码的属性名称spring-doc.cn

另见：Vault 文档：使用 Vault 设置 PostgreSQL spring-doc.cn

自定义要作为 PropertySource 公开的 secret 后端

Spring Cloud Vault 使用基于属性的配置为键值和发现的秘密后端创建 s。PropertySourcespring-doc.cn

发现的后端提供 bean 来描述使用 secret backend 的配置状态，如 . 需要 A 才能创建包含 path、name 和 property transformation 配置的对象。VaultSecretBackendDescriptorPropertySourceSecretBackendMetadataFactorySecretBackendMetadataspring-doc.cn

SecretBackendMetadata用于支持特定的 .PropertySourcespring-doc.cn

您可以注册 for customization. 如果您提供 . 但是，您可以使用和启用默认注册。VaultConfigurerVaultConfigurerSecretBackendConfigurer.registerDefaultKeyValueSecretBackends()SecretBackendConfigurer.registerDefaultDiscoveredSecretBackends()spring-doc.cn

public class CustomizationBean implements VaultConfigurer {

    @Override
    public void addSecretBackends(SecretBackendConfigurer configurer) {

        configurer.add("secret/my-application");

        configurer.registerDefaultKeyValueSecretBackends(false);
        configurer.registerDefaultDiscoveredSecretBackends(true);
    }
}

SpringApplication application = new SpringApplication(MyApplication.class);
application.addBootstrapper(VaultBootstrapper.fromConfigurer(new CustomizationBean()));

自定义密钥后端实现

Spring Cloud Vault 为最常见的后端集成提供了秘密后端支持。您可以通过提供一个实现来与任何类型的后端集成，该实现描述如何从要使用的后端获取数据，以及如何通过提供 .PropertyTransformerspring-doc.cn

为后端添加自定义实现需要实现两个接口：spring-doc.cn

org.springframework.cloud.vault.config.VaultSecretBackendDescriptorspring-doc.cn
org.springframework.cloud.vault.config.SecretBackendMetadataFactoryspring-doc.cn

VaultSecretBackendDescriptor通常是保存配置数据的对象，例如 .Spring Cloud Vault 要求对你的类型进行注释，以便从配置中具体化类。VaultDatabaseProperties@ConfigurationPropertiesspring-doc.cn

SecretBackendMetadataFactory接受创建在 Vault 服务器中保存上下文路径的实际对象、解析参数化上下文路径所需的任何路径变量以及 .VaultSecretBackendDescriptorSecretBackendMetadataPropertyTransformerspring-doc.cn

both 和 types 都必须注册，其中是 Spring 提供的扩展机制，类似于 Java 的 ServiceLoader。VaultSecretBackendDescriptorSecretBackendMetadataFactoryspring.factoriesspring-doc.cn