/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-10-24 17:48:13 UTC
  • mto: This revision was merged to the branch mainline in revision 791.
  • Revision ID: teddy@recompile.se-20151024174813-56h6prp05qt30fx0
Tags: version-1.7.1-1
* Makefile (version): Changed to "1.7.1".
* NEWS (Version 1.7.1): New entry.
* debian/changelog (1.7.1-1): - '' -

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