/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: 2009-01-15 02:52:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090115025202-utyjssfivzumvw7m
* debian/watch: New file.

* debian/mandos-client.README.Debian (Emergency Escape): New section;
                                                         document the
                                                         "mandos=off"
                                                         kernel
                                                         parameter.
* initramfs-tools-script: Exit if kernel has parameter "mandos=off".

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (or later).
 
7
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
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
 
   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
 
   
 
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
  
17
16
** Libraries
18
17
   
19
18
   The following libraries and packages are needed.  (It is possible
28
27
    + DocBook 4.5         http://www.docbook.org/
29
28
      Note: DocBook 5.0 is not compatible.
30
29
    + DocBook XSL stylesheets 1.71.0
31
 
                         http://wiki.docbook.org/DocBookXslStylesheets
 
30
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
32
31
    
33
32
    Package names:
34
33
    docbook docbook-xsl
36
35
    To build just the documentation, run the command "make doc".  Then
37
36
    the manual page "mandos.8", for example, can be read by running
38
37
    "man -l mandos.8".
39
 
    
 
38
   
40
39
*** Mandos Server
41
 
    + GnuTLS 2.4          http://www.gnutls.org/
42
 
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
43
41
    + Avahi 0.6.16        http://www.avahi.org/
44
 
    + Python 2.7          https://www.python.org/
45
 
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
 
42
    + Python 2.4          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
46
44
    + 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
 
    + Urwid 1.0.1         http://urwid.org/
50
 
      (Only needed by the "mandos-monitor" tool.)
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
51
46
    
52
47
    Strongly recommended:
53
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
54
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
55
49
    
56
50
    Package names:
57
51
    python-gnutls avahi-daemon python python-avahi python-dbus
58
 
    python-gobject python-urwid pkg-config fping ssh-client
59
 
    
 
52
    python-ctypes
 
53
   
60
54
*** Mandos Client
61
55
    + initramfs-tools 0.85i
62
 
                        https://tracker.debian.org/pkg/initramfs-tools
63
 
    + GnuTLS 2.4        http://www.gnutls.org/
64
 
    + Avahi 0.6.16      http://www.avahi.org/
65
 
    + GnuPG 1.4.9       https://www.gnupg.org/
66
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
67
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
68
 
    
69
 
    Strongly recommended:
70
 
    + OpenSSH           http://www.openssh.com/
 
56
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
57
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
58
    + Avahi 0.6.16        http://www.avahi.org/
 
59
    + GnuPG 1.4.9         http://www.gnupg.org/
 
60
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
71
61
    
72
62
    Package names:
73
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
74
 
    libgpgme11-dev pkg-config ssh
 
64
    libgpgme11-dev
75
65
 
76
66
* Installing the Mandos server
77
67
  
107
97
     and append this to the file "/etc/mandos/clients.conf" *on the
108
98
     server computer*.
109
99
  
110
 
  4. Configure the client to use any special configuration needed for
111
 
     your local system.  Note: This is not necessary if the server is
112
 
     present on the same wired local network as the client.  If you do
113
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
100
  4. Configure the client to use the correct network interface.  The
 
101
     default is "eth0", and if this needs to be adjusted, it will be
 
102
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
 
103
     change the line there.  If that file is changed, the initrd.img
114
104
     file must be updated, possibly using the following command:
115
105
     
116
106
        # update-initramfs -k all -u
117
107
  
118
108
  5. On the server computer, start the server by running the command
119
109
     For Debian: su -c 'invoke-rc.d mandos start'
120
 
     For Ubuntu: sudo service mandos start
 
110
     For Ubuntu: sudo invoke-rc.d mandos start
121
111
     
122
112
     At this point, it is possible to verify that the correct password
123
113
     will be received by the client by running the command:
131
121
     
132
122
     After this, the client computer should be able to reboot without
133
123
     needing a password entered on the console, as long as it does not
134
 
     take more than five minutes to reboot.
 
124
     take more than an hour to reboot.
135
125
 
136
126
* Further customizations
137
127
  
138
128
  You may want to tighten or loosen the timeouts in the server
139
129
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
140
 
  If IPsec is not used and SSH is not installed, it is suggested that
141
 
  a more cryptographically secure checker program is used and
142
 
  configured, since, without IPsec, ping packets can be faked.
143
 
 
144
 
#+STARTUP: showall
 
130
  If IPsec is not used, it is suggested that a more cryptographically
 
131
  secure checker program is used and configured, since without IPsec
 
132
  ping packets can be faked.