VaultTemplate 简介

类 VaultTemplate 位于包 org.springframework.vault.core 中，是 Spring Vault 支持的核心类，提供丰富的功能集以与 Vault 交互。该模板提供方便的操作，用于在 Vault 中读取、写入和删除数据，并提供您的域对象与 Vault 数据之间的映射。

一旦配置完成，VaultTemplate 是线程安全的，可以在多个实例中重用。

Vault 文档和域类之间的映射通过委托给 RestTemplate 完成。Spring Web 支持提供映射基础设施。

VaultTemplate 类实现了接口 VaultOperations。在可能的情况下，VaultOperations 上的方法名称与 Vault API 上可用的方法名称相同，以使熟悉 API 和 CLI 的现有 Vault 开发人员熟悉该 API。例如，您会找到诸如“write”、“delete”、“read”和“revoke”之类的方法。设计目标是尽可能简化 Vault API 和 VaultOperations 之间的转换。两个 API 之间的一个主要区别是 VaultOperations 可以传递域对象而不是 JSON 键值对。

VaultTemplate 中使用的路径（以及可从中访问的接口）被视为相对于 VaultEndpoint。完全限定的 URI 路径可用于在经过身份验证的上下文中访问 Vault 集群成员。为防止不必要的完整 URI 访问，请确保在将路径传递给 VaultTemplate 之前对其进行清理。

引用 VaultTemplate 实例上的操作的首选方式是通过其接口 VaultOperations。

虽然 VaultTemplate 上有许多便利方法可以帮助您轻松执行常见任务，但如果您需要直接访问 Vault API 以访问 VaultTemplate 未明确公开的功能，您可以使用几种执行回调方法之一来访问底层 API。执行回调将为您提供一个 RestOperations 对象的引用。有关更多信息，请参阅 执行回调 部分。

现在让我们看一些如何在 Spring 容器上下文中与 Vault 协作的示例。

注册和配置 Spring Vault bean

使用 Spring Vault 不需要 Spring Context。但是，在托管上下文中注册的 VaultTemplate 和 SessionManager 实例将参与 Spring IoC 容器提供的生命周期事件。这对于在应用程序关闭时处理活动 Vault 会话非常有用。您还可以受益于在整个应用程序中重用相同的 VaultTemplate 实例。

Spring Vault 提供了一个支持配置类，该类提供在 Spring 上下文内部使用的 bean 定义。应用程序配置类通常继承自 AbstractVaultConfiguration，并且需要提供特定于环境的额外详细信息。

继承自 AbstractVaultConfiguration 需要实现 VaultEndpoint vaultEndpoint() 和 ClientAuthentication clientAuthentication() 方法。

示例 1. 使用基于 Java 的 bean 元数据注册 Spring Vault 对象
@Configuration
public class AppConfig extends AbstractVaultConfiguration {

    /**
     * Specify an endpoint for connecting to Vault.
     */
    @Override
    public VaultEndpoint vaultEndpoint() {
        return new VaultEndpoint();                            (1)
    }

    /**
     * Configure a client authentication.
     * Please consider a more secure authentication method
     * for production use.
     */
    @Override
    public ClientAuthentication clientAuthentication() {
        return new TokenAuthentication("…");                   (2)
    }
}
1 创建一个新的 VaultEndpoint，默认指向 https://:8200。
2 此示例使用 TokenAuthentication 快速入门。有关支持的身份验证方法的详细信息，请参阅 [vault.core.authentication]。
示例 2. 注册 Spring Vault 并应用注入的属性
@Configuration
public class AppConfig extends AbstractVaultConfiguration {

    @Value("${vault.uri}")
    URI vaultUri;

    /**
     * Specify an endpoint that was injected as URI.
     */
    @Override
    public VaultEndpoint vaultEndpoint() {
        return VaultEndpoint.from(vaultUri);                          (1)
    }

    /**
     * Configure a Client Certificate authentication.
     * {@link RestOperations} can be obtained from {@link #restOperations()}.
     */
    @Override
    public ClientAuthentication clientAuthentication() {
        return new ClientCertificateAuthentication(restOperations()); (2)
    }
}
1 VaultEndpoint 可以使用各种工厂方法构造，例如 from(URI uri) 或 VaultEndpoint.create(String host, int port)。
2 ClientAuthentication 方法的依赖项可以从 AbstractVaultConfiguration 获取，也可以由您的配置提供。
在某些情况下，创建自定义配置类可能会很麻烦。查看 EnvironmentVaultConfiguration，它允许使用现有属性源和 Spring 的 Environment 中的属性进行配置。在 使用 EnvironmentVaultConfiguration 中阅读更多内容。

会话管理

Spring Vault 需要 ClientAuthentication 才能登录和访问 Vault。有关身份验证的详细信息，请参阅 [vault.core.authentication]。Vault 登录不应在每次经过身份验证的 Vault 交互时发生，而必须在整个会话中重用。此方面由 SessionManager 实现处理。SessionManager 决定获取令牌的频率、撤销和续订。Spring Vault 提供了两个实现

  • SimpleSessionManager：仅从提供的 ClientAuthentication 获取令牌，不进行刷新和撤销

  • LifecycleAwareSessionManager：此 SessionManager 会在令牌可续订时安排令牌续订，并在处置时撤销登录令牌。续订由 AsyncTaskExecutor 调度。如果使用 AbstractVaultConfiguration，LifecycleAwareSessionManager 默认配置。

使用 EnvironmentVaultConfiguration

Spring Vault 包含 EnvironmentVaultConfiguration，用于从 Spring 的 Environment 和一组预定义属性键配置 Vault 客户端。EnvironmentVaultConfiguration 支持常用的配置。其他配置通过继承最合适的配置类来支持。使用 @Import(EnvironmentVaultConfiguration.class) 将 EnvironmentVaultConfiguration 包含到现有基于 Java 的配置类中，并通过 Spring 的任何 PropertySource 提供配置属性。

示例 3. 将 EnvironmentVaultConfiguration 与属性文件一起使用
基于 Java 的配置类
@PropertySource("vault.properties")
@Import(EnvironmentVaultConfiguration.class)
public class MyConfiguration{
}
vault.properties
vault.uri=https://:8200
vault.token=00000000-0000-0000-0000-000000000000

属性键

  • Vault URI：vault.uri

  • SSL 配置

    • 密钥库资源：vault.ssl.key-store (可选)

    • 密钥库密码：vault.ssl.key-store-password (可选)

    • 密钥库类型：vault.ssl.key-store-type (可选，通常为 jks，也支持 pem)

    • 信任库资源：vault.ssl.trust-store (可选)

    • 信任库密码：vault.ssl.trust-store-password (可选)

    • 信任库类型：vault.ssl.trust-store-type (可选，通常为 jks，也支持 pem)

    • 启用的 SSL/TLS 协议：vault.ssl.enabled-protocols (自 2.3.2 起，可选，协议以逗号分隔)

    • 启用的 SSL/TLS 密码套件：vault.ssl.enabled-cipher-suites (自 2.3.2 起，可选，密码套件以逗号分隔)

  • 身份验证方法：vault.authentication (默认为 TOKEN，支持的身份验证方法有：TOKEN、APPROLE、AWS_EC2、AWS_IAM、AZURE、CERT、CUBBYHOLE、KUBERNETES)

身份验证特定属性键

[vault.authentication.token]

  • Vault 令牌：vault.token

[vault.authentication.approle]

  • AppRole 路径：vault.app-role.app-role-path (默认为 approle)

  • RoleId：vault.app-role.role-id

  • SecretId：vault.app-role.secret-id (可选)

[vault.authentication.awsec2]

  • AWS EC2 路径：vault.aws-ec2.aws-ec2-path (默认为 aws-ec2)

  • 角色：vault.aws-ec2.role

  • RoleId：vault.aws-ec2.role-id (已弃用：请改用 vault.aws-ec2.role)

  • 身份文档 URL：vault.aws-ec2.identity-document (默认为 169.254.169.254/latest/dynamic/instance-identity/pkcs7)

[vault.authentication.awsiam]

  • 角色：vault.aws-iam.role

[vault.authentication.azuremsi]

[vault.authentication.clientcert]

无配置选项。

[vault.authentication.cubbyhole]

  • 初始 Vault 令牌：vault.token

[vault.authentication.kubernetes]

  • Kubernetes 路径：vault.kubernetes.kubernetes-path (默认为 kubernetes)

  • 角色：vault.kubernetes.role

  • 服务帐户令牌文件路径：vault.kubernetes.service-account-token-file (默认为 /var/run/secrets/kubernetes.io/serviceaccount/token)

执行回调

所有 Spring 模板类的一个共同设计特征是所有功能都通过模板的某个执行回调方法进行路由。这有助于确保一致地执行异常处理和可能需要的任何资源管理。虽然在 JDBC 和 JMS 的情况下比 Vault 更需要这一点，但它仍然提供了一个单一的访问和日志记录点。因此，使用执行回调是访问 Vault API 以执行我们未作为 VaultTemplate 上的方法显式公开的非常规操作的首选方式。

以下是执行回调方法的列表。

  • <T> T doWithVault (RestOperationsCallback<T> callback) 执行给定的 RestOperationsCallback，允许使用 RestOperations 与 Vault 交互而无需会话。

  • <T> T doWithSession (RestOperationsCallback<T> callback) 执行给定的 RestOperationsCallback，允许在经过身份验证的会话中与 Vault 交互。

这是一个使用 ClientCallback 初始化 Vault 的示例

vaultOperations.doWithVault(new RestOperationsCallback<VaultInitializationResponse>() {

  @Override
  public VaultInitializationResponse doWithRestOperations(RestOperations restOperations) {

    ResponseEntity<VaultInitializationResponse> exchange = restOperations
                       .exchange("/sys/init", HttpMethod.PUT,
                                 new HttpEntity<Object>(request),
                                 VaultInitializationResponse.class);

    return exchange.getBody();
    }
});
© . This site is unofficial and not affiliated with VMware.