/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: 2019-07-25 22:44:36 UTC
  • Revision ID: teddy@recompile.se-20190725224436-19eyd06r7qmtowo6
Allow line breaks on long lines in plugin-runner manual

* debian/mandos-client.lintian-overrides
  (manpage-has-errors-from-man): Remove.
* plugin-runner.xml (EXAMPLE): Allow line breaks by adding ZERO WIDTH
                               SPACE characters.  Also correct
                               description of example command line.

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".
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
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 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.
 
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.
15
16
   
16
17
** Libraries
17
18
   
27
28
    + DocBook 4.5         http://www.docbook.org/
28
29
      Note: DocBook 5.0 is not compatible.
29
30
    + DocBook XSL stylesheets 1.71.0
30
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
31
32
    
32
33
    Package names:
33
34
    docbook docbook-xsl
37
38
    "man -l mandos.8".
38
39
    
39
40
*** Mandos Server
40
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
41
 
    + Avahi 0.6.16        http://www.avahi.org/
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/
 
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.)
47
50
    
48
51
    Strongly recommended:
49
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
52
    + fping 2.4b2-to-ipv6      http://www.fping.org/
50
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
51
54
    
52
55
    Package names:
53
 
    python-gnutls avahi-daemon python python-avahi python-dbus
54
 
    python-gobject python-urwid ssh-client
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
55
58
    
56
59
*** Mandos Client
 
60
    + GNU C Library 2.17 https://gnu.org/software/libc/
57
61
    + initramfs-tools 0.85i
58
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
59
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
60
 
    + Avahi 0.6.16        http://www.avahi.org/
61
 
    + GnuPG 1.4.9         http://www.gnupg.org/
62
 
    + GPGME 1.1.6         http://www.gnupg.org/related_software/gpgme/
 
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      https://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
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
63
70
    
64
71
    Strongly recommended:
65
 
    + OpenSSH             http://www.openssh.com/
 
72
    + OpenSSH           http://www.openssh.com/
66
73
    
67
74
    Package names:
68
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
69
 
    libgpgme11-dev ssh
 
75
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
 
76
    libgpgme11-dev pkg-config ssh libnl-route-3-dev
70
77
 
71
78
* Installing the Mandos server
72
79
  
102
109
     and append this to the file "/etc/mandos/clients.conf" *on the
103
110
     server computer*.
104
111
  
105
 
  4. Configure the client to use the correct network interface.  The
106
 
     interface to use is automatically chosen at boot, and if this
107
 
     needs to be adjusted, it will be necessary to edit
108
 
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
109
 
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
110
 
     can be edited to add a "--device" parameter for the
111
 
     mandos-client(8) plugin.  Please note: If any of those files are
112
 
     changed, the initrd.img file must be updated, possibly using the
113
 
     following command:
 
112
  4. Configure the client to use any special configuration needed for
 
113
     your local system.  Note: This is not necessary if the server is
 
114
     present on the same wired local network as the client.  If you do
 
115
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
116
     file must be updated, possibly using the following command:
114
117
     
115
118
        # update-initramfs -k all -u
116
119
  
123
126
     
124
127
        # /usr/lib/mandos/plugins.d/mandos-client \
125
128
                --pubkey=/etc/keys/mandos/pubkey.txt \
126
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
129
                --seckey=/etc/keys/mandos/seckey.txt \
 
130
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
 
131
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
127
132
     
128
133
     This command should retrieve the password from the server,
129
134
     decrypt it, and output it to standard output.
130
135
     
131
136
     After this, the client computer should be able to reboot without
132
137
     needing a password entered on the console, as long as it does not
133
 
     take more than an hour to reboot.
 
138
     take more than five minutes to reboot.
134
139
 
135
140
* Further customizations
136
141
  
139
144
  If IPsec is not used and SSH is not installed, it is suggested that
140
145
  a more cryptographically secure checker program is used and
141
146
  configured, since, without IPsec, ping packets can be faked.
 
147
 
 
148
#+STARTUP: showall