/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-11-03 19:17:57 UTC
  • Revision ID: teddy@recompile.se-20191103191757-1hdpp0u5fxa8iumo
INSTALL: Add "-" argument to "su" invocations.

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 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.
 
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.
15
16
   
16
17
** Libraries
17
18
   
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
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 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.)
47
53
    
48
54
    Strongly recommended:
49
 
    + fping 2.4b2-to-ipv6 http://www.fping.com/
 
55
    + fping 2.4b2-to-ipv6      http://www.fping.org/
50
56
    + ssh-keyscan from OpenSSH http://www.openssh.com/
51
57
    
52
58
    Package names:
53
 
    python-gnutls avahi-daemon python python-avahi python-dbus
54
 
    python-gobject python-urwid ssh-client
 
59
    avahi-daemon python3 python3-dbus python3-gi python3-urwid
 
60
    pkg-config fping ssh-client
55
61
    
56
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:
57
74
    + initramfs-tools 0.85i
58
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
59
 
    + GnuTLS 2.4          http://www.gnu.org/software/gnutls/
60
 
    + Avahi 0.6.16        http://www.avahi.org/
61
 
    + GnuPG 1.4.9         http://www.gnupg.org/
62
 
    + 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
63
78
    
64
79
    Strongly recommended:
65
 
    + OpenSSH             http://www.openssh.com/
 
80
    + OpenSSH           http://www.openssh.com/
66
81
    
67
82
    Package names:
68
 
    initramfs-tools libgnutls-dev libavahi-core-dev gnupg
69
 
    libgpgme11-dev ssh
 
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
70
86
 
71
87
* Installing the Mandos server
72
88
  
74
90
  
75
91
  2. On the computer to run as a Mandos server, run the following
76
92
     command:
77
 
     For Debian: su -c 'make install-server'
 
93
     For Debian: su - -c 'make install-server'
78
94
     For Ubuntu: sudo make install-server
79
95
     
80
96
     (This creates a configuration without any clients configured; you
86
102
  
87
103
  2. On the computer to run as a Mandos client, run the following
88
104
     command:
89
 
     For Debian: su -c 'make install-client'
 
105
     For Debian: su - -c 'make install-client'
90
106
     For Ubuntu: sudo make install-client
91
107
     
92
108
     This will also create an OpenPGP key, which will take some time
93
109
     and entropy, so be patient.
94
110
  
95
111
  3. Run the following command:
96
 
     For Debian: su -c 'mandos-keygen --password'
 
112
     For Debian: su - -c 'mandos-keygen --password'
97
113
     For Ubuntu: sudo mandos-keygen --password
98
114
     
99
115
     When prompted, enter the password/passphrase for the encrypted
102
118
     and append this to the file "/etc/mandos/clients.conf" *on the
103
119
     server computer*.
104
120
  
105
 
  4. Configure the client to use the correct network interface.  The
106
 
     interface to use is automatically chosen at boot, and if this
107
 
     needs to be adjusted, it will be necessary to edit
108
 
     /etc/initramfs-tools/initramfs.conf to change the DEVICE setting
109
 
     there.  Alternatively, the file /etc/mandos/plugin-runner.conf
110
 
     can be edited to add a "--device" parameter for the
111
 
     mandos-client(8) plugin.  Please note: If any of those files are
112
 
     changed, the initrd.img file must be updated, possibly using the
113
 
     following command:
 
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
 
125
     file must be updated, possibly using the following command:
114
126
     
115
127
        # update-initramfs -k all -u
116
128
  
117
129
  5. On the server computer, start the server by running the command
118
 
     For Debian: su -c 'invoke-rc.d mandos start'
 
130
     For Debian: su - -c 'invoke-rc.d mandos start'
119
131
     For Ubuntu: sudo service mandos start
120
132
     
121
133
     At this point, it is possible to verify that the correct password
123
135
     
124
136
        # /usr/lib/mandos/plugins.d/mandos-client \
125
137
                --pubkey=/etc/keys/mandos/pubkey.txt \
126
 
                --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
127
141
     
128
142
     This command should retrieve the password from the server,
129
143
     decrypt it, and output it to standard output.
130
144
     
131
145
     After this, the client computer should be able to reboot without
132
146
     needing a password entered on the console, as long as it does not
133
 
     take more than an hour to reboot.
 
147
     take more than five minutes to reboot.
134
148
 
135
149
* Further customizations
136
150
  
139
153
  If IPsec is not used and SSH is not installed, it is suggested that
140
154
  a more cryptographically secure checker program is used and
141
155
  configured, since, without IPsec, ping packets can be faked.
 
156
 
 
157
#+STARTUP: showall