Documentation/process: updates to the PGP guide
Small tweaks to the Maintainer PGP guide: - Use --quick-addkey command that is compatible between GnuPG-2.2 and GnuPG-2.1 (which many people still have) - Add a note about the Nitrokey program - Warn that some devices can't change the passphrase before there are keys on the card (specifically, Nitrokeys) - Link to the GnuPG wiki page about gpg-agent forwarding over ssh - Tell git to use gpgv2 instead of legacy gpgv when verifying signed tags or commits Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
9225e4e029
commit
1ba2211c52
|
@ -219,7 +219,7 @@ Our goal is to protect your master key by moving it to offline media, so
|
||||||
if you only have a combined **[SC]** key, then you should create a separate
|
if you only have a combined **[SC]** key, then you should create a separate
|
||||||
signing subkey::
|
signing subkey::
|
||||||
|
|
||||||
$ gpg --quick-add-key [fpr] ed25519 sign
|
$ gpg --quick-addkey [fpr] ed25519 sign
|
||||||
|
|
||||||
Remember to tell the keyservers about this change, so others can pull down
|
Remember to tell the keyservers about this change, so others can pull down
|
||||||
your new subkey::
|
your new subkey::
|
||||||
|
@ -450,11 +450,18 @@ functionality. There are several options available:
|
||||||
others. If you want to use ECC keys, your best bet among commercially
|
others. If you want to use ECC keys, your best bet among commercially
|
||||||
available devices is the Nitrokey Start.
|
available devices is the Nitrokey Start.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
If you are listed in MAINTAINERS or have an account at kernel.org,
|
||||||
|
you `qualify for a free Nitrokey Start`_ courtesy of The Linux
|
||||||
|
Foundation.
|
||||||
|
|
||||||
.. _`Nitrokey Start`: https://shop.nitrokey.com/shop/product/nitrokey-start-6
|
.. _`Nitrokey Start`: https://shop.nitrokey.com/shop/product/nitrokey-start-6
|
||||||
.. _`Nitrokey Pro`: https://shop.nitrokey.com/shop/product/nitrokey-pro-3
|
.. _`Nitrokey Pro`: https://shop.nitrokey.com/shop/product/nitrokey-pro-3
|
||||||
.. _`Yubikey 4`: https://www.yubico.com/product/yubikey-4-series/
|
.. _`Yubikey 4`: https://www.yubico.com/product/yubikey-4-series/
|
||||||
.. _Gnuk: http://www.fsij.org/doc-gnuk/
|
.. _Gnuk: http://www.fsij.org/doc-gnuk/
|
||||||
.. _`LWN has a good review`: https://lwn.net/Articles/736231/
|
.. _`LWN has a good review`: https://lwn.net/Articles/736231/
|
||||||
|
.. _`qualify for a free Nitrokey Start`: https://www.kernel.org/nitrokey-digital-tokens-for-kernel-developers.html
|
||||||
|
|
||||||
Configure your smartcard device
|
Configure your smartcard device
|
||||||
-------------------------------
|
-------------------------------
|
||||||
|
@ -494,6 +501,12 @@ additionally leak information about your smartcard should you lose it.
|
||||||
Despite having the name "PIN", neither the user PIN nor the admin
|
Despite having the name "PIN", neither the user PIN nor the admin
|
||||||
PIN on the card need to be numbers.
|
PIN on the card need to be numbers.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
Some devices may require that you move the subkeys onto the device
|
||||||
|
before you can change the passphrase. Please check the documentation
|
||||||
|
provided by the device manufacturer.
|
||||||
|
|
||||||
Move the subkeys to your smartcard
|
Move the subkeys to your smartcard
|
||||||
----------------------------------
|
----------------------------------
|
||||||
|
|
||||||
|
@ -655,6 +668,20 @@ want to import these changes back into your regular working directory::
|
||||||
$ gpg --export | gpg --homedir ~/.gnupg --import
|
$ gpg --export | gpg --homedir ~/.gnupg --import
|
||||||
$ unset GNUPGHOME
|
$ unset GNUPGHOME
|
||||||
|
|
||||||
|
Using gpg-agent over ssh
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
You can forward your gpg-agent over ssh if you need to sign tags or
|
||||||
|
commits on a remote system. Please refer to the instructions provided
|
||||||
|
on the GnuPG wiki:
|
||||||
|
|
||||||
|
- `Agent Forwarding over SSH`_
|
||||||
|
|
||||||
|
It works more smoothly if you can modify the sshd server settings on the
|
||||||
|
remote end.
|
||||||
|
|
||||||
|
.. _`Agent Forwarding over SSH`: https://wiki.gnupg.org/AgentForwarding
|
||||||
|
|
||||||
|
|
||||||
Using PGP with Git
|
Using PGP with Git
|
||||||
==================
|
==================
|
||||||
|
@ -692,6 +719,7 @@ should be used (``[fpr]`` is the fingerprint of your key)::
|
||||||
tell git to always use it instead of the legacy ``gpg`` from version 1::
|
tell git to always use it instead of the legacy ``gpg`` from version 1::
|
||||||
|
|
||||||
$ git config --global gpg.program gpg2
|
$ git config --global gpg.program gpg2
|
||||||
|
$ git config --global gpgv.program gpgv2
|
||||||
|
|
||||||
How to work with signed tags
|
How to work with signed tags
|
||||||
----------------------------
|
----------------------------
|
||||||
|
@ -731,6 +759,13 @@ If you are verifying someone else's git tag, then you will need to
|
||||||
import their PGP key. Please refer to the
|
import their PGP key. Please refer to the
|
||||||
":ref:`verify_identities`" section below.
|
":ref:`verify_identities`" section below.
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
If you get "``gpg: Can't check signature: unknown pubkey
|
||||||
|
algorithm``" error, you need to tell git to use gpgv2 for
|
||||||
|
verification, so it properly processes signatures made by ECC keys.
|
||||||
|
See instructions at the start of this section.
|
||||||
|
|
||||||
Configure git to always sign annotated tags
|
Configure git to always sign annotated tags
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue