/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

* Makefile (plugins.d/mandos-client): Bug fix: Put $^ before all
                                      libraries.  Remove "$(COMMON)".
                                      Thanks to Angel Abad
                                      <angelabad@ubuntu.com>.
* initramfs-tools-script: Work around change in initramfs-tools,
                          Debian bug #633582.
* plugins.d/mandos-client.c (init_gnutls_global): Bug fix: check for
                errors from gnutls_certificate_allocate_credentials().

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 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
 
   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 written with portabillity to other Unixes in mind.
 
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)
 
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
 
    + 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.)
 
42
    + Python 2.6          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
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
46
    + Urwid 0.9.8.3       http://excess.org/urwid/
50
47
    
51
48
    Strongly recommended:
52
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
53
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
49
    + fping 2.4b2-to-ipv6 http://www.fping.com/
54
50
    
55
51
    Package names:
56
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
57
 
    fping ssh-client
58
 
    
 
52
    python-gnutls avahi-daemon python python-avahi python-dbus
 
53
    python-gobject python-urwid
 
54
   
59
55
*** Mandos Client
60
 
    + GNU C Library 2.16 https://gnu.org/software/libc/
61
56
    + initramfs-tools 0.85i
62
 
                        https://tracker.debian.org/pkg/initramfs-tools
63
 
    + GnuTLS 3.3        https://www.gnutls.org/
64
 
      (but not 3.6.0 or later, until 3.6.6 which works)
65
 
    + Avahi 0.6.16      http://www.avahi.org/
66
 
    + GnuPG 1.4.9       https://www.gnupg.org/
67
 
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
68
 
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
69
 
    
70
 
    Strongly recommended:
71
 
    + OpenSSH           http://www.openssh.com/
 
57
                  http://packages.qa.debian.org/i/initramfs-tools.html
 
58
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
 
59
    + Avahi 0.6.16        http://www.avahi.org/
 
60
    + GnuPG 1.4.9         http://www.gnupg.org/
 
61
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
72
62
    
73
63
    Package names:
74
 
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
75
 
    libgpgme11-dev pkg-config ssh
 
64
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
 
65
    libgpgme11-dev
76
66
 
77
67
* Installing the Mandos server
78
68
  
108
98
     and append this to the file "/etc/mandos/clients.conf" *on the
109
99
     server computer*.
110
100
  
111
 
  4. Configure the client to use any special configuration needed for
112
 
     your local system.  Note: This is not necessary if the server is
113
 
     present on the same wired local network as the client.  If you do
114
 
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
115
 
     file must be updated, possibly using the following 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:
116
110
     
117
111
        # update-initramfs -k all -u
118
112
  
125
119
     
126
120
        # /usr/lib/mandos/plugins.d/mandos-client \
127
121
                --pubkey=/etc/keys/mandos/pubkey.txt \
128
 
                --seckey=/etc/keys/mandos/seckey.txt \
129
 
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
130
 
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
122
                --seckey=/etc/keys/mandos/seckey.txt; echo
131
123
     
132
124
     This command should retrieve the password from the server,
133
125
     decrypt it, and output it to standard output.
134
126
     
135
127
     After this, the client computer should be able to reboot without
136
128
     needing a password entered on the console, as long as it does not
137
 
     take more than five minutes to reboot.
 
129
     take more than an hour to reboot.
138
130
 
139
131
* Further customizations
140
132
  
141
133
  You may want to tighten or loosen the timeouts in the server
142
134
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
143
 
  If IPsec is not used and SSH is not installed, it is suggested that
144
 
  a more cryptographically secure checker program is used and
145
 
  configured, since, without IPsec, ping packets can be faked.
146
 
 
147
 
#+STARTUP: showall
 
135
  If IPsec is not used, it is suggested that a more cryptographically
 
136
  secure checker program is used and configured, since without IPsec
 
137
  ping packets can be faked.