# 管理GitHub应用的私钥

您可以管理私钥，以通过您的 GitHub App 进行身份验证。

## 关于 GitHub Apps 的私钥

创建 GitHub App 后，您需要生成一个私钥，才能以应用程序自身的身份向 GitHub API 发出请求。 例如，需要一个私钥来对 JSON Web 令牌 (JWT) 进行签名才能请求安装访问令牌。 有关详细信息，请参阅“[为GitHub应用生成 JSON Web 令牌 （JWT）](/zh/enterprise-server@3.19/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-json-web-token-jwt-for-a-github-app)”

最多可以为应用创建 25 个私钥。 应使用多个密钥，以便在密钥泄露的情况下轮换密钥而不会停机。 如果应用程序具有 25 个或更多密钥，则必须删除某些密钥，然后才能创建更多密钥。

私钥不会过期，而是需要手动撤销。 有关如何撤销或删除私钥的详细信息，请参阅[删除私钥](#deleting-private-keys)。

您必须妥善保管 GitHub Apps 的私钥。 有关详细信息，请参阅[存储私钥](#storing-private-keys)。

要验证私钥是否与公钥匹配，请参阅[验证私钥](#verifying-private-keys)。

## 生成私钥

要生成私钥：

1. 在 GitHub 上任意页的右上角，单击你的个人资料图片。

2. 导航到你的帐户设置。
   * 对于由个人帐户拥有的应用，请单击“设置”\*\*\*\*。
   * 对于组织拥有的应用：
     1. 单击“你的组织”。
     2. 在组织的右侧，单击**设置**。
   * 对于由企业拥有的应用：
     1. 单击**企业设置**。

3. 导航到 GitHub App 设置。
   * 对于由个人帐户或组织拥有的应用：
     1. 在左侧边栏中，单击“<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code" aria-label="code" role="img"><path d="m11.28 3.22 4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L13.94 8l-3.72-3.72a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215Zm-6.56 0a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L2.06 8l3.72 3.72a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L.47 8.53a.75.75 0 0 1 0-1.06Z"></path></svg> Developer settings”，然后单击“GitHub Apps”\*\*\*\*\*\*\*\*。
   * 对于由企业拥有的应用：
     1. 在左侧边栏中，单击**设置**，然后单击 **GitHub Apps**。

4. 在您要为其生成私钥的 GitHub App 旁边，单击“**编辑**”。

5. 在“私钥”下，单击“ **生成私钥**”。

6. 您将看到一个以 PEM 格式下载至您的计算机的私钥。 请确保存储此文件，因为GitHub仅存储密钥的公共部分。 有关安全存储密钥的详细信息，请参阅[存储私钥](#storing-private-keys)。

> [!NOTE]
> 如果你使用的库需要特定文件格式，你下载的 PEM 文件将采用 `PKCS#1 RSAPrivateKey` 格式。

## 验证私钥

GitHub 使用 SHA-256 哈希函数为每个私钥和公钥对生成指纹。 可以通过生成私钥的指纹并将其与显示的GitHub指纹进行比较来验证私钥是否与存储GitHub的公钥匹配。

要验证私钥：

1. 在 “私钥” 部分中，找到您要验证的私钥和公钥对的指纹。 有关详细信息，请参阅[生成私钥](#generating-private-keys)。

![GitHub App 设置页中私钥的屏幕截图。 指纹，即私钥中冒号后面的部分，以深橙色勾勒出来。](/assets/images/github-apps/github-apps-private-key-fingerprint.png)

1. 使用以下命令在本地生成私钥指纹 (PEM)：

   ```shell
   openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64
   ```

2. 将本地生成的指纹的结果与你看到的 GitHub指纹进行比较。

## 删除私钥

可以通过删除密钥来删除丢失或泄露的私钥，但在删除现有密钥之前，必须先重新生成新密钥。

1. 在 GitHub 上任意页的右上角，单击你的个人资料图片。

2. 导航到你的帐户设置。
   * 对于由个人帐户拥有的应用，请单击“设置”\*\*\*\*。
   * 对于组织拥有的应用：
     1. 单击“你的组织”。
     2. 在组织的右侧，单击**设置**。
   * 对于由企业拥有的应用：
     1. 单击**企业设置**。

3. 在左边栏中，单击 <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-code" aria-label="code" role="img"><path d="m11.28 3.22 4.25 4.25a.75.75 0 0 1 0 1.06l-4.25 4.25a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L13.94 8l-3.72-3.72a.749.749 0 0 1 .326-1.275.749.749 0 0 1 .734.215Zm-6.56 0a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042L2.06 8l3.72 3.72a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L.47 8.53a.75.75 0 0 1 0-1.06Z"></path></svg>“Developer settings”\*\*\*\*。

4. 在左侧边栏中，单击“GitHub Apps”。

5. 在要删除私钥的旁边 GitHub App ，单击“ **编辑**”。

6. 在“私钥”下，在要删除的私钥右侧，单击“ **删除**”。

7. 出现提示时，单击“删除”确认要删除私钥。
   GitHub App如果只有一个密钥，则需要在删除旧密钥之前生成一个新密钥。 有关详细信息，请参阅[生成私钥](#generating-private-keys)。

## 存储私钥

私钥是 GitHub App 最有价值的秘密。 请考虑将密钥存储在密钥保管库中，例如 [Azure 密钥保管库](https://azure.microsoft.com/en-gb/products/key-vault)，并使其仅登录。 这有助于确保不会丢失私钥。 将私钥上传到密钥保管库后，就无法从中读取它。 它只能用于对内容进行签名，对私钥的访问由基础结构规则决定。

或者，可以将密钥存储为环境变量。 此方法不如将密钥存储在密钥保管库中强大。 如果攻击者获得对环境的访问权限，他们可以读取私钥，并获取 GitHub App作为持久身份验证。

即使代码存储在专用存储库中，也不应在应用中对私钥进行硬编码。

有关详细信息，请参阅“[创建GitHub应用的最佳做法](/zh/enterprise-server@3.19/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)”。