/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-08-31 14:00:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140036-5bruinjq267s5f8p
* mandos-clients.conf.xml: Changed all single quotes to double quotes
                           for consistency.
* mandos.conf.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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