GitHub supports several GPG key algorithms. If you try to add a key generated with an unsupported algorithm, you may encounter an error.
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. For more information, see "Verifying your email address."
Download and install the GPG command line tools for your operating system. We generally recommend installing the latest version for your operating system.
Open TerminalTerminalGit Bash.
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.
If you are not on version 2.1.17 or greater, the
gpg --full-generate-keycommand doesn't work. Paste the text below and skip to step 6.
gpg --default-new-key-algo rsa4096 --gen-key
At the prompt, specify the kind of key you want, or press
Enterto accept the default.
At the prompt, specify the key size you want, or press
Enterto accept the default.
Enter the length of time the key should be valid. Press
Enterto specify the default selection, indicating that the key doesn't expire. Unless you require an expiration date, we recommend accepting this default.
Verify that your selections are correct.
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. To keep your email address private, use your GitHub-provided
no-replyemail address. For more information, see "Verifying your email address" and "Setting your commit email address."
Type a secure passphrase.
gpg --list-secret-keys --keyid-format=longcommand to list the long form of the GPG keys for which you have both a public and private key. A private key is required for signing commits or tags.
gpg --list-secret-keys --keyid-format=long
Note: Some GPG installations on Linux may require you to use
gpg2 --list-keys --keyid-format LONGto view a list of your existing keys instead. In this case you will also need to configure Git to use
git config --global gpg.program gpg2.
From the list of GPG keys, copy the long form of the GPG key ID you'd like to use. In this example, the GPG key ID is
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@example.com> ssb 4096R/4BB6D45482678BE3 2016-03-10
Paste the text below, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is
gpg --armor --export 3AA5C34371567BD2 Prints the GPG key ID, in ASCII armor format
Copy your GPG key, beginning with
-----BEGIN PGP PUBLIC KEY BLOCK-----and ending with
-----END PGP PUBLIC KEY BLOCK-----.