/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-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

Show diffs side-by-side

added added

removed removed

Lines of Context:
INSTALL
2
2
 
3
3
* Prerequisites
4
4
  
5
 
  Debian 5.0 "lenny" or Ubuntu 8.04 "Hardy Heron".
6
 
  
7
 
  The following libraries and packages are needed.  (It is possible
8
 
  that it might work with older versions of some of these, but these
9
 
  versions are confirmed to work.  Newer versions are almost certainly
10
 
  OK.)
11
 
  
12
 
** Documentation
13
 
   These are required to build the manual pages for both the server
14
 
   and client:
15
 
   
16
 
   + DocBook 4.5          http://www.docbook.org/
17
 
   + DocBook XSL stylesheets 1.71.0
18
 
                   http://wiki.docbook.org/topic/DocBookXslStylesheets
19
 
  
20
 
** Mandos Server
21
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
22
 
   + Avahi 0.6.16         http://www.avahi.org/
23
 
   + Python 2.4           http://www.python.org/
24
 
   + Python-GnuTLS 1.1.5  http://pypi.python.org/pypi/python-gnutls/
25
 
   + dbus-python 0.82.4   http://dbus.freedesktop.org/doc/dbus-python/
26
 
   + python-ctypes 1.0.0  http://pypi.python.org/pypi/ctypes
27
 
   
28
 
   Strongly recommended:
29
 
   + fping 2.4b2-to-ipv6  http://www.fping.com/
30
 
  
31
 
** Mandos Client
32
 
   + initramfs-tools 0.85i
33
 
                  http://packages.qa.debian.org/i/initramfs-tools.html
34
 
   + GnuTLS 2.4           http://www.gnu.org/software/gnutls/
35
 
   + Avahi 0.6.16         http://www.avahi.org/
36
 
   + GnuPG 1.4.9          http://www.gnupg.org/
37
 
   + GPGME 1.1.6          http://www.gnupg.org/related_software/gpgme/
 
5
** Operating System
 
6
   
 
7
   Debian 8.0 "jessie" or Ubuntu 15.10 "Wily Werewolf" (or later).
 
8
   
 
9
   This is mostly for the support scripts which make sure that the
 
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
   
 
17
** Libraries
 
18
   
 
19
   The following libraries and packages are needed.  (It is possible
 
20
   that it might work with older versions of some of these, but these
 
21
   versions are confirmed to work.  Newer versions are almost
 
22
   certainly OK.)
 
23
   
 
24
*** Documentation
 
25
    These are required to build the manual pages for both the server
 
26
    and client:
 
27
    
 
28
    + DocBook 4.5         http://www.docbook.org/
 
29
      Note: DocBook 5.0 is not compatible.
 
30
    + DocBook XSL stylesheets 1.71.0
 
31
                         http://wiki.docbook.org/DocBookXslStylesheets
 
32
    
 
33
    Package names:
 
34
    docbook docbook-xsl
 
35
    
 
36
    To build just the documentation, run the command "make doc".  Then
 
37
    the manual page "mandos.8", for example, can be read by running
 
38
    "man -l mandos.8".
 
39
    
 
40
*** Mandos Server
 
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        http://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.)
 
50
    
 
51
    Strongly recommended:
 
52
    + fping 2.4b2-to-ipv6      http://www.fping.org/
 
53
    + ssh-keyscan from OpenSSH http://www.openssh.com/
 
54
    
 
55
    Package names:
 
56
    avahi-daemon python python-dbus python-gi python-urwid pkg-config
 
57
    fping ssh-client
 
58
    
 
59
*** Mandos Client
 
60
    + GNU C Library 2.16 https://gnu.org/software/libc/
 
61
    + initramfs-tools 0.85i
 
62
                        https://tracker.debian.org/pkg/initramfs-tools
 
63
    + GnuTLS 3.3        https://www.gnutls.org/
 
64
      (but not 3.6.0 or later, until 3.6.6 which works)
 
65
    + Avahi 0.6.16      http://www.avahi.org/
 
66
    + GnuPG 1.4.9       https://www.gnupg.org/
 
67
    + GPGME 1.1.6       https://www.gnupg.org/related_software/gpgme/
 
68
    + pkg-config https://www.freedesktop.org/wiki/Software/pkg-config/
 
69
    
 
70
    Strongly recommended:
 
71
    + OpenSSH           http://www.openssh.com/
 
72
    
 
73
    Package names:
 
74
    initramfs-tools libgnutls-dev gnutls-bin libavahi-core-dev gnupg
 
75
    libgpgme11-dev pkg-config ssh
38
76
 
39
77
* Installing the Mandos server
40
78
  
41
 
  + Do "make doc".
 
79
  1. Do "make doc".
42
80
  
43
 
  + On the computer to run as a Mandos server, run the following
44
 
    command: "sudo make install-server".
45
 
    
46
 
    (This creates a configuration without any clients configured; we
47
 
    need an actually configured client to do that; see below.)
 
81
  2. On the computer to run as a Mandos server, run the following
 
82
     command:
 
83
     For Debian: su -c 'make install-server'
 
84
     For Ubuntu: sudo make install-server
 
85
     
 
86
     (This creates a configuration without any clients configured; you
 
87
     need an actually configured client to do that; see below.)
48
88
 
49
89
* Installing the Mandos client.
50
90
  
51
 
  + Do "make all doc".
52
 
  
53
 
  + On the computer to run as a Mandos server, run the following
54
 
    command: "sudo make install-client".  This will also create an
55
 
    OpenPGP key, which will take some time and entropy, so either wait
56
 
    patiently or frob your mouse until it's done.
57
 
  
58
 
  + Run "mandos-keygen --password".  When prompted, enter the
59
 
    password/passphrase for the encrypted root file system on this
60
 
    client computer.  It will output a section of text, starting with
61
 
    a [section header].  Copy and paste this into the
62
 
    "/etc/mandos/clients.conf" file *on the server computer*.
63
 
  
64
 
  + On the server computer, start the server by running the command
65
 
    "invoke-rc.d mandos start".
 
91
  1. Do "make all doc".
 
92
  
 
93
  2. On the computer to run as a Mandos client, run the following
 
94
     command:
 
95
     For Debian: su -c 'make install-client'
 
96
     For Ubuntu: sudo make install-client
 
97
     
 
98
     This will also create an OpenPGP key, which will take some time
 
99
     and entropy, so be patient.
 
100
  
 
101
  3. Run the following command:
 
102
     For Debian: su -c 'mandos-keygen --password'
 
103
     For Ubuntu: sudo mandos-keygen --password
 
104
     
 
105
     When prompted, enter the password/passphrase for the encrypted
 
106
     root file system on this client computer.  The command will
 
107
     output a section of text, starting with a [section header].  Copy
 
108
     and append this to the file "/etc/mandos/clients.conf" *on the
 
109
     server computer*.
 
110
  
 
111
  4. Configure the client to use any special configuration needed for
 
112
     your local system.  Note: This is not necessary if the server is
 
113
     present on the same wired local network as the client.  If you do
 
114
     make changes to /etc/mandos/plugin-runner.conf, the initrd.img
 
115
     file must be updated, possibly using the following command:
 
116
     
 
117
        # update-initramfs -k all -u
 
118
  
 
119
  5. On the server computer, start the server by running the command
 
120
     For Debian: su -c 'invoke-rc.d mandos start'
 
121
     For Ubuntu: sudo service mandos start
 
122
     
 
123
     At this point, it is possible to verify that the correct password
 
124
     will be received by the client by running the command:
 
125
     
 
126
        # /usr/lib/mandos/plugins.d/mandos-client \
 
127
                --pubkey=/etc/keys/mandos/pubkey.txt \
 
128
                --seckey=/etc/keys/mandos/seckey.txt \
 
129
                --tls-privkey=/etc/keys/mandos/tls-privkey.pem \
 
130
                --tls-pubkey=/etc/keys/mandos/tls-pubkey.pem; echo
 
131
     
 
132
     This command should retrieve the password from the server,
 
133
     decrypt it, and output it to standard output.
 
134
     
 
135
     After this, the client computer should be able to reboot without
 
136
     needing a password entered on the console, as long as it does not
 
137
     take more than five minutes to reboot.
66
138
 
67
139
* Further customizations
68
140
  
69
141
  You may want to tighten or loosen the timeouts in the server
70
142
  configuration files; see mandos.conf(5) and mandos-clients.conf(5).
71
 
  Is IPsec is not used, it is suggested that a more cryptographically
72
 
  secure checker program is used and configured, since without IPsec
73
 
  ping packets can be faked.
 
143
  If IPsec is not used and SSH is not installed, it is suggested that
 
144
  a more cryptographically secure checker program is used and
 
145
  configured, since, without IPsec, ping packets can be faked.
 
146
 
 
147
#+STARTUP: showall