/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-29 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
8
<!ENTITY TIMESTAMP "2008-08-29">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
13
    <title>&COMMANDNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&COMMANDNAME;</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
16
18
    <authorgroup>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <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>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
52
75
  <refsynopsisdiv>
53
76
    <cmdsynopsis>
54
77
      <command>&COMMANDNAME;</command>
55
 
      <group>
56
 
        <arg choice="plain"><option>--connect
57
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
 
        ><replaceable>PORT</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-c
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
 
        ><replaceable>PORT</replaceable></option></arg>
62
 
      </group>
63
 
      <sbr/>
64
 
      <group>
65
 
        <arg choice="plain"><option>--interface
66
 
        <replaceable>NAME</replaceable></option></arg>
67
 
        <arg choice="plain"><option>-i
68
 
        <replaceable>NAME</replaceable></option></arg>
69
 
      </group>
70
 
      <sbr/>
71
 
      <group>
72
 
        <arg choice="plain"><option>--pubkey
73
 
        <replaceable>FILE</replaceable></option></arg>
74
 
        <arg choice="plain"><option>-p
75
 
        <replaceable>FILE</replaceable></option></arg>
76
 
      </group>
77
 
      <sbr/>
78
 
      <group>
79
 
        <arg choice="plain"><option>--seckey
80
 
        <replaceable>FILE</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-s
82
 
        <replaceable>FILE</replaceable></option></arg>
83
 
      </group>
84
 
      <sbr/>
85
 
      <arg>
86
 
        <option>--priority <replaceable>STRING</replaceable></option>
87
 
      </arg>
88
 
      <sbr/>
89
 
      <arg>
90
 
        <option>--dh-bits <replaceable>BITS</replaceable></option>
91
 
      </arg>
92
 
      <sbr/>
93
 
      <arg>
94
 
        <option>--debug</option>
95
 
      </arg>
96
 
    </cmdsynopsis>
97
 
    <cmdsynopsis>
98
 
      <command>&COMMANDNAME;</command>
99
 
      <group choice="req">
100
 
        <arg choice="plain"><option>--help</option></arg>
101
 
        <arg choice="plain"><option>-?</option></arg>
102
 
      </group>
103
 
    </cmdsynopsis>
104
 
    <cmdsynopsis>
105
 
      <command>&COMMANDNAME;</command>
106
 
      <arg choice="plain"><option>--usage</option></arg>
107
 
    </cmdsynopsis>
108
 
    <cmdsynopsis>
109
 
      <command>&COMMANDNAME;</command>
110
 
      <group choice="req">
111
 
        <arg choice="plain"><option>--version</option></arg>
112
 
        <arg choice="plain"><option>-V</option></arg>
113
 
      </group>
114
 
    </cmdsynopsis>
 
78
      <arg choice='opt'>--connect<arg choice='plain'>IP</arg></arg>
 
79
      <arg choice='opt'>--keydir<arg choice='plain'>KEYDIR</arg></arg>
 
80
      <arg choice='opt'>--interface<arg choice='plain'>INTERFACE</arg></arg>
 
81
      <arg choice='opt'>--pubkey<arg choice='plain'>PUBKEY</arg></arg>
 
82
      <arg choice='opt'>--seckey<arg choice='plain'>SECKEY</arg></arg>
 
83
      <arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
 
84
      <arg choice='opt'>--dh-bits<arg choice='plain'>BITS</arg></arg>      
 
85
      <arg choice='opt'>--debug</arg>
 
86
    </cmdsynopsis>
 
87
    <cmdsynopsis>
 
88
      <command>&COMMANDNAME;</command>
 
89
      <arg choice='plain'>--help</arg>
 
90
    </cmdsynopsis>
 
91
    <cmdsynopsis>
 
92
      <command>&COMMANDNAME;</command>
 
93
      <arg choice='plain'>--usage</arg>
 
94
    </cmdsynopsis>
 
95
    <cmdsynopsis>
 
96
      <command>&COMMANDNAME;</command>
 
97
      <arg choice='plain'>--version</arg>
 
98
    </cmdsynopsis>    
115
99
  </refsynopsisdiv>
116
100
 
117
101
  <refsect1 id="description">
118
102
    <title>DESCRIPTION</title>
119
103
    <para>
120
 
      <command>&COMMANDNAME;</command> is a client program that
121
 
      communicates with <citerefentry><refentrytitle
122
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
 
      to get a password.  It uses IPv6 link-local addresses to get
124
 
      network connectivity, Zeroconf to find servers, and TLS with an
125
 
      OpenPGP key to ensure authenticity and confidentiality.  It
126
 
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
128
 
    </para>
129
 
    <para>
130
 
      This program is not meant to be run directly; it is really meant
131
 
      to run as a plugin of the <application>Mandos</application>
132
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
133
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
134
 
      initial <acronym>RAM</acronym> disk environment because it is
135
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
136
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
137
 
      </citerefentry> file.
138
 
    </para>
139
 
  </refsect1>
140
 
  
141
 
  <refsect1 id="purpose">
142
 
    <title>PURPOSE</title>
143
 
    <para>
144
 
      The purpose of this is to enable <emphasis>remote and unattended
145
 
      rebooting</emphasis> of client host computer with an
146
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
147
 
      linkend="overview"/> for details.
148
 
    </para>
149
 
  </refsect1>
 
104
      <command>&COMMANDNAME;</command> is a mandos plugin that works
 
105
      like a client program that through avahi detects mandos servers,
 
106
      sets up a gnutls connect and request a encrypted password. Any
 
107
      passwords given is automaticly decrypted and passed to
 
108
      cryptsetup.
 
109
    </para>
 
110
  </refsect1>  
150
111
  
151
112
  <refsect1 id="options">
152
113
    <title>OPTIONS</title>
153
114
    <para>
154
 
      This program is commonly not invoked from the command line; it
155
 
      is normally started by the <application>Mandos</application>
156
 
      plugin runner, see <citerefentry><refentrytitle
157
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
158
 
      </citerefentry>.  Any command line options this program accepts
159
 
      are therefore normally provided by the plugin runner, and not
160
 
      directly.
 
115
      Commonly not invoked as command lines but from configuration
 
116
      file of plugin runner.
161
117
    </para>
162
 
    
 
118
 
163
119
    <variablelist>
164
120
      <varlistentry>
165
 
        <term><option>--connect=<replaceable
166
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
167
 
        >PORT</replaceable></option></term>
168
 
        <term><option>-c
169
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
170
 
        ><replaceable>PORT</replaceable></option></term>
171
 
        <listitem>
172
 
          <para>
173
 
            Do not use Zeroconf to locate servers.  Connect directly
174
 
            to only one specified <application>Mandos</application>
175
 
            server.  Note that an IPv6 address has colon characters in
176
 
            it, so the <emphasis>last</emphasis> colon character is
177
 
            assumed to separate the address from the port number.
178
 
          </para>
179
 
          <para>
180
 
            This option is normally only useful for testing and
181
 
            debugging.
182
 
          </para>
183
 
        </listitem>
184
 
      </varlistentry>
185
 
      
186
 
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
189
 
        <term><option>-i
190
 
        <replaceable>NAME</replaceable></option></term>
191
 
        <listitem>
192
 
          <para>
193
 
            Network interface that will be brought up and scanned for
194
 
            Mandos servers to connect to.  The default it
195
 
            <quote><literal>eth0</literal></quote>.
196
 
          </para>
197
 
          <para>
198
 
            If the <option>--connect</option> option is used, this
199
 
            specifies the interface to use to connect to the address
200
 
            given.
201
 
          </para>
202
 
        </listitem>
203
 
      </varlistentry>
204
 
      
205
 
      <varlistentry>
206
 
        <term><option>--pubkey=<replaceable
207
 
        >FILE</replaceable></option></term>
208
 
        <term><option>-p
209
 
        <replaceable>FILE</replaceable></option></term>
210
 
        <listitem>
211
 
          <para>
212
 
            OpenPGP public key file name.  The default name is
213
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
214
 
            ></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
 
219
 
      <varlistentry>
220
 
        <term><option>--seckey=<replaceable
221
 
        >FILE</replaceable></option></term>
222
 
        <term><option>-s
223
 
        <replaceable>FILE</replaceable></option></term>
224
 
        <listitem>
225
 
          <para>
226
 
            OpenPGP secret key file name.  The default name is
227
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
228
 
            ></quote>.
229
 
          </para>
230
 
        </listitem>
231
 
      </varlistentry>
232
 
      
233
 
      <varlistentry>
234
 
        <term><option>--priority=<replaceable
235
 
        >STRING</replaceable></option></term>
236
 
        <listitem>
237
 
          <xi:include href="../mandos-options.xml"
238
 
                      xpointer="priority"/>
239
 
        </listitem>
240
 
      </varlistentry>
241
 
 
242
 
      <varlistentry>
243
 
        <term><option>--dh-bits=<replaceable
244
 
        >BITS</replaceable></option></term>
245
 
        <listitem>
246
 
          <para>
247
 
            Sets the number of bits to use for the prime number in the
248
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
249
 
          </para>
250
 
        </listitem>
251
 
      </varlistentry>
252
 
      
253
 
      <varlistentry>
254
 
        <term><option>--debug</option></term>
255
 
        <listitem>
256
 
          <para>
257
 
            Enable debug mode.  This will enable a lot of output to
258
 
            standard error about what the program is doing.  The
259
 
            program will still perform all other functions normally.
260
 
          </para>
261
 
          <para>
262
 
            It will also enable debug mode in the Avahi and GnuTLS
263
 
            libraries, making them print large amounts of debugging
264
 
            output.
265
 
          </para>
266
 
        </listitem>
267
 
      </varlistentry>
268
 
      
269
 
      <varlistentry>
270
 
        <term><option>--help</option></term>
271
 
        <term><option>-?</option></term>
272
 
        <listitem>
273
 
          <para>
274
 
            Gives a help message about options and their meanings.
275
 
          </para>
276
 
        </listitem>
277
 
      </varlistentry>
278
 
      
279
 
      <varlistentry>
280
 
        <term><option>--usage</option></term>
281
 
        <listitem>
282
 
          <para>
283
 
            Gives a short usage message.
284
 
          </para>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
 
288
 
      <varlistentry>
289
 
        <term><option>--version</option></term>
290
 
        <term><option>-V</option></term>
291
 
        <listitem>
292
 
          <para>
293
 
            Prints the program version.
294
 
          </para>
295
 
        </listitem>
296
 
      </varlistentry>
 
121
        <term><literal>-c</literal>, <literal>--connect=<replaceable>
 
122
        IP</replaceable></literal></term>
 
123
        <listitem>
 
124
          <para>
 
125
            Connect directly to a specified mandos server
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>-d</literal>, <literal>--keydir=<replaceable>
 
132
        KEYDIR</replaceable></literal></term>
 
133
        <listitem>
 
134
          <para>
 
135
            Directory where the openpgp keyring is
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>      
 
139
 
 
140
      <varlistentry>
 
141
        <term><literal>-i</literal>, <literal>--interface=
 
142
        <replaceable>INTERFACE</replaceable></literal></term>
 
143
        <listitem>
 
144
          <para>
 
145
            Interface that Avahi will conntect through
 
146
          </para>
 
147
        </listitem>
 
148
      </varlistentry>      
 
149
 
 
150
      <varlistentry>
 
151
        <term><literal>-p</literal>, <literal>--pubkey=<replaceable>
 
152
        PUBKEY</replaceable></literal></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Public openpgp key for gnutls authentication
 
156
          </para>
 
157
        </listitem>
 
158
      </varlistentry>      
 
159
 
 
160
      <varlistentry>
 
161
        <term><literal>-s</literal>, <literal>--seckey=<replaceable>
 
162
        SECKEY</replaceable></literal></term>
 
163
        <listitem>
 
164
          <para>
 
165
            Secret openpgp key for gnutls authentication
 
166
          </para>
 
167
        </listitem>
 
168
      </varlistentry>            
 
169
      
 
170
      <varlistentry>
 
171
        <term><literal>--priority=<replaceable>PRIORITY</replaceable>
 
172
        </literal></term>
 
173
        <listitem>
 
174
          <para>
 
175
            GNUTLS priority
 
176
          </para>
 
177
        </listitem>
 
178
      </varlistentry>            
 
179
 
 
180
      <varlistentry>
 
181
        <term><literal>--dh-bits=<replaceable>BITS</replaceable>
 
182
        </literal></term>
 
183
        <listitem>
 
184
          <para>
 
185
            dh-bits to use in gnutls communication
 
186
          </para>
 
187
        </listitem>
 
188
      </varlistentry>      
 
189
      
 
190
      <varlistentry>
 
191
        <term><literal>--debug</literal></term>
 
192
        <listitem>
 
193
          <para>
 
194
            Debug mode
 
195
          </para>
 
196
        </listitem>
 
197
      </varlistentry>
 
198
      
 
199
      <varlistentry>
 
200
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
201
        <listitem>
 
202
          <para>
 
203
            Gives a help message
 
204
          </para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
 
209
        <term><literal>--usage</literal></term>
 
210
        <listitem>
 
211
          <para>
 
212
            Gives a short usage message
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
 
 
217
      <varlistentry>
 
218
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
219
        <listitem>
 
220
          <para>
 
221
            Prints the program version
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>            
297
225
    </variablelist>
298
226
  </refsect1>
299
227
 
300
 
  <refsect1 id="overview">
301
 
    <title>OVERVIEW</title>
302
 
    <xi:include href="../overview.xml"/>
303
 
    <para>
304
 
      This program is the client part.  It is a plugin started by
305
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
306
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
307
 
      an initial <acronym>RAM</acronym> disk environment.
308
 
    </para>
309
 
    <para>
310
 
      This program could, theoretically, be used as a keyscript in
311
 
      <filename>/etc/crypttab</filename>, but it would then be
312
 
      impossible to enter a password for the encrypted root disk at
313
 
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
315
 
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallel to this one by the plugin runner.
318
 
    </para>
319
 
  </refsect1>
320
 
  
321
228
  <refsect1 id="exit_status">
322
229
    <title>EXIT STATUS</title>
323
230
    <para>
324
 
      This program will exit with a successful (zero) exit status if a
325
 
      server could be found and the password received from it could be
326
 
      successfully decrypted and output on standard output.  The
327
 
      program will exit with a non-zero exit status only if a critical
328
 
      error occurs.  Otherwise, it will forever connect to new
329
 
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
331
231
    </para>
332
232
  </refsect1>
333
 
  
 
233
 
334
234
  <refsect1 id="environment">
335
235
    <title>ENVIRONMENT</title>
336
236
    <para>
337
 
      This program does not use any environment variables, not even
338
 
      the ones provided by <citerefentry><refentrytitle
339
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
340
 
    </citerefentry>.
341
237
    </para>
342
 
  </refsect1>
343
 
  
 
238
  </refsect1>  
 
239
 
344
240
  <refsect1 id="file">
345
241
    <title>FILES</title>
346
 
    <variablelist>
347
 
      <varlistentry>
348
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
349
 
        ></term>
350
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
351
 
        ></term>
352
 
        <listitem>
353
 
          <para>
354
 
            OpenPGP public and private key files, in <quote>ASCII
355
 
            Armor</quote> format.  These are the default file names,
356
 
            they can be changed with the <option>--pubkey</option> and
357
 
            <option>--seckey</option> options.
358
 
          </para>
359
 
        </listitem>
360
 
      </varlistentry>
361
 
    </variablelist>
362
 
  </refsect1>
 
242
    <para>
 
243
    </para>
 
244
  </refsect1>  
363
245
  
364
 
<!--   <refsect1 id="bugs"> -->
365
 
<!--     <title>BUGS</title> -->
366
 
<!--     <para> -->
367
 
<!--     </para> -->
368
 
<!--   </refsect1> -->
 
246
  <refsect1 id="bugs">
 
247
    <title>BUGS</title>
 
248
    <para>
 
249
    </para>
 
250
  </refsect1>  
369
251
 
370
252
  <refsect1 id="example">
371
253
    <title>EXAMPLE</title>
372
254
    <para>
373
 
      Note that normally, command line options will not be given
374
 
      directly, but via options for the Mandos <citerefentry
375
 
      ><refentrytitle>plugin-runner</refentrytitle>
376
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
377
255
    </para>
378
 
    <informalexample>
379
 
      <para>
380
 
        Normal invocation needs no options, if the network interface
381
 
        is <quote>eth0</quote>:
382
 
      </para>
383
 
      <para>
384
 
        <userinput>&COMMANDNAME;</userinput>
385
 
      </para>
386
 
    </informalexample>
387
 
    <informalexample>
388
 
      <para>
389
 
        Search for Mandos servers (and connect to them) using another
390
 
        interface:
391
 
      </para>
392
 
      <para>
393
 
        <!-- do not wrap this line -->
394
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
395
 
      </para>
396
 
    </informalexample>
397
 
    <informalexample>
398
 
      <para>
399
 
        Run in debug mode, and use a custom key:
400
 
      </para>
401
 
      <para>
402
 
 
403
 
<!-- do not wrap this line -->
404
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
405
 
 
406
 
      </para>
407
 
    </informalexample>
408
 
    <informalexample>
409
 
      <para>
410
 
        Run in debug mode, with a custom key, and do not use Zeroconf
411
 
        to locate a server; connect directly to the IPv6 address
412
 
        <quote><systemitem class="ipaddress"
413
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
414
 
        port 4711, using interface eth2:
415
 
      </para>
416
 
      <para>
417
 
 
418
 
<!-- do not wrap this line -->
419
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
420
 
 
421
 
      </para>
422
 
    </informalexample>
423
256
  </refsect1>
424
257
 
425
258
  <refsect1 id="security">
426
259
    <title>SECURITY</title>
427
260
    <para>
428
 
      This program is set-uid to root, but will switch back to the
429
 
      original (and presumably non-privileged) user and group after
430
 
      bringing up the network interface.
431
 
    </para>
432
 
    <para>
433
 
      To use this program for its intended purpose (see <xref
434
 
      linkend="purpose"/>), the password for the root file system will
435
 
      have to be given out to be stored in a server computer, after
436
 
      having been encrypted using an OpenPGP key.  This encrypted data
437
 
      which will be stored in a server can only be decrypted by the
438
 
      OpenPGP key, and the data will only be given out to those
439
 
      clients who can prove they actually have that key.  This key,
440
 
      however, is stored unencrypted on the client side in its initial
441
 
      <acronym>RAM</acronym> disk image file system.  This is normally
442
 
      readable by all, but this is normally fixed during installation
443
 
      of this program; file permissions are set so that no-one is able
444
 
      to read that file.
445
 
    </para>
446
 
    <para>
447
 
      The only remaining weak point is that someone with physical
448
 
      access to the client hard drive might turn off the client
449
 
      computer, read the OpenPGP keys directly from the hard drive,
450
 
      and communicate with the server.  The defense against this is
451
 
      that the server is supposed to notice the client disappearing
452
 
      and will stop giving out the encrypted data.  Therefore, it is
453
 
      important to set the timeout and checker interval values tightly
454
 
      on the server.  See <citerefentry><refentrytitle
455
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
456
 
    </para>
457
 
    <para>
458
 
      It will also help if the checker program on the server is
459
 
      configured to request something from the client which can not be
460
 
      spoofed by someone else on the network, unlike unencrypted
461
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
462
 
    </para>
463
 
    <para>
464
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
465
 
      have <application >Mandos</application> clients which dual-boot
466
 
      to another operating system which is <emphasis>not</emphasis>
467
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
468
 
      confidential.
469
261
    </para>
470
262
  </refsect1>
471
263
 
472
264
  <refsect1 id="see_also">
473
265
    <title>SEE ALSO</title>
474
 
    <para>
475
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
476
 
      <manvolnum>8</manvolnum></citerefentry>,
477
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
478
 
      <manvolnum>5</manvolnum></citerefentry>,
479
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
480
 
      <manvolnum>8</manvolnum></citerefentry>,
481
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
482
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
483
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
484
 
      <manvolnum>8mandos</manvolnum></citerefentry>
485
 
    </para>
486
 
    <variablelist>
487
 
      <varlistentry>
488
 
        <term>
489
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
490
 
        </term>
491
 
        <listitem>
492
 
          <para>
493
 
            Zeroconf is the network protocol standard used for finding
494
 
            Mandos servers on the local network.
495
 
          </para>
496
 
        </listitem>
497
 
      </varlistentry>
498
 
      <varlistentry>
499
 
        <term>
500
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
501
 
        </term>
502
 
      <listitem>
503
 
        <para>
504
 
          Avahi is the library this program calls to find Zeroconf
505
 
          services.
506
 
        </para>
507
 
      </listitem>
508
 
      </varlistentry>
509
 
      <varlistentry>
510
 
        <term>
511
 
          <ulink url="http://www.gnu.org/software/gnutls/"
512
 
          >GnuTLS</ulink>
513
 
        </term>
514
 
      <listitem>
515
 
        <para>
516
 
          GnuTLS is the library this client uses to implement TLS for
517
 
          communicating securely with the server, and at the same time
518
 
          send the public OpenPGP key to the server.
519
 
        </para>
520
 
      </listitem>
521
 
      </varlistentry>
522
 
      <varlistentry>
523
 
        <term>
524
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
525
 
                 >GPGME</ulink>
526
 
        </term>
527
 
        <listitem>
528
 
          <para>
529
 
            GPGME is the library used to decrypt the OpenPGP data sent
530
 
            by the server.
531
 
          </para>
532
 
        </listitem>
533
 
      </varlistentry>
534
 
      <varlistentry>
535
 
        <term>
536
 
          RFC 4291: <citetitle>IP Version 6 Addressing
537
 
          Architecture</citetitle>
538
 
        </term>
539
 
        <listitem>
540
 
          <variablelist>
541
 
            <varlistentry>
542
 
              <term>Section 2.2: <citetitle>Text Representation of
543
 
              Addresses</citetitle></term>
544
 
              <listitem><para/></listitem>
545
 
            </varlistentry>
546
 
            <varlistentry>
547
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
548
 
              Address</citetitle></term>
549
 
              <listitem><para/></listitem>
550
 
            </varlistentry>
551
 
            <varlistentry>
552
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
553
 
            Addresses</citetitle></term>
554
 
            <listitem>
555
 
              <para>
556
 
                This client uses IPv6 link-local addresses, which are
557
 
                immediately usable since a link-local addresses is
558
 
                automatically assigned to a network interfaces when it
559
 
                is brought up.
560
 
              </para>
561
 
            </listitem>
562
 
            </varlistentry>
563
 
          </variablelist>
564
 
        </listitem>
565
 
      </varlistentry>
566
 
      <varlistentry>
567
 
        <term>
568
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
569
 
          Protocol Version 1.1</citetitle>
570
 
        </term>
571
 
      <listitem>
572
 
        <para>
573
 
          TLS 1.1 is the protocol implemented by GnuTLS.
574
 
        </para>
575
 
      </listitem>
576
 
      </varlistentry>
577
 
      <varlistentry>
578
 
        <term>
579
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
580
 
        </term>
581
 
      <listitem>
582
 
        <para>
583
 
          The data received from the server is binary encrypted
584
 
          OpenPGP data.
585
 
        </para>
586
 
      </listitem>
587
 
      </varlistentry>
588
 
      <varlistentry>
589
 
        <term>
590
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
591
 
          Security</citetitle>
592
 
        </term>
593
 
      <listitem>
594
 
        <para>
595
 
          This is implemented by GnuTLS and used by this program so
596
 
          that OpenPGP keys can be used.
597
 
        </para>
598
 
      </listitem>
599
 
      </varlistentry>
600
 
    </variablelist>
 
266
    <itemizedlist>
 
267
      <listitem><para>
 
268
        <citerefentry><refentrytitle>mandos</refentrytitle>
 
269
        <manvolnum>8</manvolnum></citerefentry>
 
270
      </para></listitem>
 
271
      
 
272
      <listitem><para>
 
273
        <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
274
        <manvolnum>8mandos</manvolnum></citerefentry>
 
275
      </para></listitem>
 
276
      
 
277
      <listitem><para>
 
278
        <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
279
        <manvolnum>8mandos</manvolnum></citerefentry>
 
280
      </para></listitem>
 
281
      
 
282
      <listitem><para>
 
283
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
284
      </para></listitem>
 
285
      
 
286
      <listitem><para>
 
287
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
288
      </para></listitem>
 
289
      
 
290
      <listitem><para>
 
291
        <ulink
 
292
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
293
      </para></listitem>
 
294
      
 
295
      <listitem><para>
 
296
        <ulink
 
297
        url="http://www.gnupg.org/related_software/gpgme/">
 
298
        GPGME</ulink>
 
299
      </para></listitem>
 
300
      
 
301
      <listitem><para>
 
302
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
303
        Format</citetitle></citation>
 
304
      </para></listitem>
 
305
      
 
306
      <listitem><para>
 
307
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
308
        Transport Layer Security</citetitle></citation>
 
309
      </para></listitem>
 
310
      
 
311
      <listitem><para>
 
312
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
313
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
314
        Unicast Addresses</citation>
 
315
      </para></listitem>
 
316
    </itemizedlist>
601
317
  </refsect1>
602
318
 
603
319
</refentry>