/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: 2018-02-18 01:29:21 UTC
  • Revision ID: teddy@recompile.se-20180218012921-itiazxid50ycv77o
Correct comments

* plugin-helpers/mandos-client-iprouteadddel.c: Comment change only.

Show diffs side-by-side

added added

removed removed

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