/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-07-29 16:35:53 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

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