/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-08-10 15:19:47 UTC
  • Revision ID: teddy@recompile.se-20190810151947-wyw7cetrh1pvtw37
Simplification of Python 3 compatibility code

Normally, "class Foo:" in Python 2 creates a "classic" class, but in
Python 3, all classes are "new-style" classes, which you can get in
Python 2 by doing "class Foo(object):", i.e. inheriting from "object".
But, you can also get a new-style classes from "class Foo:" in Python
2 by setting the global "__metaclass__" variable to "type", which
makes the code less cluttered.  Note: it is still necessary to inherit
from "object" in Python 2 to get a new-style class if the class is
otherwise inheriting only from "classic" classes.

* mandos: Set "__metaclass__ = type" globally for Python 2, and remove
          inheriting from "object" in all places possible.
* mandos-ctl: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
  
5
5
** Operating System
6
6
   
7
 
   Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
 
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 intended to be portable to other Unixes.
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.4          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
 
    + python-ctypes 1.0.0 http://pypi.python.org/pypi/ctypes
46
 
    + PyGObject 2.14.2    http://library.gnome.org/devel/pygobject/
 
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-ctypes python-gobject
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
 
     default is "eth0", and if this needs to be adjusted, it will be
103
 
     necessary to edit /etc/mandos/plugin-runner.conf to uncomment and
104
 
     change the line there.  If that file is changed, the initrd.img
 
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
105
122
     file must be updated, possibly using the following command:
106
123
     
107
124
        # update-initramfs -k all -u
108
125
  
109
126
  5. On the server computer, start the server by running the command
110
127
     For Debian: su -c 'invoke-rc.d mandos start'
111
 
     For Ubuntu: sudo invoke-rc.d mandos start
 
128
     For Ubuntu: sudo service mandos start
112
129
     
113
130
     At this point, it is possible to verify that the correct password
114
131
     will be received by the client by running the command:
115
132
     
116
133
        # /usr/lib/mandos/plugins.d/mandos-client \
117
134
                --pubkey=/etc/keys/mandos/pubkey.txt \
118
 
                --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
119
138
     
120
139
     This command should retrieve the password from the server,
121
140
     decrypt it, and output it to standard output.
122
141
     
123
142
     After this, the client computer should be able to reboot without
124
143
     needing a password entered on the console, as long as it does not
125
 
     take more than an hour to reboot.
 
144
     take more than five minutes to reboot.
126
145
 
127
146
* Further customizations
128
147
  
129
148
  You may want to tighten or loosen the timeouts in the server
130
149
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
131
 
  If IPsec is not used, it is suggested that a more cryptographically
132
 
  secure checker program is used and configured, since without IPsec
133
 
  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