/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: 2008-09-07 09:36:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080907093635-yg1y272yv53dijhp
* Makefile (CONFDIR): Changed to be the same ("/etc/mandos") in both a
                      /usr/local install and a package install.
  (KEYDIR): Changed /usr/local install value to be "/etc/mandos/keys".
  (INITRAMFSTOOLS): Use $(DESTDIR) in /usr/local value too.

* initramfs-tools-hook: Look in "/etc/mandos/keys" too.

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