向你的 GitHub 帐户添加新的 SSH 密钥

要将你的帐户配置为在 GitHub.com 上使用你的新的（或现有的）SSH 密钥，你还需要将该密钥添加到你的帐户。

平台导航

本文内容

关于向你的帐户添加 SSH 密钥

你可以使用 SSH（安全外壳协议）访问和写入 GitHub.com 上的存储库中的数据。通过 SSH 连接时，你可以使用本地计算机上的私钥文件进行身份验证。有关更多信息，请参阅“关于 SSH”。

您还可以使用 SSH 来签署提交和标签。有关提交签名的详细信息，请参阅“关于提交签名验证”。

生成 SSH 密钥对后，您必须将公钥添加到 GitHub.com 以启用帐户的 SSH 访问。

先决条件

在向 GitHub.com 上的帐户添加新的 SSH 密钥之前，请完成以下步骤。

  1. 检查现有的 SSH 密钥。有关详细信息，请参阅“检查现有的 SSH 密钥”。
  2. 生成新的 SSH 密钥并将其添加到机器的 SSH 代理。有关详细信息，请参阅“生成新的 SSH 密钥并将其添加到 ssh-agent”。

向您的帐户添加新的 SSH 密钥

您可以添加 SSH 密钥并将其用于身份验证或提交签名，或同时用于两者。如果您想将同一个 SSH 密钥用于身份验证和签名，则需要上传两次。

向 GitHub.com 上的帐户添加新的 SSH 身份验证密钥后，您可以重新配置任何本地存储库以使用 SSH。有关详细信息，请参阅“管理远程存储库”。

注意：GitHub 在 2022 年 3 月 15 日弃用了较旧的不安全密钥类型，从而提高了安全性。

从该日期起，不再支持 DSA 密钥 (ssh-dss)。您无法将新的 DSA 密钥添加到 GitHub.com 上的个人帐户。

在 2021 年 11 月 2 日之前具有 valid_after 的 RSA 密钥 (ssh-rsa) 可以继续使用任何签名算法。该日期之后生成的 RSA 密钥必须使用 SHA-2 签名算法。某些较旧的客户端可能需要升级才能使用 SHA-2 签名。

  1. 将 SSH 公钥复制到剪贴板。

    如果您的 SSH 公钥文件与示例代码的名称不同，请修改文件名以匹配当前设置。复制密钥时，不要添加任何换行符或空格。

    $ pbcopy < ~/.ssh/id_ed25519.pub
# Copies the contents of the id_ed25519.pub file to your clipboard

    提示：如果 pbcopy 无法正常工作，你可以找到隐藏的 .ssh 文件夹，在喜欢的文本编辑器中打开文件，然后将其复制到剪贴板。

    $ clip < ~/.ssh/id_ed25519.pub
# Copies the contents of the id_ed25519.pub file to your clipboard

    说明

    • 使用 Windows Subsystem for Linux (WSL) 时，你可以使用 clip.exe。否则，如果 clip 无法正常工作，你可以找到隐藏的 .ssh 文件夹，在喜欢的文本编辑器中打开文件，然后将其复制到剪贴板。
    • 在使用 Windows Terminal 的较新版本的 Windows 上，或在其他任何使用 PowerShell 命令行的地方，你可能会收到 ParseError，指出 “'&lt;' 运算符保留供将来使用。”在这种情况下，应使用以下备用 clip 命令
    $ cat ~/.ssh/id_ed25519.pub | clip
# Copies the contents of the id_ed25519.pub file to your clipboard

    $ cat ~/.ssh/id_ed25519.pub
# Then select and copy the contents of the id_ed25519.pub file
# displayed in the terminal to your clipboard

    提示：或者，你可以找到隐藏的 .ssh 文件夹，在喜欢的文本编辑器中打开文件，然后将其复制到剪贴板。

  2. 在 GitHub 上的任意页面右上角，单击你的个人资料照片，然后单击设置。

  3. 在侧边栏的“访问”部分，单击 SSH 和 GPG 密钥。

  4. 单击新建 SSH 密钥或添加 SSH 密钥。

  5. 在“标题”字段中，为新密钥添加描述性标签。例如，如果你使用的是个人笔记本电脑，则可以将此密钥称为“个人笔记本电脑”。

  6. 选择密钥类型，身份验证或签名。有关提交签名的更多信息，请参阅“关于提交签名验证”。

  7. 在“密钥”字段中，粘贴你的公钥。

  8. 单击添加 SSH 密钥。

  9. 如果出现提示，请确认对 GitHub 帐户的访问权限。有关更多信息，请参阅“Sudo 模式”。

要详细了解 GitHub CLI，请参阅“关于 GitHub CLI”。

在使用 GitHub CLI 向帐户添加 SSH 密钥之前，必须对 GitHub CLI 进行身份验证。有关更多信息，请参阅 GitHub CLI 文档中的 gh auth login。

若要将 SSH 密钥添加到 GitHub 帐户，请使用 ssh-key add 子命令，指定您的公钥。对于身份验证密钥，如果您收到提示请求其他范围，请按照命令行中的说明进行操作。

gh ssh-key add KEY-FILE --type {authentication|signing}

若要为新密钥包含标题，请使用 -t 或 --title 标志。

gh ssh-key add KEY-FILE --title "personal laptop"

如果您按照“生成新的 SSH 密钥并将其添加到 ssh-agent”中的说明生成了 SSH 密钥，则可以使用此命令将密钥添加到您的帐户。

gh ssh-key add ~/.ssh/id_ed25519.pub --type signing

延伸阅读