/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 at recompile
  • Date: 2020-03-21 16:48:19 UTC
  • mto: This revision was merged to the branch mainline in revision 1212.
  • Revision ID: teddy@recompile.se-20200321164819-4x10yx9btb5e9n5z
Tags: version-1.8.10-1
Version 1.8.10-1

* Makefile (version): Change to "1.8.10".
* NEWS (Version 1.8.10): Add new entry.
* debian/changelog (1.8.10-1): - '' -

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
 
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 3           https://www.python.org/
 
45
      Note: Python 2.7 is still supported, if the "mandos",
 
46
      "mandos-ctl", and "mandos-monitor" files are edited to contain
 
47
      "#!/usr/bin/python" instead of python3.
 
48
    + dbus-python 0.82.4 https://dbus.freedesktop.org/doc/dbus-python/
 
49
    + PyGObject 3.8      https://wiki.gnome.org/Projects/PyGObject
 
50
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
51
    + Urwid 1.0.1         http://urwid.org/
 
52
      (Only needed by the "mandos-monitor" tool.)
46
53
    
47
54
    Strongly recommended:
48
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
55
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
49
57
    
50
58
    Package names:
51
 
    python-gnutls avahi-daemon python python-avahi python-dbus
52
 
    python-ctypes
53
 
   
 
59
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
 
60
    pkg-config fping ssh-client
 
61
    
54
62
*** Mandos Client
 
63
    + GNU C Library 2.17 https://gnu.org/software/libc/
 
64
    + GnuTLS 3.3        https://www.gnutls.org/
 
65
      (but not 3.6.0 or later, until 3.6.6 which works)
 
66
    + Avahi 0.6.16      https://www.avahi.org/
 
67
    + GnuPG 1.4.9       https://www.gnupg.org/
 
68
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
69
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
70
    + libnl-route 3     https://www.infradead.org/~tgr/libnl/
 
71
    + GLib 2.40         http://www.gtk.org/
 
72
    
 
73
    One of:
55
74
    + initramfs-tools 0.85i
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/
 
75
                        https://tracker.debian.org/pkg/initramfs-tools
 
76
    + dracut 044+241
 
77
         http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html
 
78
    
 
79
    Strongly recommended:
 
80
    + OpenSSH           http://www.openssh.com/
61
81
    
62
82
    Package names:
63
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
64
 
    libgpgme11-dev
 
83
    initramfs-tools dracut libgnutls-dev gnutls-bin libavahi-core-dev
 
84
    gnupg libgpgme11-dev pkg-config ssh libnl-route-3-dev
 
85
    libglib2.0-dev
65
86
 
66
87
* Installing the Mandos server
67
88
  
69
90
  
70
91
  2. On the computer to run as a Mandos server, run the following
71
92
     command:
72
 
     For Debian: su -c 'make install-server'
 
93
     For Debian: su - -c 'make install-server'
73
94
     For Ubuntu: sudo make install-server
74
95
     
75
96
     (This creates a configuration without any clients configured; you
81
102
  
82
103
  2. On the computer to run as a Mandos client, run the following
83
104
     command:
84
 
     For Debian: su -c 'make install-client'
 
105
     For Debian: su - -c 'make install-client'
85
106
     For Ubuntu: sudo make install-client
86
107
     
87
108
     This will also create an OpenPGP key, which will take some time
88
109
     and entropy, so be patient.
89
110
  
90
111
  3. Run the following command:
91
 
     For Debian: su -c 'mandos-keygen --password'
 
112
     For Debian: su - -c 'mandos-keygen --password'
92
113
     For Ubuntu: sudo mandos-keygen --password
93
114
     
94
115
     When prompted, enter the password/passphrase for the encrypted
97
118
     and append this to the file "/etc/mandos/clients.conf" *on the
98
119
     server computer*.
99
120
  
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
 
121
  4. Configure the client to use any special configuration needed for
 
122
     your local system.  Note: This is not necessary if the server is
 
123
     present on the same wired local network as the client.  If you do
 
124
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
104
125
     file must be updated, possibly using the following command:
105
126
     
106
127
        # update-initramfs -k all -u
107
128
  
108
129
  5. On the server computer, start the server by running the command
109
 
     For Debian: su -c 'invoke-rc.d mandos start'
110
 
     For Ubuntu: sudo invoke-rc.d mandos start
 
130
     For Debian: su - -c 'invoke-rc.d mandos start'
 
131
     For Ubuntu: sudo service mandos start
111
132
     
112
133
     At this point, it is possible to verify that the correct password
113
134
     will be received by the client by running the command:
114
135
     
115
136
        # /usr/lib/mandos/plugins.d/mandos-client \
116
137
                --pubkey=/etc/keys/mandos/pubkey.txt \
117
 
                --seckey=/etc/keys/mandos/seckey.txt; echo
 
138
                --seckey=/etc/keys/mandos/seckey.txt \
 
139
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
 
140
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
118
141
     
119
142
     This command should retrieve the password from the server,
120
143
     decrypt it, and output it to standard output.
121
144
     
122
145
     After this, the client computer should be able to reboot without
123
146
     needing a password entered on the console, as long as it does not
124
 
     take more than an hour to reboot.
 
147
     take more than five minutes to reboot.
125
148
 
126
149
* Further customizations
127
150
  
128
151
  You may want to tighten or loosen the timeouts in the server
129
152
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
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.
 
153
  If IPsec is not used and SSH is not installed, it is suggested that
 
154
  a more cryptographically secure checker program is used and
 
155
  configured, since, without IPsec, ping packets can be faked.
 
156
 
 
157
#+STARTUP: showall