Documentation for social key management

This commit is contained in:
Bob Mottram 2015-07-05 19:35:57 +01:00
parent f73d8d79bf
commit f98e243718
2 changed files with 255 additions and 136 deletions

View File

@ -7,7 +7,7 @@
#+BEGIN_CENTER
[[./images/logo.png]]
#+END_CENTER
| [[file:index.html][Home]] | [[Preparation for the Beaglebone Black]] | [[Checklist]] | [[GPG Keys]] | [[Interactive Setup]] | [[Non-Interactive Setup]] | [[Post-Setup]] | [[On Client Machines]] |
| [[file:index.html][Home]] | [[Preparation for the Beaglebone Black]] | [[Checklist]] | [[Interactive Setup]] | [[Non-Interactive Setup]] | [[Post-Setup]] | [[Keydrives]] | [[On Client Machines]] |
* Preparation for the Beaglebone Black
@ -57,13 +57,6 @@ Before running the freedombone command you will need a few things.
* If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains
* Have ssh access to the system
* GPG Keys
If you have existing GPG keys then copy the .gnupg directory onto the system.
#+BEGIN_SRC bash
scp -r ~/.gnupg username@freedombone_IP_address:/home/username
#+END_SRC
* Interactive Setup
The interactive server configuration setup is recommended for most users. On the system where freedombone is to be installed create a configuration file.
@ -126,6 +119,8 @@ FULLBLOG_DOMAIN_NAME=myblogdomain
MICROBLOG_DOMAIN_NAME=mymicroblogdomain
REDMATRIX_DOMAIN_NAME=myredmatrixdomain
OWNCLOUD_DOMAIN_NAME=myownclouddomain
HWRNG_TYPE=haveged
ENABLE_SOCIAL_KEY_MANAGEMENT="no"
#+END_SRC
Both of the IP addresses are local IP addresses, typically of the form 192.168.x.x, with one being for the system and the other being for the internet router.
@ -142,6 +137,15 @@ The above command should be run in the same directory in which your configuratio
Also see the manpage for additional options which can be used instead of a configuration file.
* Social Key Management
If you are using the interactive installer then you will be aked if you wish to import GPG keys. If you don't already possess GPG keys then just select "Ok" and they will be generated during the install. If you do already have GPG keys then there are a few possibilities
** You have the gnupg keyring on an encrypted USB drive
If you previously made a master keydrive containing the full keyring (the .gnupg directory). This is the most straightforward case, but not as secure as splitting the key into fragments.
** You have a number of key fragments on USB drives retrieved from friends
If you previously made some USB drives containing key fragments then retrieve them from your friends and plug them in one after the other. After the last drive has been read then remove it and just select "Ok". The system will then try to reconstruct the key. For this to work you will need to have previously made three or more [[Keydrives]].
** You can specify some ssh login details for friends servers containing key fragments
Enter three or more sets of login details and the installer will try to retrieve key fragments and then assemble them into the full key. This only works if you previously were using remote backups and had social key management enabled.
* Post-Setup
Setup of the server and installation of all the relevant packages is not quick, and depends upon which variant you choose and your internet bandwidth. Allow about three hours for a full installation on the Beaglebone Black. On the Beaglebone installation is in two parts, since a reboot is needed to enable the hardware random number generator and zram.
@ -174,6 +178,32 @@ On your internet router, typically under firewall settings, open the following p
| Email | 993 |
| VoIP | 64738 |
* Keydrives
After installing for the first time it's a good idea to create some keydrives. These will store your gpg key so that if all else fails you will still be able to restore from backup. There are two ways to do this:
** Master Keydrive
This is the traditional security model in which you carry your full keyring on an encrypted USB drive. To make a master keydrive first format a USB drive as a LUKS encrypted drive. In Ubuntu this can be done from the "Discs" application. Then plug it into the Freedombone system, then from your local machine run:
#+BEGIN_SRC bash
ssh myusername@mydomainname -p 2222
su
freedombone-keydrive -u myusername -d sdb --master yes
exit
exit
#+END_SRC
If you are on a Beaglebone Black then use /sda/ rather than /sdb/ for the drive parameter.
** Fragment keydrives
This breaks your GPG key into a number of fragments and randomly selects one to add to the USB drive. First format a USB drive as a LUKS encrypted drive. In Ubuntu this can be done from the "Discs" application. Plug it into the Freedombone system then from your local machine run the following commands:
#+BEGIN_SRC bash
ssh myusername@mydomainname -p 2222
su
freedombone-keydrive -u myusername -d sdb
exit
exit
#+END_SRC
Fragments are randomly assigned and so you will need at least three or four keydrives to have enough fragments to reconstruct your original key in a worst case scenario. You can store fragments for different Freedombone systems on the same encrypted USB drive, so you can help to ensure that your friends can also recover their systems. This might be called "/the web of backups/" or "/the web of encryption/". Since you can only write a single key fragment from your Freedombone system to a given USB drive each friend doesn't have enough information to decrypt your backups or steal your identity, even if they turn evil. This is based on the assumption that it may be difficult to get three or more friends to conspire against you all at once.
* On Client Machines
You can configure laptops or desktop machines which connect to the Freedombone server in the following way. This alters encryption settings to improve overall security.

View File

@ -4,25 +4,32 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title></title>
<!-- 2015-02-03 Tue 20:51 -->
<!-- 2015-07-05 Sun 19:34 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="Bob Mottram" />
<meta name="description" content="Turn the Beaglebone Black into a personal communications server"
/>
<meta name="keywords" content="freedombox, debian, beaglebone, red matrix, email, web server, home server, internet, censorship, surveillance, social network, irc, jabber" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
.title { text-align: center; }
.title { text-align: center;
margin-bottom: .2em; }
.subtitle { text-align: center;
font-size: medium;
font-weight: bold;
margin-top:0; }
.todo { font-family: monospace; color: red; }
.done { color: green; }
.done { font-family: monospace; color: green; }
.priority { font-family: monospace; color: orange; }
.tag { background-color: #eee; font-family: monospace;
padding: 2px; font-size: 80%; font-weight: normal; }
.timestamp { color: #bebebe; }
.timestamp-kwd { color: #5f9ea0; }
.right { margin-left: auto; margin-right: 0px; text-align: right; }
.left { margin-left: 0px; margin-right: auto; text-align: left; }
.center { margin-left: auto; margin-right: auto; text-align: center; }
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
.underline { text-decoration: underline; }
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
p.verse { margin-left: 3%; }
@ -61,12 +68,12 @@
caption.t-above { caption-side: top; }
caption.t-bottom { caption-side: bottom; }
td, th { vertical-align:top; }
th.right { text-align: center; }
th.left { text-align: center; }
th.center { text-align: center; }
td.right { text-align: right; }
td.left { text-align: left; }
td.center { text-align: center; }
th.org-right { text-align: center; }
th.org-left { text-align: center; }
th.org-center { text-align: center; }
td.org-right { text-align: right; }
td.org-left { text-align: left; }
td.org-center { text-align: center; }
dt { font-weight: bold; }
.footpara:nth-child(2) { display: inline; }
.footpara { display: block; }
@ -147,7 +154,32 @@ for the JavaScript code in this tag.
<a name="top" id="top"></a>
</div>
<div id="content">
<h1 class="title"></h1>
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
<li><a href="#orgheadline1">Preparation for the Beaglebone Black</a></li>
<li><a href="#orgheadline2">Checklist</a></li>
<li><a href="#orgheadline3">Interactive Setup</a></li>
<li><a href="#orgheadline4">Non-Interactive Setup</a></li>
<li><a href="#orgheadline8">Social Key Management</a>
<ul>
<li><a href="#orgheadline9">You have the gnupg keyring on an encrypted USB drive</a></li>
<li><a href="#orgheadline10">You have a number of key fragments on USB drives retrieved from friends</a></li>
<li><a href="#orgheadline11">You can specify some ssh login details for friends servers containing key fragments</a></li>
</ul>
</li>
<li><a href="#orgheadline5">Post-Setup</a></li>
<li><a href="#orgheadline6">Keydrives</a>
<ul>
<li><a href="#orgheadline12">Master Keydrive</a></li>
<li><a href="#orgheadline13">Fragment keydrives</a></li>
</ul>
</li>
<li><a href="#orgheadline7">On Client Machines</a></li>
</ul>
</div>
</div>
<div class="center">
<div class="figure">
@ -159,40 +191,40 @@ for the JavaScript code in this tag.
<colgroup>
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
<col class="left" />
<col class="org-left" />
</colgroup>
<tbody>
<tr>
<td class="left"><a href="index.html">Home</a></td>
<td class="left"><a href="#unnumbered-1">Preparation for the Beaglebone Black</a></td>
<td class="left"><a href="#unnumbered-2">Checklist</a></td>
<td class="left"><a href="#unnumbered-3">GPG Keys</a></td>
<td class="left"><a href="#unnumbered-4">Interactive Setup</a></td>
<td class="left"><a href="#unnumbered-5">Non-Interactive Setup</a></td>
<td class="left"><a href="#unnumbered-6">Post-Setup</a></td>
<td class="left"><a href="#unnumbered-7">On Client Machines</a></td>
<td class="org-left"><a href="index.html">Home</a></td>
<td class="org-left"><a href="#orgheadline1">Preparation for the Beaglebone Black</a></td>
<td class="org-left"><a href="#orgheadline2">Checklist</a></td>
<td class="org-left"><a href="#orgheadline3">Interactive Setup</a></td>
<td class="org-left"><a href="#orgheadline4">Non-Interactive Setup</a></td>
<td class="org-left"><a href="#orgheadline5">Post-Setup</a></td>
<td class="org-left"><a href="#orgheadline6">Keydrives</a></td>
<td class="org-left"><a href="#orgheadline7">On Client Machines</a></td>
</tr>
</tbody>
</table>
<div id="outline-container-unnumbered-1" class="outline-2">
<h2 id="unnumbered-1">Preparation for the Beaglebone Black</h2>
<div class="outline-text-2" id="text-unnumbered-1">
<div id="outline-container-orgheadline1" class="outline-2">
<h2 id="orgheadline1">Preparation for the Beaglebone Black</h2>
<div class="outline-text-2" id="text-orgheadline1">
<p>
This section is specific to the Beaglebone Black hardware. If you're not using that hardware then just skip to the next section.
</p>
@ -202,24 +234,15 @@ To get started you will need:
</p>
<ul class="org-ul">
<li>A Beaglebone Black
</li>
<li>A MicroSD card
</li>
<li>Ethernet cable
</li>
<li>Optionally a 5V 2A power supply for the Beaglebone Black
</li>
<li>Access to the internet via a router with ethernet sockets
</li>
<li>USB thumb drive (for backups or storing media)
</li>
<li>One or more domains available via a dynamic DNS provider, such as <a href="https://freedns.afraid.org/">https://freedns.afraid.org/</a>
</li>
<li>A purchased domain name and SSL certificate (only needed for Red Matrix)
</li>
<li>A laptop or desktop machine with the ability to write to a microSD card (might need an adaptor)
</li>
<li>A Beaglebone Black</li>
<li>A MicroSD card</li>
<li>Ethernet cable</li>
<li>Optionally a 5V 2A power supply for the Beaglebone Black</li>
<li>Access to the internet via a router with ethernet sockets</li>
<li>USB thumb drive (for backups or storing media)</li>
<li>One or more domains available via a dynamic DNS provider, such as <a href="https://freedns.afraid.org/">https://freedns.afraid.org/</a></li>
<li>A purchased domain name and SSL certificate (only needed for Red Matrix)</li>
<li>A laptop or desktop machine with the ability to write to a microSD card (might need an adaptor)</li>
</ul>
<p>
@ -260,48 +283,27 @@ When the initial setup is done follow the instructions on screen to run the main
</div>
</div>
<div id="outline-container-unnumbered-2" class="outline-2">
<h2 id="unnumbered-2">Checklist</h2>
<div class="outline-text-2" id="text-unnumbered-2">
<div id="outline-container-orgheadline2" class="outline-2">
<h2 id="orgheadline2">Checklist</h2>
<div class="outline-text-2" id="text-orgheadline2">
<p>
Before running the freedombone command you will need a few things.
</p>
<ul class="org-ul">
<li>Have some domains, or subdomains, registered with a dynamic DNS service
</li>
<li>System with a new installation of Debian Jessie
</li>
<li>Ethernet connection to an internet router
</li>
<li>It is possible to forward ports from the internet router to the system
</li>
<li>If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains
</li>
<li>Have ssh access to the system
</li>
<li>Have some domains, or subdomains, registered with a dynamic DNS service</li>
<li>System with a new installation of Debian Jessie</li>
<li>Ethernet connection to an internet router</li>
<li>It is possible to forward ports from the internet router to the system</li>
<li>If you want to set up a social network or microblog then you will need SSL certificates corresponding to those domains</li>
<li>Have ssh access to the system</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-3" class="outline-2">
<h2 id="unnumbered-3">GPG Keys</h2>
<div class="outline-text-2" id="text-unnumbered-3">
<p>
If you have existing GPG keys then copy the .gnupg directory onto the system.
</p>
<div class="org-src-container">
<pre class="src src-bash">scp -r ~/.gnupg username@freedombone_IP_address:/home/username
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-4" class="outline-2">
<h2 id="unnumbered-4">Interactive Setup</h2>
<div class="outline-text-2" id="text-unnumbered-4">
<div id="outline-container-orgheadline3" class="outline-2">
<h2 id="orgheadline3">Interactive Setup</h2>
<div class="outline-text-2" id="text-orgheadline3">
<p>
The interactive server configuration setup is recommended for most users. On the system where freedombone is to be installed create a configuration file.
</p>
@ -334,9 +336,9 @@ You can select which variant you wish to install and then enter the details as r
</div>
</div>
<div id="outline-container-unnumbered-5" class="outline-2">
<h2 id="unnumbered-5">Non-Interactive Setup</h2>
<div class="outline-text-2" id="text-unnumbered-5">
<div id="outline-container-orgheadline4" class="outline-2">
<h2 id="orgheadline4">Non-Interactive Setup</h2>
<div class="outline-text-2" id="text-orgheadline4">
<p>
If you don't want to install interactively then it's possible to manually create a configuration file as follows:
</p>
@ -386,6 +388,8 @@ Add the following, and set the values as needed. DEFAULT_DOMAIN_NAME is where yo
<span class="org-variable-name">MICROBLOG_DOMAIN_NAME</span>=mymicroblogdomain
<span class="org-variable-name">REDMATRIX_DOMAIN_NAME</span>=myredmatrixdomain
<span class="org-variable-name">OWNCLOUD_DOMAIN_NAME</span>=myownclouddomain
<span class="org-variable-name">HWRNG_TYPE</span>=haveged
<span class="org-variable-name">ENABLE_SOCIAL_KEY_MANAGEMENT</span>=<span class="org-string">"no"</span>
</pre>
</div>
@ -417,9 +421,42 @@ Also see the manpage for additional options which can be used instead of a confi
</div>
</div>
<div id="outline-container-unnumbered-6" class="outline-2">
<h2 id="unnumbered-6">Post-Setup</h2>
<div class="outline-text-2" id="text-unnumbered-6">
<div id="outline-container-orgheadline8" class="outline-2">
<h2 id="orgheadline8">Social Key Management</h2>
<div class="outline-text-2" id="text-orgheadline8">
<p>
If you are using the interactive installer then you will be aked if you wish to import GPG keys. If you don't already possess GPG keys then just select "Ok" and they will be generated during the install. If you do already have GPG keys then there are a few possibilities
</p>
</div>
<div id="outline-container-orgheadline9" class="outline-3">
<h3 id="orgheadline9">You have the gnupg keyring on an encrypted USB drive</h3>
<div class="outline-text-3" id="text-orgheadline9">
<p>
If you previously made a master keydrive containing the full keyring (the .gnupg directory). This is the most straightforward case, but not as secure as splitting the key into fragments.
</p>
</div>
</div>
<div id="outline-container-orgheadline10" class="outline-3">
<h3 id="orgheadline10">You have a number of key fragments on USB drives retrieved from friends</h3>
<div class="outline-text-3" id="text-orgheadline10">
<p>
If you previously made some USB drives containing key fragments then retrieve them from your friends and plug them in one after the other. After the last drive has been read then remove it and just select "Ok". The system will then try to reconstruct the key. For this to work you will need to have previously made three or more <a href="#orgheadline6">Keydrives</a>.
</p>
</div>
</div>
<div id="outline-container-orgheadline11" class="outline-3">
<h3 id="orgheadline11">You can specify some ssh login details for friends servers containing key fragments</h3>
<div class="outline-text-3" id="text-orgheadline11">
<p>
Enter three or more sets of login details and the installer will try to retrieve key fragments and then assemble them into the full key. This only works if you previously were using remote backups and had social key management enabled.
</p>
</div>
</div>
</div>
<div id="outline-container-orgheadline5" class="outline-2">
<h2 id="orgheadline5">Post-Setup</h2>
<div class="outline-text-2" id="text-orgheadline5">
<p>
Setup of the server and installation of all the relevant packages is not quick, and depends upon which variant you choose and your internet bandwidth. Allow about three hours for a full installation on the Beaglebone Black. On the Beaglebone installation is in two parts, since a reboot is needed to enable the hardware random number generator and zram.
</p>
@ -446,104 +483,156 @@ On your internet router, typically under firewall settings, open the following p
<colgroup>
<col class="left" />
<col class="org-left" />
<col class="right" />
<col class="org-right" />
</colgroup>
<thead>
<tr>
<th scope="col" class="left">Service</th>
<th scope="col" class="right">Ports</th>
<th scope="col" class="org-left">Service</th>
<th scope="col" class="org-right">Ports</th>
</tr>
</thead>
<tbody>
<tr>
<td class="left">HTTP</td>
<td class="right">80</td>
<td class="org-left">HTTP</td>
<td class="org-right">80</td>
</tr>
<tr>
<td class="left">HTTPS</td>
<td class="right">443</td>
<td class="org-left">HTTPS</td>
<td class="org-right">443</td>
</tr>
<tr>
<td class="left">SSH</td>
<td class="right">2222</td>
<td class="org-left">SSH</td>
<td class="org-right">2222</td>
</tr>
<tr>
<td class="left">DLNA</td>
<td class="right">1900</td>
<td class="org-left">DLNA</td>
<td class="org-right">1900</td>
</tr>
<tr>
<td class="left">DLNA</td>
<td class="right">8200</td>
<td class="org-left">DLNA</td>
<td class="org-right">8200</td>
</tr>
<tr>
<td class="left">XMPP</td>
<td class="right">5222..5223</td>
<td class="org-left">XMPP</td>
<td class="org-right">5222..5223</td>
</tr>
<tr>
<td class="left">XMPP</td>
<td class="right">5269</td>
<td class="org-left">XMPP</td>
<td class="org-right">5269</td>
</tr>
<tr>
<td class="left">XMPP</td>
<td class="right">5280..5281</td>
<td class="org-left">XMPP</td>
<td class="org-right">5280..5281</td>
</tr>
<tr>
<td class="left">IRC</td>
<td class="right">6697</td>
<td class="org-left">IRC</td>
<td class="org-right">6697</td>
</tr>
<tr>
<td class="left">IRC</td>
<td class="right">9999</td>
<td class="org-left">IRC</td>
<td class="org-right">9999</td>
</tr>
<tr>
<td class="left">Git</td>
<td class="right">9418</td>
<td class="org-left">Git</td>
<td class="org-right">9418</td>
</tr>
<tr>
<td class="left">Email</td>
<td class="right">25</td>
<td class="org-left">Email</td>
<td class="org-right">25</td>
</tr>
<tr>
<td class="left">Email</td>
<td class="right">587</td>
<td class="org-left">Email</td>
<td class="org-right">587</td>
</tr>
<tr>
<td class="left">Email</td>
<td class="right">465</td>
<td class="org-left">Email</td>
<td class="org-right">465</td>
</tr>
<tr>
<td class="left">Email</td>
<td class="right">993</td>
<td class="org-left">Email</td>
<td class="org-right">993</td>
</tr>
<tr>
<td class="left">VoIP</td>
<td class="right">64738</td>
<td class="org-left">VoIP</td>
<td class="org-right">64738</td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="outline-container-unnumbered-7" class="outline-2">
<h2 id="unnumbered-7">On Client Machines</h2>
<div class="outline-text-2" id="text-unnumbered-7">
<div id="outline-container-orgheadline6" class="outline-2">
<h2 id="orgheadline6">Keydrives</h2>
<div class="outline-text-2" id="text-orgheadline6">
<p>
After installing for the first time it's a good idea to create some keydrives. These will store your gpg key so that if all else fails you will still be able to restore from backup. There are two ways to do this:
</p>
</div>
<div id="outline-container-orgheadline12" class="outline-3">
<h3 id="orgheadline12">Master Keydrive</h3>
<div class="outline-text-3" id="text-orgheadline12">
<p>
This is the traditional security model in which you carry your full keyring on an encrypted USB drive. To make a master keydrive first format a USB drive as a LUKS encrypted drive. In Ubuntu this can be done from the "Discs" application. Then plug it into the Freedombone system, then from your local machine run:
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh myusername@mydomainname -p 2222
su
freedombone-keydrive -u myusername -d sdb --master yes
<span class="org-keyword">exit</span>
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
If you are on a Beaglebone Black then use <i>sda</i> rather than <i>sdb</i> for the drive parameter.
</p>
</div>
</div>
<div id="outline-container-orgheadline13" class="outline-3">
<h3 id="orgheadline13">Fragment keydrives</h3>
<div class="outline-text-3" id="text-orgheadline13">
<p>
This breaks your GPG key into a number of fragments and randomly selects one to add to the USB drive. First format a USB drive as a LUKS encrypted drive. In Ubuntu this can be done from the "Discs" application. Plug it into the Freedombone system then from your local machine run the following commands:
</p>
<div class="org-src-container">
<pre class="src src-bash">ssh myusername@mydomainname -p 2222
su
freedombone-keydrive -u myusername -d sdb
<span class="org-keyword">exit</span>
<span class="org-keyword">exit</span>
</pre>
</div>
<p>
Fragments are randomly assigned and so you will need at least three or four keydrives to have enough fragments to reconstruct your original key in a worst case scenario. You can store fragments for different Freedombone systems on the same encrypted USB drive, so you can help to ensure that your friends can also recover their systems. This might be called "<i>the web of backups</i>" or "<i>the web of encryption</i>". Since you can only write a single key fragment from your Freedombone system to a given USB drive each friend doesn't have enough information to decrypt your backups or steal your identity, even if they turn evil. This is based on the assumption that it may be difficult to get three or more friends to conspire against you all at once.
</p>
</div>
</div>
</div>
<div id="outline-container-orgheadline7" class="outline-2">
<h2 id="orgheadline7">On Client Machines</h2>
<div class="outline-text-2" id="text-orgheadline7">
<p>
You can configure laptops or desktop machines which connect to the Freedombone server in the following way. This alters encryption settings to improve overall security.
</p>