/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 18:18:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908181849-ogydhr0m4axi3dnu
* INSTALL: More text.  Better text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
   
7
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
8
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.
 
9
   This is mostly for scripts to make sure that the client is
 
10
   installed and started in the initial RAM disk environment and that
 
11
   the initrd.img file is automatically made unreadable.  The programs
 
12
   themselves *could* be run in other distributions, but they *are*
 
13
   specific to GNU/Linux systems, and not intended to be portable to
 
14
   other Unix systems.
15
15
  
16
16
** Libraries
17
17
   
25
25
    and client:
26
26
    
27
27
    + DocBook 4.5         http://www.docbook.org/
28
 
      Note: DocBook 5.0 is not compatible.
29
28
    + DocBook XSL stylesheets 1.71.0
30
29
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
31
30
    
32
31
    Package names:
33
32
    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
33
   
39
34
*** Mandos Server
40
35
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
36
    + Avahi 0.6.16        http://www.avahi.org/
42
 
    + Python 2.5          http://www.python.org/
 
37
    + Python 2.4          http://www.python.org/
43
38
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
44
39
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
45
40
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
46
 
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
47
41
    
48
42
    Strongly recommended:
49
43
    + fping 2.4b2-to-ipv6 http://www.fping.com/
50
44
    
51
45
    Package names:
52
 
    python-gnutls avahi-daemon python python-avahi python-dbus
53
 
    python-ctypes python-gobject
 
46
    python-gnutls avahi-daemon python2.5 python-avahi python-dbus
 
47
    python-ctypes
54
48
   
55
49
*** Mandos Client
56
50
    + initramfs-tools 0.85i
69
63
  1. Do "make doc".
70
64
  
71
65
  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
 
66
     command: "sudo make install-server".
 
67
    
 
68
     (This creates a configuration without any clients configured; we
77
69
     need an actually configured client to do that; see below.)
78
70
 
79
71
* Installing the Mandos client.
81
73
  1. Do "make all doc".
82
74
  
83
75
  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.
 
76
     command: "sudo make install-client".  This will also create an
 
77
     OpenPGP key, which will take some time and entropy, so either
 
78
     wait patiently or frob your mouse until it's done.
 
79
  
 
80
  3. Run "mandos-keygen --password".  When prompted, enter the
 
81
     password/passphrase for the encrypted root file system on this
 
82
     client computer.  It will output a section of text, starting with
 
83
     a [section header].  Copy and paste this into the file
 
84
     "/etc/mandos/clients.conf" *on the server computer*.
 
85
  
 
86
  4. On the server computer, start the server by running the command
 
87
     "invoke-rc.d mandos start".
126
88
 
127
89
* Further customizations
128
90
  
129
91
  You may want to tighten or loosen the timeouts in the server
130
92
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
131
 
  If IPsec is not used, it is suggested that a more cryptographically
 
93
  Is IPsec is not used, it is suggested that a more cryptographically
132
94
  secure checker program is used and configured, since without IPsec
133
95
  ping packets can be faked.