/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

* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
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 "2019-02-09">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
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>
45
35
      <holder>Teddy Hogeborn</holder>
46
36
      <holder>Björn Påhlsson</holder>
47
37
    </copyright>
72
62
        ><replaceable>PORT</replaceable></option></arg>
73
63
      </group>
74
64
      <sbr/>
75
 
      <group rep='repeat'>
 
65
      <group>
76
66
        <arg choice="plain"><option>--interface
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>
 
67
        <replaceable>NAME</replaceable></option></arg>
 
68
        <arg choice="plain"><option>-i
 
69
        <replaceable>NAME</replaceable></option></arg>
82
70
      </group>
83
71
      <sbr/>
84
72
      <group>
95
83
        <replaceable>FILE</replaceable></option></arg>
96
84
      </group>
97
85
      <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/>
112
86
      <arg>
113
87
        <option>--priority <replaceable>STRING</replaceable></option>
114
88
      </arg>
118
92
      </arg>
119
93
      <sbr/>
120
94
      <arg>
121
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
122
 
      </arg>
123
 
      <sbr/>
124
 
      <arg>
125
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
126
 
      </arg>
127
 
      <sbr/>
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>
138
95
        <option>--debug</option>
139
96
      </arg>
140
97
    </cmdsynopsis>
164
121
      <command>&COMMANDNAME;</command> is a client program that
165
122
      communicates with <citerefentry><refentrytitle
166
123
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
167
 
      to get a password.  In slightly more detail, this client program
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"/>.
 
124
      to get a password.  It uses IPv6 link-local addresses to get
 
125
      network connectivity, Zeroconf to find servers, and TLS with an
 
126
      OpenPGP key to ensure authenticity and confidentiality.  It
 
127
      keeps running, trying all servers on the network, until it
 
128
      receives a satisfactory reply or a TERM signal is received.
195
129
    </para>
196
130
    <para>
197
131
      This program is not meant to be run directly; it is really meant
244
178
            assumed to separate the address from the port number.
245
179
          </para>
246
180
          <para>
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.
 
181
            This option is normally only useful for testing and
 
182
            debugging.
250
183
          </para>
251
184
        </listitem>
252
185
      </varlistentry>
253
186
      
254
187
      <varlistentry>
255
 
        <term><option>--interface=<replaceable
256
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
257
 
        >NAME</replaceable></arg></option></term>
 
188
        <term><option>--interface=
 
189
        <replaceable>NAME</replaceable></option></term>
258
190
        <term><option>-i
259
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
260
 
        >NAME</replaceable></arg></option></term>
 
191
        <replaceable>NAME</replaceable></option></term>
261
192
        <listitem>
262
193
          <para>
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.
267
 
          </para>
268
 
          <para>
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.
273
 
          </para>
274
 
          <para>
275
 
            Note that since this program will normally run in the
276
 
            initial RAM disk environment, the interface must be an
277
 
            interface which exists at that stage.  Thus, the interface
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"/>.
284
 
          </para>
285
 
          <para>
286
 
            <replaceable>NAME</replaceable> can be the string
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.
 
194
            Network interface that will be brought up and scanned for
 
195
            Mandos servers to connect to.  The default it
 
196
            <quote><literal>eth0</literal></quote>.
 
197
          </para>
 
198
          <para>
 
199
            If the <option>--connect</option> option is used, this
 
200
            specifies the interface to use to connect to the address
 
201
            given.
291
202
          </para>
292
203
        </listitem>
293
204
      </varlistentry>
321
232
      </varlistentry>
322
233
      
323
234
      <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>
352
235
        <term><option>--priority=<replaceable
353
236
        >STRING</replaceable></option></term>
354
237
        <listitem>
363
246
        <listitem>
364
247
          <para>
365
248
            Sets the number of bits to use for the prime number in the
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.
388
 
          </para>
389
 
        </listitem>
390
 
      </varlistentry>
391
 
 
392
 
      <varlistentry>
393
 
        <term><option>--delay=<replaceable
394
 
        >SECONDS</replaceable></option></term>
395
 
        <listitem>
396
 
          <para>
397
 
            After bringing a network interface up, the program waits
398
 
            for the interface to arrive in a <quote>running</quote>
399
 
            state before proceeding.  During this time, the kernel log
400
 
            level will be lowered to reduce clutter on the system
401
 
            console, alleviating any other plugins which might be
402
 
            using the system console.  This option sets the upper
403
 
            limit of seconds to wait.  The default is 2.5 seconds.
404
 
          </para>
405
 
        </listitem>
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>.
 
249
            TLS Diffie-Hellman key exchange.  Default is 1024.
429
250
          </para>
430
251
        </listitem>
431
252
      </varlistentry>
495
316
      <refentrytitle>plugin-runner</refentrytitle>
496
317
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
497
318
      both this program and others in in parallel,
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.
 
319
      <emphasis>one</emphasis> of which will prompt for passwords on
 
320
      the system console.
502
321
    </para>
503
322
  </refsect1>
504
323
  
509
328
      server could be found and the password received from it could be
510
329
      successfully decrypted and output on standard output.  The
511
330
      program will exit with a non-zero exit status only if a critical
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.
 
331
      error occurs.  Otherwise, it will forever connect to new
 
332
      <application>Mandos</application> servers as they appear, trying
 
333
      to get a decryptable password and print it.
515
334
    </para>
516
335
  </refsect1>
517
336
  
518
337
  <refsect1 id="environment">
519
338
    <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>
533
339
    <para>
534
 
      This program does not use any other environment variables, not
535
 
      even the ones provided by <citerefentry><refentrytitle
 
340
      This program does not use any environment variables, not even
 
341
      the ones provided by <citerefentry><refentrytitle
536
342
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
537
343
    </citerefentry>.
538
344
    </para>
539
345
  </refsect1>
540
346
  
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
 
  
710
347
  <refsect1 id="files">
711
348
    <title>FILES</title>
712
349
    <variablelist>
724
361
          </para>
725
362
        </listitem>
726
363
      </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>
752
364
    </variablelist>
753
365
  </refsect1>
754
366
  
755
 
  <refsect1 id="bugs">
756
 
    <title>BUGS</title>
757
 
    <xi:include href="../bugs.xml"/>
758
 
  </refsect1>
 
367
<!--   <refsect1 id="bugs"> -->
 
368
<!--     <title>BUGS</title> -->
 
369
<!--     <para> -->
 
370
<!--     </para> -->
 
371
<!--   </refsect1> -->
759
372
  
760
373
  <refsect1 id="example">
761
374
    <title>EXAMPLE</title>
767
380
    </para>
768
381
    <informalexample>
769
382
      <para>
770
 
        Normal invocation needs no options, if the network interfaces
771
 
        can be automatically determined:
 
383
        Normal invocation needs no options, if the network interface
 
384
        is <quote>eth0</quote>:
772
385
      </para>
773
386
      <para>
774
387
        <userinput>&COMMANDNAME;</userinput>
776
389
    </informalexample>
777
390
    <informalexample>
778
391
      <para>
779
 
        Search for Mandos servers (and connect to them) using one
780
 
        specific interface:
 
392
        Search for Mandos servers (and connect to them) using another
 
393
        interface:
781
394
      </para>
782
395
      <para>
783
396
        <!-- do not wrap this line -->
786
399
    </informalexample>
787
400
    <informalexample>
788
401
      <para>
789
 
        Run in debug mode, and use custom keys:
 
402
        Run in debug mode, and use a custom key:
790
403
      </para>
791
404
      <para>
792
405
 
793
406
<!-- do not wrap this line -->
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>
 
407
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
408
 
796
409
      </para>
797
410
    </informalexample>
798
411
    <informalexample>
799
412
      <para>
800
 
        Run in debug mode, with custom keys, and do not use Zeroconf
801
 
        to locate a server; connect directly to the IPv6 link-local
802
 
        address <quote><systemitem class="ipaddress"
803
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
804
 
        using interface eth2:
 
413
        Run in debug mode, with a custom key, and do not use Zeroconf
 
414
        to locate a server; connect directly to the IPv6 address
 
415
        <quote><systemitem class="ipaddress"
 
416
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
417
        port 4711, using interface eth2:
805
418
      </para>
806
419
      <para>
807
420
 
808
421
<!-- do not wrap this line -->
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>
 
422
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
810
423
 
811
424
      </para>
812
425
    </informalexample>
836
449
    <para>
837
450
      The only remaining weak point is that someone with physical
838
451
      access to the client hard drive might turn off the client
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
 
452
      computer, read the OpenPGP keys directly from the hard drive,
 
453
      and communicate with the server.  To safeguard against this, the
 
454
      server is supposed to notice the client disappearing and stop
 
455
      giving out the encrypted data.  Therefore, it is important to
 
456
      set the timeout and checker interval values tightly on the
 
457
      server.  See <citerefentry><refentrytitle
845
458
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
459
    </para>
847
460
    <para>
848
461
      It will also help if the checker program on the server is
849
462
      configured to request something from the client which can not be
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.
 
463
      spoofed by someone else on the network, unlike unencrypted
 
464
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
853
465
    </para>
854
466
    <para>
855
467
      <emphasis>Note</emphasis>: This makes it completely insecure to
863
475
  <refsect1 id="see_also">
864
476
    <title>SEE ALSO</title>
865
477
    <para>
866
 
      <citerefentry><refentrytitle>intro</refentrytitle>
867
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
868
478
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
869
479
      <manvolnum>8</manvolnum></citerefentry>,
870
480
      <citerefentry><refentrytitle>crypttab</refentrytitle>
901
511
      </varlistentry>
902
512
      <varlistentry>
903
513
        <term>
904
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
514
          <ulink url="http://www.gnu.org/software/gnutls/"
 
515
          >GnuTLS</ulink>
905
516
        </term>
906
517
      <listitem>
907
518
        <para>
908
519
          GnuTLS is the library this client uses to implement TLS for
909
520
          communicating securely with the server, and at the same time
910
 
          send the public key to the server.
 
521
          send the public OpenPGP key to the server.
911
522
        </para>
912
523
      </listitem>
913
524
      </varlistentry>
914
525
      <varlistentry>
915
526
        <term>
916
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
527
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
917
528
                 >GPGME</ulink>
918
529
        </term>
919
530
        <listitem>
947
558
              <para>
948
559
                This client uses IPv6 link-local addresses, which are
949
560
                immediately usable since a link-local addresses is
950
 
                automatically assigned to a network interface when it
 
561
                automatically assigned to a network interfaces when it
951
562
                is brought up.
952
563
              </para>
953
564
            </listitem>
957
568
      </varlistentry>
958
569
      <varlistentry>
959
570
        <term>
960
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
 
          Protocol Version 1.2</citetitle>
 
571
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
572
          Protocol Version 1.1</citetitle>
962
573
        </term>
963
574
      <listitem>
964
575
        <para>
965
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
576
          TLS 1.1 is the protocol implemented by GnuTLS.
966
577
        </para>
967
578
      </listitem>
968
579
      </varlistentry>
979
590
      </varlistentry>
980
591
      <varlistentry>
981
592
        <term>
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
 
593
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
997
594
          Security</citetitle>
998
595
        </term>
999
596
      <listitem>
1000
597
        <para>
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.
 
598
          This is implemented by GnuTLS and used by this program so
 
599
          that OpenPGP keys can be used.
1004
600
        </para>
1005
601
      </listitem>
1006
602
      </varlistentry>