/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: 2013-10-13 01:49:18 UTC
  • Revision ID: teddy@recompile.se-20131013014918-08ybiy64qxy4ceza
* initramfs-tools-hook: Bug fix: Make sure the right version of GnuPG
                        is copied into the initramfs image.  Always
                        assume that GPGME is used to avoid searching
                        for it since the path might not be /usr/lib.
                        Thanks to Félix Sipma <felix+debian@gueux.org>
                        for the initial bug report, and also thanks to
                        Dick Middleton <dick@lingbrae.com> for some
                        more debugging.
* initramfs-unpack: New script to help with development and debugging.
                    It is only part of the source tree, it is not
                    installed.

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
9
   This is mostly for the support scripts which make sure that the
10
10
   client is installed and started in the initial RAM disk environment
11
11
   and that the initrd.img file is automatically made unreadable.  The
12
12
   server and client programs themselves *could* be run in other
13
13
   distributions, but they *are* specific to GNU/Linux systems, and
14
 
   are not intended to be portable to other Unixes.
15
 
  
 
14
   are not written with portabillity to other Unixes in mind.
 
15
   
16
16
** Libraries
17
17
   
18
18
   The following libraries and packages are needed.  (It is possible
35
35
    To build just the documentation, run the command "make doc".  Then
36
36
    the manual page "mandos.8", for example, can be read by running
37
37
    "man -l mandos.8".
38
 
   
 
38
    
39
39
*** Mandos Server
40
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
41
    + Avahi 0.6.16        http://www.avahi.org/
42
 
    + Python 2.4          http://www.python.org/
 
42
    + Python 2.6          http://www.python.org/
43
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
44
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
 
45
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
46
47
    
47
48
    Strongly recommended:
48
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
49
50
    
50
51
    Package names:
51
52
    python-gnutls avahi-daemon python python-avahi python-dbus
52
 
    python-ctypes
53
 
   
 
53
    python-gobject python-urwid
 
54
    
54
55
*** Mandos Client
55
56
    + initramfs-tools 0.85i
56
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
97
98
     and append this to the file "/etc/mandos/clients.conf" *on the
98
99
     server computer*.
99
100
  
100
 
  4. On the server computer, start the server by running the command
 
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
101
114
     For Debian: su -c 'invoke-rc.d mandos start'
102
 
     For Ubuntu: sudo 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.
103
126
     
104
127
     After this, the client computer should be able to reboot without
105
128
     needing a password entered on the console, as long as it does not
109
132
  
110
133
  You may want to tighten or loosen the timeouts in the server
111
134
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
112
 
  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
113
136
  secure checker program is used and configured, since without IPsec
114
137
  ping packets can be faked.