/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: 2010-10-03 01:38:05 UTC
  • mfrom: (24.1.170 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20101003013805-ojt18455zatp2ewh
Merge from Björn.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
-*- org -*-
 
2
 
 
3
* Prerequisites
 
4
  
 
5
** Operating System
 
6
   
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
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 intended to be portable to other Unixes.
 
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
 
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
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.5          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
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
46
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
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-ctypes python-gobject
 
54
   
 
55
*** Mandos Client
 
56
    + initramfs-tools 0.85i
 
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
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
 
66
 
 
67
* Installing the Mandos server
 
68
  
 
69
  1. Do "make doc".
 
70
  
 
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.)
 
78
 
 
79
* Installing the Mandos client.
 
80
  
 
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
     default is "eth0", and if this needs to be adjusted, it will be
 
103
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
 
104
     change the line there.  If that file is changed, the initrd.img
 
105
     file must be updated, possibly using the following command:
 
106
     
 
107
        # update-initramfs -k all -u
 
108
  
 
109
  5. On the server computer, start the server by running the command
 
110
     For Debian: su -c 'invoke-rc.d mandos start'
 
111
     For Ubuntu: sudo invoke-rc.d mandos start
 
112
     
 
113
     At this point, it is possible to verify that the correct password
 
114
     will be received by the client by running the command:
 
115
     
 
116
        # /usr/lib/mandos/plugins.d/mandos-client \
 
117
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
118
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
119
     
 
120
     This command should retrieve the password from the server,
 
121
     decrypt it, and output it to standard output.
 
122
     
 
123
     After this, the client computer should be able to reboot without
 
124
     needing a password entered on the console, as long as it does not
 
125
     take more than an hour to reboot.
 
126
 
 
127
* Further customizations
 
128
  
 
129
  You may want to tighten or loosen the timeouts in the server
 
130
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
 
131
  If IPsec is not used, it is suggested that a more cryptographically
 
132
  secure checker program is used and configured, since without IPsec
 
133
  ping packets can be faked.