/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: 2013-10-22 19:24:01 UTC
  • Revision ID: teddy@recompile.se-20131022192401-op6mwsb7f7gygjyh
http://bugs.debian.org/702120
* mandos (priority): Bug fix: Add even more magic to make the old
                     DSA/ELG 2048-bit keys work with GnuTLS.
* mandos-keygen (KEYCOMMENT): Changed default to "".
* mandos-keygen (OPTIONS): Document new default value of "--comment".
* mandos-options.xml (priority): Document new default value.
* mandos.conf (priority): - '' -

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