Skip to main content

为您的仓库和代码空间组织管理加密的密钥

加密密钥允许您将敏感信息存储在您的组织、仓库或 Codespaces 中。

To manage secrets for Codespaces for an organization, you must be an organization owner.

代码空间可用于使用 GitHub Team 或 GitHub Enterprise Cloud 的组织。 更多信息请参阅“GitHub 的产品”。

关于密钥

密钥是您在组织或仓库中创建的加密环境变量。 您创建的密钥可用于 Codespaces。 GitHub 在密钥到达 GitHub 之前使用 libsodium sealed box 对其加密,并且仅当您在代码空间中使用它们时才予以解密。

组织级密钥允许在多个仓库之间共享密钥,从而减少创建重复密钥的需要。 您可以使用访问策略来控制哪些仓库可以使用组织密钥。

一旦创建了密码,便可以在创建新的代码空间或重新启动代码空间时使用它。 要使用刚刚在当前代码空间中创建的密码,您需要停止代码空间并恢复它。 有关停止代码空间的信息,请参阅“在 Codespaces中使用命令面板”。

命名密钥

以下规则适用于密码名称:

  • 密码名称只能包含字母数字字符([a-z][A-Z][0-9])或下划线 (_)。 不允许空格。

  • 密码名称不能以 GITHUB_ 前缀开头。

  • 密码名称不能以数字开头。

  • 机密名称不区分大小写。

  • 密码名称在所创建的级别上必须是唯一的。 例如,在仓库级别创建的密钥必须在该仓库中具有唯一的名称, 而在组织级创建的密钥必须在该级别有独特的名称。

    如果具有相同名称的机密存在于多个级别,则较低级别的机密优先。 例如,如果组织级别密码的名称与仓库级别的密码相同,则仓库级别的密码优先。

密码的限制

每个组织最多可存储 100 个密钥,每个仓库最多可存储 100 个密钥。

密码大小限于 64 KB。

为仓库添加密钥

要为组织仓库创建密码,您必须具有管理员访问权限。

  1. 在 GitHub.com 上,导航到仓库的主页面。
  2. 在仓库名称下,单击 Settings(设置)仓库设置按钮
  3. 在左侧边栏中,单击 Secrets(密码)
  4. 向下滚动页面并在 Secrets(密钥)下选择 Codespaces侧栏中的代码空间选项
  5. 在页面顶部,单击 New repository secret(新仓库密钥)
  6. Name(名称)输入框中键入密码的名称。
  7. 输入密码的值。
  8. 单击 Add secret(添加密码)

为组织添加密钥

在组织中创建密码时,可以使用策略来限制可以访问该密码的仓库。 例如,您可以将访问权限授予所有仓库,也可以限制仅私有仓库或指定的仓库列表拥有访问权限。

要在组织级别创建密码,必须具有管理员访问权限。

  1. 在 GitHub.com 上,导航到组织的主页面。
  2. 在组织名称下,单击 设置. 组织设置按钮
  3. 在左侧边栏中,单击 Secrets(密码)
  4. 向下滚动页面并在 Secrets(密钥)下选择 Codespaces侧栏中的代码空间选项
  5. 在页面顶部,单击 New organization secret(新组织密钥)
  6. Name(名称)输入框中键入密码的名称。
  7. 输入密码的 Value(值)
  8. Repository access(仓库访问权限)下拉列表,选择访问策略。 已选定私有仓库的仓库访问列表
  9. 单击 Add secret(添加密码)

审查对组织级别密码的访问权限

您可以检查哪些访问策略应用于组织中的密钥。

  1. 在 GitHub.com 上,导航到组织的主页面。
  2. 在组织名称下,单击 设置. 组织设置按钮
  3. 在左侧边栏中,单击 Secrets(密码)
  4. 密码列表包括任何已配置的权限和策略。 例如: 密码列表
  5. 有关已为每个密码配置的权限的更多信息,请单击 Update(更新)

延伸阅读