/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:50:20 UTC
  • Revision ID: teddy@recompile.se-20190210035020-nttr1tybgwwixueu
Show debconf note about new TLS key IDs

If mandos-client did not see TLS keys and had to create them, or if
mandos sees GnuTLS version 3.6.6 or later, show an important notice on
package installation about the importance of adding the new key_id
options to clients.conf on the Mandos server.

* debian/control (Package: mandos, Package: mandos-client): Depend on
                                                            debconf.
* debian/mandos-client.lintian-overrides: Override warnings.
* debian/mandos-client.postinst (create_keys): Show notice if new TLS
                                               key files were created.
* debian/mandos-client.templates: New.
* debian/mandos.lintian-overrides: Override warnings.
* debian/mandos.postinst (configure): If GnuTLS 3.6.6 or later is
                                      detected, show an important
                                      notice (once) about the new
                                      key_id option required in
                                      clients.conf.
* debian/mandos.templates: New.

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