/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-06 15:34:21 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906153421-605ydhwyo404krh9
* initramfs-tools-hook: Use long options where available.  Use only
                        one "test" invocation instead of several.

* mandos-keygen: Use only one "test" invocation instead of several.
                 Use long options where available.  Strip newline from
                 entered password.

* plugin-runner.c (print_out_password): Do not strip trailing newline.
  (fallback): Strip trailing newline from getpass().

* plugin-runner.xml (PLUGINS): Plugins should not print trailing
                               newlines.

* plugins.d/password-prompt.c (main): Strip trailing newline.

* plugins.d/password-request.c (main): Bug fix: Read "pubkey.txt", not
                                       "pupkey.txt".

Show diffs side-by-side

added added

removed removed

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