/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2013-09-29 15:52:19 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20130929155219-rer4z6583z1qu7kj
* debian/mandos-client.README.Debian: Update Linux documentation link.
* mandos-keygen: Change default key and subkey type to RSA and default
                 key length to 4096 bits.

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