/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-23 23:17:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090123231742-joje60549e3qagy0
* mandos (peer_certificate): Handle NULL pointer from
                             "gnutls_certificate_get_peers" slightly
                             better.
  (TCP_handler.handle): Added some extra debug output.

  (MandosServer.GetAllClients,
  MandosServer.GetAllClientsWithProperties,
  MandosServer.RemoveClient): Added doc string.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (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 3.3          https://www.gnutls.org/
42
 
      (but not 3.6.0 or later, until 3.6.6, which works)
43
 
    + Avahi 0.6.16        https://www.avahi.org/
44
 
    + Python 2.7          https://www.python.org/
45
 
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
46
 
    + PyGObject 3.7.1     https://wiki.gnome.org/Projects/PyGObject
47
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
48
 
    + Urwid 1.0.1         http://urwid.org/
49
 
      (Only needed by the "mandos-monitor" tool.)
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
41
    + Avahi 0.6.16        http://www.avahi.org/
 
42
    + Python 2.4          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
50
46
    
51
47
    Strongly recommended:
52
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
53
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
54
49
    
55
50
    Package names:
56
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
57
 
    fping ssh-client
58
 
    
 
51
    python-gnutls avahi-daemon python python-avahi python-dbus
 
52
    python-ctypes
 
53
   
59
54
*** Mandos Client
60
 
    + GNU C Library 2.17 https://gnu.org/software/libc/
61
 
    + GnuTLS 3.3        https://www.gnutls.org/
62
 
      (but not 3.6.0 or later, until 3.6.6 which works)
63
 
    + Avahi 0.6.16      https://www.avahi.org/
64
 
    + GnuPG 1.4.9       https://www.gnupg.org/
65
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
66
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
67
 
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
68
 
    + GLib 2.40         http://www.gtk.org/
69
 
    
70
 
    One of:
71
55
    + initramfs-tools 0.85i
72
 
                        https://tracker.debian.org/pkg/initramfs-tools
73
 
    + dracut 044+241
74
 
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
75
 
    
76
 
    Strongly recommended:
77
 
    + 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/
78
61
    
79
62
    Package names:
80
 
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
81
 
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
82
 
    libglib2.0-dev
 
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
64
    libgpgme11-dev
83
65
 
84
66
* Installing the Mandos server
85
67
  
115
97
     and append this to the file "/etc/mandos/clients.conf" *on the
116
98
     server computer*.
117
99
  
118
 
  4. Configure the client to use any special configuration needed for
119
 
     your local system.  Note: This is not necessary if the server is
120
 
     present on the same wired local network as the client.  If you do
121
 
     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
122
104
     file must be updated, possibly using the following command:
123
105
     
124
106
        # update-initramfs -k all -u
125
107
  
126
108
  5. On the server computer, start the server by running the command
127
109
     For Debian: su -c 'invoke-rc.d mandos start'
128
 
     For Ubuntu: sudo service mandos start
 
110
     For Ubuntu: sudo invoke-rc.d mandos start
129
111
     
130
112
     At this point, it is possible to verify that the correct password
131
113
     will be received by the client by running the command:
132
114
     
133
115
        # /usr/lib/mandos/plugins.d/mandos-client \
134
116
                --pubkey=/etc/keys/mandos/pubkey.txt \
135
 
                --seckey=/etc/keys/mandos/seckey.txt \
136
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
137
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
117
                --seckey=/etc/keys/mandos/seckey.txt; echo
138
118
     
139
119
     This command should retrieve the password from the server,
140
120
     decrypt it, and output it to standard output.
141
121
     
142
122
     After this, the client computer should be able to reboot without
143
123
     needing a password entered on the console, as long as it does not
144
 
     take more than five minutes to reboot.
 
124
     take more than an hour to reboot.
145
125
 
146
126
* Further customizations
147
127
  
148
128
  You may want to tighten or loosen the timeouts in the server
149
129
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
150
 
  If IPsec is not used and SSH is not installed, it is suggested that
151
 
  a more cryptographically secure checker program is used and
152
 
  configured, since, without IPsec, ping packets can be faked.
153
 
 
154
 
#+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.