/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: 2015-07-06 20:29:34 UTC
  • mfrom: (738.1.6 route-external)
  • Revision ID: teddy@recompile.se-20150706202934-09j06jm2fiw1bn80
Merge change to add local route when network is "unreachable".

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