/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: 2017-02-21 21:42:08 UTC
  • Revision ID: teddy@recompile.se-20170221214208-09wu1p4l2hjhqfoj
Use "read -r" in shell scripts to avoid backslash escapes

* initramfs-tools-hook: Use "read -r" to read filenames from network
  hook given the "files" argument.
* initramfs-tools-script: Use "read -e" when parsing
  "/conf/conf.d/cryptroot".
* mandos-keygen (keygen): Use "read -r" when reading passphrase.

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