使用 Secret Manager 管理密文

Secret Manager 可让您避免将密文存储在代码库中,您可以将密文存储在 Secret Manager 中,并在需要时以编程方式提取。借助 Cloud Code 的 Secret Manager 集成,您可以轻松创建、查看、更新和使用密文。

本页面介绍了如何在 IDE 中访问 Secret Manager,以及如何开始创建和管理密文。

启用 Secret Manager

您的密文需要与应用代码位于同一项目中,并且需要为项目启用 Secret Manager API。

  1. 如需启动 Secret Manager,请点击右侧 Cloud Code 边栏中的 Secret Manager 标签页,或转到工具 > Cloud Code > Secret Manager

    在右侧边栏和打开的 Secret Manager 窗格中突出显示了 Cloud Code 中的 Secret Manager 标签页,其中的三个密文以及密文“测试”的版本详情列在底部窗格中

  2. 如果您尚未启用 Secret Manager API,请在 Cloud Code 提示时点击启用 API 时启用它。

    Secret Manager 窗格中的“启用 API”链接

创建和查看密文

创建密文

您可以使用以下方法之一创建 Secret:

使用 Secret Manager 窗格

  1. 导航到 Secret Manager 窗格。

  2. 点击添加

  3. 在“创建密钥”对话框中,配置您的密文,然后点击确定

    这时会打开“创建密文”对话框,其中“名称”字段中填写了“life”,而“密文值”字段中填写了“42”

使用编辑器

  1. 在编辑器中打开其中包含您想要以密文形式存储的文本的文件。
  2. 选中要存储为密文的文本,右键点击文本,然后点击 Create Secret in Secret Manager
  3. 在“创建密钥”对话框中,配置您的密文,然后点击确定

使用 Project Explorer

  1. 在 Project Explorer 中,不需要选中任何文本,点击右键,然后点击 Create Secret in Secret Manager

  2. 在“创建密钥”对话框中,配置您的密文,然后点击确定

创建新版密文

如需更新现有密文,请创建一个新的密文版本:

  1. 在 Secret Manager 窗格中,右键点击密文,然后点击新版本

  2. 在“添加新版本”对话框中,通过使用“密钥值”字段或导入文件来设置现有密文的值。

    这时会打开“添加新版本”对话框,其中密文“test-secret”的“密文值”字段更新为“bar”

  3. 如需移除密文的所有先前版本并仅保留您创建的新版本,请选择停用所有旧版本 (Disable all past versions)。

  4. 点击确定。添加版本后,您可以看到最新的密文版本,并且“版本”标签页上将列出密文的所有版本(如果适用)。

查看密文

如需查看密文,在 Secret Manager 窗格中,从“密钥名称”部分的列表中选择密文。“概览”标签页中列出了其名称、复制政策、创建时间戳和资源 ID 等详细信息。

如需在浏览器中查看和管理密文,请右键点击密文,然后选择在 Cloud Console 中打开 (Open in Cloud Console)。

从应用访问密文

创建密文后,您可以将其添加在代码中并设置身份验证。

Secret Manager 窗格的“代码”标签页列出了访问您代码中的密文所需的步骤

要从应用访问新创建的密文,请按以下步骤操作:

  1. 在 Secret Manager 窗格中,点击您要在代码中访问的密文的名称,然后点击代码标签页。
  2. 点击安装 Secret Manager 客户端库 (Install the Secret Manager client library)。
  3. 在 Secret Manager API 页面上,设置 Google Cloud 项目并启用 Secret Manager API(如果尚未启用)。
  4. 按照与您所用语言对应的安装客户端库下的说明操作。
  5. 在您的应用代码中自定义并添加相关代码段
  6. 如果您使用的是服务帐号,请为您的 Google 服务帐号分配访问 Secret Manager 密文所需的角色。如需了解适用于 Secret Manager 的 IAM 角色,请参阅 Secret Manager 访问权限控制指南
  7. 要完成身份验证设置,请按照设置身份验证中的说明操作。

获取支持

如需在 IntelliJ IDE 中提交反馈或报告问题,请转到工具 > Cloud Code > 帮助 / 简介 > 提交反馈或报告问题以报告 GitHub 问题或询问 Stack Overflow 问题。

您还可以加入属于 Google Cloud Slack 社区#cloud-code 频道。