/mandos/release

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2016-10-01 14:24:14 UTC
  • Revision ID: teddy@recompile.se-20161001142414-y53pczg9ll0r2q4y
Tags: version-1.7.11-1
* Makefile (version): Change to 1.7.11.
* NEWS (Version 1.7.11): Add new entry.
* debian/changelog (1.7.11-1): - '' -

Show diffs side-by-side

added added

removed removed

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