[github/shaarli/Shaarli.git] / doc / GnuPG-signature.md

#GnuPG signature
## Introduction
### PGP and GPG
[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good [](.html)
Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication, 
signature and encryption.

It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify:[](.html)
- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master [](.html)
Keys](https://www.archlinux.org/master-keys/)
- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity[](.html)

### Trust
To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/):[](.html)

> 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.

Trust 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:[](.html)
- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html)[](.html)
- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html)

## Generate a GPG key
- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)[](.html)
- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)[](.html)

### gpg - provide identity information
```bash
$ gpg --gen-key

gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog.

GnuPG needs to construct a user ID to identify your key.

Real name: Marvin the Paranoid Android
Email address: marvin@h2g2.net
You selected this USER-ID:
    "Marvin the Paranoid Android <marvin@h2g2.net>"

Change (N)ame, (E)mail, or (O)kay/(Q)uit? o
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
```

### gpg - entropy interlude
At this point, you will:
- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)
- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step _may take some time_ 

### gpg - key creation confirmation
```bash
gpg: key A9D53A3E marked as ultimately trusted
public and secret key created and signed.

gpg: checking the trustdb
gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
gpg: depth: 0  valid:   2  signed:   0  trust: 0-, 0q, 0n, 0m, 0f, 2u
pub   rsa2048/A9D53A3E 2015-07-31
      Key fingerprint = AF2A 5381 E54B 2FD2 14C4  A9A3 0E35 ACA4 A9D5 3A3E
uid       [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>[](.html)
sub   rsa2048/8C0EACF1 2015-07-31
```

### gpg - submit your public key to a PGP server (Optional)
``` bash
$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E
gpg: sending key A9D53A3E to hkp server pgp.mit.edu
```

## Create and push a GPG-signed tag

See [Release Shaarli](Release-Shaarli.html).
Commit	Line	Data
	1	#GnuPG signature
	2	## Introduction
	3	### PGP and GPG
	4	[Gnu Privacy Guard](https://gnupg.org/) (GnuPG) is an Open Source implementation of the [Pretty Good [](.html)
	5	Privacy](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP) (OpenPGP) specification. Its main purposes are digital authentication,
	6	signature and encryption.
	7
	8	It is often used by the [FLOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) community to verify:[](.html)
	9	- Linux package signatures: Debian [SecureApt](https://wiki.debian.org/SecureApt), ArchLinux [Master [](.html)
	10	Keys](https://www.archlinux.org/master-keys/)
	11	- [SCM](https://en.wikipedia.org/wiki/Revision_control) releases & maintainer identity[](.html)
	12
	13	### Trust
	14	To quote Phil Pennock (the author of the [SKS](https://bitbucket.org/skskeyserver/sks-keyserver/wiki/Home) key server - http://sks.spodhuis.org/):[](.html)
	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
	18	Trust 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:[](.html)
	19	- [The Keysigning party HOWTO](http://www.cryptnet.net/fdp/crypto/keysigning_party/en/keysigning_party.html)[](.html)
	20	- [Web of trust](https://en.wikipedia.org/wiki/Web_of_trust)[](.html)
	21
	22	## Generate a GPG key
	23	- [Generating a GPG key for Git tagging](http://stackoverflow.com/a/16725717) (StackOverflow)[](.html)
	24	- [Generating a GPG key](https://help.github.com/articles/generating-a-gpg-key/) (GitHub)[](.html)
	25
	26	### gpg - provide identity information
	27	```bash
	28	$ gpg --gen-key
	29
	30	gpg (GnuPG) 2.1.6; Copyright (C) 2015 Free Software Foundation, Inc.
	31	This is free software: you are free to change and redistribute it.
	32	There is NO WARRANTY, to the extent permitted by law.
	33
	34	Note: Use "gpg2 --full-gen-key" for a full featured key generation dialog.
	35
	36	GnuPG needs to construct a user ID to identify your key.
	37
	38	Real name: Marvin the Paranoid Android
	39	Email address: marvin@h2g2.net
	40	You selected this USER-ID:
	41	"Marvin the Paranoid Android <marvin@h2g2.net>"
	42
	43	Change (N)ame, (E)mail, or (O)kay/(Q)uit? o
	44	We need to generate a lot of random bytes. It is a good idea to perform
	45	some other action (type on the keyboard, move the mouse, utilize the
	46	disks) during the prime generation; this gives the random number
	47	generator a better chance to gain enough entropy.
	48	```
	49
	50	### gpg - entropy interlude
	51	At this point, you will:
	52	- be prompted for a secure password to protect your key (the input method will depend on your Desktop Environment and configuration)
	53	- be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step _may take some time_
	54
	55	### gpg - key creation confirmation
	56	```bash
	57	gpg: key A9D53A3E marked as ultimately trusted
	58	public and secret key created and signed.
	59
	60	gpg: checking the trustdb
	61	gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
	62	gpg: depth: 0 valid: 2 signed: 0 trust: 0-, 0q, 0n, 0m, 0f, 2u
	63	pub rsa2048/A9D53A3E 2015-07-31
	64	Key fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E
	65	uid [ultimate] Marvin the Paranoid Android <marvin@h2g2.net>[](.html)
	66	sub rsa2048/8C0EACF1 2015-07-31
	67	```
	68
	69	### gpg - submit your public key to a PGP server (Optional)
	70	``` bash
	71	$ gpg --keyserver pgp.mit.edu --send-keys A9D53A3E
	72	gpg: sending key A9D53A3E to hkp server pgp.mit.edu
	73	```
	74
	75	## Create and push a GPG-signed tag
	76
	77	See [Release Shaarli](Release-Shaarli.html).