/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-05-31 20:12:27 UTC
  • mfrom: (749.1.2 multiprocessing-exec)
  • Revision ID: teddy@recompile.se-20150531201227-u3n1z1ito5siqh7c
Merge change to use multiprocessing module to run checkers.

Show diffs side-by-side

added added

removed removed

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