/mandos/release

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

« back to all changes in this revision

Viewing changes to INSTALL

  • Committer: Teddy Hogeborn
  • Date: 2008-09-08 12:03:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908120316-rrt6r0a5yezc3q1d
* INSTALL: New file.

* mandos-keygen: Use "/etc/mandos/keys" if "/etc/keys/mandos" does not
                 exist.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
 
3
3
* Prerequisites
4
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
 
    + GNU C Library 2.16 https://gnu.org/software/libc/
60
 
    + initramfs-tools 0.85i
61
 
                        https://tracker.debian.org/pkg/initramfs-tools
62
 
    + GnuTLS 3.3        http://www.gnutls.org/
63
 
    + Avahi 0.6.16      http://www.avahi.org/
64
 
    + GnuPG 1.4.9       https://www.gnupg.org/
65
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
66
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
67
 
    
68
 
    Strongly recommended:
69
 
    + OpenSSH           http://www.openssh.com/
70
 
    
71
 
    Package names:
72
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
73
 
    libgpgme11-dev pkg-config ssh
 
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
 
18
                   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
 
33
                  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/
74
38
 
75
39
* Installing the Mandos server
76
40
  
77
 
  1. Do "make doc".
 
41
  + Do "make doc".
78
42
  
79
 
  2. On the computer to run as a Mandos server, run the following
80
 
     command:
81
 
     For Debian: su -c 'make install-server'
82
 
     For Ubuntu: sudo make install-server
83
 
     
84
 
     (This creates a configuration without any clients configured; you
85
 
     need an actually configured client to do that; see below.)
 
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.)
86
48
 
87
49
* Installing the Mandos client.
88
50
  
89
 
  1. Do "make all doc".
90
 
  
91
 
  2. On the computer to run as a Mandos client, run the following
92
 
     command:
93
 
     For Debian: su -c 'make install-client'
94
 
     For Ubuntu: sudo make install-client
95
 
     
96
 
     This will also create an OpenPGP key, which will take some time
97
 
     and entropy, so be patient.
98
 
  
99
 
  3. Run the following command:
100
 
     For Debian: su -c 'mandos-keygen --password'
101
 
     For Ubuntu: sudo mandos-keygen --password
102
 
     
103
 
     When prompted, enter the password/passphrase for the encrypted
104
 
     root file system on this client computer.  The command will
105
 
     output a section of text, starting with a [section header].  Copy
106
 
     and append this to the file "/etc/mandos/clients.conf" *on the
107
 
     server computer*.
108
 
  
109
 
  4. Configure the client to use any special configuration needed for
110
 
     your local system.  Note: This is not necessary if the server is
111
 
     present on the same wired local network as the client.  If you do
112
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
113
 
     file must be updated, possibly using the 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 five minutes to reboot.
 
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".
134
66
 
135
67
* Further customizations
136
68
  
137
69
  You may want to tighten or loosen the timeouts in the server
138
70
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
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.
142
 
 
143
 
#+STARTUP: showall
 
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.