/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

Fixed unkown -> unknown
updated TODO

Show diffs side-by-side

added added

removed removed

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