/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 03:50:57 UTC
  • mfrom: (237.4.51 release)
  • Revision ID: teddy@recompile.se-20140717035057-bg2gbhm4dqbcjewx
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
-*- org -*-
 
2
 
 
3
* Prerequisites
 
4
  
 
5
** Operating System
 
6
   
 
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (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 2.4          http://www.gnutls.org/
 
42
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
 
43
    + Avahi 0.6.16        http://www.avahi.org/
 
44
    + Python 2.6          https://www.python.org/
 
45
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
 
46
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
 
47
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
 
48
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
49
    + Python-argparse     https://pypi.python.org/pypi/argparse
 
50
    + Urwid 1.0.1         http://urwid.org/
 
51
      (Only needed by the "mandos-monitor" tool.)
 
52
    
 
53
    Strongly recommended:
 
54
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
55
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
56
    
 
57
    Package names:
 
58
    python-gnutls avahi-daemon python python-avahi python-dbus
 
59
    python-gobject python-urwid pkg-config fping ssh-client
 
60
    
 
61
*** Mandos Client
 
62
    + initramfs-tools 0.85i
 
63
                        https://tracker.debian.org/pkg/initramfs-tools
 
64
    + GnuTLS 2.4        http://www.gnutls.org/
 
65
    + Avahi 0.6.16      http://www.avahi.org/
 
66
    + GnuPG 1.4.9       https://www.gnupg.org/
 
67
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
68
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
 
69
    
 
70
    Strongly recommended:
 
71
    + OpenSSH           http://www.openssh.com/
 
72
    
 
73
    Package names:
 
74
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
75
    libgpgme11-dev pkg-config ssh
 
76
 
 
77
* Installing the Mandos server
 
78
  
 
79
  1. Do "make doc".
 
80
  
 
81
  2. On the computer to run as a Mandos server, run the following
 
82
     command:
 
83
     For Debian: su -c 'make install-server'
 
84
     For Ubuntu: sudo make install-server
 
85
     
 
86
     (This creates a configuration without any clients configured; you
 
87
     need an actually configured client to do that; see below.)
 
88
 
 
89
* Installing the Mandos client.
 
90
  
 
91
  1. Do "make all doc".
 
92
  
 
93
  2. On the computer to run as a Mandos client, run the following
 
94
     command:
 
95
     For Debian: su -c 'make install-client'
 
96
     For Ubuntu: sudo make install-client
 
97
     
 
98
     This will also create an OpenPGP key, which will take some time
 
99
     and entropy, so be patient.
 
100
  
 
101
  3. Run the following command:
 
102
     For Debian: su -c 'mandos-keygen --password'
 
103
     For Ubuntu: sudo mandos-keygen --password
 
104
     
 
105
     When prompted, enter the password/passphrase for the encrypted
 
106
     root file system on this client computer.  The command will
 
107
     output a section of text, starting with a [section header].  Copy
 
108
     and append this to the file "/etc/mandos/clients.conf" *on the
 
109
     server computer*.
 
110
  
 
111
  4. Configure the client to use any special configuration needed for
 
112
     your local system.  Note: This is not necessary if the server is
 
113
     present on the same wired local network as the client.  If you do
 
114
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
115
     file must be updated, possibly using the following command:
 
116
     
 
117
        # update-initramfs -k all -u
 
118
  
 
119
  5. On the server computer, start the server by running the command
 
120
     For Debian: su -c 'invoke-rc.d mandos start'
 
121
     For Ubuntu: sudo service mandos start
 
122
     
 
123
     At this point, it is possible to verify that the correct password
 
124
     will be received by the client by running the command:
 
125
     
 
126
        # /usr/lib/mandos/plugins.d/mandos-client \
 
127
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
128
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
129
     
 
130
     This command should retrieve the password from the server,
 
131
     decrypt it, and output it to standard output.
 
132
     
 
133
     After this, the client computer should be able to reboot without
 
134
     needing a password entered on the console, as long as it does not
 
135
     take more than five minutes to reboot.
 
136
 
 
137
* Further customizations
 
138
  
 
139
  You may want to tighten or loosen the timeouts in the server
 
140
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
 
141
  If IPsec is not used and SSH is not installed, it is suggested that
 
142
  a more cryptographically secure checker program is used and
 
143
  configured, since, without IPsec, ping packets can be faked.