/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 intro.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:23:26 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • 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:
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY TIMESTAMP "2011-08-08">
 
4
<!ENTITY TIMESTAMP "2019-02-09">
5
5
<!ENTITY % common SYSTEM "common.ent">
6
6
%common;
7
7
]>
18
18
        <firstname>Björn</firstname>
19
19
        <surname>Påhlsson</surname>
20
20
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
21
          <email>belorn@recompile.se</email>
22
22
        </address>
23
23
      </author>
24
24
      <author>
25
25
        <firstname>Teddy</firstname>
26
26
        <surname>Hogeborn</surname>
27
27
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
28
          <email>teddy@recompile.se</email>
29
29
        </address>
30
30
      </author>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2011</year>
 
34
      <year>2012</year>
 
35
      <year>2013</year>
 
36
      <year>2014</year>
 
37
      <year>2015</year>
 
38
      <year>2016</year>
 
39
      <year>2017</year>
 
40
      <year>2018</year>
34
41
      <holder>Teddy Hogeborn</holder>
35
42
      <holder>Björn Påhlsson</holder>
36
43
    </copyright>
60
67
      The computers run a small client program in the initial RAM disk
61
68
      environment which will communicate with a server over a network.
62
69
      All network communication is encrypted using TLS.  The clients
63
 
      are identified by the server using an OpenPGP key; each client
 
70
      are identified by the server using a TLS public key; each client
64
71
      has one unique to it.  The server sends the clients an encrypted
65
72
      password.  The encrypted password is decrypted by the clients
66
 
      using the same OpenPGP key, and the password is then used to
 
73
      using a separate OpenPGP key, and the password is then used to
67
74
      unlock the root file system, whereupon the computers can
68
75
      continue booting normally.
69
76
    </para>
72
79
  <refsect1 id="introduction">
73
80
    <title>INTRODUCTION</title>
74
81
    <para>
 
82
      <!-- This paragraph is a combination and paraphrase of two
 
83
           quotes from the 1995 movie “The Usual Suspects”. -->
75
84
      You know how it is.  You’ve heard of it happening.  The Man
76
85
      comes and takes away your servers, your friends’ servers, the
77
86
      servers of everybody in the same hosting facility. The servers
191
200
      <para>
192
201
        No.  The server only gives out the passwords to clients which
193
202
        have <emphasis>in the TLS handshake</emphasis> proven that
194
 
        they do indeed hold the OpenPGP private key corresponding to
195
 
        that client.
 
203
        they do indeed hold the private key corresponding to that
 
204
        client.
 
205
      </para>
 
206
    </refsect2>
 
207
    
 
208
    <refsect2 id="sniff">
 
209
      <title>How about sniffing the network traffic and decrypting it
 
210
      later by physically grabbing the Mandos client and using its
 
211
      key?</title>
 
212
      <para>
 
213
        We only use <acronym>PFS</acronym> (Perfect Forward Security)
 
214
        key exchange algorithms in TLS, which protects against this.
196
215
      </para>
197
216
    </refsect2>
198
217
    
214
233
      </para>
215
234
    </refsect2>
216
235
    
217
 
    <refsect2 id="fakeping">
218
 
      <title>Faking ping replies?</title>
 
236
    <refsect2 id="fakecheck">
 
237
      <title>Faking checker results?</title>
219
238
      <para>
220
 
        The default for the server is to use
 
239
        If the Mandos client does not have an SSH server, the default
 
240
        is for the Mandos server to use
221
241
        <quote><literal>fping</literal></quote>, the replies to which
222
242
        could be faked to eliminate the timeout.  But this could
223
243
        easily be changed to any shell command, with any security
224
 
        measures you like.  It could, for instance, be changed to an
225
 
        SSH command with strict keychecking, which could not be faked.
226
 
        Or IPsec could be used for the ping packets, making them
227
 
        secure.
 
244
        measures you like.  If the Mandos client
 
245
        <emphasis>has</emphasis> an SSH server, the default
 
246
        configuration (as generated by
 
247
        <command>mandos-keygen</command> with the
 
248
        <option>--password</option> option) is for the Mandos server
 
249
        to use an <command>ssh-keyscan</command> command with strict
 
250
        keychecking, which can not be faked.  Alternatively, IPsec
 
251
        could be used for the ping packets, making them secure.
228
252
      </para>
229
253
    </refsect2>
230
254
  </refsect1>
359
383
    </para>
360
384
  </refsect1>
361
385
  
 
386
  <refsect1 id="bugs">
 
387
    <title>BUGS</title>
 
388
    <xi:include href="bugs.xml"/>
 
389
  </refsect1>
 
390
  
362
391
  <refsect1 id="see_also">
363
392
    <title>SEE ALSO</title>
364
393
    <para>
392
421
    <variablelist>
393
422
      <varlistentry>
394
423
        <term>
395
 
          <ulink url="http://www.fukt.bsnet.se/mandos">Mandos</ulink>
 
424
          <ulink url="https://www.recompile.se/mandos">Mandos</ulink>
396
425
        </term>
397
426
        <listitem>
398
427
          <para>