/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/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 19:13:50 UTC
  • mfrom: (24.1.83 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080903191350-la2y2wuxt67xjslb
* mandos-keygen.xml (BUGS): Commented out.

* mandos.xml (BUGS): Note non-checking of expire time of OpenPGP keys.

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