/mandos/release

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2016-02-29 21:21:45 UTC
  • mfrom: (237.7.361 trunk)
  • Revision ID: teddy@recompile.se-20160229212145-plspagxx4kiyw1un
Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2016-02-28">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </copyright>
37
46
    <xi:include href="../legalnotice.xml"/>
38
47
  </refentryinfo>
39
 
 
 
48
  
40
49
  <refmeta>
41
50
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
51
    <manvolnum>8mandos</manvolnum>
45
54
  <refnamediv>
46
55
    <refname><command>&COMMANDNAME;</command></refname>
47
56
    <refpurpose>
48
 
      Client for mandos
 
57
      Client for <application>Mandos</application>
49
58
    </refpurpose>
50
59
  </refnamediv>
51
 
 
 
60
  
52
61
  <refsynopsisdiv>
53
62
    <cmdsynopsis>
54
63
      <command>&COMMANDNAME;</command>
55
64
      <group>
56
65
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
66
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
67
        ><replaceable>PORT</replaceable></option></arg>
59
68
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
69
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
70
        ><replaceable>PORT</replaceable></option></arg>
62
71
      </group>
63
72
      <sbr/>
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
      <group rep='repeat'>
72
74
        <arg choice="plain"><option>--interface
73
 
        <replaceable>NAME</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-i
75
 
        <replaceable>NAME</replaceable></option></arg>
 
75
        <replaceable>NAME</replaceable><arg rep='repeat'
 
76
        >,<replaceable>NAME</replaceable></arg></option></arg>
 
77
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
 
78
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
 
79
        ></option></arg>
76
80
      </group>
77
81
      <sbr/>
78
82
      <group>
98
102
      </arg>
99
103
      <sbr/>
100
104
      <arg>
 
105
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
 
109
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
110
      </arg>
 
111
      <sbr/>
 
112
      <arg>
 
113
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
114
      </arg>
 
115
      <sbr/>
 
116
      <arg>
 
117
        <option>--network-hook-dir
 
118
        <replaceable>DIR</replaceable></option>
 
119
      </arg>
 
120
      <sbr/>
 
121
      <arg>
101
122
        <option>--debug</option>
102
123
      </arg>
103
124
    </cmdsynopsis>
120
141
      </group>
121
142
    </cmdsynopsis>
122
143
  </refsynopsisdiv>
123
 
 
 
144
  
124
145
  <refsect1 id="description">
125
146
    <title>DESCRIPTION</title>
126
147
    <para>
127
148
      <command>&COMMANDNAME;</command> is a client program that
128
149
      communicates with <citerefentry><refentrytitle
129
150
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
 
      to get a password.  It uses IPv6 link-local addresses to get
131
 
      network connectivity, Zeroconf to find the server, and TLS with
132
 
      an OpenPGP key to ensure authenticity and confidentiality.  It
133
 
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply.
 
151
      to get a password.  In slightly more detail, this client program
 
152
      brings up network interfaces, uses the interfaces’ IPv6
 
153
      link-local addresses to get network connectivity, uses Zeroconf
 
154
      to find servers on the local network, and communicates with
 
155
      servers using TLS with an OpenPGP key to ensure authenticity and
 
156
      confidentiality.  This client program keeps running, trying all
 
157
      servers on the network, until it receives a satisfactory reply
 
158
      or a TERM signal.  After all servers have been tried, all
 
159
      servers are periodically retried.  If no servers are found it
 
160
      will wait indefinitely for new servers to appear.
 
161
    </para>
 
162
    <para>
 
163
      The network interfaces are selected like this: If any interfaces
 
164
      are specified using the <option>--interface</option> option,
 
165
      those interface are used.  Otherwise,
 
166
      <command>&COMMANDNAME;</command> will use all interfaces that
 
167
      are not loopback interfaces, are not point-to-point interfaces,
 
168
      are capable of broadcasting and do not have the NOARP flag (see
 
169
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
170
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
171
      <option>--connect</option> option is used, point-to-point
 
172
      interfaces and non-broadcast interfaces are accepted.)  If any
 
173
      used interfaces are not up and running, they are first taken up
 
174
      (and later taken down again on program exit).
 
175
    </para>
 
176
    <para>
 
177
      Before network interfaces are selected, all <quote>network
 
178
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
135
179
    </para>
136
180
    <para>
137
181
      This program is not meant to be run directly; it is really meant
138
182
      to run as a plugin of the <application>Mandos</application>
139
183
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn
141
 
      runs as a <quote>keyscript</quote> specified in the
142
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
143
 
      <manvolnum>5</manvolnum></citerefentry> file.
 
184
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
185
      initial <acronym>RAM</acronym> disk environment because it is
 
186
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
187
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
188
      </citerefentry> file.
144
189
    </para>
145
190
  </refsect1>
146
191
  
154
199
    </para>
155
200
  </refsect1>
156
201
  
157
 
  <refsect1 id="overview">
158
 
    <title>OVERVIEW</title>
159
 
    <xi:include href="overview.xml"/>
160
 
    <para>
161
 
      This program is the client part.  It is a plugin started by
162
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
163
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
164
 
      an initial <acronym>RAM</acronym> disk environment.
165
 
    </para>
166
 
    <para>
167
 
      This program could, theoretically, be used as a keyscript in
168
 
      <filename>/etc/crypttab</filename>, but it would then be
169
 
      impossible to enter the encrypted root disk password at the
170
 
      console, since this program does not read from the console at
171
 
      all.  This is why a separate plugin does that, which will be run
172
 
      in parallell to this one.
173
 
    </para>
174
 
  </refsect1>
175
 
  
176
202
  <refsect1 id="options">
177
203
    <title>OPTIONS</title>
178
204
    <para>
188
214
    <variablelist>
189
215
      <varlistentry>
190
216
        <term><option>--connect=<replaceable
191
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
217
        >ADDRESS</replaceable><literal>:</literal><replaceable
192
218
        >PORT</replaceable></option></term>
193
219
        <term><option>-c
194
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
220
        <replaceable>ADDRESS</replaceable><literal>:</literal
195
221
        ><replaceable>PORT</replaceable></option></term>
196
222
        <listitem>
197
223
          <para>
202
228
            assumed to separate the address from the port number.
203
229
          </para>
204
230
          <para>
205
 
            This option is normally only useful for debugging.
 
231
            Normally, Zeroconf would be used to locate Mandos servers,
 
232
            in which case this option would only be used when testing
 
233
            and debugging.
206
234
          </para>
207
235
        </listitem>
208
236
      </varlistentry>
209
237
      
210
238
      <varlistentry>
211
 
        <term><option>--keydir=<replaceable
212
 
        >DIRECTORY</replaceable></option></term>
213
 
        <term><option>-d
214
 
        <replaceable>DIRECTORY</replaceable></option></term>
215
 
        <listitem>
216
 
          <para>
217
 
            Directory to read the OpenPGP key files
218
 
            <filename>pubkey.txt</filename> and
219
 
            <filename>seckey.txt</filename> from.  The default is
220
 
            <filename>/conf/conf.d/mandos</filename> (in the initial
221
 
            <acronym>RAM</acronym> disk environment).
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
 
226
 
      <varlistentry>
227
 
        <term><option>--interface=
228
 
        <replaceable>NAME</replaceable></option></term>
 
239
        <term><option>--interface=<replaceable
 
240
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
241
        >NAME</replaceable></arg></option></term>
229
242
        <term><option>-i
230
 
        <replaceable>NAME</replaceable></option></term>
 
243
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
244
        >NAME</replaceable></arg></option></term>
231
245
        <listitem>
232
246
          <para>
233
 
            Network interface that will be brought up and scanned for
234
 
            Mandos servers to connect to.  The default it
235
 
            <quote><literal>eth0</literal></quote>.
 
247
            Comma separated list of network interfaces that will be
 
248
            brought up and scanned for Mandos servers to connect to.
 
249
            The default is the empty string, which will automatically
 
250
            use all appropriate interfaces.
 
251
          </para>
 
252
          <para>
 
253
            If the <option>--connect</option> option is used, and
 
254
            exactly one interface name is specified (except
 
255
            <quote><literal>none</literal></quote>), this specifies
 
256
            the interface to use to connect to the address given.
 
257
          </para>
 
258
          <para>
 
259
            Note that since this program will normally run in the
 
260
            initial RAM disk environment, the interface must be an
 
261
            interface which exists at that stage.  Thus, the interface
 
262
            can normally not be a pseudo-interface such as
 
263
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
 
264
            will not exist until much later in the boot process, and
 
265
            can not be used by this program, unless created by a
 
266
            <quote>network hook</quote> — see <xref
 
267
            linkend="network-hooks"/>.
 
268
          </para>
 
269
          <para>
 
270
            <replaceable>NAME</replaceable> can be the string
 
271
            <quote><literal>none</literal></quote>; this will make
 
272
            <command>&COMMANDNAME;</command> only bring up interfaces
 
273
            specified <emphasis>before</emphasis> this string.  This
 
274
            is not recommended, and only meant for advanced users.
236
275
          </para>
237
276
        </listitem>
238
277
      </varlistentry>
244
283
        <replaceable>FILE</replaceable></option></term>
245
284
        <listitem>
246
285
          <para>
247
 
            OpenPGP public key file name.  This will be combined with
248
 
            the directory from the <option>--keydir</option> option to
249
 
            form an absolute file name.  The default name is
250
 
            <quote><literal>pubkey.txt</literal></quote>.
 
286
            OpenPGP public key file name.  The default name is
 
287
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
288
            ></quote>.
251
289
          </para>
252
290
        </listitem>
253
291
      </varlistentry>
254
 
 
 
292
      
255
293
      <varlistentry>
256
294
        <term><option>--seckey=<replaceable
257
295
        >FILE</replaceable></option></term>
259
297
        <replaceable>FILE</replaceable></option></term>
260
298
        <listitem>
261
299
          <para>
262
 
            OpenPGP secret key file name.  This will be combined with
263
 
            the directory from the <option>--keydir</option> option to
264
 
            form an absolute file name.  The default name is
265
 
            <quote><literal>seckey.txt</literal></quote>.
 
300
            OpenPGP secret key file name.  The default name is
 
301
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
302
            ></quote>.
266
303
          </para>
267
304
        </listitem>
268
305
      </varlistentry>
271
308
        <term><option>--priority=<replaceable
272
309
        >STRING</replaceable></option></term>
273
310
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
311
          <xi:include href="../mandos-options.xml"
 
312
                      xpointer="priority"/>
275
313
        </listitem>
276
314
      </varlistentry>
277
 
 
 
315
      
278
316
      <varlistentry>
279
317
        <term><option>--dh-bits=<replaceable
280
318
        >BITS</replaceable></option></term>
281
319
        <listitem>
282
320
          <para>
283
321
            Sets the number of bits to use for the prime number in the
284
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
322
            TLS Diffie-Hellman key exchange.  The default value is
 
323
            selected automatically based on the OpenPGP key.  Note
 
324
            that if the <option>--dh-params</option> option is used,
 
325
            the values from that file will be used instead.
 
326
          </para>
 
327
        </listitem>
 
328
      </varlistentry>
 
329
      
 
330
      <varlistentry>
 
331
        <term><option>--dh-params=<replaceable
 
332
        >FILE</replaceable></option></term>
 
333
        <listitem>
 
334
          <para>
 
335
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
336
            needed by the TLS Diffie-Hellman key exchange from.  If
 
337
            this option is not given, or if the file for some reason
 
338
            could not be used, the parameters will be generated on
 
339
            startup, which will take some time and processing power.
 
340
            Those using servers running under time, power or processor
 
341
            constraints may want to generate such a file in advance
 
342
            and use this option.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
 
346
 
 
347
      <varlistentry>
 
348
        <term><option>--delay=<replaceable
 
349
        >SECONDS</replaceable></option></term>
 
350
        <listitem>
 
351
          <para>
 
352
            After bringing a network interface up, the program waits
 
353
            for the interface to arrive in a <quote>running</quote>
 
354
            state before proceeding.  During this time, the kernel log
 
355
            level will be lowered to reduce clutter on the system
 
356
            console, alleviating any other plugins which might be
 
357
            using the system console.  This option sets the upper
 
358
            limit of seconds to wait.  The default is 2.5 seconds.
 
359
          </para>
 
360
        </listitem>
 
361
      </varlistentry>
 
362
 
 
363
      <varlistentry>
 
364
        <term><option>--retry=<replaceable
 
365
        >SECONDS</replaceable></option></term>
 
366
        <listitem>
 
367
          <para>
 
368
            All Mandos servers are tried repeatedly until a password
 
369
            is received.  This value specifies, in seconds, how long
 
370
            between each successive try <emphasis>for the same
 
371
            server</emphasis>.  The default is 10 seconds.
 
372
          </para>
 
373
        </listitem>
 
374
      </varlistentry>
 
375
 
 
376
      <varlistentry>
 
377
        <term><option>--network-hook-dir=<replaceable
 
378
        >DIR</replaceable></option></term>
 
379
        <listitem>
 
380
          <para>
 
381
            Network hook directory.  The default directory is
 
382
            <quote><filename class="directory"
 
383
            >/lib/mandos/network-hooks.d</filename></quote>.
285
384
          </para>
286
385
        </listitem>
287
386
      </varlistentry>
320
419
          </para>
321
420
        </listitem>
322
421
      </varlistentry>
323
 
 
 
422
      
324
423
      <varlistentry>
325
424
        <term><option>--version</option></term>
326
425
        <term><option>-V</option></term>
332
431
      </varlistentry>
333
432
    </variablelist>
334
433
  </refsect1>
335
 
 
 
434
  
 
435
  <refsect1 id="overview">
 
436
    <title>OVERVIEW</title>
 
437
    <xi:include href="../overview.xml"/>
 
438
    <para>
 
439
      This program is the client part.  It is a plugin started by
 
440
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
441
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
442
      an initial <acronym>RAM</acronym> disk environment.
 
443
    </para>
 
444
    <para>
 
445
      This program could, theoretically, be used as a keyscript in
 
446
      <filename>/etc/crypttab</filename>, but it would then be
 
447
      impossible to enter a password for the encrypted root disk at
 
448
      the console, since this program does not read from the console
 
449
      at all.  This is why a separate plugin runner (<citerefentry>
 
450
      <refentrytitle>plugin-runner</refentrytitle>
 
451
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
452
      both this program and others in in parallel,
 
453
      <emphasis>one</emphasis> of which (<citerefentry>
 
454
      <refentrytitle>password-prompt</refentrytitle>
 
455
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
456
      passwords on the system console.
 
457
    </para>
 
458
  </refsect1>
 
459
  
336
460
  <refsect1 id="exit_status">
337
461
    <title>EXIT STATUS</title>
338
462
    <para>
340
464
      server could be found and the password received from it could be
341
465
      successfully decrypted and output on standard output.  The
342
466
      program will exit with a non-zero exit status only if a critical
343
 
      error occurs.  Otherwise, it will forever connect to new
344
 
      <application>Mandosservers</application> servers as they appear,
345
 
      trying to get a decryptable password.
346
 
    </para>
347
 
  </refsect1>
348
 
  
349
 
<!--   <refsect1 id="environment"> -->
350
 
<!--     <title>ENVIRONMENT</title> -->
 
467
      error occurs.  Otherwise, it will forever connect to any
 
468
      discovered <application>Mandos</application> servers, trying to
 
469
      get a decryptable password and print it.
 
470
    </para>
 
471
  </refsect1>
 
472
  
 
473
  <refsect1 id="environment">
 
474
    <title>ENVIRONMENT</title>
 
475
    <variablelist>
 
476
      <varlistentry>
 
477
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
478
        <listitem>
 
479
          <para>
 
480
            This environment variable will be assumed to contain the
 
481
            directory containing any helper executables.  The use and
 
482
            nature of these helper executables, if any, is
 
483
            purposefully not documented.
 
484
        </para>
 
485
        </listitem>
 
486
      </varlistentry>
 
487
    </variablelist>
 
488
    <para>
 
489
      This program does not use any other environment variables, not
 
490
      even the ones provided by <citerefentry><refentrytitle
 
491
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
492
    </citerefentry>.
 
493
    </para>
 
494
  </refsect1>
 
495
  
 
496
  <refsect1 id="network-hooks">
 
497
    <title>NETWORK HOOKS</title>
 
498
    <para>
 
499
      If a network interface like a bridge or tunnel is required to
 
500
      find a Mandos server, this requires the interface to be up and
 
501
      running before <command>&COMMANDNAME;</command> starts looking
 
502
      for Mandos servers.  This can be accomplished by creating a
 
503
      <quote>network hook</quote> program, and placing it in a special
 
504
      directory.
 
505
    </para>
 
506
    <para>
 
507
      Before the network is used (and again before program exit), any
 
508
      runnable programs found in the network hook directory are run
 
509
      with the argument <quote><literal>start</literal></quote> or
 
510
      <quote><literal>stop</literal></quote>.  This should bring up or
 
511
      down, respectively, any network interface which
 
512
      <command>&COMMANDNAME;</command> should use.
 
513
    </para>
 
514
    <refsect2 id="hook-requirements">
 
515
      <title>REQUIREMENTS</title>
 
516
      <para>
 
517
        A network hook must be an executable file, and its name must
 
518
        consist entirely of upper and lower case letters, digits,
 
519
        underscores, periods, and hyphens.
 
520
      </para>
 
521
      <para>
 
522
        A network hook will receive one argument, which can be one of
 
523
        the following:
 
524
      </para>
 
525
      <variablelist>
 
526
        <varlistentry>
 
527
          <term><literal>start</literal></term>
 
528
          <listitem>
 
529
            <para>
 
530
              This should make the network hook create (if necessary)
 
531
              and bring up a network interface.
 
532
            </para>
 
533
          </listitem>
 
534
        </varlistentry>
 
535
        <varlistentry>
 
536
          <term><literal>stop</literal></term>
 
537
          <listitem>
 
538
            <para>
 
539
              This should make the network hook take down a network
 
540
              interface, and delete it if it did not exist previously.
 
541
            </para>
 
542
          </listitem>
 
543
        </varlistentry>
 
544
        <varlistentry>
 
545
          <term><literal>files</literal></term>
 
546
          <listitem>
 
547
            <para>
 
548
              This should make the network hook print, <emphasis>one
 
549
              file per line</emphasis>, all the files needed for it to
 
550
              run.  (These files will be copied into the initial RAM
 
551
              filesystem.)  Typical use is for a network hook which is
 
552
              a shell script to print its needed binaries.
 
553
            </para>
 
554
            <para>
 
555
              It is not necessary to print any non-executable files
 
556
              already in the network hook directory, these will be
 
557
              copied implicitly if they otherwise satisfy the name
 
558
              requirements.
 
559
            </para>
 
560
          </listitem>
 
561
        </varlistentry>
 
562
        <varlistentry>
 
563
          <term><literal>modules</literal></term>
 
564
          <listitem>
 
565
            <para>
 
566
              This should make the network hook print, <emphasis>on
 
567
              separate lines</emphasis>, all the kernel modules needed
 
568
              for it to run.  (These modules will be copied into the
 
569
              initial RAM filesystem.)  For instance, a tunnel
 
570
              interface needs the
 
571
              <quote><literal>tun</literal></quote> module.
 
572
            </para>
 
573
          </listitem>
 
574
        </varlistentry>
 
575
      </variablelist>
 
576
      <para>
 
577
        The network hook will be provided with a number of environment
 
578
        variables:
 
579
      </para>
 
580
      <variablelist>
 
581
        <varlistentry>
 
582
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
583
          <listitem>
 
584
            <para>
 
585
              The network hook directory, specified to
 
586
              <command>&COMMANDNAME;</command> by the
 
587
              <option>--network-hook-dir</option> option.  Note: this
 
588
              should <emphasis>always</emphasis> be used by the
 
589
              network hook to refer to itself or any files in the hook
 
590
              directory it may require.
 
591
            </para>
 
592
          </listitem>
 
593
        </varlistentry>
 
594
        <varlistentry>
 
595
          <term><envar>DEVICE</envar></term>
 
596
          <listitem>
 
597
            <para>
 
598
              The network interfaces, as specified to
 
599
              <command>&COMMANDNAME;</command> by the
 
600
              <option>--interface</option> option, combined to one
 
601
              string and separated by commas.  If this is set, and
 
602
              does not contain the interface a hook will bring up,
 
603
              there is no reason for a hook to continue.
 
604
            </para>
 
605
          </listitem>
 
606
        </varlistentry>
 
607
        <varlistentry>
 
608
          <term><envar>MODE</envar></term>
 
609
          <listitem>
 
610
            <para>
 
611
              This will be the same as the first argument;
 
612
              i.e. <quote><literal>start</literal></quote>,
 
613
              <quote><literal>stop</literal></quote>,
 
614
              <quote><literal>files</literal></quote>, or
 
615
              <quote><literal>modules</literal></quote>.
 
616
            </para>
 
617
          </listitem>
 
618
        </varlistentry>
 
619
        <varlistentry>
 
620
          <term><envar>VERBOSITY</envar></term>
 
621
          <listitem>
 
622
            <para>
 
623
              This will be the <quote><literal>1</literal></quote> if
 
624
              the <option>--debug</option> option is passed to
 
625
              <command>&COMMANDNAME;</command>, otherwise
 
626
              <quote><literal>0</literal></quote>.
 
627
            </para>
 
628
          </listitem>
 
629
        </varlistentry>
 
630
        <varlistentry>
 
631
          <term><envar>DELAY</envar></term>
 
632
          <listitem>
 
633
            <para>
 
634
              This will be the same as the <option>--delay</option>
 
635
              option passed to <command>&COMMANDNAME;</command>.  Is
 
636
              only set if <envar>MODE</envar> is
 
637
              <quote><literal>start</literal></quote> or
 
638
              <quote><literal>stop</literal></quote>.
 
639
            </para>
 
640
          </listitem>
 
641
        </varlistentry>
 
642
        <varlistentry>
 
643
          <term><envar>CONNECT</envar></term>
 
644
          <listitem>
 
645
            <para>
 
646
              This will be the same as the <option>--connect</option>
 
647
              option passed to <command>&COMMANDNAME;</command>.  Is
 
648
              only set if <option>--connect</option> is passed and
 
649
              <envar>MODE</envar> is
 
650
              <quote><literal>start</literal></quote> or
 
651
              <quote><literal>stop</literal></quote>.
 
652
            </para>
 
653
          </listitem>
 
654
        </varlistentry>
 
655
      </variablelist>
 
656
      <para>
 
657
        A hook may not read from standard input, and should be
 
658
        restrictive in printing to standard output or standard error
 
659
        unless <varname>VERBOSITY</varname> is
 
660
        <quote><literal>1</literal></quote>.
 
661
      </para>
 
662
    </refsect2>
 
663
  </refsect1>
 
664
  
 
665
  <refsect1 id="files">
 
666
    <title>FILES</title>
 
667
    <variablelist>
 
668
      <varlistentry>
 
669
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
670
        ></term>
 
671
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
672
        ></term>
 
673
        <listitem>
 
674
          <para>
 
675
            OpenPGP public and private key files, in <quote>ASCII
 
676
            Armor</quote> format.  These are the default file names,
 
677
            they can be changed with the <option>--pubkey</option> and
 
678
            <option>--seckey</option> options.
 
679
          </para>
 
680
        </listitem>
 
681
      </varlistentry>
 
682
      <varlistentry>
 
683
        <term><filename
 
684
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
685
        <listitem>
 
686
          <para>
 
687
            Directory where network hooks are located.  Change this
 
688
            with the <option>--network-hook-dir</option> option.  See
 
689
            <xref linkend="network-hooks"/>.
 
690
          </para>
 
691
        </listitem>
 
692
      </varlistentry>
 
693
    </variablelist>
 
694
  </refsect1>
 
695
  
 
696
<!--   <refsect1 id="bugs"> -->
 
697
<!--     <title>BUGS</title> -->
351
698
<!--     <para> -->
352
 
<!--       This program does not use any environment variables. -->
353
699
<!--     </para> -->
354
700
<!--   </refsect1> -->
355
701
  
356
 
  <refsect1 id="file">
357
 
    <title>FILES</title>
358
 
    <para>
359
 
    </para>
360
 
  </refsect1>
361
 
  
362
 
  <refsect1 id="bugs">
363
 
    <title>BUGS</title>
364
 
    <para>
365
 
    </para>
366
 
  </refsect1>
367
 
 
368
702
  <refsect1 id="example">
369
703
    <title>EXAMPLE</title>
370
704
    <para>
 
705
      Note that normally, command line options will not be given
 
706
      directly, but via options for the Mandos <citerefentry
 
707
      ><refentrytitle>plugin-runner</refentrytitle>
 
708
      <manvolnum>8mandos</manvolnum></citerefentry>.
371
709
    </para>
 
710
    <informalexample>
 
711
      <para>
 
712
        Normal invocation needs no options, if the network interfaces
 
713
        can be automatically determined:
 
714
      </para>
 
715
      <para>
 
716
        <userinput>&COMMANDNAME;</userinput>
 
717
      </para>
 
718
    </informalexample>
 
719
    <informalexample>
 
720
      <para>
 
721
        Search for Mandos servers (and connect to them) using one
 
722
        specific interface:
 
723
      </para>
 
724
      <para>
 
725
        <!-- do not wrap this line -->
 
726
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
727
      </para>
 
728
    </informalexample>
 
729
    <informalexample>
 
730
      <para>
 
731
        Run in debug mode, and use a custom key:
 
732
      </para>
 
733
      <para>
 
734
 
 
735
<!-- do not wrap this line -->
 
736
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
737
 
 
738
      </para>
 
739
    </informalexample>
 
740
    <informalexample>
 
741
      <para>
 
742
        Run in debug mode, with a custom key, and do not use Zeroconf
 
743
        to locate a server; connect directly to the IPv6 link-local
 
744
        address <quote><systemitem class="ipaddress"
 
745
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
746
        using interface eth2:
 
747
      </para>
 
748
      <para>
 
749
 
 
750
<!-- do not wrap this line -->
 
751
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
752
 
 
753
      </para>
 
754
    </informalexample>
372
755
  </refsect1>
373
 
 
 
756
  
374
757
  <refsect1 id="security">
375
758
    <title>SECURITY</title>
376
759
    <para>
 
760
      This program is set-uid to root, but will switch back to the
 
761
      original (and presumably non-privileged) user and group after
 
762
      bringing up the network interface.
 
763
    </para>
 
764
    <para>
 
765
      To use this program for its intended purpose (see <xref
 
766
      linkend="purpose"/>), the password for the root file system will
 
767
      have to be given out to be stored in a server computer, after
 
768
      having been encrypted using an OpenPGP key.  This encrypted data
 
769
      which will be stored in a server can only be decrypted by the
 
770
      OpenPGP key, and the data will only be given out to those
 
771
      clients who can prove they actually have that key.  This key,
 
772
      however, is stored unencrypted on the client side in its initial
 
773
      <acronym>RAM</acronym> disk image file system.  This is normally
 
774
      readable by all, but this is normally fixed during installation
 
775
      of this program; file permissions are set so that no-one is able
 
776
      to read that file.
 
777
    </para>
 
778
    <para>
 
779
      The only remaining weak point is that someone with physical
 
780
      access to the client hard drive might turn off the client
 
781
      computer, read the OpenPGP keys directly from the hard drive,
 
782
      and communicate with the server.  To safeguard against this, the
 
783
      server is supposed to notice the client disappearing and stop
 
784
      giving out the encrypted data.  Therefore, it is important to
 
785
      set the timeout and checker interval values tightly on the
 
786
      server.  See <citerefentry><refentrytitle
 
787
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
788
    </para>
 
789
    <para>
 
790
      It will also help if the checker program on the server is
 
791
      configured to request something from the client which can not be
 
792
      spoofed by someone else on the network, like SSH server key
 
793
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
794
      echo (<quote>ping</quote>) replies.
 
795
    </para>
 
796
    <para>
 
797
      <emphasis>Note</emphasis>: This makes it completely insecure to
 
798
      have <application >Mandos</application> clients which dual-boot
 
799
      to another operating system which is <emphasis>not</emphasis>
 
800
      trusted to keep the initial <acronym>RAM</acronym> disk image
 
801
      confidential.
377
802
    </para>
378
803
  </refsect1>
379
 
 
 
804
  
380
805
  <refsect1 id="see_also">
381
806
    <title>SEE ALSO</title>
382
807
    <para>
 
808
      <citerefentry><refentrytitle>intro</refentrytitle>
 
809
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
810
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
811
      <manvolnum>8</manvolnum></citerefentry>,
 
812
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
813
      <manvolnum>5</manvolnum></citerefentry>,
383
814
      <citerefentry><refentrytitle>mandos</refentrytitle>
384
815
      <manvolnum>8</manvolnum></citerefentry>,
385
816
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
387
818
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
388
819
      <manvolnum>8mandos</manvolnum></citerefentry>
389
820
    </para>
390
 
    <itemizedlist>
391
 
      <listitem><para>
392
 
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
393
 
      </para></listitem>
394
 
      
395
 
      <listitem><para>
396
 
        <ulink url="http://www.avahi.org/">Avahi</ulink>
397
 
      </para></listitem>
398
 
      
399
 
      <listitem><para>
400
 
        <ulink
401
 
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
402
 
      </para></listitem>
403
 
      
404
 
      <listitem><para>
405
 
        <ulink
406
 
        url="http://www.gnupg.org/related_software/gpgme/">
407
 
        GPGME</ulink>
408
 
      </para></listitem>
409
 
      
410
 
      <listitem><para>
411
 
        <citation>RFC 4880: <citetitle>OpenPGP Message
412
 
        Format</citetitle></citation>
413
 
      </para></listitem>
414
 
      
415
 
      <listitem><para>
416
 
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
417
 
        Transport Layer Security</citetitle></citation>
418
 
      </para></listitem>
419
 
      
420
 
      <listitem><para>
421
 
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
422
 
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
423
 
        Unicast Addresses</citation>
424
 
      </para></listitem>
425
 
    </itemizedlist>
 
821
    <variablelist>
 
822
      <varlistentry>
 
823
        <term>
 
824
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
825
        </term>
 
826
        <listitem>
 
827
          <para>
 
828
            Zeroconf is the network protocol standard used for finding
 
829
            Mandos servers on the local network.
 
830
          </para>
 
831
        </listitem>
 
832
      </varlistentry>
 
833
      <varlistentry>
 
834
        <term>
 
835
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
836
        </term>
 
837
      <listitem>
 
838
        <para>
 
839
          Avahi is the library this program calls to find Zeroconf
 
840
          services.
 
841
        </para>
 
842
      </listitem>
 
843
      </varlistentry>
 
844
      <varlistentry>
 
845
        <term>
 
846
          <ulink url="http://www.gnu.org/software/gnutls/"
 
847
          >GnuTLS</ulink>
 
848
        </term>
 
849
      <listitem>
 
850
        <para>
 
851
          GnuTLS is the library this client uses to implement TLS for
 
852
          communicating securely with the server, and at the same time
 
853
          send the public OpenPGP key to the server.
 
854
        </para>
 
855
      </listitem>
 
856
      </varlistentry>
 
857
      <varlistentry>
 
858
        <term>
 
859
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
860
                 >GPGME</ulink>
 
861
        </term>
 
862
        <listitem>
 
863
          <para>
 
864
            GPGME is the library used to decrypt the OpenPGP data sent
 
865
            by the server.
 
866
          </para>
 
867
        </listitem>
 
868
      </varlistentry>
 
869
      <varlistentry>
 
870
        <term>
 
871
          RFC 4291: <citetitle>IP Version 6 Addressing
 
872
          Architecture</citetitle>
 
873
        </term>
 
874
        <listitem>
 
875
          <variablelist>
 
876
            <varlistentry>
 
877
              <term>Section 2.2: <citetitle>Text Representation of
 
878
              Addresses</citetitle></term>
 
879
              <listitem><para/></listitem>
 
880
            </varlistentry>
 
881
            <varlistentry>
 
882
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
883
              Address</citetitle></term>
 
884
              <listitem><para/></listitem>
 
885
            </varlistentry>
 
886
            <varlistentry>
 
887
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
888
            Addresses</citetitle></term>
 
889
            <listitem>
 
890
              <para>
 
891
                This client uses IPv6 link-local addresses, which are
 
892
                immediately usable since a link-local addresses is
 
893
                automatically assigned to a network interface when it
 
894
                is brought up.
 
895
              </para>
 
896
            </listitem>
 
897
            </varlistentry>
 
898
          </variablelist>
 
899
        </listitem>
 
900
      </varlistentry>
 
901
      <varlistentry>
 
902
        <term>
 
903
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
904
          Protocol Version 1.1</citetitle>
 
905
        </term>
 
906
      <listitem>
 
907
        <para>
 
908
          TLS 1.1 is the protocol implemented by GnuTLS.
 
909
        </para>
 
910
      </listitem>
 
911
      </varlistentry>
 
912
      <varlistentry>
 
913
        <term>
 
914
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
915
        </term>
 
916
      <listitem>
 
917
        <para>
 
918
          The data received from the server is binary encrypted
 
919
          OpenPGP data.
 
920
        </para>
 
921
      </listitem>
 
922
      </varlistentry>
 
923
      <varlistentry>
 
924
        <term>
 
925
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
926
          Security</citetitle>
 
927
        </term>
 
928
      <listitem>
 
929
        <para>
 
930
          This is implemented by GnuTLS and used by this program so
 
931
          that OpenPGP keys can be used.
 
932
        </para>
 
933
      </listitem>
 
934
      </varlistentry>
 
935
    </variablelist>
426
936
  </refsect1>
427
 
 
428
937
</refentry>
 
938
 
429
939
<!-- Local Variables: -->
430
940
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
431
941
<!-- time-stamp-end: "[\"']>" -->