/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: 2012-06-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
    
 
51
    Package names:
 
52
    python-gnutls avahi-daemon python python-avahi python-dbus
 
53
    python-gobject python-urwid
 
54
   
 
55
*** Mandos Client
 
56
    + initramfs-tools 0.85i
33
57
                  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/
 
58
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
59
    + Avahi 0.6.16        http://www.avahi.org/
 
60
    + GnuPG 1.4.9         http://www.gnupg.org/
 
61
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
62
    
 
63
    Package names:
 
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
65
    libgpgme11-dev
38
66
 
39
67
* Installing the Mandos server
40
68
  
41
 
  + Do "make doc".
 
69
  1. Do "make doc".
42
70
  
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.)
 
71
  2. On the computer to run as a Mandos server, run the following
 
72
     command:
 
73
     For Debian: su -c 'make install-server'
 
74
     For Ubuntu: sudo make install-server
 
75
     
 
76
     (This creates a configuration without any clients configured; you
 
77
     need an actually configured client to do that; see below.)
48
78
 
49
79
* Installing the Mandos client.
50
80
  
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".
 
81
  1. Do "make all doc".
 
82
  
 
83
  2. On the computer to run as a Mandos client, run the following
 
84
     command:
 
85
     For Debian: su -c 'make install-client'
 
86
     For Ubuntu: sudo make install-client
 
87
     
 
88
     This will also create an OpenPGP key, which will take some time
 
89
     and entropy, so be patient.
 
90
  
 
91
  3. Run the following command:
 
92
     For Debian: su -c 'mandos-keygen --password'
 
93
     For Ubuntu: sudo mandos-keygen --password
 
94
     
 
95
     When prompted, enter the password/passphrase for the encrypted
 
96
     root file system on this client computer.  The command will
 
97
     output a section of text, starting with a [section header].  Copy
 
98
     and append this to the file "/etc/mandos/clients.conf" *on the
 
99
     server computer*.
 
100
  
 
101
  4. Configure the client to use the correct network interface.  The
 
102
     interface to use is automatically chosen at boot, and if this
 
103
     needs to be adjusted, it will be necessary to edit
 
104
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
 
105
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
 
106
     can be edited to add a "--device" parameter for the
 
107
     mandos-client(8) plugin.  Please note: If any of those files are
 
108
     changed, the initrd.img file must be updated, possibly using the
 
109
     following command:
 
110
     
 
111
        # update-initramfs -k all -u
 
112
  
 
113
  5. On the server computer, start the server by running the command
 
114
     For Debian: su -c 'invoke-rc.d mandos start'
 
115
     For Ubuntu: sudo service mandos start
 
116
     
 
117
     At this point, it is possible to verify that the correct password
 
118
     will be received by the client by running the command:
 
119
     
 
120
        # /usr/lib/mandos/plugins.d/mandos-client \
 
121
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
122
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
123
     
 
124
     This command should retrieve the password from the server,
 
125
     decrypt it, and output it to standard output.
 
126
     
 
127
     After this, the client computer should be able to reboot without
 
128
     needing a password entered on the console, as long as it does not
 
129
     take more than an hour to reboot.
66
130
 
67
131
* Further customizations
68
132
  
69
133
  You may want to tighten or loosen the timeouts in the server
70
134
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
71
 
  Is IPsec is not used, it is suggested that a more cryptographically
 
135
  If IPsec is not used, it is suggested that a more cryptographically
72
136
  secure checker program is used and configured, since without IPsec
73
137
  ping packets can be faked.