/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

* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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 "2019-07-24">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
36
      <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>
46
37
      <holder>Teddy Hogeborn</holder>
47
38
      <holder>Björn Påhlsson</holder>
48
39
    </copyright>
73
64
        ><replaceable>PORT</replaceable></option></arg>
74
65
      </group>
75
66
      <sbr/>
76
 
      <group rep='repeat'>
 
67
      <group>
77
68
        <arg choice="plain"><option>--interface
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>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
83
72
      </group>
84
73
      <sbr/>
85
74
      <group>
96
85
        <replaceable>FILE</replaceable></option></arg>
97
86
      </group>
98
87
      <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/>
113
88
      <arg>
114
89
        <option>--priority <replaceable>STRING</replaceable></option>
115
90
      </arg>
119
94
      </arg>
120
95
      <sbr/>
121
96
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
98
      </arg>
128
99
      <sbr/>
131
102
      </arg>
132
103
      <sbr/>
133
104
      <arg>
134
 
        <option>--network-hook-dir
135
 
        <replaceable>DIR</replaceable></option>
 
105
        <option>--network-hook-dir<replaceable>DIR</replaceable></option>
136
106
      </arg>
137
107
      <sbr/>
138
108
      <arg>
166
136
      communicates with <citerefentry><refentrytitle
167
137
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
168
138
      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
 
139
      brings up a network interface, uses the interface’s IPv6
 
140
      link-local address to get network connectivity, uses Zeroconf to
 
141
      find servers on the local network, and communicates with servers
 
142
      using TLS with an OpenPGP key to ensure authenticity and
 
143
      confidentiality.  This client program keeps running, trying all
 
144
      servers on the network, until it receives a satisfactory reply
 
145
      or a TERM signal.  After all servers have been tried, all
176
146
      servers are periodically retried.  If no servers are found it
177
147
      will wait indefinitely for new servers to appear.
178
148
    </para>
179
149
    <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"/>.
196
 
    </para>
197
 
    <para>
198
150
      This program is not meant to be run directly; it is really meant
199
151
      to run as a plugin of the <application>Mandos</application>
200
152
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
245
197
            assumed to separate the address from the port number.
246
198
          </para>
247
199
          <para>
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.
 
200
            This option is normally only useful for testing and
 
201
            debugging.
251
202
          </para>
252
203
        </listitem>
253
204
      </varlistentry>
254
205
      
255
206
      <varlistentry>
256
207
        <term><option>--interface=<replaceable
257
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
258
 
        >NAME</replaceable></arg></option></term>
 
208
        >NAME</replaceable></option></term>
259
209
        <term><option>-i
260
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
261
 
        >NAME</replaceable></arg></option></term>
 
210
        <replaceable>NAME</replaceable></option></term>
262
211
        <listitem>
263
212
          <para>
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.
 
213
            Network interface that will be brought up and scanned for
 
214
            Mandos servers to connect to.  The default is the empty
 
215
            string, which will automatically choose an appropriate
 
216
            interface.
268
217
          </para>
269
218
          <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.
 
219
            If the <option>--connect</option> option is used, this
 
220
            specifies the interface to use to connect to the address
 
221
            given.
274
222
          </para>
275
223
          <para>
276
224
            Note that since this program will normally run in the
277
225
            initial RAM disk environment, the interface must be an
278
226
            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"/>.
 
227
            can not be a pseudo-interface such as <quote>br0</quote>
 
228
            or <quote>tun0</quote>; such interfaces will not exist
 
229
            until much later in the boot process, and can not be used
 
230
            by this program.
285
231
          </para>
286
232
          <para>
287
233
            <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.
 
234
            <quote><literal>none</literal></quote>; this will not use
 
235
            any specific interface, and will not bring up an interface
 
236
            on startup.  This is not recommended, and only meant for
 
237
            advanced users.
292
238
          </para>
293
239
        </listitem>
294
240
      </varlistentry>
322
268
      </varlistentry>
323
269
      
324
270
      <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>
353
271
        <term><option>--priority=<replaceable
354
272
        >STRING</replaceable></option></term>
355
273
        <listitem>
364
282
        <listitem>
365
283
          <para>
366
284
            Sets the number of bits to use for the prime number in the
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.
 
285
            TLS Diffie-Hellman key exchange.  Default is 1024.
389
286
          </para>
390
287
        </listitem>
391
288
      </varlistentry>
395
292
        >SECONDS</replaceable></option></term>
396
293
        <listitem>
397
294
          <para>
398
 
            After bringing a network interface up, the program waits
 
295
            After bringing the network interface up, the program waits
399
296
            for the interface to arrive in a <quote>running</quote>
400
297
            state before proceeding.  During this time, the kernel log
401
298
            level will be lowered to reduce clutter on the system
425
322
        <listitem>
426
323
          <para>
427
324
            Network hook directory.  The default directory is
428
 
            <quote><filename class="directory"
429
 
            >/lib/mandos/network-hooks.d</filename></quote>.
 
325
            <quote><directory class="directory"
 
326
            >/lib/mandos/network-hooks.d</directory></quote>.
430
327
          </para>
431
328
        </listitem>
432
329
      </varlistentry>
496
393
      <refentrytitle>plugin-runner</refentrytitle>
497
394
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
498
395
      both this program and others in in parallel,
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.
 
396
      <emphasis>one</emphasis> of which will prompt for passwords on
 
397
      the system console.
503
398
    </para>
504
399
  </refsect1>
505
400
  
518
413
  
519
414
  <refsect1 id="environment">
520
415
    <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>
534
416
    <para>
535
 
      This program does not use any other environment variables, not
536
 
      even the ones provided by <citerefentry><refentrytitle
 
417
      This program does not use any environment variables, not even
 
418
      the ones provided by <citerefentry><refentrytitle
537
419
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
538
420
    </citerefentry>.
539
421
    </para>
540
422
  </refsect1>
541
423
  
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
 
  
711
424
  <refsect1 id="files">
712
425
    <title>FILES</title>
713
426
    <variablelist>
725
438
          </para>
726
439
        </listitem>
727
440
      </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>
753
441
    </variablelist>
754
442
  </refsect1>
755
443
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
444
<!--   <refsect1 id="bugs"> -->
 
445
<!--     <title>BUGS</title> -->
 
446
<!--     <para> -->
 
447
<!--     </para> -->
 
448
<!--   </refsect1> -->
760
449
  
761
450
  <refsect1 id="example">
762
451
    <title>EXAMPLE</title>
768
457
    </para>
769
458
    <informalexample>
770
459
      <para>
771
 
        Normal invocation needs no options, if the network interfaces
772
 
        can be automatically determined:
 
460
        Normal invocation needs no options, if the network interface
 
461
        is <quote>eth0</quote>:
773
462
      </para>
774
463
      <para>
775
464
        <userinput>&COMMANDNAME;</userinput>
777
466
    </informalexample>
778
467
    <informalexample>
779
468
      <para>
780
 
        Search for Mandos servers (and connect to them) using one
781
 
        specific interface:
 
469
        Search for Mandos servers (and connect to them) using another
 
470
        interface:
782
471
      </para>
783
472
      <para>
784
473
        <!-- do not wrap this line -->
787
476
    </informalexample>
788
477
    <informalexample>
789
478
      <para>
790
 
        Run in debug mode, and use custom keys:
 
479
        Run in debug mode, and use a custom key:
791
480
      </para>
792
481
      <para>
793
482
 
794
483
<!-- do not wrap this line -->
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>
 
484
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
485
 
797
486
      </para>
798
487
    </informalexample>
799
488
    <informalexample>
800
489
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
490
        Run in debug mode, with a custom key, and do not use Zeroconf
802
491
        to locate a server; connect directly to the IPv6 link-local
803
492
        address <quote><systemitem class="ipaddress"
804
493
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
496
      <para>
808
497
 
809
498
<!-- do not wrap this line -->
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>
 
499
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
500
 
812
501
      </para>
813
502
    </informalexample>
816
505
  <refsect1 id="security">
817
506
    <title>SECURITY</title>
818
507
    <para>
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.
 
508
      This program is set-uid to root, but will switch back to the
 
509
      original (and presumably non-privileged) user and group after
 
510
      bringing up the network interface.
822
511
    </para>
823
512
    <para>
824
513
      To use this program for its intended purpose (see <xref
837
526
    <para>
838
527
      The only remaining weak point is that someone with physical
839
528
      access to the client hard drive might turn off the client
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
 
529
      computer, read the OpenPGP keys directly from the hard drive,
 
530
      and communicate with the server.  To safeguard against this, the
 
531
      server is supposed to notice the client disappearing and stop
 
532
      giving out the encrypted data.  Therefore, it is important to
 
533
      set the timeout and checker interval values tightly on the
 
534
      server.  See <citerefentry><refentrytitle
846
535
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
536
    </para>
848
537
    <para>
849
538
      It will also help if the checker program on the server is
850
539
      configured to request something from the client which can not be
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.
 
540
      spoofed by someone else on the network, unlike unencrypted
 
541
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
854
542
    </para>
855
543
    <para>
856
544
      <emphasis>Note</emphasis>: This makes it completely insecure to
891
579
      </varlistentry>
892
580
      <varlistentry>
893
581
        <term>
894
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
582
          <ulink url="http://www.avahi.org/">Avahi</ulink>
895
583
        </term>
896
584
      <listitem>
897
585
        <para>
902
590
      </varlistentry>
903
591
      <varlistentry>
904
592
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
593
          <ulink url="http://www.gnu.org/software/gnutls/"
 
594
          >GnuTLS</ulink>
906
595
        </term>
907
596
      <listitem>
908
597
        <para>
909
598
          GnuTLS is the library this client uses to implement TLS for
910
599
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
600
          send the public OpenPGP key to the server.
912
601
        </para>
913
602
      </listitem>
914
603
      </varlistentry>
915
604
      <varlistentry>
916
605
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
606
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
607
                 >GPGME</ulink>
919
608
        </term>
920
609
        <listitem>
948
637
              <para>
949
638
                This client uses IPv6 link-local addresses, which are
950
639
                immediately usable since a link-local addresses is
951
 
                automatically assigned to a network interface when it
 
640
                automatically assigned to a network interfaces when it
952
641
                is brought up.
953
642
              </para>
954
643
            </listitem>
958
647
      </varlistentry>
959
648
      <varlistentry>
960
649
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
650
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
651
          Protocol Version 1.1</citetitle>
963
652
        </term>
964
653
      <listitem>
965
654
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
655
          TLS 1.1 is the protocol implemented by GnuTLS.
967
656
        </para>
968
657
      </listitem>
969
658
      </varlistentry>
980
669
      </varlistentry>
981
670
      <varlistentry>
982
671
        <term>
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
 
672
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
673
          Security</citetitle>
999
674
        </term>
1000
675
      <listitem>
1001
676
        <para>
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.
 
677
          This is implemented by GnuTLS and used by this program so
 
678
          that OpenPGP keys can be used.
1005
679
        </para>
1006
680
      </listitem>
1007
681
      </varlistentry>