/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: 2015-08-10 07:34:37 UTC
  • Revision ID: teddy@recompile.se-20150810073437-3m8jgt13nqric6vf
Revert change to D-Bus API.

The D-Bus API signal CheckerCompleted is documented to provide a
wait(2) status value.  Since the server switched to using subprocess
to run checkers, it no longer has access to a wait(2) status value.  A
previous change to work around this made the D-Bus API incompatible.
Revert this change by constructing a fake wait(2) status value; this
keeps the D-Bus API stable.

* DBUS-API (CheckerCompleted): Revert incompatible change.
* mandos (ClientDBus.checker_callback): Construct fake wait(2) status.
* mandos-monitor (MandosClientWidget.checker_completed): Revert to
                                                         using
                                                         original API
                                                         with wait(2)
                                                         condition
                                                         value.

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 6.0 "squeeze" or Ubuntu 10.10 "Maverick Meerkat" (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
    + GnuTLS 2.4          http://www.gnutls.org/
 
42
      Note: GnuTLS 3 will only work with Python-GnuTLS 2
41
43
    + 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
    + Python 2.7          https://www.python.org/
 
45
    + Python-GnuTLS 1.1.5 https://pypi.python.org/pypi/python-gnutls/
44
46
    + 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/
 
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.)
47
51
    
48
52
    Strongly recommended:
49
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
53
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
54
    + ssh-keyscan from OpenSSH http://www.openssh.com/
50
55
    
51
56
    Package names:
52
57
    python-gnutls avahi-daemon python python-avahi python-dbus
53
 
    python-gobject python-urwid
54
 
   
 
58
    python-gobject python-urwid pkg-config fping ssh-client
 
59
    
55
60
*** Mandos Client
56
61
    + 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/
 
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/
62
71
    
63
72
    Package names:
64
73
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
65
 
    libgpgme11-dev
 
74
    libgpgme11-dev pkg-config ssh
66
75
 
67
76
* Installing the Mandos server
68
77
  
98
107
     and append this to the file "/etc/mandos/clients.conf" *on the
99
108
     server computer*.
100
109
  
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:
 
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
 
114
     file must be updated, possibly using the following command:
110
115
     
111
116
        # update-initramfs -k all -u
112
117
  
126
131
     
127
132
     After this, the client computer should be able to reboot without
128
133
     needing a password entered on the console, as long as it does not
129
 
     take more than an hour to reboot.
 
134
     take more than five minutes to reboot.
130
135
 
131
136
* Further customizations
132
137
  
133
138
  You may want to tighten or loosen the timeouts in the server
134
139
  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.
 
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