/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: 2012-06-16 19:30:08 UTC
  • Revision ID: teddy@recompile.se-20120616193008-2erbfaw5a5y3yay1
* debian/mandos-client.README.Debian: Update documentation for using
                                      multiple interfaces.

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