/mandos/trunk

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

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

merge

Show diffs side-by-side

added added

removed removed

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