/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-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

Show diffs side-by-side

added added

removed removed

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