/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2014-01-21 20:43:52 UTC
  • mfrom: (237.7.200 trunk)
  • Revision ID: teddy@recompile.se-20140121204352-s0sd0d4mp86ivvog
Merge from trunk.

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