/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 13:09:43 UTC
  • Revision ID: teddy@recompile.se-20160228130943-6ofi0xgek1xd7qmy
Use GnuPG 2 if available

* debian/control (Package: mandos/Depends): Change "gnupg (<< 2)" to
                                            "gnupg".
  (Package: mandos-client/Depends): Remove "gnupg (<< 2)"; it will be
                                    depended on by libgpgme11, which
                                    will be added automatically by
                                    ${shlibs:Depends}.
* mandos (PGPEngine.__init__): Try to run "gpgconf" and set 'self.gpg'
                               to any binary found.  Also change
                               "--home" to "--homedir".
  (PGPEngine.encrypt, PGPEngine.decrypt): Use the 'self.gpg' attribute
                                          instead of "gpg".

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
-*- org -*-
 
2
 
 
3
* Prerequisites
 
4
  
 
5
** Operating System
 
6
   
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
 
8
   
 
9
   This is mostly for the support scripts which make sure that the
 
10
   client is installed and started in the initial RAM disk environment
 
11
   and that the initial RAM file system image file is automatically
 
12
   made unreadable.  The server and client programs themselves *could*
 
13
   be run in other distributions, but they *are* specific to GNU/Linux
 
14
   systems, and are not written with portabillity to other Unixes in
 
15
   mind.
 
16
   
 
17
** Libraries
 
18
   
 
19
   The following libraries and packages are needed.  (It is possible
 
20
   that it might work with older versions of some of these, but these
 
21
   versions are confirmed to work.  Newer versions are almost
 
22
   certainly OK.)
 
23
   
 
24
*** Documentation
 
25
    These are required to build the manual pages for both the server
 
26
    and client:
 
27
    
 
28
    + DocBook 4.5         http://www.docbook.org/
 
29
      Note: DocBook 5.0 is not compatible.
 
30
    + DocBook XSL stylesheets 1.71.0
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
 
32
    
 
33
    Package names:
 
34
    docbook docbook-xsl
 
35
    
 
36
    To build just the documentation, run the command "make doc".  Then
 
37
    the manual page "mandos.8", for example, can be read by running
 
38
    "man -l mandos.8".
 
39
    
 
40
*** Mandos Server
 
41
    + GnuTLS 3.3          http://www.gnutls.org/
 
42
    + Avahi 0.6.16        http://www.avahi.org/
 
43
    + Python 2.7          https://www.python.org/
 
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
45
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
 
46
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
47
    + Urwid 1.0.1         http://urwid.org/
 
48
      (Only needed by the "mandos-monitor" tool.)
 
49
    
 
50
    Strongly recommended:
 
51
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
52
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
53
    
 
54
    Package names:
 
55
    avahi-daemon python python-avahi python-dbus python-gobject
 
56
    python-urwid pkg-config fping ssh-client
 
57
    
 
58
*** Mandos Client
 
59
    + initramfs-tools 0.85i
 
60
                        https://tracker.debian.org/pkg/initramfs-tools
 
61
    + GnuTLS 3.3        http://www.gnutls.org/
 
62
    + Avahi 0.6.16      http://www.avahi.org/
 
63
    + GnuPG 1.4.9       https://www.gnupg.org/
 
64
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
65
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
66
    
 
67
    Strongly recommended:
 
68
    + OpenSSH           http://www.openssh.com/
 
69
    
 
70
    Package names:
 
71
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
72
    libgpgme11-dev pkg-config ssh
 
73
 
 
74
* Installing the Mandos server
 
75
  
 
76
  1. Do "make doc".
 
77
  
 
78
  2. On the computer to run as a Mandos server, run the following
 
79
     command:
 
80
     For Debian: su -c 'make install-server'
 
81
     For Ubuntu: sudo make install-server
 
82
     
 
83
     (This creates a configuration without any clients configured; you
 
84
     need an actually configured client to do that; see below.)
 
85
 
 
86
* Installing the Mandos client.
 
87
  
 
88
  1. Do "make all doc".
 
89
  
 
90
  2. On the computer to run as a Mandos client, run the following
 
91
     command:
 
92
     For Debian: su -c 'make install-client'
 
93
     For Ubuntu: sudo make install-client
 
94
     
 
95
     This will also create an OpenPGP key, which will take some time
 
96
     and entropy, so be patient.
 
97
  
 
98
  3. Run the following command:
 
99
     For Debian: su -c 'mandos-keygen --password'
 
100
     For Ubuntu: sudo mandos-keygen --password
 
101
     
 
102
     When prompted, enter the password/passphrase for the encrypted
 
103
     root file system on this client computer.  The command will
 
104
     output a section of text, starting with a [section header].  Copy
 
105
     and append this to the file "/etc/mandos/clients.conf" *on the
 
106
     server computer*.
 
107
  
 
108
  4. Configure the client to use any special configuration needed for
 
109
     your local system.  Note: This is not necessary if the server is
 
110
     present on the same wired local network as the client.  If you do
 
111
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
112
     file must be updated, possibly using the following command:
 
113
     
 
114
        # update-initramfs -k all -u
 
115
  
 
116
  5. On the server computer, start the server by running the command
 
117
     For Debian: su -c 'invoke-rc.d mandos start'
 
118
     For Ubuntu: sudo service mandos start
 
119
     
 
120
     At this point, it is possible to verify that the correct password
 
121
     will be received by the client by running the command:
 
122
     
 
123
        # /usr/lib/mandos/plugins.d/mandos-client \
 
124
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
125
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
126
     
 
127
     This command should retrieve the password from the server,
 
128
     decrypt it, and output it to standard output.
 
129
     
 
130
     After this, the client computer should be able to reboot without
 
131
     needing a password entered on the console, as long as it does not
 
132
     take more than five minutes to reboot.
 
133
 
 
134
* Further customizations
 
135
  
 
136
  You may want to tighten or loosen the timeouts in the server
 
137
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
 
138
  If IPsec is not used and SSH is not installed, it is suggested that
 
139
  a more cryptographically secure checker program is used and
 
140
  configured, since, without IPsec, ping packets can be faked.
 
141
 
 
142
#+STARTUP: showall