/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 at recompile
  • Date: 2020-07-04 09:04:03 UTC
  • Revision ID: teddy@recompile.se-20200704090403-genhux7261tjpcou
mandos-ctl: Correct and add some comments

* mandos-ctl: Correct program description in file header comment.
  (dbussy_adapter.SystemBus.call_method): Correct comment about DBussy
  return values.
  (dbussy_adapter.SystemBus.type_filter): Add comment about the
  representation of DBussy "Variant" values.

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