/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 10:41:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825104116-cjd54qqs535kpdxq
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
                                syntax by name.

* mandos.conf.xml (SEE ALSO): Also refer to gnutls_priority_init(3),
                              RFC 4291, and Zeroconf.

* mandos.xml (SEE ALSO): Also refer to sections 2.2 and 2.5.5.2 of RFC
                         4291.  Stop using <citation> tags.

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