/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2016-02-21 14:24:01 UTC
  • Revision ID: teddy@recompile.se-20160221142401-j7glu6a2hg604d1e
Use AddressSanitizer and UndefinedBehaviorSanitizer.

* Makefile (SANITIZE): New; set to all sanitizing options depending on
                       GCC version.
  (CFLAGS): Added "$(SANITIZE)".

Show diffs side-by-side

added added

removed removed

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