/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-10 20:35:01 UTC
  • mfrom: (24.1.42 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080810203501-euh3qcf1nopilksm
Merge.

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 "2016-02-28">
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>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>
43
 
      <holder>Teddy Hogeborn</holder>
44
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
45
35
    </copyright>
46
 
    <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>
47
59
  </refentryinfo>
48
 
  
 
60
 
49
61
  <refmeta>
50
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
63
    <manvolnum>8mandos</manvolnum>
54
66
  <refnamediv>
55
67
    <refname><command>&COMMANDNAME;</command></refname>
56
68
    <refpurpose>
57
 
      Client for <application>Mandos</application>
 
69
      Client for mandos
58
70
    </refpurpose>
59
71
  </refnamediv>
60
 
  
 
72
 
61
73
  <refsynopsisdiv>
62
74
    <cmdsynopsis>
63
75
      <command>&COMMANDNAME;</command>
64
 
      <group>
65
 
        <arg choice="plain"><option>--connect
66
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
67
 
        ><replaceable>PORT</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-c
69
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
70
 
        ><replaceable>PORT</replaceable></option></arg>
71
 
      </group>
72
 
      <sbr/>
73
 
      <group rep='repeat'>
74
 
        <arg choice="plain"><option>--interface
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>
80
 
      </group>
81
 
      <sbr/>
82
 
      <group>
83
 
        <arg choice="plain"><option>--pubkey
84
 
        <replaceable>FILE</replaceable></option></arg>
85
 
        <arg choice="plain"><option>-p
86
 
        <replaceable>FILE</replaceable></option></arg>
87
 
      </group>
88
 
      <sbr/>
89
 
      <group>
90
 
        <arg choice="plain"><option>--seckey
91
 
        <replaceable>FILE</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-s
93
 
        <replaceable>FILE</replaceable></option></arg>
94
 
      </group>
95
 
      <sbr/>
96
 
      <arg>
97
 
        <option>--priority <replaceable>STRING</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
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>
122
 
        <option>--debug</option>
123
 
      </arg>
124
 
    </cmdsynopsis>
125
 
    <cmdsynopsis>
126
 
      <command>&COMMANDNAME;</command>
127
 
      <group choice="req">
128
 
        <arg choice="plain"><option>--help</option></arg>
129
 
        <arg choice="plain"><option>-?</option></arg>
130
 
      </group>
131
 
    </cmdsynopsis>
132
 
    <cmdsynopsis>
133
 
      <command>&COMMANDNAME;</command>
134
 
      <arg choice="plain"><option>--usage</option></arg>
135
 
    </cmdsynopsis>
136
 
    <cmdsynopsis>
137
 
      <command>&COMMANDNAME;</command>
138
 
      <group choice="req">
139
 
        <arg choice="plain"><option>--version</option></arg>
140
 
        <arg choice="plain"><option>-V</option></arg>
141
 
      </group>
142
 
    </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>    
143
97
  </refsynopsisdiv>
144
 
  
 
98
 
145
99
  <refsect1 id="description">
146
100
    <title>DESCRIPTION</title>
147
101
    <para>
148
 
      <command>&COMMANDNAME;</command> is a client program that
149
 
      communicates with <citerefentry><refentrytitle
150
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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"/>.
179
 
    </para>
180
 
    <para>
181
 
      This program is not meant to be run directly; it is really meant
182
 
      to run as a plugin of the <application>Mandos</application>
183
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
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.
189
 
    </para>
190
 
  </refsect1>
191
 
  
192
 
  <refsect1 id="purpose">
193
 
    <title>PURPOSE</title>
194
 
    <para>
195
 
      The purpose of this is to enable <emphasis>remote and unattended
196
 
      rebooting</emphasis> of client host computer with an
197
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
198
 
      linkend="overview"/> for details.
199
 
    </para>
200
 
  </refsect1>
201
 
  
202
 
  <refsect1 id="options">
203
 
    <title>OPTIONS</title>
204
 
    <para>
205
 
      This program is commonly not invoked from the command line; it
206
 
      is normally started by the <application>Mandos</application>
207
 
      plugin runner, see <citerefentry><refentrytitle
208
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
209
 
      </citerefentry>.  Any command line options this program accepts
210
 
      are therefore normally provided by the plugin runner, and not
211
 
      directly.
212
 
    </para>
213
 
    
214
 
    <variablelist>
215
 
      <varlistentry>
216
 
        <term><option>--connect=<replaceable
217
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
218
 
        >PORT</replaceable></option></term>
219
 
        <term><option>-c
220
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
221
 
        ><replaceable>PORT</replaceable></option></term>
222
 
        <listitem>
223
 
          <para>
224
 
            Do not use Zeroconf to locate servers.  Connect directly
225
 
            to only one specified <application>Mandos</application>
226
 
            server.  Note that an IPv6 address has colon characters in
227
 
            it, so the <emphasis>last</emphasis> colon character is
228
 
            assumed to separate the address from the port number.
229
 
          </para>
230
 
          <para>
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.
234
 
          </para>
235
 
        </listitem>
236
 
      </varlistentry>
237
 
      
238
 
      <varlistentry>
239
 
        <term><option>--interface=<replaceable
240
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
241
 
        >NAME</replaceable></arg></option></term>
242
 
        <term><option>-i
243
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
244
 
        >NAME</replaceable></arg></option></term>
245
 
        <listitem>
246
 
          <para>
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.
275
 
          </para>
276
 
        </listitem>
277
 
      </varlistentry>
278
 
      
279
 
      <varlistentry>
280
 
        <term><option>--pubkey=<replaceable
281
 
        >FILE</replaceable></option></term>
282
 
        <term><option>-p
283
 
        <replaceable>FILE</replaceable></option></term>
284
 
        <listitem>
285
 
          <para>
286
 
            OpenPGP public key file name.  The default name is
287
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
288
 
            ></quote>.
289
 
          </para>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>--seckey=<replaceable
295
 
        >FILE</replaceable></option></term>
296
 
        <term><option>-s
297
 
        <replaceable>FILE</replaceable></option></term>
298
 
        <listitem>
299
 
          <para>
300
 
            OpenPGP secret key file name.  The default name is
301
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
302
 
            ></quote>.
303
 
          </para>
304
 
        </listitem>
305
 
      </varlistentry>
306
 
      
307
 
      <varlistentry>
308
 
        <term><option>--priority=<replaceable
309
 
        >STRING</replaceable></option></term>
310
 
        <listitem>
311
 
          <xi:include href="../mandos-options.xml"
312
 
                      xpointer="priority"/>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--dh-bits=<replaceable
318
 
        >BITS</replaceable></option></term>
319
 
        <listitem>
320
 
          <para>
321
 
            Sets the number of bits to use for the prime number in the
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>.
384
 
          </para>
385
 
        </listitem>
386
 
      </varlistentry>
387
 
      
388
 
      <varlistentry>
389
 
        <term><option>--debug</option></term>
390
 
        <listitem>
391
 
          <para>
392
 
            Enable debug mode.  This will enable a lot of output to
393
 
            standard error about what the program is doing.  The
394
 
            program will still perform all other functions normally.
395
 
          </para>
396
 
          <para>
397
 
            It will also enable debug mode in the Avahi and GnuTLS
398
 
            libraries, making them print large amounts of debugging
399
 
            output.
400
 
          </para>
401
 
        </listitem>
402
 
      </varlistentry>
403
 
      
404
 
      <varlistentry>
405
 
        <term><option>--help</option></term>
406
 
        <term><option>-?</option></term>
407
 
        <listitem>
408
 
          <para>
409
 
            Gives a help message about options and their meanings.
410
 
          </para>
411
 
        </listitem>
412
 
      </varlistentry>
413
 
      
414
 
      <varlistentry>
415
 
        <term><option>--usage</option></term>
416
 
        <listitem>
417
 
          <para>
418
 
            Gives a short usage message.
419
 
          </para>
420
 
        </listitem>
421
 
      </varlistentry>
422
 
      
423
 
      <varlistentry>
424
 
        <term><option>--version</option></term>
425
 
        <term><option>-V</option></term>
426
 
        <listitem>
427
 
          <para>
428
 
            Prints the program version.
429
 
          </para>
430
 
        </listitem>
431
 
      </varlistentry>
432
 
    </variablelist>
433
 
  </refsect1>
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
 
  
460
 
  <refsect1 id="exit_status">
461
 
    <title>EXIT STATUS</title>
462
 
    <para>
463
 
      This program will exit with a successful (zero) exit status if a
464
 
      server could be found and the password received from it could be
465
 
      successfully decrypted and output on standard output.  The
466
 
      program will exit with a non-zero exit status only if a critical
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> -->
698
 
<!--     <para> -->
699
 
<!--     </para> -->
700
 
<!--   </refsect1> -->
701
 
  
702
 
  <refsect1 id="example">
703
 
    <title>EXAMPLE</title>
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>.
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>
755
 
  </refsect1>
756
 
  
757
 
  <refsect1 id="security">
758
 
    <title>SECURITY</title>
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.
802
 
    </para>
803
 
  </refsect1>
804
 
  
805
 
  <refsect1 id="see_also">
806
 
    <title>SEE ALSO</title>
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>,
814
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
815
 
      <manvolnum>8</manvolnum></citerefentry>,
816
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
817
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
818
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
819
 
      <manvolnum>8mandos</manvolnum></citerefentry>
820
 
    </para>
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>
 
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>            
935
215
    </variablelist>
936
216
  </refsect1>
937
217
</refentry>
938
 
 
939
 
<!-- Local Variables: -->
940
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
941
 
<!-- time-stamp-end: "[\"']>" -->
942
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
943
 
<!-- End: -->