aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/GnuPG-signature.html
diff options
context:
space:
mode:
authorArthurHoaro <arthur@hoa.ro>2016-04-14 14:20:23 +0200
committerArthurHoaro <arthur@hoa.ro>2016-04-14 15:18:25 +0200
commit5409ade28c5f0acf99dbadd4d95e6f8efda5d395 (patch)
tree4c8b55010ad02d91b524b0cb8cc02ddf318fcaa2 /doc/GnuPG-signature.html
parent9f400b0dad68b82d65692bd6ab6190f6a787fa89 (diff)
downloadShaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.tar.gz
Shaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.tar.zst
Shaarli-5409ade28c5f0acf99dbadd4d95e6f8efda5d395.zip
Update docs from Wiki
Diffstat (limited to 'doc/GnuPG-signature.html')
-rw-r--r--doc/GnuPG-signature.html143
1 files changed, 59 insertions, 84 deletions
diff --git a/doc/GnuPG-signature.html b/doc/GnuPG-signature.html
index a1210b75..c187c996 100644
--- a/doc/GnuPG-signature.html
+++ b/doc/GnuPG-signature.html
@@ -4,31 +4,49 @@
4 <meta charset="utf-8"> 4 <meta charset="utf-8">
5 <meta name="generator" content="pandoc"> 5 <meta name="generator" content="pandoc">
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
7 <title>Shaarli - GnuPG signature</title> 7 <title>Shaarli GnuPG signature</title>
8 <style type="text/css">code{white-space: pre;}</style> 8 <style type="text/css">code{white-space: pre;}</style>
9 <!--[if lt IE 9]>
10 <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <style type="text/css"> 9 <style type="text/css">
10div.sourceCode { overflow-x: auto; }
13table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode { 11table.sourceCode, tr.sourceCode, td.lineNumbers, td.sourceCode {
14 margin: 0; padding: 0; vertical-align: baseline; border: none; } 12 margin: 0; padding: 0; vertical-align: baseline; border: none; }
15table.sourceCode { width: 100%; line-height: 100%; } 13table.sourceCode { width: 100%; line-height: 100%; }
16td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; } 14td.lineNumbers { text-align: right; padding-right: 4px; padding-left: 4px; color: #aaaaaa; border-right: 1px solid #aaaaaa; }
17td.sourceCode { padding-left: 5px; } 15td.sourceCode { padding-left: 5px; }
18code > span.kw { color: #007020; font-weight: bold; } 16code > span.kw { color: #007020; font-weight: bold; } /* Keyword */
19code > span.dt { color: #902000; } 17code > span.dt { color: #902000; } /* DataType */
20code > span.dv { color: #40a070; } 18code > span.dv { color: #40a070; } /* DecVal */
21code > span.bn { color: #40a070; } 19code > span.bn { color: #40a070; } /* BaseN */
22code > span.fl { color: #40a070; } 20code > span.fl { color: #40a070; } /* Float */
23code > span.ch { color: #4070a0; } 21code > span.ch { color: #4070a0; } /* Char */
24code > span.st { color: #4070a0; } 22code > span.st { color: #4070a0; } /* String */
25code > span.co { color: #60a0b0; font-style: italic; } 23code > span.co { color: #60a0b0; font-style: italic; } /* Comment */
26code > span.ot { color: #007020; } 24code > span.ot { color: #007020; } /* Other */
27code > span.al { color: #ff0000; font-weight: bold; } 25code > span.al { color: #ff0000; font-weight: bold; } /* Alert */
28code > span.fu { color: #06287e; } 26code > span.fu { color: #06287e; } /* Function */
29code > span.er { color: #ff0000; font-weight: bold; } 27code > span.er { color: #ff0000; font-weight: bold; } /* Error */
28code > span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
29code > span.cn { color: #880000; } /* Constant */
30code > span.sc { color: #4070a0; } /* SpecialChar */
31code > span.vs { color: #4070a0; } /* VerbatimString */
32code > span.ss { color: #bb6688; } /* SpecialString */
33code > span.im { } /* Import */
34code > span.va { color: #19177c; } /* Variable */
35code > span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
36code > span.op { color: #666666; } /* Operator */
37code > span.bu { } /* BuiltIn */
38code > span.ex { } /* Extension */
39code > span.pp { color: #bc7a00; } /* Preprocessor */
40code > span.at { color: #7d9029; } /* Attribute */
41code > span.do { color: #ba2121; font-style: italic; } /* Documentation */
42code > span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
43code > span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
44code > span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
30 </style> 45 </style>
31 <link rel="stylesheet" href="github-markdown.css"> 46 <link rel="stylesheet" href="github-markdown.css">
47 <!--[if lt IE 9]>
48 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
49 <![endif]-->
32</head> 50</head>
33<body> 51<body>
34<div id="local-sidebar"> 52<div id="local-sidebar">
@@ -39,18 +57,26 @@ code > span.er { color: #ff0000; font-weight: bold; }
39<li><a href="Download.html">Download</a></li> 57<li><a href="Download.html">Download</a></li>
40<li><a href="Server-requirements.html">Server requirements</a></li> 58<li><a href="Server-requirements.html">Server requirements</a></li>
41<li><a href="Server-configuration.html">Server configuration</a></li> 59<li><a href="Server-configuration.html">Server configuration</a></li>
60<li><a href="Server-security.html">Server security</a></li>
61<li><a href="Shaarli-installation.html">Shaarli installation</a></li>
42<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li> 62<li><a href="Shaarli-configuration.html">Shaarli configuration</a></li>
63<li><a href="Plugin-installation-&amp;-configuration.html">Plugin installation &amp; configuration</a></li>
43</ul></li> 64</ul></li>
65<li><a href="Docker.html">Docker</a></li>
66<li><a href="Plugin-list.html">Plugin list</a></li>
44<li><a href="Usage.html">Usage</a> 67<li><a href="Usage.html">Usage</a>
45<ul> 68<ul>
46<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li> 69<li><a href="Sharing-button.html">Sharing button</a> (bookmarklet)</li>
70<li><a href="Browsing-and-Searching.html">Browsing and Searching</a></li>
47<li><a href="Firefox-share.html">Firefox share</a></li> 71<li><a href="Firefox-share.html">Firefox share</a></li>
48<li><a href="RSS-feeds.html">RSS feeds</a></li> 72<li><a href="RSS-feeds.html">RSS feeds</a></li>
49</ul></li> 73</ul></li>
50<li>How To 74<li>How To
51<ul> 75<ul>
52<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li> 76<li><a href="Backup,-restore,-import-and-export.html">Backup, restore, import and export</a></li>
77<li><a href="Upgrade-from-original-sebsauvage/Shaarli.html">Upgrade from original sebsauvage/Shaarli</a></li>
53<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li> 78<li><a href="Copy-an-existing-installation-over-SSH-and-serve-it-locally.html">Copy an existing installation over SSH and serve it locally</a></li>
79<li><a href="Create-and-serve-multiple-Shaarlis-(farm).html">Create and serve multiple Shaarlis (farm)</a></li>
54<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li> 80<li><a href="Download-CSS-styles-from-an-OPML-list.html">Download CSS styles from an OPML list</a></li>
55<li><a href="Datastore-hacks.html">Datastore hacks</a></li> 81<li><a href="Datastore-hacks.html">Datastore hacks</a></li>
56</ul></li> 82</ul></li>
@@ -62,6 +88,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
62<li><a href="Directory-structure.html">Directory structure</a></li> 88<li><a href="Directory-structure.html">Directory structure</a></li>
63<li><a href="3rd-party-libraries.html">3rd party libraries</a></li> 89<li><a href="3rd-party-libraries.html">3rd party libraries</a></li>
64<li><a href="Plugin-System.html">Plugin System</a></li> 90<li><a href="Plugin-System.html">Plugin System</a></li>
91<li><a href="Release-Shaarli.html">Release Shaarli</a></li>
65<li><a href="Security.html">Security</a></li> 92<li><a href="Security.html">Security</a></li>
66<li><a href="Static-analysis.html">Static analysis</a></li> 93<li><a href="Static-analysis.html">Static analysis</a></li>
67<li><a href="Theming.html">Theming</a></li> 94<li><a href="Theming.html">Theming</a></li>
@@ -78,10 +105,13 @@ code > span.er { color: #ff0000; font-weight: bold; }
78<h1 id="gnupg-signature">GnuPG signature</h1> 105<h1 id="gnupg-signature">GnuPG signature</h1>
79<h2 id="introduction">Introduction</h2> 106<h2 id="introduction">Introduction</h2>
80<h3 id="pgp-and-gpg">PGP and GPG</h3> 107<h3 id="pgp-and-gpg">PGP and GPG</h3>
81<p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good [](.html)<br />Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication,<br />signature and encryption.</p> 108<p><a href="https://gnupg.org/">Gnu Privacy Guard</a> (GnuPG) is an Open Source implementation of the <a href="https://en.wikipedia.org/wiki/Pretty_Good_Privacy#OpenPGP">Pretty Good [](.html)<br />
109Privacy</a> (OpenPGP) specification. Its main purposes are digital authentication,<br />
110signature and encryption.</p>
82<p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify:<a href=".html"></a></p> 111<p>It is often used by the <a href="https://en.wikipedia.org/wiki/Free_and_open-source_software">FLOSS</a> community to verify:<a href=".html"></a></p>
83<ul> 112<ul>
84<li>Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master [](.html)<br />Keys</a></li> 113<li>Linux package signatures: Debian <a href="https://wiki.debian.org/SecureApt">SecureApt</a>, ArchLinux <a href="https://www.archlinux.org/master-keys/">Master [](.html)<br />
114Keys</a></li>
85<li><a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases &amp; maintainer identity<a href=".html"></a></li> 115<li><a href="https://en.wikipedia.org/wiki/Revision_control">SCM</a> releases &amp; maintainer identity<a href=".html"></a></li>
86</ul> 116</ul>
87<h3 id="trust">Trust</h3> 117<h3 id="trust">Trust</h3>
@@ -95,9 +125,12 @@ code > span.er { color: #ff0000; font-weight: bold; }
95<li><a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a><a href=".html"></a></li> 125<li><a href="https://en.wikipedia.org/wiki/Web_of_trust">Web of trust</a><a href=".html"></a></li>
96</ul> 126</ul>
97<h2 id="generate-a-gpg-key">Generate a GPG key</h2> 127<h2 id="generate-a-gpg-key">Generate a GPG key</h2>
98<p>See <a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a>.<a href=".html"></a></p> 128<ul>
129<li><a href="http://stackoverflow.com/a/16725717">Generating a GPG key for Git tagging</a> (StackOverflow)<a href=".html"></a></li>
130<li><a href="https://help.github.com/articles/generating-a-gpg-key/">Generating a GPG key</a> (GitHub)<a href=".html"></a></li>
131</ul>
99<h3 id="gpg---provide-identity-information">gpg - provide identity information</h3> 132<h3 id="gpg---provide-identity-information">gpg - provide identity information</h3>
100<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --gen-key 133<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --gen-key
101 134
102<span class="kw">gpg</span> (GnuPG) <span class="kw">2.1.6;</span> <span class="kw">Copyright</span> (C) <span class="kw">2015</span> Free Software Foundation, Inc. 135<span class="kw">gpg</span> (GnuPG) <span class="kw">2.1.6;</span> <span class="kw">Copyright</span> (C) <span class="kw">2015</span> Free Software Foundation, Inc.
103<span class="kw">This</span> is free software: you are free to change and redistribute it. 136<span class="kw">This</span> is free software: you are free to change and redistribute it.
@@ -116,7 +149,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
116<span class="kw">We</span> need to generate a lot of random bytes. It is a good idea to perform 149<span class="kw">We</span> need to generate a lot of random bytes. It is a good idea to perform
117<span class="kw">some</span> other action (type on the keyboard, move the mouse, utilize the 150<span class="kw">some</span> other action (type on the keyboard, move the mouse, utilize the
118<span class="kw">disks</span>) <span class="kw">during</span> the prime generation<span class="kw">;</span> <span class="kw">this</span> gives the random number 151<span class="kw">disks</span>) <span class="kw">during</span> the prime generation<span class="kw">;</span> <span class="kw">this</span> gives the random number
119<span class="kw">generator</span> a better chance to gain enough entropy.</code></pre> 152<span class="kw">generator</span> a better chance to gain enough entropy.</code></pre></div>
120<h3 id="gpg---entropy-interlude">gpg - entropy interlude</h3> 153<h3 id="gpg---entropy-interlude">gpg - entropy interlude</h3>
121<p>At this point, you will:</p> 154<p>At this point, you will:</p>
122<ul> 155<ul>
@@ -124,7 +157,7 @@ code > span.er { color: #ff0000; font-weight: bold; }
124<li>be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em></li> 157<li>be asked to use your machine's input devices (mouse, keyboard, etc.) to generate random entropy; this step <em>may take some time</em></li>
125</ul> 158</ul>
126<h3 id="gpg---key-creation-confirmation">gpg - key creation confirmation</h3> 159<h3 id="gpg---key-creation-confirmation">gpg - key creation confirmation</h3>
127<pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">gpg</span>: key A9D53A3E marked as ultimately trusted 160<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash"><span class="kw">gpg</span>: key A9D53A3E marked as ultimately trusted
128<span class="kw">public</span> and secret key created and signed. 161<span class="kw">public</span> and secret key created and signed.
129 162
130<span class="kw">gpg</span>: checking the trustdb 163<span class="kw">gpg</span>: checking the trustdb
@@ -133,69 +166,11 @@ code > span.er { color: #ff0000; font-weight: bold; }
133<span class="kw">pub</span> rsa2048/A9D53A3E 2015-07-31 166<span class="kw">pub</span> rsa2048/A9D53A3E 2015-07-31
134 <span class="kw">Key</span> fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E 167 <span class="kw">Key</span> fingerprint = AF2A 5381 E54B 2FD2 14C4 A9A3 0E35 ACA4 A9D5 3A3E
135<span class="kw">uid</span> [ultimate] Marvin the Paranoid Android <span class="kw">&lt;</span>marvin@h2g2.net<span class="kw">&gt;</span>[](.html) 168<span class="kw">uid</span> [ultimate] Marvin the Paranoid Android <span class="kw">&lt;</span>marvin@h2g2.net<span class="kw">&gt;</span>[](.html)
136<span class="kw">sub</span> rsa2048/8C0EACF1 2015-07-31</code></pre> 169<span class="kw">sub</span> rsa2048/8C0EACF1 2015-07-31</code></pre></div>
137<h3 id="gpg---submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3> 170<h3 id="gpg---submit-your-public-key-to-a-pgp-server-optional">gpg - submit your public key to a PGP server (Optional)</h3>
138<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --keyserver pgp.mit.edu --send-keys A9D53A3E 171<div class="sourceCode"><pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">gpg</span> --keyserver pgp.mit.edu --send-keys A9D53A3E
139<span class="kw">gpg</span>: sending key A9D53A3E to hkp server pgp.mit.edu</code></pre> 172<span class="kw">gpg</span>: sending key A9D53A3E to hkp server pgp.mit.edu</code></pre></div>
140<h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2> 173<h2 id="create-and-push-a-gpg-signed-tag">Create and push a GPG-signed tag</h2>
141<p>See <a href="http://git-scm.com/book/en/v2/Distributed-Git-Maintaining-a-Project#Tagging-Your-Releases">Git - Maintaining a project - Tagging your [](.html)<br />releases</a>.</p> 174<p>See <a href="Release-Shaarli.html">Release Shaarli</a>.</p>
142<h3 id="prerequisites">Prerequisites</h3>
143<p>This guide assumes that you have:</p>
144<ul>
145<li>a GPG key matching your GitHub authentication credentials
146<ul>
147<li>i.e., the email address identified by the GPG key is the same as the one in your <code>~/.gitconfig</code></li>
148</ul></li>
149<li>a GitHub fork of Shaarli</li>
150<li>a local clone of your Shaarli fork, with the following remotes:
151<ul>
152<li><code>origin</code> pointing to your GitHub fork</li>
153<li><code>upstream</code> pointing to the main Shaarli repository</li>
154</ul></li>
155<li>maintainer permissions on the main Shaarli repository (to push the signed tag)</li>
156</ul>
157<h3 id="bump-shaarlis-version">Bump Shaarli's version</h3>
158<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
159
160<span class="co"># create a new branch</span>
161$ <span class="kw">git</span> fetch upstream
162$ <span class="kw">git</span> checkout upstream/master -b v0.5.0
163
164<span class="co"># bump the version number</span>
165$ <span class="kw">vim</span> index.php shaarli_version.php
166
167<span class="co"># commit the changes</span>
168$ <span class="kw">git</span> add index.php shaarli_version.php
169$ <span class="kw">git</span> commit -s -m <span class="st">&quot;Bump version to v0.5.0&quot;</span>
170
171<span class="co"># push the commit on your GitHub fork</span>
172$ <span class="kw">git</span> push origin v0.5.0</code></pre>
173<h3 id="create-and-merge-a-pull-request">Create and merge a Pull Request</h3>
174<p>This one is pretty straightforward ;-)</p>
175<h3 id="create-and-push-a-signed-tag">Create and push a signed tag</h3>
176<pre class="sourceCode bash"><code class="sourceCode bash"><span class="co"># update your local copy</span>
177$ <span class="kw">git</span> checkout master
178$ <span class="kw">git</span> fetch upstream
179$ <span class="kw">git</span> pull upstream master
180
181<span class="co"># create a signed tag</span>
182$ <span class="kw">git</span> tag -s -m <span class="st">&quot;Release v0.5.0&quot;</span> v0.5.0
183
184<span class="co"># push it to &quot;upstream&quot;</span>
185$ <span class="kw">git</span> push --tags upstream</code></pre>
186<h3 id="verify-a-signed-tag">Verify a signed tag</h3>
187<p><a href="https://github.com/shaarli/Shaarli/releases/tag/v0.5.0"><code>v0.5.0</code></a> is the first GPG-signed tag pushed on the Community Shaarli.<a href=".html"></a></p>
188<p>Let's have a look at its signature!</p>
189<pre class="sourceCode bash"><code class="sourceCode bash">$ <span class="kw">cd</span> /path/to/shaarli
190$ <span class="kw">git</span> fetch upstream
191
192<span class="co"># get the SHA1 reference of the tag</span>
193$ <span class="kw">git</span> show-ref tags/v0.5.0
194<span class="kw">f7762cf803f03f5caf4b8078359a63783d0090c1</span> refs/tags/v0.5.0
195
196<span class="co"># verify the tag signature information</span>
197$ <span class="kw">git</span> verify-tag f7762cf803f03f5caf4b8078359a63783d0090c1
198<span class="kw">gpg</span>: Signature made Thu 30 Jul 2015 11:46:34 CEST using RSA key ID 4100DF6F
199<span class="kw">gpg</span>: Good signature from <span class="st">&quot;VirtualTam &lt;virtualtam@flibidi.net&gt;&quot;</span> [ultimate][](.html)</code></pre>
200</body> 175</body>
201</html> 176</html>