跳至主要内容

告诉 Git 您的签名密钥

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

平台导航

告诉 Git 您的 GPG 密钥

如果您使用的 GPG 密钥与您的提交者身份匹配,并且该密钥关联的已验证电子邮件地址已在 GitHub.com 上与您的账户关联,那么您即可开始为提交和标签签名。

注意

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

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

  1. 打开 终端终端Git Bash

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

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

    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 <hubot@example.com>
    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
    git config --global tag.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
    

如果您使用的 GPG 密钥与您的提交者身份匹配,并且该密钥关联的已验证电子邮件地址已在 GitHub.com 上与您的账户关联,那么您即可开始为提交和标签签名。

注意

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

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

  1. 打开 终端终端Git Bash

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

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

    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 <hubot@example.com>
    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
    git config --global tag.gpgSign true
    

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

如果您使用的 GPG 密钥与您的提交者身份匹配,并且该密钥关联的已验证电子邮件地址已在 GitHub.com 上与您的账户关联,那么您即可开始为提交和标签签名。

注意

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

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

  1. 打开 终端终端Git Bash

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

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

    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 <hubot@example.com>
    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
    git config --global tag.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.programgit 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: octocat@github.com
    
  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.programgit 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: octocat@github.com
    
  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
      

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.