/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:37:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903193707-sas85ud9r37ubs9r
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
                                     whether it is a required or
                                     optional.

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