Skip to main content

为 GitHub Codespaces 管理存储库和组织的加密机密

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

Who can use this feature

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

关于机密

密钥是您在组织或仓库中创建的加密环境变量。 你创建的机密可用于 GitHub Codespaces。 GitHub 在机密提交到 GitHub 之前使用 libsodium 密封盒对其加密,并且仅当需要在 codespace 中使用它们时才对其解密。

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

Once you have created a secret, it will be available when you create a new codespace or restart the codespace. To use a secret that you've just created in a current codespace, you will need to stop the codespace and resume it. For information about stopping the codespace, see "Using the Visual Studio Code Command Palette in GitHub Codespaces."

命名密钥

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

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

  • 机密名称不得以 GITHUB_ 前缀开头。

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

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

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

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

密码的限制

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

密码大小限于 64 KB。

为仓库添加密钥

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

  1. On GitHub.com, navigate to the main page of the repository. 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮 1. 在边栏的“安全性”部分中,选择“ 机密”,然后单击“Codespaces” 。

  2. 在页面顶部,单击“新建存储库机密”。

  3. 在“名称”输入框中键入机密名称。

  4. 输入密码的值。

  5. 单击“添加机密”。

为组织添加密钥

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

要在组织级别创建机密,必须具有 admin 访问权限。

  1. On GitHub.com, navigate to the main page of the organization. 1. 在组织名称下,单击“设置”。 组织设置按钮 1. 在边栏的“安全性”部分中,选择“ 机密”,然后单击“Codespaces” 。

  2. 在页面顶部,单击“新建组织机密”。

  3. 在“名称”输入框中键入机密名称。

  4. 输入“机密”的值。

  5. 从“存储库访问”下拉列表中,选择访问策略。 已选定专用存储库的存储库访问列表

  6. 单击“添加机密”。

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

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

  1. On GitHub.com, navigate to the main page of the organization. 1. 在组织名称下,单击“设置”。 组织设置按钮 1. 在边栏的“安全性”部分中,选择“ 机密”,然后单击“Codespaces” 。

  2. 密码列表包括任何已配置的权限和策略。 例如:机密列表

  3. 若要详细了解已为每个机密配置的权限,请单击“更新”。

延伸阅读