/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: 2014-07-17 00:49:30 UTC
  • Revision ID: teddy@recompile.se-20140717004930-tqfjwjvonrtfcr7w
mandos-ctl: Make it work in Python 3.

* mandos-ctl: Tolerate failure of importing future_builtins.  If
              Python 2, override "str" with "unicode".
  (print_clients): Use "str" instead of "unicode".
  (main): Use 'type=argparse.FileType(mode="rb")' instead of
          'type=file', and use the items() method instead of
          iteritems().

Show diffs side-by-side

added added

removed removed

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