]> git.immae.eu Git - github/shaarli/Shaarli.git/blame - doc/md/GnuPG-signature.md
documentation: fix rendering and internal references
[github/shaarli/Shaarli.git] / doc / md / GnuPG-signature.md
CommitLineData
992af0b9
V
1## Introduction
2### PGP and GPG
43ad7c8e
V
3[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the
4[Pretty Good Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP)
5(OpenPGP) specification. Its main purposes are digital authentication, signature and encryption.
992af0b9 6
53ed6d7d 7It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify:
43ad7c8e 8
53ed6d7d 9- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master
992af0b9 10Keys](https://www.archlinux.org/master-keys/)
53ed6d7d 11- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity
992af0b9
V
12
13### Trust
53ed6d7d 14To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/):
992af0b9
V
15
16> You MUST understand that presence of data in the keyserver (pools) in no way connotes trust. Anyone can generate a key, with any name or email address, and upload it. All security and trust comes from evaluating security at the “object level”, via PGP Web-Of-Trust signatures. This keyserver makes it possible to retrieve keys, looking them up via various indices, but the collection of keys in this public pool is KNOWN to contain malicious and fraudulent keys. It is the common expectation of server operators that users understand this and use software which, like all known common OpenPGP implementations, evaluates trust accordingly. This expectation is so common that it is not normally explicitly stated.
17
53ed6d7d 18Trust can be gained by having your key signed by other people (and signing their key back, too :) ), for instance during [key signing parties](https://en.wikipedia.org/wiki/Key_signing_party), see:
43ad7c8e 19
53ed6d7d 20- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html)
21- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)
992af0b9
V
22
23## Generate a GPG key
53ed6d7d 24- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)
25- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)
992af0b9
V
26
27### gpg - provide identity information
28```bash
29$ gpg --gen-key
30
31gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.
32This is free software: you are free to change and redistribute it.
33There is NO WARRANTY, to the extent permitted by law.
34
35Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog.
36
37GnuPG needs to construct a user ID to identify your key.
38
39Real name: Marvin the Paranoid Android
40Email address: marvin@h2g2.net
41You selected this USER-ID:
42 "Marvin the Paranoid Android <marvin@h2g2.net>"
43
44Change (N)ame, (E)mail, or (O)kay/(Q)uit? o
45We need to generate a lot of random bytes. It is a good idea to perform
46some other action (type on the keyboard, move the mouse, utilize the
47disks) during the prime generation; this gives the random number
48generator a better chance to gain enough entropy.
49```
50
51### gpg - entropy interlude
52At this point, you will:
53- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)
54- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step _may take some time_
55
56### gpg - key creation confirmation
57```bash
58gpg: key A9D53A3E marked as ultimately trusted
59public and secret key created and signed.
60
61gpg: checking the trustdb
62gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
63gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u
64pub rsa2048/A9D53A3E 2015-07-31
65 Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E
53ed6d7d 66uid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>
992af0b9
V
67sub rsa2048/8C0EACF1 2015-07-31
68```
69
70### gpg - submit your public key to a PGP server (Optional)
71``` bash
72$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E
73gpg: sending key A9D53A3E to hkp server pgp.mit.edu
74```
75
76## Create and push a GPG-signed tag
992af0b9 77
0433c688 78See [Release Shaarli](Release Shaarli).