/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: 2015-07-06 20:29:34 UTC
  • mfrom: (738.1.6 route-external)
  • Revision ID: teddy@recompile.se-20150706202934-09j06jm2fiw1bn80
Merge change to add local route when network is "unreachable".

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
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2015-07-06">
 
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>2012</year>
 
37
      <year>2013</year>
 
38
      <year>2014</year>
 
39
      <year>2015</year>
34
40
      <holder>Teddy Hogeborn</holder>
35
41
      <holder>Björn Påhlsson</holder>
36
42
    </copyright>
37
43
    <xi:include href="../legalnotice.xml"/>
38
44
  </refentryinfo>
39
 
 
 
45
  
40
46
  <refmeta>
41
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
48
    <manvolnum>8mandos</manvolnum>
45
51
  <refnamediv>
46
52
    <refname><command>&COMMANDNAME;</command></refname>
47
53
    <refpurpose>
48
 
      Client for mandos
 
54
      Client for <application>Mandos</application>
49
55
    </refpurpose>
50
56
  </refnamediv>
51
 
 
 
57
  
52
58
  <refsynopsisdiv>
53
59
    <cmdsynopsis>
54
60
      <command>&COMMANDNAME;</command>
61
67
        ><replaceable>PORT</replaceable></option></arg>
62
68
      </group>
63
69
      <sbr/>
64
 
      <group>
 
70
      <group rep='repeat'>
65
71
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
 
72
        <replaceable>NAME</replaceable><arg rep='repeat'
 
73
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
74
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
75
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
76
        ></option></arg>
69
77
      </group>
70
78
      <sbr/>
71
79
      <group>
91
99
      </arg>
92
100
      <sbr/>
93
101
      <arg>
 
102
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
103
      </arg>
 
104
      <sbr/>
 
105
      <arg>
 
106
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
 
110
        <option>--network-hook-dir
 
111
        <replaceable>DIR</replaceable></option>
 
112
      </arg>
 
113
      <sbr/>
 
114
      <arg>
94
115
        <option>--debug</option>
95
116
      </arg>
96
117
    </cmdsynopsis>
113
134
      </group>
114
135
    </cmdsynopsis>
115
136
  </refsynopsisdiv>
116
 
 
 
137
  
117
138
  <refsect1 id="description">
118
139
    <title>DESCRIPTION</title>
119
140
    <para>
120
141
      <command>&COMMANDNAME;</command> is a client program that
121
142
      communicates with <citerefentry><refentrytitle
122
143
      >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.
 
144
      to get a password.  In slightly more detail, this client program
 
145
      brings up network interfaces, uses the interfaces’ IPv6
 
146
      link-local addresses to get network connectivity, uses Zeroconf
 
147
      to find servers on the local network, and communicates with
 
148
      servers using TLS with an OpenPGP key to ensure authenticity and
 
149
      confidentiality.  This client program keeps running, trying all
 
150
      servers on the network, until it receives a satisfactory reply
 
151
      or a TERM signal.  After all servers have been tried, all
 
152
      servers are periodically retried.  If no servers are found it
 
153
      will wait indefinitely for new servers to appear.
 
154
    </para>
 
155
    <para>
 
156
      The network interfaces are selected like this: If any interfaces
 
157
      are specified using the <option>--interface</option> option,
 
158
      those interface are used.  Otherwise,
 
159
      <command>&COMMANDNAME;</command> will use all interfaces that
 
160
      are not loopback interfaces, are not point-to-point interfaces,
 
161
      are capable of broadcasting and do not have the NOARP flag (see
 
162
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
163
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
164
      <option>--connect</option> option is used, point-to-point
 
165
      interfaces and non-broadcast interfaces are accepted.)  If any
 
166
      used interfaces are not up and running, they are first taken up
 
167
      (and later taken down again on program exit).
 
168
    </para>
 
169
    <para>
 
170
      Before network interfaces are selected, all <quote>network
 
171
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
128
172
    </para>
129
173
    <para>
130
174
      This program is not meant to be run directly; it is really meant
177
221
            assumed to separate the address from the port number.
178
222
          </para>
179
223
          <para>
180
 
            This option is normally only useful for testing and
181
 
            debugging.
 
224
            Normally, Zeroconf would be used to locate Mandos servers,
 
225
            in which case this option would only be used when testing
 
226
            and debugging.
182
227
          </para>
183
228
        </listitem>
184
229
      </varlistentry>
185
230
      
186
231
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
232
        <term><option>--interface=<replaceable
 
233
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
234
        >NAME</replaceable></arg></option></term>
189
235
        <term><option>-i
190
 
        <replaceable>NAME</replaceable></option></term>
 
236
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
237
        >NAME</replaceable></arg></option></term>
191
238
        <listitem>
192
239
          <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.
 
240
            Comma separated list of network interfaces that will be
 
241
            brought up and scanned for Mandos servers to connect to.
 
242
            The default is the empty string, which will automatically
 
243
            use all appropriate interfaces.
 
244
          </para>
 
245
          <para>
 
246
            If the <option>--connect</option> option is used, and
 
247
            exactly one interface name is specified (except
 
248
            <quote><literal>none</literal></quote>), this specifies
 
249
            the interface to use to connect to the address given.
 
250
          </para>
 
251
          <para>
 
252
            Note that since this program will normally run in the
 
253
            initial RAM disk environment, the interface must be an
 
254
            interface which exists at that stage.  Thus, the interface
 
255
            can normally not be a pseudo-interface such as
 
256
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
257
            will not exist until much later in the boot process, and
 
258
            can not be used by this program, unless created by a
 
259
            <quote>network hook</quote> — see <xref
 
260
            linkend="network-hooks"/>.
 
261
          </para>
 
262
          <para>
 
263
            <replaceable>NAME</replaceable> can be the string
 
264
            <quote><literal>none</literal></quote>; this will make
 
265
            <command>&COMMANDNAME;</command> only bring up interfaces
 
266
            specified <emphasis>before</emphasis> this string.  This
 
267
            is not recommended, and only meant for advanced users.
201
268
          </para>
202
269
        </listitem>
203
270
      </varlistentry>
215
282
          </para>
216
283
        </listitem>
217
284
      </varlistentry>
218
 
 
 
285
      
219
286
      <varlistentry>
220
287
        <term><option>--seckey=<replaceable
221
288
        >FILE</replaceable></option></term>
238
305
                      xpointer="priority"/>
239
306
        </listitem>
240
307
      </varlistentry>
241
 
 
 
308
      
242
309
      <varlistentry>
243
310
        <term><option>--dh-bits=<replaceable
244
311
        >BITS</replaceable></option></term>
245
312
        <listitem>
246
313
          <para>
247
314
            Sets the number of bits to use for the prime number in the
248
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
315
            TLS Diffie-Hellman key exchange.  The default value is
 
316
            selected automatically based on the OpenPGP key.
 
317
          </para>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
 
 
321
      <varlistentry>
 
322
        <term><option>--delay=<replaceable
 
323
        >SECONDS</replaceable></option></term>
 
324
        <listitem>
 
325
          <para>
 
326
            After bringing a network interface up, the program waits
 
327
            for the interface to arrive in a <quote>running</quote>
 
328
            state before proceeding.  During this time, the kernel log
 
329
            level will be lowered to reduce clutter on the system
 
330
            console, alleviating any other plugins which might be
 
331
            using the system console.  This option sets the upper
 
332
            limit of seconds to wait.  The default is 2.5 seconds.
 
333
          </para>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
 
 
337
      <varlistentry>
 
338
        <term><option>--retry=<replaceable
 
339
        >SECONDS</replaceable></option></term>
 
340
        <listitem>
 
341
          <para>
 
342
            All Mandos servers are tried repeatedly until a password
 
343
            is received.  This value specifies, in seconds, how long
 
344
            between each successive try <emphasis>for the same
 
345
            server</emphasis>.  The default is 10 seconds.
 
346
          </para>
 
347
        </listitem>
 
348
      </varlistentry>
 
349
 
 
350
      <varlistentry>
 
351
        <term><option>--network-hook-dir=<replaceable
 
352
        >DIR</replaceable></option></term>
 
353
        <listitem>
 
354
          <para>
 
355
            Network hook directory.  The default directory is
 
356
            <quote><filename class="directory"
 
357
            >/lib/mandos/network-hooks.d</filename></quote>.
249
358
          </para>
250
359
        </listitem>
251
360
      </varlistentry>
284
393
          </para>
285
394
        </listitem>
286
395
      </varlistentry>
287
 
 
 
396
      
288
397
      <varlistentry>
289
398
        <term><option>--version</option></term>
290
399
        <term><option>-V</option></term>
296
405
      </varlistentry>
297
406
    </variablelist>
298
407
  </refsect1>
299
 
 
 
408
  
300
409
  <refsect1 id="overview">
301
410
    <title>OVERVIEW</title>
302
411
    <xi:include href="../overview.xml"/>
311
420
      <filename>/etc/crypttab</filename>, but it would then be
312
421
      impossible to enter a password for the encrypted root disk at
313
422
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
 
423
      at all.  This is why a separate plugin runner (<citerefentry>
 
424
      <refentrytitle>plugin-runner</refentrytitle>
 
425
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
426
      both this program and others in in parallel,
 
427
      <emphasis>one</emphasis> of which (<citerefentry>
315
428
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallel to this one by the plugin runner.
 
429
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
430
      passwords on the system console.
318
431
    </para>
319
432
  </refsect1>
320
433
  
325
438
      server could be found and the password received from it could be
326
439
      successfully decrypted and output on standard output.  The
327
440
      program will exit with a non-zero exit status only if a critical
328
 
      error occurs.  Otherwise, it will forever connect to new
329
 
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
441
      error occurs.  Otherwise, it will forever connect to any
 
442
      discovered <application>Mandos</application> servers, trying to
 
443
      get a decryptable password and print it.
331
444
    </para>
332
445
  </refsect1>
333
446
  
334
447
  <refsect1 id="environment">
335
448
    <title>ENVIRONMENT</title>
 
449
    <variablelist>
 
450
      <varlistentry>
 
451
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
452
        <listitem>
 
453
          <para>
 
454
            This environment variable will be assumed to contain the
 
455
            directory containing any helper executables.  The use and
 
456
            nature of these helper executables, if any, is
 
457
            purposefully not documented.
 
458
        </para>
 
459
        </listitem>
 
460
      </varlistentry>
 
461
    </variablelist>
336
462
    <para>
337
 
      This program does not use any environment variables, not even
338
 
      the ones provided by <citerefentry><refentrytitle
 
463
      This program does not use any other environment variables, not
 
464
      even the ones provided by <citerefentry><refentrytitle
339
465
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
340
466
    </citerefentry>.
341
467
    </para>
342
468
  </refsect1>
343
469
  
344
 
  <refsect1 id="file">
 
470
  <refsect1 id="network-hooks">
 
471
    <title>NETWORK HOOKS</title>
 
472
    <para>
 
473
      If a network interface like a bridge or tunnel is required to
 
474
      find a Mandos server, this requires the interface to be up and
 
475
      running before <command>&COMMANDNAME;</command> starts looking
 
476
      for Mandos servers.  This can be accomplished by creating a
 
477
      <quote>network hook</quote> program, and placing it in a special
 
478
      directory.
 
479
    </para>
 
480
    <para>
 
481
      Before the network is used (and again before program exit), any
 
482
      runnable programs found in the network hook directory are run
 
483
      with the argument <quote><literal>start</literal></quote> or
 
484
      <quote><literal>stop</literal></quote>.  This should bring up or
 
485
      down, respectively, any network interface which
 
486
      <command>&COMMANDNAME;</command> should use.
 
487
    </para>
 
488
    <refsect2 id="hook-requirements">
 
489
      <title>REQUIREMENTS</title>
 
490
      <para>
 
491
        A network hook must be an executable file, and its name must
 
492
        consist entirely of upper and lower case letters, digits,
 
493
        underscores, periods, and hyphens.
 
494
      </para>
 
495
      <para>
 
496
        A network hook will receive one argument, which can be one of
 
497
        the following:
 
498
      </para>
 
499
      <variablelist>
 
500
        <varlistentry>
 
501
          <term><literal>start</literal></term>
 
502
          <listitem>
 
503
            <para>
 
504
              This should make the network hook create (if necessary)
 
505
              and bring up a network interface.
 
506
            </para>
 
507
          </listitem>
 
508
        </varlistentry>
 
509
        <varlistentry>
 
510
          <term><literal>stop</literal></term>
 
511
          <listitem>
 
512
            <para>
 
513
              This should make the network hook take down a network
 
514
              interface, and delete it if it did not exist previously.
 
515
            </para>
 
516
          </listitem>
 
517
        </varlistentry>
 
518
        <varlistentry>
 
519
          <term><literal>files</literal></term>
 
520
          <listitem>
 
521
            <para>
 
522
              This should make the network hook print, <emphasis>one
 
523
              file per line</emphasis>, all the files needed for it to
 
524
              run.  (These files will be copied into the initial RAM
 
525
              filesystem.)  Typical use is for a network hook which is
 
526
              a shell script to print its needed binaries.
 
527
            </para>
 
528
            <para>
 
529
              It is not necessary to print any non-executable files
 
530
              already in the network hook directory, these will be
 
531
              copied implicitly if they otherwise satisfy the name
 
532
              requirements.
 
533
            </para>
 
534
          </listitem>
 
535
        </varlistentry>
 
536
        <varlistentry>
 
537
          <term><literal>modules</literal></term>
 
538
          <listitem>
 
539
            <para>
 
540
              This should make the network hook print, <emphasis>on
 
541
              separate lines</emphasis>, all the kernel modules needed
 
542
              for it to run.  (These modules will be copied into the
 
543
              initial RAM filesystem.)  For instance, a tunnel
 
544
              interface needs the
 
545
              <quote><literal>tun</literal></quote> module.
 
546
            </para>
 
547
          </listitem>
 
548
        </varlistentry>
 
549
      </variablelist>
 
550
      <para>
 
551
        The network hook will be provided with a number of environment
 
552
        variables:
 
553
      </para>
 
554
      <variablelist>
 
555
        <varlistentry>
 
556
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
557
          <listitem>
 
558
            <para>
 
559
              The network hook directory, specified to
 
560
              <command>&COMMANDNAME;</command> by the
 
561
              <option>--network-hook-dir</option> option.  Note: this
 
562
              should <emphasis>always</emphasis> be used by the
 
563
              network hook to refer to itself or any files in the hook
 
564
              directory it may require.
 
565
            </para>
 
566
          </listitem>
 
567
        </varlistentry>
 
568
        <varlistentry>
 
569
          <term><envar>DEVICE</envar></term>
 
570
          <listitem>
 
571
            <para>
 
572
              The network interfaces, as specified to
 
573
              <command>&COMMANDNAME;</command> by the
 
574
              <option>--interface</option> option, combined to one
 
575
              string and separated by commas.  If this is set, and
 
576
              does not contain the interface a hook will bring up,
 
577
              there is no reason for a hook to continue.
 
578
            </para>
 
579
          </listitem>
 
580
        </varlistentry>
 
581
        <varlistentry>
 
582
          <term><envar>MODE</envar></term>
 
583
          <listitem>
 
584
            <para>
 
585
              This will be the same as the first argument;
 
586
              i.e. <quote><literal>start</literal></quote>,
 
587
              <quote><literal>stop</literal></quote>,
 
588
              <quote><literal>files</literal></quote>, or
 
589
              <quote><literal>modules</literal></quote>.
 
590
            </para>
 
591
          </listitem>
 
592
        </varlistentry>
 
593
        <varlistentry>
 
594
          <term><envar>VERBOSITY</envar></term>
 
595
          <listitem>
 
596
            <para>
 
597
              This will be the <quote><literal>1</literal></quote> if
 
598
              the <option>--debug</option> option is passed to
 
599
              <command>&COMMANDNAME;</command>, otherwise
 
600
              <quote><literal>0</literal></quote>.
 
601
            </para>
 
602
          </listitem>
 
603
        </varlistentry>
 
604
        <varlistentry>
 
605
          <term><envar>DELAY</envar></term>
 
606
          <listitem>
 
607
            <para>
 
608
              This will be the same as the <option>--delay</option>
 
609
              option passed to <command>&COMMANDNAME;</command>.  Is
 
610
              only set if <envar>MODE</envar> is
 
611
              <quote><literal>start</literal></quote> or
 
612
              <quote><literal>stop</literal></quote>.
 
613
            </para>
 
614
          </listitem>
 
615
        </varlistentry>
 
616
        <varlistentry>
 
617
          <term><envar>CONNECT</envar></term>
 
618
          <listitem>
 
619
            <para>
 
620
              This will be the same as the <option>--connect</option>
 
621
              option passed to <command>&COMMANDNAME;</command>.  Is
 
622
              only set if <option>--connect</option> is passed and
 
623
              <envar>MODE</envar> is
 
624
              <quote><literal>start</literal></quote> or
 
625
              <quote><literal>stop</literal></quote>.
 
626
            </para>
 
627
          </listitem>
 
628
        </varlistentry>
 
629
      </variablelist>
 
630
      <para>
 
631
        A hook may not read from standard input, and should be
 
632
        restrictive in printing to standard output or standard error
 
633
        unless <varname>VERBOSITY</varname> is
 
634
        <quote><literal>1</literal></quote>.
 
635
      </para>
 
636
    </refsect2>
 
637
  </refsect1>
 
638
  
 
639
  <refsect1 id="files">
345
640
    <title>FILES</title>
346
641
    <variablelist>
347
642
      <varlistentry>
358
653
          </para>
359
654
        </listitem>
360
655
      </varlistentry>
 
656
      <varlistentry>
 
657
        <term><filename
 
658
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
659
        <listitem>
 
660
          <para>
 
661
            Directory where network hooks are located.  Change this
 
662
            with the <option>--network-hook-dir</option> option.  See
 
663
            <xref linkend="network-hooks"/>.
 
664
          </para>
 
665
        </listitem>
 
666
      </varlistentry>
361
667
    </variablelist>
362
668
  </refsect1>
363
669
  
366
672
<!--     <para> -->
367
673
<!--     </para> -->
368
674
<!--   </refsect1> -->
369
 
 
 
675
  
370
676
  <refsect1 id="example">
371
677
    <title>EXAMPLE</title>
372
678
    <para>
377
683
    </para>
378
684
    <informalexample>
379
685
      <para>
380
 
        Normal invocation needs no options, if the network interface
381
 
        is <quote>eth0</quote>:
 
686
        Normal invocation needs no options, if the network interfaces
 
687
        can be automatically determined:
382
688
      </para>
383
689
      <para>
384
690
        <userinput>&COMMANDNAME;</userinput>
386
692
    </informalexample>
387
693
    <informalexample>
388
694
      <para>
389
 
        Search for Mandos servers (and connect to them) using another
390
 
        interface:
 
695
        Search for Mandos servers (and connect to them) using one
 
696
        specific interface:
391
697
      </para>
392
698
      <para>
393
699
        <!-- do not wrap this line -->
408
714
    <informalexample>
409
715
      <para>
410
716
        Run in debug mode, with a custom key, and do not use Zeroconf
411
 
        to locate a server; connect directly to the IPv6 address
412
 
        <quote><systemitem class="ipaddress"
413
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
414
 
        port 4711, using interface eth2:
 
717
        to locate a server; connect directly to the IPv6 link-local
 
718
        address <quote><systemitem class="ipaddress"
 
719
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
720
        using interface eth2:
415
721
      </para>
416
722
      <para>
417
723
 
418
724
<!-- do not wrap this line -->
419
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
725
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
420
726
 
421
727
      </para>
422
728
    </informalexample>
423
729
  </refsect1>
424
 
 
 
730
  
425
731
  <refsect1 id="security">
426
732
    <title>SECURITY</title>
427
733
    <para>
447
753
      The only remaining weak point is that someone with physical
448
754
      access to the client hard drive might turn off the client
449
755
      computer, read the OpenPGP keys directly from the hard drive,
450
 
      and communicate with the server.  The defense against this is
451
 
      that the server is supposed to notice the client disappearing
452
 
      and will stop giving out the encrypted data.  Therefore, it is
453
 
      important to set the timeout and checker interval values tightly
454
 
      on the server.  See <citerefentry><refentrytitle
 
756
      and communicate with the server.  To safeguard against this, the
 
757
      server is supposed to notice the client disappearing and stop
 
758
      giving out the encrypted data.  Therefore, it is important to
 
759
      set the timeout and checker interval values tightly on the
 
760
      server.  See <citerefentry><refentrytitle
455
761
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
456
762
    </para>
457
763
    <para>
458
764
      It will also help if the checker program on the server is
459
765
      configured to request something from the client which can not be
460
 
      spoofed by someone else on the network, unlike unencrypted
461
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
766
      spoofed by someone else on the network, like SSH server key
 
767
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
768
      echo (<quote>ping</quote>) replies.
462
769
    </para>
463
770
    <para>
464
771
      <emphasis>Note</emphasis>: This makes it completely insecure to
468
775
      confidential.
469
776
    </para>
470
777
  </refsect1>
471
 
 
 
778
  
472
779
  <refsect1 id="see_also">
473
780
    <title>SEE ALSO</title>
474
781
    <para>
 
782
      <citerefentry><refentrytitle>intro</refentrytitle>
 
783
      <manvolnum>8mandos</manvolnum></citerefentry>,
475
784
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
476
785
      <manvolnum>8</manvolnum></citerefentry>,
477
786
      <citerefentry><refentrytitle>crypttab</refentrytitle>
555
864
              <para>
556
865
                This client uses IPv6 link-local addresses, which are
557
866
                immediately usable since a link-local addresses is
558
 
                automatically assigned to a network interfaces when it
 
867
                automatically assigned to a network interface when it
559
868
                is brought up.
560
869
              </para>
561
870
            </listitem>
599
908
      </varlistentry>
600
909
    </variablelist>
601
910
  </refsect1>
602
 
 
603
911
</refentry>
 
912
 
604
913
<!-- Local Variables: -->
605
914
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
606
915
<!-- time-stamp-end: "[\"']>" -->