/mandos/release

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 17:11:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903171132-usevhlf0gi9rxqc3
* plugins.d/password-request.c (init_gnutls_global): Improved wording
                                                     in debug message.
                                                     Bug fix: Make
                                                     debug message
                                                     print to stderr,
                                                     not stdout.

* plugins.d/password-request.xml (SECURITY): Add text.

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-20">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
34
      <holder>Teddy Hogeborn</holder>
43
35
      <holder>Björn Påhlsson</holder>
44
36
    </copyright>
45
37
    <xi:include href="../legalnotice.xml"/>
46
38
  </refentryinfo>
47
 
  
 
39
 
48
40
  <refmeta>
49
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
50
42
    <manvolnum>8mandos</manvolnum>
53
45
  <refnamediv>
54
46
    <refname><command>&COMMANDNAME;</command></refname>
55
47
    <refpurpose>
56
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
57
49
    </refpurpose>
58
50
  </refnamediv>
59
 
  
 
51
 
60
52
  <refsynopsisdiv>
61
53
    <cmdsynopsis>
62
54
      <command>&COMMANDNAME;</command>
63
55
      <group>
64
56
        <arg choice="plain"><option>--connect
65
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
66
58
        ><replaceable>PORT</replaceable></option></arg>
67
59
        <arg choice="plain"><option>-c
68
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
69
61
        ><replaceable>PORT</replaceable></option></arg>
70
62
      </group>
71
63
      <sbr/>
72
 
      <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>
73
72
        <arg choice="plain"><option>--interface
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>
 
73
        <replaceable>NAME</replaceable></option></arg>
 
74
        <arg choice="plain"><option>-i
 
75
        <replaceable>NAME</replaceable></option></arg>
79
76
      </group>
80
77
      <sbr/>
81
78
      <group>
101
98
      </arg>
102
99
      <sbr/>
103
100
      <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>
121
101
        <option>--debug</option>
122
102
      </arg>
123
103
    </cmdsynopsis>
140
120
      </group>
141
121
    </cmdsynopsis>
142
122
  </refsynopsisdiv>
143
 
  
 
123
 
144
124
  <refsect1 id="description">
145
125
    <title>DESCRIPTION</title>
146
126
    <para>
147
127
      <command>&COMMANDNAME;</command> is a client program that
148
128
      communicates with <citerefentry><refentrytitle
149
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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"/>.
 
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.
178
135
    </para>
179
136
    <para>
180
137
      This program is not meant to be run directly; it is really meant
227
184
            assumed to separate the address from the port number.
228
185
          </para>
229
186
          <para>
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.
 
187
            This option is normally only useful for testing and
 
188
            debugging.
233
189
          </para>
234
190
        </listitem>
235
191
      </varlistentry>
236
192
      
237
193
      <varlistentry>
238
 
        <term><option>--interface=<replaceable
239
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
240
 
        >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>
241
212
        <term><option>-i
242
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
243
 
        >NAME</replaceable></arg></option></term>
 
213
        <replaceable>NAME</replaceable></option></term>
244
214
        <listitem>
245
215
          <para>
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.
 
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.
274
224
          </para>
275
225
        </listitem>
276
226
      </varlistentry>
282
232
        <replaceable>FILE</replaceable></option></term>
283
233
        <listitem>
284
234
          <para>
285
 
            OpenPGP public key file name.  The default name is
286
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
287
 
            ></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>.
288
239
          </para>
289
240
        </listitem>
290
241
      </varlistentry>
291
 
      
 
242
 
292
243
      <varlistentry>
293
244
        <term><option>--seckey=<replaceable
294
245
        >FILE</replaceable></option></term>
296
247
        <replaceable>FILE</replaceable></option></term>
297
248
        <listitem>
298
249
          <para>
299
 
            OpenPGP secret key file name.  The default name is
300
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
301
 
            ></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>.
302
254
          </para>
303
255
        </listitem>
304
256
      </varlistentry>
311
263
                      xpointer="priority"/>
312
264
        </listitem>
313
265
      </varlistentry>
314
 
      
 
266
 
315
267
      <varlistentry>
316
268
        <term><option>--dh-bits=<replaceable
317
269
        >BITS</replaceable></option></term>
318
270
        <listitem>
319
271
          <para>
320
272
            Sets the number of bits to use for the prime number in the
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>.
 
273
            TLS Diffie-Hellman key exchange.  Default is 1024.
383
274
          </para>
384
275
        </listitem>
385
276
      </varlistentry>
418
309
          </para>
419
310
        </listitem>
420
311
      </varlistentry>
421
 
      
 
312
 
422
313
      <varlistentry>
423
314
        <term><option>--version</option></term>
424
315
        <term><option>-V</option></term>
430
321
      </varlistentry>
431
322
    </variablelist>
432
323
  </refsect1>
433
 
  
 
324
 
434
325
  <refsect1 id="overview">
435
326
    <title>OVERVIEW</title>
436
327
    <xi:include href="../overview.xml"/>
445
336
      <filename>/etc/crypttab</filename>, but it would then be
446
337
      impossible to enter a password for the encrypted root disk at
447
338
      the console, since this program does not read from the console
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>
453
 
      <refentrytitle>password-prompt</refentrytitle>
454
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
455
 
      passwords on the system console.
 
339
      at all.  This is why a separate plugin does that, which will be
 
340
      run in parallell to this one by the plugin runner.
456
341
    </para>
457
342
  </refsect1>
458
343
  
463
348
      server could be found and the password received from it could be
464
349
      successfully decrypted and output on standard output.  The
465
350
      program will exit with a non-zero exit status only if a critical
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.
 
351
      error occurs.  Otherwise, it will forever connect to new
 
352
      <application>Mandos</application> servers as they appear, trying
 
353
      to get a decryptable password.
469
354
    </para>
470
355
  </refsect1>
471
356
  
472
357
  <refsect1 id="environment">
473
358
    <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>
487
359
    <para>
488
 
      This program does not use any other environment variables, not
489
 
      even the ones provided by <citerefentry><refentrytitle
 
360
      This program does not use any environment variables, not even
 
361
      the ones provided by <citerefentry><refentrytitle
490
362
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
491
363
    </citerefentry>.
492
364
    </para>
493
365
  </refsect1>
494
366
  
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">
 
367
  <refsect1 id="file">
665
368
    <title>FILES</title>
666
369
    <variablelist>
667
370
      <varlistentry>
678
381
          </para>
679
382
        </listitem>
680
383
      </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>
692
384
    </variablelist>
693
385
  </refsect1>
694
386
  
697
389
<!--     <para> -->
698
390
<!--     </para> -->
699
391
<!--   </refsect1> -->
700
 
  
 
392
 
701
393
  <refsect1 id="example">
702
394
    <title>EXAMPLE</title>
703
395
    <para>
708
400
    </para>
709
401
    <informalexample>
710
402
      <para>
711
 
        Normal invocation needs no options, if the network interfaces
712
 
        can be automatically determined:
 
403
        Normal invocation needs no options, if the network interface
 
404
        is <quote>eth0</quote>:
713
405
      </para>
714
406
      <para>
715
407
        <userinput>&COMMANDNAME;</userinput>
717
409
    </informalexample>
718
410
    <informalexample>
719
411
      <para>
720
 
        Search for Mandos servers (and connect to them) using one
721
 
        specific interface:
 
412
        Search for Mandos servers on another interface:
722
413
      </para>
723
414
      <para>
724
415
        <!-- do not wrap this line -->
727
418
    </informalexample>
728
419
    <informalexample>
729
420
      <para>
730
 
        Run in debug mode, and use a custom key:
 
421
        Run in debug mode, and use a custom key directory:
731
422
      </para>
732
423
      <para>
733
 
 
734
 
<!-- do not wrap this line -->
735
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
736
 
 
 
424
        <!-- do not wrap this line -->
 
425
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
737
426
      </para>
738
427
    </informalexample>
739
428
    <informalexample>
740
429
      <para>
741
 
        Run in debug mode, with a custom key, and do not use Zeroconf
742
 
        to locate a server; connect directly to the IPv6 link-local
 
430
        Run in debug mode, with a custom key directory, and do not use
 
431
        Zeroconf to locate a server; connect directly to the IPv6
743
432
        address <quote><systemitem class="ipaddress"
744
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
745
 
        using interface eth2:
 
433
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
434
        port 4711, using interface eth2:
746
435
      </para>
747
436
      <para>
748
437
 
749
438
<!-- do not wrap this line -->
750
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
751
440
 
752
441
      </para>
753
442
    </informalexample>
754
443
  </refsect1>
755
 
  
 
444
 
756
445
  <refsect1 id="security">
757
446
    <title>SECURITY</title>
758
447
    <para>
759
448
      This program is set-uid to root, but will switch back to the
760
 
      original (and presumably non-privileged) user and group after
761
 
      bringing up the network interface.
 
449
      original user and group after bringing up the network interface.
762
450
    </para>
763
451
    <para>
764
452
      To use this program for its intended purpose (see <xref
778
466
      The only remaining weak point is that someone with physical
779
467
      access to the client hard drive might turn off the client
780
468
      computer, read the OpenPGP keys directly from the hard drive,
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
 
469
      and communicate with the server.  The defense against this is
 
470
      that the server is supposed to notice the client disappearing
 
471
      and will stop giving out the encrypted data.  Therefore, it is
 
472
      important to set the timeout and checker interval values tightly
 
473
      on the server.  See <citerefentry><refentrytitle
786
474
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
475
    </para>
788
476
    <para>
789
 
      It will also help if the checker program on the server is
790
 
      configured to request something from the client which can not be
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.
794
 
    </para>
795
 
    <para>
796
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
797
 
      have <application >Mandos</application> clients which dual-boot
798
 
      to another operating system which is <emphasis>not</emphasis>
799
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
800
 
      confidential.
 
477
      <emphasis>Note</emphasis>: This makes it impossible to have
 
478
      <application >Mandos</application> clients which dual-boot to
 
479
      another operating system which does <emphasis>not</emphasis> run
 
480
      a <application>Mandos</application> client.
801
481
    </para>
802
482
  </refsect1>
803
 
  
 
483
 
804
484
  <refsect1 id="see_also">
805
485
    <title>SEE ALSO</title>
806
486
    <para>
807
 
      <citerefentry><refentrytitle>intro</refentrytitle>
808
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
809
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
810
 
      <manvolnum>8</manvolnum></citerefentry>,
811
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
812
 
      <manvolnum>5</manvolnum></citerefentry>,
813
487
      <citerefentry><refentrytitle>mandos</refentrytitle>
814
488
      <manvolnum>8</manvolnum></citerefentry>,
815
489
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
817
491
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
818
492
      <manvolnum>8mandos</manvolnum></citerefentry>
819
493
    </para>
820
 
    <variablelist>
821
 
      <varlistentry>
822
 
        <term>
823
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
824
 
        </term>
825
 
        <listitem>
826
 
          <para>
827
 
            Zeroconf is the network protocol standard used for finding
828
 
            Mandos servers on the local network.
829
 
          </para>
830
 
        </listitem>
831
 
      </varlistentry>
832
 
      <varlistentry>
833
 
        <term>
834
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
835
 
        </term>
836
 
      <listitem>
837
 
        <para>
838
 
          Avahi is the library this program calls to find Zeroconf
839
 
          services.
840
 
        </para>
841
 
      </listitem>
842
 
      </varlistentry>
843
 
      <varlistentry>
844
 
        <term>
845
 
          <ulink url="http://www.gnu.org/software/gnutls/"
846
 
          >GnuTLS</ulink>
847
 
        </term>
848
 
      <listitem>
849
 
        <para>
850
 
          GnuTLS is the library this client uses to implement TLS for
851
 
          communicating securely with the server, and at the same time
852
 
          send the public OpenPGP key to the server.
853
 
        </para>
854
 
      </listitem>
855
 
      </varlistentry>
856
 
      <varlistentry>
857
 
        <term>
858
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
859
 
                 >GPGME</ulink>
860
 
        </term>
861
 
        <listitem>
862
 
          <para>
863
 
            GPGME is the library used to decrypt the OpenPGP data sent
864
 
            by the server.
865
 
          </para>
866
 
        </listitem>
867
 
      </varlistentry>
868
 
      <varlistentry>
869
 
        <term>
870
 
          RFC 4291: <citetitle>IP Version 6 Addressing
871
 
          Architecture</citetitle>
872
 
        </term>
873
 
        <listitem>
874
 
          <variablelist>
875
 
            <varlistentry>
876
 
              <term>Section 2.2: <citetitle>Text Representation of
877
 
              Addresses</citetitle></term>
878
 
              <listitem><para/></listitem>
879
 
            </varlistentry>
880
 
            <varlistentry>
881
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
882
 
              Address</citetitle></term>
883
 
              <listitem><para/></listitem>
884
 
            </varlistentry>
885
 
            <varlistentry>
886
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
887
 
            Addresses</citetitle></term>
888
 
            <listitem>
889
 
              <para>
890
 
                This client uses IPv6 link-local addresses, which are
891
 
                immediately usable since a link-local addresses is
892
 
                automatically assigned to a network interface when it
893
 
                is brought up.
894
 
              </para>
895
 
            </listitem>
896
 
            </varlistentry>
897
 
          </variablelist>
898
 
        </listitem>
899
 
      </varlistentry>
900
 
      <varlistentry>
901
 
        <term>
902
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.1</citetitle>
904
 
        </term>
905
 
      <listitem>
906
 
        <para>
907
 
          TLS 1.1 is the protocol implemented by GnuTLS.
908
 
        </para>
909
 
      </listitem>
910
 
      </varlistentry>
911
 
      <varlistentry>
912
 
        <term>
913
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
914
 
        </term>
915
 
      <listitem>
916
 
        <para>
917
 
          The data received from the server is binary encrypted
918
 
          OpenPGP data.
919
 
        </para>
920
 
      </listitem>
921
 
      </varlistentry>
922
 
      <varlistentry>
923
 
        <term>
924
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
925
 
          Security</citetitle>
926
 
        </term>
927
 
      <listitem>
928
 
        <para>
929
 
          This is implemented by GnuTLS and used by this program so
930
 
          that OpenPGP keys can be used.
931
 
        </para>
932
 
      </listitem>
933
 
      </varlistentry>
934
 
    </variablelist>
 
494
    <itemizedlist>
 
495
      <listitem><para>
 
496
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
497
      </para></listitem>
 
498
      
 
499
      <listitem><para>
 
500
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
501
      </para></listitem>
 
502
      
 
503
      <listitem><para>
 
504
        <ulink
 
505
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
506
      </para></listitem>
 
507
      
 
508
      <listitem><para>
 
509
        <ulink
 
510
        url="http://www.gnupg.org/related_software/gpgme/"
 
511
        >GPGME</ulink>
 
512
      </para></listitem>
 
513
      
 
514
      <listitem><para>
 
515
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
516
        Format</citetitle></citation>
 
517
      </para></listitem>
 
518
      
 
519
      <listitem><para>
 
520
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
521
        Transport Layer Security</citetitle></citation>
 
522
      </para></listitem>
 
523
      
 
524
      <listitem><para>
 
525
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
526
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
527
        Unicast Addresses</citation>
 
528
      </para></listitem>
 
529
    </itemizedlist>
935
530
  </refsect1>
 
531
 
936
532
</refentry>
937
 
 
938
533
<!-- Local Variables: -->
939
534
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
940
535
<!-- time-stamp-end: "[\"']>" -->