/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 plugins.d/mandos-client.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:
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
4
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
36
45
      <holder>Teddy Hogeborn</holder>
37
46
      <holder>Björn Påhlsson</holder>
38
47
    </copyright>
63
72
        ><replaceable>PORT</replaceable></option></arg>
64
73
      </group>
65
74
      <sbr/>
66
 
      <group>
 
75
      <group rep='repeat'>
67
76
        <arg choice="plain"><option>--interface
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-i
70
 
        <replaceable>NAME</replaceable></option></arg>
 
77
        <replaceable>NAME</replaceable><arg rep='repeat'
 
78
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
79
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
80
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
81
        ></option></arg>
71
82
      </group>
72
83
      <sbr/>
73
84
      <group>
84
95
        <replaceable>FILE</replaceable></option></arg>
85
96
      </group>
86
97
      <sbr/>
 
98
      <group>
 
99
        <arg choice="plain"><option>--tls-privkey
 
100
        <replaceable>FILE</replaceable></option></arg>
 
101
        <arg choice="plain"><option>-t
 
102
        <replaceable>FILE</replaceable></option></arg>
 
103
      </group>
 
104
      <sbr/>
 
105
      <group>
 
106
        <arg choice="plain"><option>--tls-pubkey
 
107
        <replaceable>FILE</replaceable></option></arg>
 
108
        <arg choice="plain"><option>-T
 
109
        <replaceable>FILE</replaceable></option></arg>
 
110
      </group>
 
111
      <sbr/>
87
112
      <arg>
88
113
        <option>--priority <replaceable>STRING</replaceable></option>
89
114
      </arg>
93
118
      </arg>
94
119
      <sbr/>
95
120
      <arg>
 
121
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
122
      </arg>
 
123
      <sbr/>
 
124
      <arg>
96
125
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
126
      </arg>
98
127
      <sbr/>
99
128
      <arg>
 
129
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
130
      </arg>
 
131
      <sbr/>
 
132
      <arg>
 
133
        <option>--network-hook-dir
 
134
        <replaceable>DIR</replaceable></option>
 
135
      </arg>
 
136
      <sbr/>
 
137
      <arg>
100
138
        <option>--debug</option>
101
139
      </arg>
102
140
    </cmdsynopsis>
127
165
      communicates with <citerefentry><refentrytitle
128
166
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
167
      to get a password.  In slightly more detail, this client program
130
 
      brings up a network interface, uses the interface’s IPv6
131
 
      link-local address to get network connectivity, uses Zeroconf to
132
 
      find servers on the local network, and communicates with servers
133
 
      using TLS with an OpenPGP key to ensure authenticity and
134
 
      confidentiality.  This client program keeps running, trying all
135
 
      servers on the network, until it receives a satisfactory reply
136
 
      or a TERM signal is received.  If no servers are found, or after
137
 
      all servers have been tried, it waits indefinitely for new
138
 
      servers to appear.
 
168
      brings up network interfaces, uses the interfaces’ IPv6
 
169
      link-local addresses to get network connectivity, uses Zeroconf
 
170
      to find servers on the local network, and communicates with
 
171
      servers using TLS with a raw public key to ensure authenticity
 
172
      and confidentiality.  This client program keeps running, trying
 
173
      all servers on the network, until it receives a satisfactory
 
174
      reply or a TERM signal.  After all servers have been tried, all
 
175
      servers are periodically retried.  If no servers are found it
 
176
      will wait indefinitely for new servers to appear.
 
177
    </para>
 
178
    <para>
 
179
      The network interfaces are selected like this: If any interfaces
 
180
      are specified using the <option>--interface</option> option,
 
181
      those interface are used.  Otherwise,
 
182
      <command>&COMMANDNAME;</command> will use all interfaces that
 
183
      are not loopback interfaces, are not point-to-point interfaces,
 
184
      are capable of broadcasting and do not have the NOARP flag (see
 
185
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
186
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
187
      <option>--connect</option> option is used, point-to-point
 
188
      interfaces and non-broadcast interfaces are accepted.)  If any
 
189
      used interfaces are not up and running, they are first taken up
 
190
      (and later taken down again on program exit).
 
191
    </para>
 
192
    <para>
 
193
      Before network interfaces are selected, all <quote>network
 
194
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
139
195
    </para>
140
196
    <para>
141
197
      This program is not meant to be run directly; it is really meant
188
244
            assumed to separate the address from the port number.
189
245
          </para>
190
246
          <para>
191
 
            This option is normally only useful for testing and
192
 
            debugging.
 
247
            Normally, Zeroconf would be used to locate Mandos servers,
 
248
            in which case this option would only be used when testing
 
249
            and debugging.
193
250
          </para>
194
251
        </listitem>
195
252
      </varlistentry>
196
253
      
197
254
      <varlistentry>
198
255
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
256
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
257
        >NAME</replaceable></arg></option></term>
200
258
        <term><option>-i
201
 
        <replaceable>NAME</replaceable></option></term>
 
259
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
260
        >NAME</replaceable></arg></option></term>
202
261
        <listitem>
203
262
          <para>
204
 
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is the empty
206
 
            string, which will automatically choose an appropriate
207
 
            interface.
 
263
            Comma separated list of network interfaces that will be
 
264
            brought up and scanned for Mandos servers to connect to.
 
265
            The default is the empty string, which will automatically
 
266
            use all appropriate interfaces.
208
267
          </para>
209
268
          <para>
210
 
            If the <option>--connect</option> option is used, this
211
 
            specifies the interface to use to connect to the address
212
 
            given.
 
269
            If the <option>--connect</option> option is used, and
 
270
            exactly one interface name is specified (except
 
271
            <quote><literal>none</literal></quote>), this specifies
 
272
            the interface to use to connect to the address given.
213
273
          </para>
214
274
          <para>
215
275
            Note that since this program will normally run in the
216
276
            initial RAM disk environment, the interface must be an
217
277
            interface which exists at that stage.  Thus, the interface
218
 
            can not be a pseudo-interface such as <quote>br0</quote>
219
 
            or <quote>tun0</quote>; such interfaces will not exist
220
 
            until much later in the boot process, and can not be used
221
 
            by this program.
 
278
            can normally not be a pseudo-interface such as
 
279
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
280
            will not exist until much later in the boot process, and
 
281
            can not be used by this program, unless created by a
 
282
            <quote>network hook</quote> — see <xref
 
283
            linkend="network-hooks"/>.
222
284
          </para>
223
285
          <para>
224
286
            <replaceable>NAME</replaceable> can be the string
225
 
            <quote><literal>none</literal></quote>; this will not use
226
 
            any specific interface, and will not bring up an interface
227
 
            on startup.  This is not recommended, and only meant for
228
 
            advanced users.
 
287
            <quote><literal>none</literal></quote>; this will make
 
288
            <command>&COMMANDNAME;</command> only bring up interfaces
 
289
            specified <emphasis>before</emphasis> this string.  This
 
290
            is not recommended, and only meant for advanced users.
229
291
          </para>
230
292
        </listitem>
231
293
      </varlistentry>
259
321
      </varlistentry>
260
322
      
261
323
      <varlistentry>
 
324
        <term><option>--tls-pubkey=<replaceable
 
325
        >FILE</replaceable></option></term>
 
326
        <term><option>-T
 
327
        <replaceable>FILE</replaceable></option></term>
 
328
        <listitem>
 
329
          <para>
 
330
            TLS raw public key file name.  The default name is
 
331
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
332
            ></quote>.
 
333
          </para>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
 
 
337
      <varlistentry>
 
338
        <term><option>--tls-privkey=<replaceable
 
339
        >FILE</replaceable></option></term>
 
340
        <term><option>-t
 
341
        <replaceable>FILE</replaceable></option></term>
 
342
        <listitem>
 
343
          <para>
 
344
            TLS secret key file name.  The default name is
 
345
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
346
            ></quote>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
 
 
351
      <varlistentry>
262
352
        <term><option>--priority=<replaceable
263
353
        >STRING</replaceable></option></term>
264
354
        <listitem>
273
363
        <listitem>
274
364
          <para>
275
365
            Sets the number of bits to use for the prime number in the
276
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
366
            TLS Diffie-Hellman key exchange.  The default value is
 
367
            selected automatically based on the GnuTLS security
 
368
            profile set in its priority string.  Note that if the
 
369
            <option>--dh-params</option> option is used, the values
 
370
            from that file will be used instead.
 
371
          </para>
 
372
        </listitem>
 
373
      </varlistentry>
 
374
      
 
375
      <varlistentry>
 
376
        <term><option>--dh-params=<replaceable
 
377
        >FILE</replaceable></option></term>
 
378
        <listitem>
 
379
          <para>
 
380
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
381
            needed by the TLS Diffie-Hellman key exchange from.  If
 
382
            this option is not given, or if the file for some reason
 
383
            could not be used, the parameters will be generated on
 
384
            startup, which will take some time and processing power.
 
385
            Those using servers running under time, power or processor
 
386
            constraints may want to generate such a file in advance
 
387
            and use this option.
277
388
          </para>
278
389
        </listitem>
279
390
      </varlistentry>
283
394
        >SECONDS</replaceable></option></term>
284
395
        <listitem>
285
396
          <para>
286
 
            After bringing the network interface up, the program waits
 
397
            After bringing a network interface up, the program waits
287
398
            for the interface to arrive in a <quote>running</quote>
288
399
            state before proceeding.  During this time, the kernel log
289
400
            level will be lowered to reduce clutter on the system
293
404
          </para>
294
405
        </listitem>
295
406
      </varlistentry>
 
407
 
 
408
      <varlistentry>
 
409
        <term><option>--retry=<replaceable
 
410
        >SECONDS</replaceable></option></term>
 
411
        <listitem>
 
412
          <para>
 
413
            All Mandos servers are tried repeatedly until a password
 
414
            is received.  This value specifies, in seconds, how long
 
415
            between each successive try <emphasis>for the same
 
416
            server</emphasis>.  The default is 10 seconds.
 
417
          </para>
 
418
        </listitem>
 
419
      </varlistentry>
 
420
 
 
421
      <varlistentry>
 
422
        <term><option>--network-hook-dir=<replaceable
 
423
        >DIR</replaceable></option></term>
 
424
        <listitem>
 
425
          <para>
 
426
            Network hook directory.  The default directory is
 
427
            <quote><filename class="directory"
 
428
            >/lib/mandos/network-hooks.d</filename></quote>.
 
429
          </para>
 
430
        </listitem>
 
431
      </varlistentry>
296
432
      
297
433
      <varlistentry>
298
434
        <term><option>--debug</option></term>
359
495
      <refentrytitle>plugin-runner</refentrytitle>
360
496
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
361
497
      both this program and others in in parallel,
362
 
      <emphasis>one</emphasis> of which will prompt for passwords on
363
 
      the system console.
 
498
      <emphasis>one</emphasis> of which (<citerefentry>
 
499
      <refentrytitle>password-prompt</refentrytitle>
 
500
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
501
      passwords on the system console.
364
502
    </para>
365
503
  </refsect1>
366
504
  
371
509
      server could be found and the password received from it could be
372
510
      successfully decrypted and output on standard output.  The
373
511
      program will exit with a non-zero exit status only if a critical
374
 
      error occurs.  Otherwise, it will forever connect to new
375
 
      <application>Mandos</application> servers as they appear, trying
376
 
      to get a decryptable password and print it.
 
512
      error occurs.  Otherwise, it will forever connect to any
 
513
      discovered <application>Mandos</application> servers, trying to
 
514
      get a decryptable password and print it.
377
515
    </para>
378
516
  </refsect1>
379
517
  
380
518
  <refsect1 id="environment">
381
519
    <title>ENVIRONMENT</title>
 
520
    <variablelist>
 
521
      <varlistentry>
 
522
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
523
        <listitem>
 
524
          <para>
 
525
            This environment variable will be assumed to contain the
 
526
            directory containing any helper executables.  The use and
 
527
            nature of these helper executables, if any, is
 
528
            purposefully not documented.
 
529
        </para>
 
530
        </listitem>
 
531
      </varlistentry>
 
532
    </variablelist>
382
533
    <para>
383
 
      This program does not use any environment variables, not even
384
 
      the ones provided by <citerefentry><refentrytitle
 
534
      This program does not use any other environment variables, not
 
535
      even the ones provided by <citerefentry><refentrytitle
385
536
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
386
537
    </citerefentry>.
387
538
    </para>
388
539
  </refsect1>
389
540
  
 
541
  <refsect1 id="network-hooks">
 
542
    <title>NETWORK HOOKS</title>
 
543
    <para>
 
544
      If a network interface like a bridge or tunnel is required to
 
545
      find a Mandos server, this requires the interface to be up and
 
546
      running before <command>&COMMANDNAME;</command> starts looking
 
547
      for Mandos servers.  This can be accomplished by creating a
 
548
      <quote>network hook</quote> program, and placing it in a special
 
549
      directory.
 
550
    </para>
 
551
    <para>
 
552
      Before the network is used (and again before program exit), any
 
553
      runnable programs found in the network hook directory are run
 
554
      with the argument <quote><literal>start</literal></quote> or
 
555
      <quote><literal>stop</literal></quote>.  This should bring up or
 
556
      down, respectively, any network interface which
 
557
      <command>&COMMANDNAME;</command> should use.
 
558
    </para>
 
559
    <refsect2 id="hook-requirements">
 
560
      <title>REQUIREMENTS</title>
 
561
      <para>
 
562
        A network hook must be an executable file, and its name must
 
563
        consist entirely of upper and lower case letters, digits,
 
564
        underscores, periods, and hyphens.
 
565
      </para>
 
566
      <para>
 
567
        A network hook will receive one argument, which can be one of
 
568
        the following:
 
569
      </para>
 
570
      <variablelist>
 
571
        <varlistentry>
 
572
          <term><literal>start</literal></term>
 
573
          <listitem>
 
574
            <para>
 
575
              This should make the network hook create (if necessary)
 
576
              and bring up a network interface.
 
577
            </para>
 
578
          </listitem>
 
579
        </varlistentry>
 
580
        <varlistentry>
 
581
          <term><literal>stop</literal></term>
 
582
          <listitem>
 
583
            <para>
 
584
              This should make the network hook take down a network
 
585
              interface, and delete it if it did not exist previously.
 
586
            </para>
 
587
          </listitem>
 
588
        </varlistentry>
 
589
        <varlistentry>
 
590
          <term><literal>files</literal></term>
 
591
          <listitem>
 
592
            <para>
 
593
              This should make the network hook print, <emphasis>one
 
594
              file per line</emphasis>, all the files needed for it to
 
595
              run.  (These files will be copied into the initial RAM
 
596
              filesystem.)  Typical use is for a network hook which is
 
597
              a shell script to print its needed binaries.
 
598
            </para>
 
599
            <para>
 
600
              It is not necessary to print any non-executable files
 
601
              already in the network hook directory, these will be
 
602
              copied implicitly if they otherwise satisfy the name
 
603
              requirements.
 
604
            </para>
 
605
          </listitem>
 
606
        </varlistentry>
 
607
        <varlistentry>
 
608
          <term><literal>modules</literal></term>
 
609
          <listitem>
 
610
            <para>
 
611
              This should make the network hook print, <emphasis>on
 
612
              separate lines</emphasis>, all the kernel modules needed
 
613
              for it to run.  (These modules will be copied into the
 
614
              initial RAM filesystem.)  For instance, a tunnel
 
615
              interface needs the
 
616
              <quote><literal>tun</literal></quote> module.
 
617
            </para>
 
618
          </listitem>
 
619
        </varlistentry>
 
620
      </variablelist>
 
621
      <para>
 
622
        The network hook will be provided with a number of environment
 
623
        variables:
 
624
      </para>
 
625
      <variablelist>
 
626
        <varlistentry>
 
627
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
628
          <listitem>
 
629
            <para>
 
630
              The network hook directory, specified to
 
631
              <command>&COMMANDNAME;</command> by the
 
632
              <option>--network-hook-dir</option> option.  Note: this
 
633
              should <emphasis>always</emphasis> be used by the
 
634
              network hook to refer to itself or any files in the hook
 
635
              directory it may require.
 
636
            </para>
 
637
          </listitem>
 
638
        </varlistentry>
 
639
        <varlistentry>
 
640
          <term><envar>DEVICE</envar></term>
 
641
          <listitem>
 
642
            <para>
 
643
              The network interfaces, as specified to
 
644
              <command>&COMMANDNAME;</command> by the
 
645
              <option>--interface</option> option, combined to one
 
646
              string and separated by commas.  If this is set, and
 
647
              does not contain the interface a hook will bring up,
 
648
              there is no reason for a hook to continue.
 
649
            </para>
 
650
          </listitem>
 
651
        </varlistentry>
 
652
        <varlistentry>
 
653
          <term><envar>MODE</envar></term>
 
654
          <listitem>
 
655
            <para>
 
656
              This will be the same as the first argument;
 
657
              i.e. <quote><literal>start</literal></quote>,
 
658
              <quote><literal>stop</literal></quote>,
 
659
              <quote><literal>files</literal></quote>, or
 
660
              <quote><literal>modules</literal></quote>.
 
661
            </para>
 
662
          </listitem>
 
663
        </varlistentry>
 
664
        <varlistentry>
 
665
          <term><envar>VERBOSITY</envar></term>
 
666
          <listitem>
 
667
            <para>
 
668
              This will be the <quote><literal>1</literal></quote> if
 
669
              the <option>--debug</option> option is passed to
 
670
              <command>&COMMANDNAME;</command>, otherwise
 
671
              <quote><literal>0</literal></quote>.
 
672
            </para>
 
673
          </listitem>
 
674
        </varlistentry>
 
675
        <varlistentry>
 
676
          <term><envar>DELAY</envar></term>
 
677
          <listitem>
 
678
            <para>
 
679
              This will be the same as the <option>--delay</option>
 
680
              option passed to <command>&COMMANDNAME;</command>.  Is
 
681
              only set if <envar>MODE</envar> is
 
682
              <quote><literal>start</literal></quote> or
 
683
              <quote><literal>stop</literal></quote>.
 
684
            </para>
 
685
          </listitem>
 
686
        </varlistentry>
 
687
        <varlistentry>
 
688
          <term><envar>CONNECT</envar></term>
 
689
          <listitem>
 
690
            <para>
 
691
              This will be the same as the <option>--connect</option>
 
692
              option passed to <command>&COMMANDNAME;</command>.  Is
 
693
              only set if <option>--connect</option> is passed and
 
694
              <envar>MODE</envar> is
 
695
              <quote><literal>start</literal></quote> or
 
696
              <quote><literal>stop</literal></quote>.
 
697
            </para>
 
698
          </listitem>
 
699
        </varlistentry>
 
700
      </variablelist>
 
701
      <para>
 
702
        A hook may not read from standard input, and should be
 
703
        restrictive in printing to standard output or standard error
 
704
        unless <varname>VERBOSITY</varname> is
 
705
        <quote><literal>1</literal></quote>.
 
706
      </para>
 
707
    </refsect2>
 
708
  </refsect1>
 
709
  
390
710
  <refsect1 id="files">
391
711
    <title>FILES</title>
392
712
    <variablelist>
404
724
          </para>
405
725
        </listitem>
406
726
      </varlistentry>
 
727
      <varlistentry>
 
728
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
729
        ></term>
 
730
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
731
        ></term>
 
732
        <listitem>
 
733
          <para>
 
734
            Public and private raw key files, in <quote>PEM</quote>
 
735
            format.  These are the default file names, they can be
 
736
            changed with the <option>--tls-pubkey</option> and
 
737
            <option>--tls-privkey</option> options.
 
738
          </para>
 
739
        </listitem>
 
740
      </varlistentry>
 
741
      <varlistentry>
 
742
        <term><filename
 
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
744
        <listitem>
 
745
          <para>
 
746
            Directory where network hooks are located.  Change this
 
747
            with the <option>--network-hook-dir</option> option.  See
 
748
            <xref linkend="network-hooks"/>.
 
749
          </para>
 
750
        </listitem>
 
751
      </varlistentry>
407
752
    </variablelist>
408
753
  </refsect1>
409
754
  
410
 
<!--   <refsect1 id="bugs"> -->
411
 
<!--     <title>BUGS</title> -->
412
 
<!--     <para> -->
413
 
<!--     </para> -->
414
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
415
759
  
416
760
  <refsect1 id="example">
417
761
    <title>EXAMPLE</title>
423
767
    </para>
424
768
    <informalexample>
425
769
      <para>
426
 
        Normal invocation needs no options, if the network interface
427
 
        is <quote>eth0</quote>:
 
770
        Normal invocation needs no options, if the network interfaces
 
771
        can be automatically determined:
428
772
      </para>
429
773
      <para>
430
774
        <userinput>&COMMANDNAME;</userinput>
432
776
    </informalexample>
433
777
    <informalexample>
434
778
      <para>
435
 
        Search for Mandos servers (and connect to them) using another
436
 
        interface:
 
779
        Search for Mandos servers (and connect to them) using one
 
780
        specific interface:
437
781
      </para>
438
782
      <para>
439
783
        <!-- do not wrap this line -->
442
786
    </informalexample>
443
787
    <informalexample>
444
788
      <para>
445
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
446
790
      </para>
447
791
      <para>
448
792
 
449
793
<!-- do not wrap this line -->
450
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
794
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
451
795
 
452
796
      </para>
453
797
    </informalexample>
454
798
    <informalexample>
455
799
      <para>
456
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
800
        Run in debug mode, with custom keys, and do not use Zeroconf
457
801
        to locate a server; connect directly to the IPv6 link-local
458
802
        address <quote><systemitem class="ipaddress"
459
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
462
806
      <para>
463
807
 
464
808
<!-- do not wrap this line -->
465
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
809
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
466
810
 
467
811
      </para>
468
812
    </informalexample>
492
836
    <para>
493
837
      The only remaining weak point is that someone with physical
494
838
      access to the client hard drive might turn off the client
495
 
      computer, read the OpenPGP keys directly from the hard drive,
496
 
      and communicate with the server.  To safeguard against this, the
497
 
      server is supposed to notice the client disappearing and stop
498
 
      giving out the encrypted data.  Therefore, it is important to
499
 
      set the timeout and checker interval values tightly on the
500
 
      server.  See <citerefentry><refentrytitle
 
839
      computer, read the OpenPGP and TLS keys directly from the hard
 
840
      drive, and communicate with the server.  To safeguard against
 
841
      this, the server is supposed to notice the client disappearing
 
842
      and stop giving out the encrypted data.  Therefore, it is
 
843
      important to set the timeout and checker interval values tightly
 
844
      on the server.  See <citerefentry><refentrytitle
501
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
502
846
    </para>
503
847
    <para>
504
848
      It will also help if the checker program on the server is
505
849
      configured to request something from the client which can not be
506
 
      spoofed by someone else on the network, unlike unencrypted
507
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
850
      spoofed by someone else on the network, like SSH server key
 
851
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
852
      echo (<quote>ping</quote>) replies.
508
853
    </para>
509
854
    <para>
510
855
      <emphasis>Note</emphasis>: This makes it completely insecure to
518
863
  <refsect1 id="see_also">
519
864
    <title>SEE ALSO</title>
520
865
    <para>
 
866
      <citerefentry><refentrytitle>intro</refentrytitle>
 
867
      <manvolnum>8mandos</manvolnum></citerefentry>,
521
868
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
522
869
      <manvolnum>8</manvolnum></citerefentry>,
523
870
      <citerefentry><refentrytitle>crypttab</refentrytitle>
554
901
      </varlistentry>
555
902
      <varlistentry>
556
903
        <term>
557
 
          <ulink url="http://www.gnu.org/software/gnutls/"
558
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
559
905
        </term>
560
906
      <listitem>
561
907
        <para>
562
908
          GnuTLS is the library this client uses to implement TLS for
563
909
          communicating securely with the server, and at the same time
564
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
565
911
        </para>
566
912
      </listitem>
567
913
      </varlistentry>
568
914
      <varlistentry>
569
915
        <term>
570
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
571
917
                 >GPGME</ulink>
572
918
        </term>
573
919
        <listitem>
601
947
              <para>
602
948
                This client uses IPv6 link-local addresses, which are
603
949
                immediately usable since a link-local addresses is
604
 
                automatically assigned to a network interfaces when it
 
950
                automatically assigned to a network interface when it
605
951
                is brought up.
606
952
              </para>
607
953
            </listitem>
611
957
      </varlistentry>
612
958
      <varlistentry>
613
959
        <term>
614
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
615
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
616
962
        </term>
617
963
      <listitem>
618
964
        <para>
619
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
620
966
        </para>
621
967
      </listitem>
622
968
      </varlistentry>
633
979
      </varlistentry>
634
980
      <varlistentry>
635
981
        <term>
636
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
982
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
983
          Layer Security (TLS) and Datagram Transport Layer Security
 
984
          (DTLS)</citetitle>
 
985
        </term>
 
986
      <listitem>
 
987
        <para>
 
988
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
989
          present, used by this program so that raw public keys can be
 
990
          used.
 
991
        </para>
 
992
      </listitem>
 
993
      </varlistentry>
 
994
      <varlistentry>
 
995
        <term>
 
996
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
637
997
          Security</citetitle>
638
998
        </term>
639
999
      <listitem>
640
1000
        <para>
641
 
          This is implemented by GnuTLS and used by this program so
642
 
          that OpenPGP keys can be used.
 
1001
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1002
          if present, used by this program so that OpenPGP keys can be
 
1003
          used.
643
1004
        </para>
644
1005
      </listitem>
645
1006
      </varlistentry>