/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-01 21:48:12 UTC
  • Revision ID: teddy@recompile.se-20120601214812-g7685v5oeiuhi2qw
* debian/copyright (Copyright): Join the two lines to one line.
* debian/mandos-client.README.Debian: Refer to new location of example
  network hooks.
* debian/mandos-client.docs (network-hooks.d): Removed.
* debian/mandos-client.examples: New; contains "network-hooks.d".
* debian/rules (binary-common): Added "dh_installexamples".
  (binary-common/dh_fixperms): Changed to exclude new location of
  "network-hooks.d".
* init.d-mandos (status): Support new "status" action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
7
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat".
8
8
   
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.
 
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
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.
28
29
    + DocBook XSL stylesheets 1.71.0
29
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
30
31
    
31
32
    Package names:
32
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".
33
38
   
34
39
*** Mandos Server
35
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
36
41
    + Avahi 0.6.16        http://www.avahi.org/
37
 
    + Python 2.4          http://www.python.org/
 
42
    + Python 2.6          http://www.python.org/
38
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
39
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
40
 
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
 
45
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
41
47
    
42
48
    Strongly recommended:
43
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
44
50
    
45
51
    Package names:
46
 
    python-gnutls avahi-daemon python2.5 python-avahi python-dbus
47
 
    python-ctypes
 
52
    python-gnutls avahi-daemon python python-avahi python-dbus
 
53
    python-gobject python-urwid
48
54
   
49
55
*** Mandos Client
50
56
    + initramfs-tools 0.85i
63
69
  1. Do "make doc".
64
70
  
65
71
  2. On the computer to run as a Mandos server, run the following
66
 
     command: "sudo make install-server".
67
 
    
68
 
     (This creates a configuration without any clients configured; we
 
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
69
77
     need an actually configured client to do that; see below.)
70
78
 
71
79
* Installing the Mandos client.
73
81
  1. Do "make all doc".
74
82
  
75
83
  2. On the computer to run as a Mandos client, run the following
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".
 
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.
88
130
 
89
131
* Further customizations
90
132
  
91
133
  You may want to tighten or loosen the timeouts in the server
92
134
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
93
 
  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
94
136
  secure checker program is used and configured, since without IPsec
95
137
  ping packets can be faked.