Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 3.98 KB

generating-a-new-gpg-key.md

File metadata and controls

67 lines (54 loc) · 3.98 KB
Raw
title intro redirect_from versions topics
Generating a new GPG key
If you don't have an existing GPG key, you can generate a new GPG key to use for signing commits and tags.
/articles/generating-a-new-gpg-key
/github/authenticating-to-github/generating-a-new-gpg-key
/github/authenticating-to-github/managing-commit-signature-verification/generating-a-new-gpg-key
fpt ghes ghec
*
*
*
Identity
Access management

{% data reusables.gpg.supported-gpg-key-algorithms %}

Generating a GPG key

Note

Before generating a new GPG key, make sure you've verified your email address. If you haven't verified your email address, you won't be able to sign commits and tags with GPG.{% ifversion fpt or ghec %} For more information, see "AUTOTITLE."{% endif %}

  1. Download and install the GPG command line tools for your operating system. We generally recommend installing the latest version for your operating system. {% data reusables.command_line.open_the_multi_os_terminal %}

  2. Generate a GPG key pair. Since there are multiple versions of GPG, you may need to consult the relevant man page to find the appropriate key generation command.

    • If you are on version 2.1.17 or greater, paste the text below to generate a GPG key pair.

      gpg --full-generate-key

    • If you are not on version 2.1.17 or greater, the gpg --full-generate-key command doesn't work. Paste the text below and skip to step 6.

      gpg --default-new-key-algo rsa4096 --gen-key

  3. At the prompt, specify the kind of key you want, or press Enter to accept the default.

  4. At the prompt, specify the key size you want, or press Enter to accept the default.

  5. Enter the length of time the key should be valid. Press Enter to specify the default selection, indicating that the key doesn't expire. Unless you require an expiration date, we recommend accepting this default.

  6. Verify that your selections are correct.

  7. Enter your user ID information.

    [!NOTE] When asked to enter your email address, ensure that you enter the verified email address for your GitHub account. {% data reusables.gpg.private-email %} {% ifversion fpt or ghec %} For more information, see "AUTOTITLE" and "AUTOTITLE."{% endif %}

  8. Type a secure passphrase. {% data reusables.gpg.list-keys-with-note %} {% data reusables.gpg.copy-gpg-key-id %}

  9. Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is 3AA5C34371567BD2:

    gpg --armor --export 3AA5C34371567BD2
# Prints the GPG key ID, in ASCII armor format

  10. Copy your GPG key, beginning with -----BEGIN PGP PUBLIC KEY BLOCK----- and ending with -----END PGP PUBLIC KEY BLOCK-----.

  11. Add the GPG key to your GitHub account.

Further reading