我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 已停止服务 2020-11-12. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

将您的签名密钥告知 Git

To sign commits locally, you need to inform Git that there's a GPG or X.509 key you'd like to use.

本文内容

将您的 GPG 密钥告知 Git

如果使用的 GPG 密钥匹配提交者身份以及与 GitHub Enterprise Server 帐户关联的已验证电子邮件地址,则您可以开始对提交和标记签名。

如果您没有与提交者身份匹配的 GPG 密钥,则需要将电子邮件与现有密钥关联。 更多信息请参阅“将电子邮件与 GPG 密钥关联”。

如果您有多个 GPG 密钥,则需要告知 Git 要使用哪一个。

  1. 打开 Terminal(终端)Terminal(终端)Git Bash

  2. 使用 gpg --list-secret-key--keyid-form LONG 命令列出您拥有其公钥和私钥的 GPG 密钥。 签名提交或标记需要私钥。

    $ gpg --list-secret-keys --keyid-format LONG

    注:Linux上的一些 GPG 安装可能需要使用 gpg2 --list-keyid-form LONG 查看您现有密钥的列表。 在这种情况下,您还需要运行 git config --global gpg.program gpg2 来配置 Git 使用 git gpg2

  3. 从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ gpg --list-secret-keys --keyid-format LONG
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot 
    ssb   4096R/42B317FD4BA89E7A 2016-03-10
  4. 要在 Git 中设置 GPG 签名密钥,请粘贴下面的文本,替换您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ git config --global user.signingkey 3AA5C34371567BD2
  5. 如果没有使用 GPG Suite,请粘贴下面的文本以将 GPG 密钥添加到您的 bash 配置文件:

    $ test -r ~/.bash_profile && echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile
    $ echo 'export GPG_TTY=$(tty)' >> ~/.profile

    注:如果您没有 .bash_profile,此命令会将 GPG 密钥添加到 .profile

将您的 X.509 密钥告知 Git

您可以使用 smimesign 以 S/MIME 代替 GPG 对提交和标记签名。

注:S/MIME 签名验证可用于 Git 2.19 或更高版本。 要更新 Git 版本,请参阅 Git 网站。

  1. 安装 smimesign
  2. 打开 Terminal(终端)Terminal(终端)Git Bash
  3. 配置 Git 使用 S/MIME 对提交和标记签名。 在 Git 2.19 或更高版本中,使用 git config gpg.x509.programgit config gpg.form 命令:
  • 要使用 S/MIME 对所有仓库签名:
    $ git config --global gpg.x509.program smimesign
    $ git config --global gpg.format x509
  • 要使用 S/MIME 对单一仓库签名:
    $ cd /path/to/my/repository
    $ git config --local gpg.x509.program smimesign
    $ git config --local gpg.format x509
    在 Git 2.18 或更早版本中,使用 git config gpg.program 命令:
  • 要使用 S/MIME 对所有仓库签名:
    $ git config --global gpg.program smimesign
  • 要使用 S/MIME 对单一仓库签名:
    $ cd /path/to/my/repository
    $ git config --local gpg.program smimesign
    如果您使用的是与提交者身份匹配的 X.509 密钥,您可以开始对提交和标记签名。
  1. 如果您使用的不是与提交者身份匹配的 X.509 密钥,则使用 smimesign --list-keys 命令列出您有其证书和私钥的 X.509 密钥。
    $ smimesign --list-keys
  2. 从 X.509 密钥列表中复制您想要使用的 X.509 密钥的证书 ID。 在此示例中,证书 ID 是 0ff455a2708394633e4b2f88002e3cd80cbd76f
    $ smimesign --list-keys
                 ID: 0ff455a2708394633e4bb2f88002e3cd80cbd76f
                S/N: a2dfa7e8c9c4d1616f1009c988bb70f
          Algorithm: SHA256-RSA
           Validity: 2017-11-22 00:00:00 +0000 UTC - 2020-11-22 12:00:00 +0000 UTC
             Issuer: CN=DigiCert SHA2 Assured ID CA,OU=www.digicert.com,O=DigiCert Inc,C=US
            Subject: CN=Octocat,O=GitHub\, Inc.,L=San Francisco,ST=California,C=US
             Emails: octocat@github.com
  3. 要在 Git 中设置您的 X.509 签名密钥,请粘贴下面的文本,替换之前复制的证书 ID 。
  • 要使用 X.509 密钥注册所有仓库:
    $ git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
  • 要使用 X.509 密钥注册单一仓库:
    $ cd /path/to/my/repository
    $ git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f

将您的 GPG 密钥告知 Git

如果使用的 GPG 密钥匹配提交者身份以及与 GitHub Enterprise Server 帐户关联的已验证电子邮件地址,则您可以开始对提交和标记签名。

如果您没有与提交者身份匹配的 GPG 密钥,则需要将电子邮件与现有密钥关联。 更多信息请参阅“将电子邮件与 GPG 密钥关联”。

如果您有多个 GPG 密钥,则需要告知 Git 要使用哪一个。

  1. 打开 Terminal(终端)Terminal(终端)Git Bash

  2. 使用 gpg --list-secret-key--keyid-form LONG 命令列出您拥有其公钥和私钥的 GPG 密钥。 签名提交或标记需要私钥。

    $ gpg --list-secret-keys --keyid-format LONG

    注:Linux上的一些 GPG 安装可能需要使用 gpg2 --list-keyid-form LONG 查看您现有密钥的列表。 在这种情况下,您还需要运行 git config --global gpg.program gpg2 来配置 Git 使用 git gpg2

  3. 从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ gpg --list-secret-keys --keyid-format LONG
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot 
    ssb   4096R/42B317FD4BA89E7A 2016-03-10
  4. 要在 Git 中设置 GPG 签名密钥,请粘贴下面的文本,替换您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ git config --global user.signingkey 3AA5C34371567BD2

将您的 X.509 密钥告知 Git

您可以使用 smimesign 以 S/MIME 代替 GPG 对提交和标记签名。

注:S/MIME 签名验证可用于 Git 2.19 或更高版本。 要更新 Git 版本,请参阅 Git 网站。

  1. 安装 smimesign
  2. 打开 Terminal(终端)Terminal(终端)Git Bash
  3. 配置 Git 使用 S/MIME 对提交和标记签名。 在 Git 2.19 或更高版本中,使用 git config gpg.x509.programgit config gpg.form 命令:
  • 要使用 S/MIME 对所有仓库签名:
    $ git config --global gpg.x509.program smimesign
    $ git config --global gpg.format x509
  • 要使用 S/MIME 对单一仓库签名:
    $ cd /path/to/my/repository
    $ git config --local gpg.x509.program smimesign
    $ git config --local gpg.format x509
    在 Git 2.18 或更早版本中,使用 git config gpg.program 命令:
  • 要使用 S/MIME 对所有仓库签名:
    $ git config --global gpg.program smimesign
  • 要使用 S/MIME 对单一仓库签名:
    $ cd /path/to/my/repository
    $ git config --local gpg.program smimesign
    如果您使用的是与提交者身份匹配的 X.509 密钥,您可以开始对提交和标记签名。
  1. 如果您使用的不是与提交者身份匹配的 X.509 密钥,则使用 smimesign --list-keys 命令列出您有其证书和私钥的 X.509 密钥。
    $ smimesign --list-keys
  2. 从 X.509 密钥列表中复制您想要使用的 X.509 密钥的证书 ID。 在此示例中,证书 ID 是 0ff455a2708394633e4b2f88002e3cd80cbd76f
    $ smimesign --list-keys
                 ID: 0ff455a2708394633e4bb2f88002e3cd80cbd76f
                S/N: a2dfa7e8c9c4d1616f1009c988bb70f
          Algorithm: SHA256-RSA
           Validity: 2017-11-22 00:00:00 +0000 UTC - 2020-11-22 12:00:00 +0000 UTC
             Issuer: CN=DigiCert SHA2 Assured ID CA,OU=www.digicert.com,O=DigiCert Inc,C=US
            Subject: CN=Octocat,O=GitHub\, Inc.,L=San Francisco,ST=California,C=US
             Emails: octocat@github.com
  3. 要在 Git 中设置您的 X.509 签名密钥,请粘贴下面的文本,替换之前复制的证书 ID 。
  • 要使用 X.509 密钥注册所有仓库:
    $ git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
  • 要使用 X.509 密钥注册单一仓库:
    $ cd /path/to/my/repository
    $ git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f

注:Linux 上不支持 X.509 密钥。 您可配置 gpgsm 以提供加密和签名服务,但 GitHub Enterprise Server 目前不支持此功能。 更多信息请参阅 GnuPG 文档中的 gpgsm 主题。

将您的 GPG 密钥告知 Git

如果使用的 GPG 密钥匹配提交者身份以及与 GitHub Enterprise Server 帐户关联的已验证电子邮件地址,则您可以开始对提交和标记签名。

如果您没有与提交者身份匹配的 GPG 密钥,则需要将电子邮件与现有密钥关联。 更多信息请参阅“将电子邮件与 GPG 密钥关联”。

如果您有多个 GPG 密钥,则需要告知 Git 要使用哪一个。

  1. 打开 Terminal(终端)Terminal(终端)Git Bash

  2. 使用 gpg --list-secret-key--keyid-form LONG 命令列出您拥有其公钥和私钥的 GPG 密钥。 签名提交或标记需要私钥。

    $ gpg --list-secret-keys --keyid-format LONG

    注:Linux上的一些 GPG 安装可能需要使用 gpg2 --list-keyid-form LONG 查看您现有密钥的列表。 在这种情况下,您还需要运行 git config --global gpg.program gpg2 来配置 Git 使用 git gpg2

  3. 从 GPG 密钥列表中复制您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ gpg --list-secret-keys --keyid-format LONG
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot 
    ssb   4096R/42B317FD4BA89E7A 2016-03-10
  4. 要在 Git 中设置 GPG 签名密钥,请粘贴下面的文本,替换您想要使用的 GPG 密钥 ID。 在此例中,GPG 密钥 ID 是 3AA5C34371567BD2

    $ git config --global user.signingkey 3AA5C34371567BD2
  5. 要将 GPG 密钥添加到 bash 配置文件,请粘贴下面的文本:

    $ test -r ~/.bash_profile && echo 'export GPG_TTY=$(tty)' >> ~/.bash_profile
    $ echo 'export GPG_TTY=$(tty)' >> ~/.profile

    注:如果您没有 .bash_profile,此命令会将 GPG 密钥添加到 .profile

延伸阅读