/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: 2017-08-20 20:12:54 UTC
  • mfrom: (237.4.92 release)
  • Revision ID: teddy@recompile.se-20170820201254-5tbkyqovrbvo4fqi
Merge from release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
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>
34
44
      <holder>Teddy Hogeborn</holder>
35
45
      <holder>Björn Påhlsson</holder>
36
46
    </copyright>
37
47
    <xi:include href="../legalnotice.xml"/>
38
48
  </refentryinfo>
39
 
 
 
49
  
40
50
  <refmeta>
41
51
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
52
    <manvolnum>8mandos</manvolnum>
48
58
      Client for <application>Mandos</application>
49
59
    </refpurpose>
50
60
  </refnamediv>
51
 
 
 
61
  
52
62
  <refsynopsisdiv>
53
63
    <cmdsynopsis>
54
64
      <command>&COMMANDNAME;</command>
61
71
        ><replaceable>PORT</replaceable></option></arg>
62
72
      </group>
63
73
      <sbr/>
64
 
      <group>
 
74
      <group rep='repeat'>
65
75
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
 
76
        <replaceable>NAME</replaceable><arg rep='repeat'
 
77
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
78
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
79
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
80
        ></option></arg>
69
81
      </group>
70
82
      <sbr/>
71
83
      <group>
91
103
      </arg>
92
104
      <sbr/>
93
105
      <arg>
 
106
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
 
110
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
111
      </arg>
 
112
      <sbr/>
 
113
      <arg>
 
114
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
115
      </arg>
 
116
      <sbr/>
 
117
      <arg>
 
118
        <option>--network-hook-dir
 
119
        <replaceable>DIR</replaceable></option>
 
120
      </arg>
 
121
      <sbr/>
 
122
      <arg>
94
123
        <option>--debug</option>
95
124
      </arg>
96
125
    </cmdsynopsis>
113
142
      </group>
114
143
    </cmdsynopsis>
115
144
  </refsynopsisdiv>
116
 
 
 
145
  
117
146
  <refsect1 id="description">
118
147
    <title>DESCRIPTION</title>
119
148
    <para>
120
149
      <command>&COMMANDNAME;</command> is a client program that
121
150
      communicates with <citerefentry><refentrytitle
122
151
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
 
      to get a password.  It uses IPv6 link-local addresses to get
124
 
      network connectivity, Zeroconf to find servers, and TLS with an
125
 
      OpenPGP key to ensure authenticity and confidentiality.  It
126
 
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
 
152
      to get a password.  In slightly more detail, this client program
 
153
      brings up network interfaces, uses the interfaces’ IPv6
 
154
      link-local addresses to get network connectivity, uses Zeroconf
 
155
      to find servers on the local network, and communicates with
 
156
      servers using TLS with an OpenPGP key to ensure authenticity and
 
157
      confidentiality.  This client program keeps running, trying all
 
158
      servers on the network, until it receives a satisfactory reply
 
159
      or a TERM signal.  After all servers have been tried, all
 
160
      servers are periodically retried.  If no servers are found it
 
161
      will wait indefinitely for new servers to appear.
 
162
    </para>
 
163
    <para>
 
164
      The network interfaces are selected like this: If any interfaces
 
165
      are specified using the <option>--interface</option> option,
 
166
      those interface are used.  Otherwise,
 
167
      <command>&COMMANDNAME;</command> will use all interfaces that
 
168
      are not loopback interfaces, are not point-to-point interfaces,
 
169
      are capable of broadcasting and do not have the NOARP flag (see
 
170
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
171
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
172
      <option>--connect</option> option is used, point-to-point
 
173
      interfaces and non-broadcast interfaces are accepted.)  If any
 
174
      used interfaces are not up and running, they are first taken up
 
175
      (and later taken down again on program exit).
 
176
    </para>
 
177
    <para>
 
178
      Before network interfaces are selected, all <quote>network
 
179
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
128
180
    </para>
129
181
    <para>
130
182
      This program is not meant to be run directly; it is really meant
177
229
            assumed to separate the address from the port number.
178
230
          </para>
179
231
          <para>
180
 
            This option is normally only useful for testing and
181
 
            debugging.
 
232
            Normally, Zeroconf would be used to locate Mandos servers,
 
233
            in which case this option would only be used when testing
 
234
            and debugging.
182
235
          </para>
183
236
        </listitem>
184
237
      </varlistentry>
185
238
      
186
239
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
240
        <term><option>--interface=<replaceable
 
241
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
242
        >NAME</replaceable></arg></option></term>
189
243
        <term><option>-i
190
 
        <replaceable>NAME</replaceable></option></term>
 
244
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
245
        >NAME</replaceable></arg></option></term>
191
246
        <listitem>
192
247
          <para>
193
 
            Network interface that will be brought up and scanned for
194
 
            Mandos servers to connect to.  The default it
195
 
            <quote><literal>eth0</literal></quote>.
196
 
          </para>
197
 
          <para>
198
 
            If the <option>--connect</option> option is used, this
199
 
            specifies the interface to use to connect to the address
200
 
            given.
 
248
            Comma separated list of network interfaces that will be
 
249
            brought up and scanned for Mandos servers to connect to.
 
250
            The default is the empty string, which will automatically
 
251
            use all appropriate interfaces.
 
252
          </para>
 
253
          <para>
 
254
            If the <option>--connect</option> option is used, and
 
255
            exactly one interface name is specified (except
 
256
            <quote><literal>none</literal></quote>), this specifies
 
257
            the interface to use to connect to the address given.
 
258
          </para>
 
259
          <para>
 
260
            Note that since this program will normally run in the
 
261
            initial RAM disk environment, the interface must be an
 
262
            interface which exists at that stage.  Thus, the interface
 
263
            can normally not be a pseudo-interface such as
 
264
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
265
            will not exist until much later in the boot process, and
 
266
            can not be used by this program, unless created by a
 
267
            <quote>network hook</quote> — see <xref
 
268
            linkend="network-hooks"/>.
 
269
          </para>
 
270
          <para>
 
271
            <replaceable>NAME</replaceable> can be the string
 
272
            <quote><literal>none</literal></quote>; this will make
 
273
            <command>&COMMANDNAME;</command> only bring up interfaces
 
274
            specified <emphasis>before</emphasis> this string.  This
 
275
            is not recommended, and only meant for advanced users.
201
276
          </para>
202
277
        </listitem>
203
278
      </varlistentry>
215
290
          </para>
216
291
        </listitem>
217
292
      </varlistentry>
218
 
 
 
293
      
219
294
      <varlistentry>
220
295
        <term><option>--seckey=<replaceable
221
296
        >FILE</replaceable></option></term>
238
313
                      xpointer="priority"/>
239
314
        </listitem>
240
315
      </varlistentry>
241
 
 
 
316
      
242
317
      <varlistentry>
243
318
        <term><option>--dh-bits=<replaceable
244
319
        >BITS</replaceable></option></term>
245
320
        <listitem>
246
321
          <para>
247
322
            Sets the number of bits to use for the prime number in the
248
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
323
            TLS Diffie-Hellman key exchange.  The default value is
 
324
            selected automatically based on the OpenPGP key.  Note
 
325
            that if the <option>--dh-params</option> option is used,
 
326
            the values from that file will be used instead.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--dh-params=<replaceable
 
333
        >FILE</replaceable></option></term>
 
334
        <listitem>
 
335
          <para>
 
336
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
337
            needed by the TLS Diffie-Hellman key exchange from.  If
 
338
            this option is not given, or if the file for some reason
 
339
            could not be used, the parameters will be generated on
 
340
            startup, which will take some time and processing power.
 
341
            Those using servers running under time, power or processor
 
342
            constraints may want to generate such a file in advance
 
343
            and use this option.
 
344
          </para>
 
345
        </listitem>
 
346
      </varlistentry>
 
347
 
 
348
      <varlistentry>
 
349
        <term><option>--delay=<replaceable
 
350
        >SECONDS</replaceable></option></term>
 
351
        <listitem>
 
352
          <para>
 
353
            After bringing a network interface up, the program waits
 
354
            for the interface to arrive in a <quote>running</quote>
 
355
            state before proceeding.  During this time, the kernel log
 
356
            level will be lowered to reduce clutter on the system
 
357
            console, alleviating any other plugins which might be
 
358
            using the system console.  This option sets the upper
 
359
            limit of seconds to wait.  The default is 2.5 seconds.
 
360
          </para>
 
361
        </listitem>
 
362
      </varlistentry>
 
363
 
 
364
      <varlistentry>
 
365
        <term><option>--retry=<replaceable
 
366
        >SECONDS</replaceable></option></term>
 
367
        <listitem>
 
368
          <para>
 
369
            All Mandos servers are tried repeatedly until a password
 
370
            is received.  This value specifies, in seconds, how long
 
371
            between each successive try <emphasis>for the same
 
372
            server</emphasis>.  The default is 10 seconds.
 
373
          </para>
 
374
        </listitem>
 
375
      </varlistentry>
 
376
 
 
377
      <varlistentry>
 
378
        <term><option>--network-hook-dir=<replaceable
 
379
        >DIR</replaceable></option></term>
 
380
        <listitem>
 
381
          <para>
 
382
            Network hook directory.  The default directory is
 
383
            <quote><filename class="directory"
 
384
            >/lib/mandos/network-hooks.d</filename></quote>.
249
385
          </para>
250
386
        </listitem>
251
387
      </varlistentry>
284
420
          </para>
285
421
        </listitem>
286
422
      </varlistentry>
287
 
 
 
423
      
288
424
      <varlistentry>
289
425
        <term><option>--version</option></term>
290
426
        <term><option>-V</option></term>
296
432
      </varlistentry>
297
433
    </variablelist>
298
434
  </refsect1>
299
 
 
 
435
  
300
436
  <refsect1 id="overview">
301
437
    <title>OVERVIEW</title>
302
438
    <xi:include href="../overview.xml"/>
315
451
      <refentrytitle>plugin-runner</refentrytitle>
316
452
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
453
      both this program and others in in parallel,
318
 
      <emphasis>one</emphasis> of which will prompt for passwords on
319
 
      the system console.
 
454
      <emphasis>one</emphasis> of which (<citerefentry>
 
455
      <refentrytitle>password-prompt</refentrytitle>
 
456
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
457
      passwords on the system console.
320
458
    </para>
321
459
  </refsect1>
322
460
  
327
465
      server could be found and the password received from it could be
328
466
      successfully decrypted and output on standard output.  The
329
467
      program will exit with a non-zero exit status only if a critical
330
 
      error occurs.  Otherwise, it will forever connect to new
331
 
      <application>Mandos</application> servers as they appear, trying
332
 
      to get a decryptable password and print it.
 
468
      error occurs.  Otherwise, it will forever connect to any
 
469
      discovered <application>Mandos</application> servers, trying to
 
470
      get a decryptable password and print it.
333
471
    </para>
334
472
  </refsect1>
335
473
  
336
474
  <refsect1 id="environment">
337
475
    <title>ENVIRONMENT</title>
 
476
    <variablelist>
 
477
      <varlistentry>
 
478
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
479
        <listitem>
 
480
          <para>
 
481
            This environment variable will be assumed to contain the
 
482
            directory containing any helper executables.  The use and
 
483
            nature of these helper executables, if any, is
 
484
            purposefully not documented.
 
485
        </para>
 
486
        </listitem>
 
487
      </varlistentry>
 
488
    </variablelist>
338
489
    <para>
339
 
      This program does not use any environment variables, not even
340
 
      the ones provided by <citerefentry><refentrytitle
 
490
      This program does not use any other environment variables, not
 
491
      even the ones provided by <citerefentry><refentrytitle
341
492
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
342
493
    </citerefentry>.
343
494
    </para>
344
495
  </refsect1>
345
496
  
346
 
  <refsect1 id="file">
 
497
  <refsect1 id="network-hooks">
 
498
    <title>NETWORK HOOKS</title>
 
499
    <para>
 
500
      If a network interface like a bridge or tunnel is required to
 
501
      find a Mandos server, this requires the interface to be up and
 
502
      running before <command>&COMMANDNAME;</command> starts looking
 
503
      for Mandos servers.  This can be accomplished by creating a
 
504
      <quote>network hook</quote> program, and placing it in a special
 
505
      directory.
 
506
    </para>
 
507
    <para>
 
508
      Before the network is used (and again before program exit), any
 
509
      runnable programs found in the network hook directory are run
 
510
      with the argument <quote><literal>start</literal></quote> or
 
511
      <quote><literal>stop</literal></quote>.  This should bring up or
 
512
      down, respectively, any network interface which
 
513
      <command>&COMMANDNAME;</command> should use.
 
514
    </para>
 
515
    <refsect2 id="hook-requirements">
 
516
      <title>REQUIREMENTS</title>
 
517
      <para>
 
518
        A network hook must be an executable file, and its name must
 
519
        consist entirely of upper and lower case letters, digits,
 
520
        underscores, periods, and hyphens.
 
521
      </para>
 
522
      <para>
 
523
        A network hook will receive one argument, which can be one of
 
524
        the following:
 
525
      </para>
 
526
      <variablelist>
 
527
        <varlistentry>
 
528
          <term><literal>start</literal></term>
 
529
          <listitem>
 
530
            <para>
 
531
              This should make the network hook create (if necessary)
 
532
              and bring up a network interface.
 
533
            </para>
 
534
          </listitem>
 
535
        </varlistentry>
 
536
        <varlistentry>
 
537
          <term><literal>stop</literal></term>
 
538
          <listitem>
 
539
            <para>
 
540
              This should make the network hook take down a network
 
541
              interface, and delete it if it did not exist previously.
 
542
            </para>
 
543
          </listitem>
 
544
        </varlistentry>
 
545
        <varlistentry>
 
546
          <term><literal>files</literal></term>
 
547
          <listitem>
 
548
            <para>
 
549
              This should make the network hook print, <emphasis>one
 
550
              file per line</emphasis>, all the files needed for it to
 
551
              run.  (These files will be copied into the initial RAM
 
552
              filesystem.)  Typical use is for a network hook which is
 
553
              a shell script to print its needed binaries.
 
554
            </para>
 
555
            <para>
 
556
              It is not necessary to print any non-executable files
 
557
              already in the network hook directory, these will be
 
558
              copied implicitly if they otherwise satisfy the name
 
559
              requirements.
 
560
            </para>
 
561
          </listitem>
 
562
        </varlistentry>
 
563
        <varlistentry>
 
564
          <term><literal>modules</literal></term>
 
565
          <listitem>
 
566
            <para>
 
567
              This should make the network hook print, <emphasis>on
 
568
              separate lines</emphasis>, all the kernel modules needed
 
569
              for it to run.  (These modules will be copied into the
 
570
              initial RAM filesystem.)  For instance, a tunnel
 
571
              interface needs the
 
572
              <quote><literal>tun</literal></quote> module.
 
573
            </para>
 
574
          </listitem>
 
575
        </varlistentry>
 
576
      </variablelist>
 
577
      <para>
 
578
        The network hook will be provided with a number of environment
 
579
        variables:
 
580
      </para>
 
581
      <variablelist>
 
582
        <varlistentry>
 
583
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
584
          <listitem>
 
585
            <para>
 
586
              The network hook directory, specified to
 
587
              <command>&COMMANDNAME;</command> by the
 
588
              <option>--network-hook-dir</option> option.  Note: this
 
589
              should <emphasis>always</emphasis> be used by the
 
590
              network hook to refer to itself or any files in the hook
 
591
              directory it may require.
 
592
            </para>
 
593
          </listitem>
 
594
        </varlistentry>
 
595
        <varlistentry>
 
596
          <term><envar>DEVICE</envar></term>
 
597
          <listitem>
 
598
            <para>
 
599
              The network interfaces, as specified to
 
600
              <command>&COMMANDNAME;</command> by the
 
601
              <option>--interface</option> option, combined to one
 
602
              string and separated by commas.  If this is set, and
 
603
              does not contain the interface a hook will bring up,
 
604
              there is no reason for a hook to continue.
 
605
            </para>
 
606
          </listitem>
 
607
        </varlistentry>
 
608
        <varlistentry>
 
609
          <term><envar>MODE</envar></term>
 
610
          <listitem>
 
611
            <para>
 
612
              This will be the same as the first argument;
 
613
              i.e. <quote><literal>start</literal></quote>,
 
614
              <quote><literal>stop</literal></quote>,
 
615
              <quote><literal>files</literal></quote>, or
 
616
              <quote><literal>modules</literal></quote>.
 
617
            </para>
 
618
          </listitem>
 
619
        </varlistentry>
 
620
        <varlistentry>
 
621
          <term><envar>VERBOSITY</envar></term>
 
622
          <listitem>
 
623
            <para>
 
624
              This will be the <quote><literal>1</literal></quote> if
 
625
              the <option>--debug</option> option is passed to
 
626
              <command>&COMMANDNAME;</command>, otherwise
 
627
              <quote><literal>0</literal></quote>.
 
628
            </para>
 
629
          </listitem>
 
630
        </varlistentry>
 
631
        <varlistentry>
 
632
          <term><envar>DELAY</envar></term>
 
633
          <listitem>
 
634
            <para>
 
635
              This will be the same as the <option>--delay</option>
 
636
              option passed to <command>&COMMANDNAME;</command>.  Is
 
637
              only set if <envar>MODE</envar> is
 
638
              <quote><literal>start</literal></quote> or
 
639
              <quote><literal>stop</literal></quote>.
 
640
            </para>
 
641
          </listitem>
 
642
        </varlistentry>
 
643
        <varlistentry>
 
644
          <term><envar>CONNECT</envar></term>
 
645
          <listitem>
 
646
            <para>
 
647
              This will be the same as the <option>--connect</option>
 
648
              option passed to <command>&COMMANDNAME;</command>.  Is
 
649
              only set if <option>--connect</option> is passed and
 
650
              <envar>MODE</envar> is
 
651
              <quote><literal>start</literal></quote> or
 
652
              <quote><literal>stop</literal></quote>.
 
653
            </para>
 
654
          </listitem>
 
655
        </varlistentry>
 
656
      </variablelist>
 
657
      <para>
 
658
        A hook may not read from standard input, and should be
 
659
        restrictive in printing to standard output or standard error
 
660
        unless <varname>VERBOSITY</varname> is
 
661
        <quote><literal>1</literal></quote>.
 
662
      </para>
 
663
    </refsect2>
 
664
  </refsect1>
 
665
  
 
666
  <refsect1 id="files">
347
667
    <title>FILES</title>
348
668
    <variablelist>
349
669
      <varlistentry>
360
680
          </para>
361
681
        </listitem>
362
682
      </varlistentry>
 
683
      <varlistentry>
 
684
        <term><filename
 
685
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
686
        <listitem>
 
687
          <para>
 
688
            Directory where network hooks are located.  Change this
 
689
            with the <option>--network-hook-dir</option> option.  See
 
690
            <xref linkend="network-hooks"/>.
 
691
          </para>
 
692
        </listitem>
 
693
      </varlistentry>
363
694
    </variablelist>
364
695
  </refsect1>
365
696
  
366
 
<!--   <refsect1 id="bugs"> -->
367
 
<!--     <title>BUGS</title> -->
368
 
<!--     <para> -->
369
 
<!--     </para> -->
370
 
<!--   </refsect1> -->
371
 
 
 
697
  <refsect1 id="bugs">
 
698
    <title>BUGS</title>
 
699
    <xi:include href="../bugs.xml"/>
 
700
  </refsect1>
 
701
  
372
702
  <refsect1 id="example">
373
703
    <title>EXAMPLE</title>
374
704
    <para>
379
709
    </para>
380
710
    <informalexample>
381
711
      <para>
382
 
        Normal invocation needs no options, if the network interface
383
 
        is <quote>eth0</quote>:
 
712
        Normal invocation needs no options, if the network interfaces
 
713
        can be automatically determined:
384
714
      </para>
385
715
      <para>
386
716
        <userinput>&COMMANDNAME;</userinput>
388
718
    </informalexample>
389
719
    <informalexample>
390
720
      <para>
391
 
        Search for Mandos servers (and connect to them) using another
392
 
        interface:
 
721
        Search for Mandos servers (and connect to them) using one
 
722
        specific interface:
393
723
      </para>
394
724
      <para>
395
725
        <!-- do not wrap this line -->
410
740
    <informalexample>
411
741
      <para>
412
742
        Run in debug mode, with a custom key, and do not use Zeroconf
413
 
        to locate a server; connect directly to the IPv6 address
414
 
        <quote><systemitem class="ipaddress"
415
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
 
        port 4711, using interface eth2:
 
743
        to locate a server; connect directly to the IPv6 link-local
 
744
        address <quote><systemitem class="ipaddress"
 
745
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
746
        using interface eth2:
417
747
      </para>
418
748
      <para>
419
749
 
420
750
<!-- do not wrap this line -->
421
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
751
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
422
752
 
423
753
      </para>
424
754
    </informalexample>
425
755
  </refsect1>
426
 
 
 
756
  
427
757
  <refsect1 id="security">
428
758
    <title>SECURITY</title>
429
759
    <para>
449
779
      The only remaining weak point is that someone with physical
450
780
      access to the client hard drive might turn off the client
451
781
      computer, read the OpenPGP keys directly from the hard drive,
452
 
      and communicate with the server.  The defense against this is
453
 
      that the server is supposed to notice the client disappearing
454
 
      and will stop giving out the encrypted data.  Therefore, it is
455
 
      important to set the timeout and checker interval values tightly
456
 
      on the server.  See <citerefentry><refentrytitle
 
782
      and communicate with the server.  To safeguard against this, the
 
783
      server is supposed to notice the client disappearing and stop
 
784
      giving out the encrypted data.  Therefore, it is important to
 
785
      set the timeout and checker interval values tightly on the
 
786
      server.  See <citerefentry><refentrytitle
457
787
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
788
    </para>
459
789
    <para>
460
790
      It will also help if the checker program on the server is
461
791
      configured to request something from the client which can not be
462
 
      spoofed by someone else on the network, unlike unencrypted
463
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
792
      spoofed by someone else on the network, like SSH server key
 
793
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
794
      echo (<quote>ping</quote>) replies.
464
795
    </para>
465
796
    <para>
466
797
      <emphasis>Note</emphasis>: This makes it completely insecure to
470
801
      confidential.
471
802
    </para>
472
803
  </refsect1>
473
 
 
 
804
  
474
805
  <refsect1 id="see_also">
475
806
    <title>SEE ALSO</title>
476
807
    <para>
 
808
      <citerefentry><refentrytitle>intro</refentrytitle>
 
809
      <manvolnum>8mandos</manvolnum></citerefentry>,
477
810
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
478
811
      <manvolnum>8</manvolnum></citerefentry>,
479
812
      <citerefentry><refentrytitle>crypttab</refentrytitle>
510
843
      </varlistentry>
511
844
      <varlistentry>
512
845
        <term>
513
 
          <ulink url="http://www.gnu.org/software/gnutls/"
514
 
          >GnuTLS</ulink>
 
846
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
515
847
        </term>
516
848
      <listitem>
517
849
        <para>
523
855
      </varlistentry>
524
856
      <varlistentry>
525
857
        <term>
526
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
527
859
                 >GPGME</ulink>
528
860
        </term>
529
861
        <listitem>
557
889
              <para>
558
890
                This client uses IPv6 link-local addresses, which are
559
891
                immediately usable since a link-local addresses is
560
 
                automatically assigned to a network interfaces when it
 
892
                automatically assigned to a network interface when it
561
893
                is brought up.
562
894
              </para>
563
895
            </listitem>
567
899
      </varlistentry>
568
900
      <varlistentry>
569
901
        <term>
570
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
571
 
          Protocol Version 1.1</citetitle>
 
902
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.2</citetitle>
572
904
        </term>
573
905
      <listitem>
574
906
        <para>
575
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
907
          TLS 1.2 is the protocol implemented by GnuTLS.
576
908
        </para>
577
909
      </listitem>
578
910
      </varlistentry>
589
921
      </varlistentry>
590
922
      <varlistentry>
591
923
        <term>
592
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
924
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
593
925
          Security</citetitle>
594
926
        </term>
595
927
      <listitem>
601
933
      </varlistentry>
602
934
    </variablelist>
603
935
  </refsect1>
604
 
 
605
936
</refentry>
 
937
 
606
938
<!-- Local Variables: -->
607
939
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
940
<!-- time-stamp-end: "[\"']>" -->