/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 11:31:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113137-v0inyj0limprzfwn
* mandos-options.xml (priority): Added <acronym> tags.

* mandos.xml (NAME): Improved wording.

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