/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-09-01 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

Show diffs side-by-side

added added

removed removed

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