/mandos/release

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

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

merge

Show diffs side-by-side

added added

removed removed

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