/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

First version of a somewhat complete D-Bus server interface.  Also
change user/group name to "_mandos".

* debian/mandos.postinst: Rename old "mandos" user and group to
                          "_mandos"; create "_mandos" user and group
                          if none exist.
* debian/mandos-client.postinst: - '' -

* initramfs-tools-hook: Try "_mandos" before "mandos" as user and
                        group name.

* mandos (_datetime_to_dbus_struct): New; was previously local.
  (Client.started): Renamed to "last_started".  All users changed.
  (Client.started): New; boolean.
  (Client.dbus_object_path): New.
  (Client.check_command): Renamed to "checker_command".  All users
                          changed.
  (Client.__init__): Set and use "self.dbus_object_path".  Set
                     "self.started".
  (Client.start): Update "self.started".  Emit "self.PropertyChanged"
                  signals for both "started" and "last_started".
  (Client.stop): Update "self.started".  Emit "self.PropertyChanged"
                 signal for "started".
  (Client.checker_callback): Take additional "command" argument.  All
                             callers changed. Emit
                             "self.PropertyChanged" signal.
  (Client.bump_timeout): Emit "self.PropertyChanged" signal for
                         "last_checked_ok".
  (Client.start_checker): Emit "self.PropertyChanged" signal for
                          "checker_running".
  (Client.stop_checker): Emit "self.PropertyChanged" signal for
                         "checker_running".
  (Client.still_valid): Bug fix: use "getattr(self, started, False)"
                        instead of "self.started" in case this client
                        object is so new that the "started" attribute
                        has not been created yet.
  (Client.IntervalChanged, Client.CheckerIsRunning, Client.GetChecker,
  Client.GetCreated, Client.GetFingerprint, Client.GetHost,
  Client.GetInterval, Client.GetName, Client.GetStarted,
  Client.GetTimeout, Client.StateChanged, Client.TimeoutChanged):
  Removed; all callers changed.
  (Client.CheckerCompleted): Add "condition" and "command" arguments.
                             All callers changed.
  (Client.GetAllProperties, Client.PropertyChanged): New.
  (Client.StillValid): Renamed to "IsStillValid".
  (Client.StartChecker): Changed to its own function to avoid the
                         return value from "Client.start_checker()".
  (Client.Stop): Changed to its own function to avoid the return value
                 from "Client.stop()".
  (main): Try "_mandos" before "mandos" as user and group name.
          Removed inner function "remove_from_clients".  New inner
          class "MandosServer".

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          http://www.gnutls.org/
 
40
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
42
41
    + Avahi 0.6.16        http://www.avahi.org/
43
 
    + Python 2.7          https://www.python.org/
 
42
    + Python 2.4          http://www.python.org/
 
43
    + Python-GnuTLS 1.1.5 http://pypi.python.org/pypi/python-gnutls/
44
44
    + dbus-python 0.82.4  http://dbus.freedesktop.org/doc/dbus-python/
45
 
    + PyGObject 2.14.2    https://developer.gnome.org/pygobject/
46
 
    + pkg-config  http://www.freedesktop.org/wiki/Software/pkg-config/
47
 
    + Urwid 1.0.1         http://urwid.org/
48
 
      (Only needed by the "mandos-monitor" tool.)
 
45
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
49
46
    
50
47
    Strongly recommended:
51
 
    + fping 2.4b2-to-ipv6      http://www.fping.org/
52
 
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
48
    + fping 2.4b2-to-ipv6 http://www.fping.com/
53
49
    
54
50
    Package names:
55
 
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
56
 
    fping ssh-client
57
 
    
 
51
    python-gnutls avahi-daemon python python-avahi python-dbus
 
52
    python-ctypes
 
53
   
58
54
*** Mandos Client
59
 
    + GNU C Library 2.16 https://gnu.org/software/libc/
60
55
    + initramfs-tools 0.85i
61
 
                        https://tracker.debian.org/pkg/initramfs-tools
62
 
    + GnuTLS 3.3        http://www.gnutls.org/
63
 
    + Avahi 0.6.16      http://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  http://www.freedesktop.org/wiki/Software/pkg-config/
67
 
    
68
 
    Strongly recommended:
69
 
    + 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/
70
61
    
71
62
    Package names:
72
63
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
73
 
    libgpgme11-dev pkg-config ssh
 
64
    libgpgme11-dev
74
65
 
75
66
* Installing the Mandos server
76
67
  
106
97
     and append this to the file "/etc/mandos/clients.conf" *on the
107
98
     server computer*.
108
99
  
109
 
  4. Configure the client to use any special configuration needed for
110
 
     your local system.  Note: This is not necessary if the server is
111
 
     present on the same wired local network as the client.  If you do
112
 
     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
113
104
     file must be updated, possibly using the following command:
114
105
     
115
106
        # update-initramfs -k all -u
116
107
  
117
108
  5. On the server computer, start the server by running the command
118
109
     For Debian: su -c 'invoke-rc.d mandos start'
119
 
     For Ubuntu: sudo service mandos start
 
110
     For Ubuntu: sudo invoke-rc.d mandos start
120
111
     
121
112
     At this point, it is possible to verify that the correct password
122
113
     will be received by the client by running the command:
130
121
     
131
122
     After this, the client computer should be able to reboot without
132
123
     needing a password entered on the console, as long as it does not
133
 
     take more than five minutes to reboot.
 
124
     take more than an hour to reboot.
134
125
 
135
126
* Further customizations
136
127
  
137
128
  You may want to tighten or loosen the timeouts in the server
138
129
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
139
 
  If IPsec is not used and SSH is not installed, it is suggested that
140
 
  a more cryptographically secure checker program is used and
141
 
  configured, since, without IPsec, ping packets can be faked.
142
 
 
143
 
#+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.