/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

  • Committer: Teddy Hogeborn
  • Date: 2019-08-02 22:16:53 UTC
  • mto: This revision was merged to the branch mainline in revision 386.
  • Revision ID: teddy@recompile.se-20190802221653-ic1iko9hbefzwsk7
Fix bug in server Debian package: Fails to start on first install

There has been a very long-standing bug where installation of the
server (the "mandos" Debian package) would fail to start the server
properly right after installation.  It would work on manual (re)start
after installation, or after reboot, and even after package purge and
reinstall, it would then work the first time.  The problem, it turns
out, is when the new "_mandos" user (and corresponding group) is
created, the D-Bus server is not reloaded, and is therefore not aware
of that user, and does not recognize the user and group name in the
/etc/dbus-1/system.d/mandos.conf file.  The Mandos server, when it
tries to start and access the D-Bus, is then not permitted to connect
to its D-Bus bus name, and disables D-Bus use as a fallback measure;
i.e. the server works, but it is not controllable via D-Bus commands
(via mandos-ctl or mandos-monitor).  The next time the D-Bus daemon is
reloaded for any reason, the new user & group would become visible to
the D-Bus daemon and after that, any restart of the Mandos server
would succeed and it would bind to its D-Bus name properly, and
thereby be visible and controllable by mandos-ctl & mandos-monitor.
This was mostly invisible when using sysvinit, but systemd makes the
problem visible since the systemd service file for the Mandos server
is configured to not consider the Mandos server "started" until the
D-Bus name has been bound; this makes the starting of the service wait
for 90 seconds and then fail with a timeout error.

Fixing this should also make the Debian CI autopkgtest tests work.

* debian/mandos.postinst (configure): After creating (or renaming)
                                      user & group, reload D-Bus
                                      daemon (if present).

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
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.
15
 
  
 
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
   
16
17
** Libraries
17
18
   
18
19
   The following libraries and packages are needed.  (It is possible
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
35
36
    To build just the documentation, run the command "make doc".  Then
36
37
    the manual page "mandos.8", for example, can be read by running
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/
 
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
50
54
    
51
55
    Package names:
52
 
    python-gnutls avahi-daemon python python-avahi python-dbus
53
 
    python-gobject python-urwid
54
 
   
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
 
58
    
55
59
*** 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:
56
71
    + initramfs-tools 0.85i
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
                        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/
62
78
    
63
79
    Package names:
64
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
65
 
    libgpgme11-dev
 
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
66
83
 
67
84
* Installing the Mandos server
68
85
  
98
115
     and append this to the file "/etc/mandos/clients.conf" *on the
99
116
     server computer*.
100
117
  
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:
 
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
 
122
     file must be updated, possibly using the following command:
110
123
     
111
124
        # update-initramfs -k all -u
112
125
  
119
132
     
120
133
        # /usr/lib/mandos/plugins.d/mandos-client \
121
134
                --pubkey=/etc/keys/mandos/pubkey.txt \
122
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
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
123
138
     
124
139
     This command should retrieve the password from the server,
125
140
     decrypt it, and output it to standard output.
126
141
     
127
142
     After this, the client computer should be able to reboot without
128
143
     needing a password entered on the console, as long as it does not
129
 
     take more than an hour to reboot.
 
144
     take more than five minutes to reboot.
130
145
 
131
146
* Further customizations
132
147
  
133
148
  You may want to tighten or loosen the timeouts in the server
134
149
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
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.
 
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