/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/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

Show diffs side-by-side

added added

removed removed

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