跳至主要内容

告知 Git 你的签名密钥

要在本地签署提交,你需要告知 Git 你想要使用的 GPG、SSH 或 X.509 密钥。

平台导航

告知 Git 你的 GPG 密钥

如果你使用的是与你的提交者身份和与你在 GitHub.com 上的帐户关联的已验证电子邮件地址匹配的 GPG 密钥,那么你可以开始签署提交和签署标签。

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

如果你有多个 GPG 密钥,你需要告诉 Git 使用哪个密钥。

  1. 打开终端终端Git Bash

  2. 如果你之前已配置 Git 在使用 `--gpg-sign` 签名时使用其他密钥格式,请取消设置此配置,以便使用 `openpgp` 的默认格式。

    git config --global --unset gpg.format
    
  3. 使用 `gpg --list-secret-keys --keyid-format=long` 命令列出你同时拥有公钥和私钥的 GPG 密钥的长格式。签署提交或标签需要私钥。

    Shell
    gpg --list-secret-keys --keyid-format=long
    

    注意

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

  4. 从 GPG 密钥列表中,复制你想要使用的 GPG 密钥 ID 的长格式。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    Shell
    $ gpg --list-secret-keys --keyid-format=long
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot <[email protected]>
    ssb   4096R/4BB6D45482678BE3 2016-03-10
    
  5. 要在 Git 中设置你的主 GPG 签名密钥,请粘贴下面的文本,并替换为你想要使用的 GPG 主密钥 ID。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    git config --global user.signingkey 3AA5C34371567BD2
    

    或者,你可能想要使用子密钥。在此示例中,GPG 子密钥 ID 为 `4BB6D45482678BE3`

    git config --global user.signingkey 4BB6D45482678BE3
    

    如果你使用多个密钥和子密钥,则应将感叹号 `!` 附加到密钥后面,以告诉 git 这是你的首选密钥。有时你可能需要使用反斜杠转义感叹号:`\!`。

  6. 可选:要配置 Git 默认签署所有提交,请输入以下命令

    git config --global commit.gpgsign true
    

    有关更多信息,请参阅“签署提交”。

  7. 如果你没有使用 GPG 套件,请在 `zsh` shell 中运行以下命令,将 GPG 密钥添加到你的 `.zshrc` 文件(如果存在)或你的 `.zprofile` 文件

    $ if [ -r ~/.zshrc ]; then echo -e '\nexport GPG_TTY=$(tty)' >> ~/.zshrc; \
      else echo -e '\nexport GPG_TTY=$(tty)' >> ~/.zprofile; fi
    

    或者,如果你使用的是 `bash` shell,请运行此命令

    $ if [ -r ~/.bash_profile ]; then echo -e '\nexport GPG_TTY=$(tty)' >> ~/.bash_profile; \
      else echo -e '\nexport GPG_TTY=$(tty)' >> ~/.profile; fi
    
  8. 可选:要在需要时提示你输入 PIN 或密码短语,请安装 `pinentry-mac`。例如,使用 Homebrew

    brew install pinentry-mac
    echo "pinentry-program $(which pinentry-mac)" >> ~/.gnupg/gpg-agent.conf
    killall gpg-agent
    

如果你使用的是与你的提交者身份和与你在 GitHub.com 上的帐户关联的已验证电子邮件地址匹配的 GPG 密钥,那么你可以开始签署提交和签署标签。

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

如果你有多个 GPG 密钥,你需要告诉 Git 使用哪个密钥。

  1. 打开终端终端Git Bash

  2. 如果你之前已配置 Git 在使用 `--gpg-sign` 签名时使用其他密钥格式,请取消设置此配置,以便使用 `openpgp` 的默认格式。

    git config --global --unset gpg.format
    
  3. 使用 `gpg --list-secret-keys --keyid-format=long` 命令列出你同时拥有公钥和私钥的 GPG 密钥的长格式。签署提交或标签需要私钥。

    Shell
    gpg --list-secret-keys --keyid-format=long
    

    注意

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

  4. 从 GPG 密钥列表中,复制你想要使用的 GPG 密钥 ID 的长格式。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    Shell
    $ gpg --list-secret-keys --keyid-format=long
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot <[email protected]>
    ssb   4096R/4BB6D45482678BE3 2016-03-10
    
  5. 要在 Git 中设置你的主 GPG 签名密钥,请粘贴下面的文本,并替换为你想要使用的 GPG 主密钥 ID。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    git config --global user.signingkey 3AA5C34371567BD2
    

    或者,你可能想要使用子密钥。在此示例中,GPG 子密钥 ID 为 `4BB6D45482678BE3`

    git config --global user.signingkey 4BB6D45482678BE3
    

    如果你使用多个密钥和子密钥,则应将感叹号 `!` 附加到密钥后面,以告诉 git 这是你的首选密钥。有时你可能需要使用反斜杠转义感叹号:`\!`。

  6. 可选:要配置 Git 默认签署所有提交,请输入以下命令

    git config --global commit.gpgsign true
    

    有关更多信息,请参阅“签署提交”。

如果你使用的是与你的提交者身份和与你在 GitHub.com 上的帐户关联的已验证电子邮件地址匹配的 GPG 密钥,那么你可以开始签署提交和签署标签。

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

如果你有多个 GPG 密钥,你需要告诉 Git 使用哪个密钥。

  1. 打开终端终端Git Bash

  2. 如果你之前已配置 Git 在使用 `--gpg-sign` 签名时使用其他密钥格式,请取消设置此配置,以便使用 `openpgp` 的默认格式。

    git config --global --unset gpg.format
    
  3. 使用 `gpg --list-secret-keys --keyid-format=long` 命令列出你同时拥有公钥和私钥的 GPG 密钥的长格式。签署提交或标签需要私钥。

    Shell
    gpg --list-secret-keys --keyid-format=long
    

    注意

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

  4. 从 GPG 密钥列表中,复制你想要使用的 GPG 密钥 ID 的长格式。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    Shell
    $ gpg --list-secret-keys --keyid-format=long
    /Users/hubot/.gnupg/secring.gpg
    ------------------------------------
    sec   4096R/3AA5C34371567BD2 2016-03-10 [expires: 2017-03-10]
    uid                          Hubot <[email protected]>
    ssb   4096R/4BB6D45482678BE3 2016-03-10
    
  5. 要在 Git 中设置你的主 GPG 签名密钥,请粘贴下面的文本,并替换为你想要使用的 GPG 主密钥 ID。在此示例中,GPG 密钥 ID 为 `3AA5C34371567BD2`

    git config --global user.signingkey 3AA5C34371567BD2
    

    或者,你可能想要使用子密钥。在此示例中,GPG 子密钥 ID 为 `4BB6D45482678BE3`

    git config --global user.signingkey 4BB6D45482678BE3
    

    如果你使用多个密钥和子密钥,则应将感叹号 `!` 附加到密钥后面,以告诉 git 这是你的首选密钥。有时你可能需要使用反斜杠转义感叹号:`\!`。

  6. 可选:要配置 Git 默认签署所有提交,请输入以下命令

    git config --global commit.gpgsign true
    

    有关更多信息,请参阅“签署提交”。

  7. 要将你的 GPG 密钥添加到你的 `.bashrc` 启动文件,请运行以下命令

    [ -f ~/.bashrc ] && echo -e '\nexport GPG_TTY=$(tty)' >> ~/.bashrc
    

告知 Git 你的 SSH 密钥

你可以使用现有的 SSH 密钥来签署提交和标签,或者专门生成一个用于签名的密钥。有关更多信息,请参阅“生成新的 SSH 密钥并将其添加到 ssh-agent”。

注意

SSH 签名验证在 Git 2.34 或更高版本中可用。要更新你的 Git 版本,请参阅 Git 网站。

  1. 打开终端终端Git Bash

  2. 配置 Git 使用 SSH 签署提交和标签

    git config --global gpg.format ssh
    
  3. 要在 Git 中设置你的 SSH 签名密钥,请粘贴下面的文本,并将 **`/PATH/TO/.SSH/KEY.PUB`** 替换为你想要使用的公钥的路径。

    git config --global user.signingkey /PATH/TO/.SSH/KEY.PUB
    

告知 Git 你的 X.509 密钥

你可以使用 smimesign 使用 S/MIME 签署提交和标签。

注意

S/MIME 签名验证在 Git 2.19 或更高版本中可用。要更新你的 Git 版本,请参阅 Git 网站。

  1. 安装 smimesign

  2. 打开终端终端Git Bash

  3. 配置 Git 使用 S/MIME 签署提交和标签。在 Git 2.19 或更高版本中,使用 `git config gpg.x509.program` 和 `git config gpg.format` 命令

    • 要使用 S/MIME 为所有存储库签名

      git config --global gpg.x509.program smimesign
      git config --global gpg.format x509
      
    • 要使用 S/MIME 为单个存储库签名

      cd PATH-TO-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-REPOSITORY
      git config --local gpg.program smimesign
      

      如果你使用的是与你的提交者身份匹配的 X.509 密钥,则可以开始签署提交和标签。

  4. 如果你没有使用与你的提交者身份匹配的 X.509 密钥,请使用 `smimesign --list-keys` 命令列出你同时拥有证书和私钥的 X.509 密钥。

    smimesign --list-keys
    
  5. 从 X.509 密钥列表中,复制你想要使用的 X.509 密钥的证书 ID。在此示例中,证书 ID 为 `0ff455a2708394633e4bb2f88002e3cd80cbd76f`

    $ 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: [email protected]
    
  6. 要在 Git 中设置您的 X.509 签名密钥,请粘贴下面的文本,并替换您之前复制的证书 ID。

    • 使用您的 X.509 密钥为所有仓库签名

      git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
      
    • 使用您的 X.509 密钥为单个仓库签名

      cd  PATH-TO-REPOSITORY
      git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
      

告知 Git 你的 X.509 密钥

你可以使用 smimesign 使用 S/MIME 签署提交和标签。

注意

S/MIME 签名验证在 Git 2.19 或更高版本中可用。要更新你的 Git 版本,请参阅 Git 网站。

  1. 安装 smimesign

  2. 打开终端终端Git Bash

  3. 配置 Git 使用 S/MIME 签署提交和标签。在 Git 2.19 或更高版本中,使用 `git config gpg.x509.program` 和 `git config gpg.format` 命令

    • 要使用 S/MIME 为所有存储库签名

      git config --global gpg.x509.program smimesign
      git config --global gpg.format x509
      
    • 要使用 S/MIME 为单个存储库签名

      cd PATH-TO-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-REPOSITORY
      git config --local gpg.program smimesign
      

      如果你使用的是与你的提交者身份匹配的 X.509 密钥,则可以开始签署提交和标签。

  4. 如果你没有使用与你的提交者身份匹配的 X.509 密钥,请使用 `smimesign --list-keys` 命令列出你同时拥有证书和私钥的 X.509 密钥。

    smimesign --list-keys
    
  5. 从 X.509 密钥列表中,复制你想要使用的 X.509 密钥的证书 ID。在此示例中,证书 ID 为 `0ff455a2708394633e4bb2f88002e3cd80cbd76f`

    $ 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: [email protected]
    
  6. 要在 Git 中设置您的 X.509 签名密钥,请粘贴下面的文本,并替换您之前复制的证书 ID。

    • 使用您的 X.509 密钥为所有仓库签名

      git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
      
    • 使用您的 X.509 密钥为单个仓库签名

      cd  PATH-TO-REPOSITORY
      git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f
      

进一步阅读