/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-10-01 15:29:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001152901-fh30whl3m4vb7m24
* debian/changelog: New Debian revision.

* debian/mandos-client.lintian-overrides: Added comments.
* debian/mandos.lintian-overrides: - '' -

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">
8
 
<!ENTITY TIMESTAMP "2008-08-29">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2008-09-30">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
9
8
]>
10
9
 
11
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
  <refentryinfo>
13
12
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn</holder>
 
36
      <holder>Björn Påhlsson</holder>
37
37
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
38
    <xi:include href="../legalnotice.xml"/>
61
39
  </refentryinfo>
62
 
 
 
40
  
63
41
  <refmeta>
64
42
    <refentrytitle>&COMMANDNAME;</refentrytitle>
65
43
    <manvolnum>8mandos</manvolnum>
68
46
  <refnamediv>
69
47
    <refname><command>&COMMANDNAME;</command></refname>
70
48
    <refpurpose>
71
 
      Client for mandos
 
49
      Client for <application>Mandos</application>
72
50
    </refpurpose>
73
51
  </refnamediv>
74
 
 
 
52
  
75
53
  <refsynopsisdiv>
76
54
    <cmdsynopsis>
77
55
      <command>&COMMANDNAME;</command>
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>    
 
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>
99
116
  </refsynopsisdiv>
100
 
 
 
117
  
101
118
  <refsect1 id="description">
102
119
    <title>DESCRIPTION</title>
103
120
    <para>
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>  
 
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>
111
151
  
112
152
  <refsect1 id="options">
113
153
    <title>OPTIONS</title>
114
154
    <para>
115
 
      Commonly not invoked as command lines but from configuration
116
 
      file of plugin runner.
 
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.
117
162
    </para>
118
 
 
 
163
    
119
164
    <variablelist>
120
165
      <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>            
 
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>
225
298
    </variablelist>
226
299
  </refsect1>
227
 
 
 
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
  
228
324
  <refsect1 id="exit_status">
229
325
    <title>EXIT STATUS</title>
230
326
    <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.
231
334
    </para>
232
335
  </refsect1>
233
 
 
 
336
  
234
337
  <refsect1 id="environment">
235
338
    <title>ENVIRONMENT</title>
236
339
    <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>.
237
344
    </para>
238
 
  </refsect1>  
239
 
 
 
345
  </refsect1>
 
346
  
240
347
  <refsect1 id="file">
241
348
    <title>FILES</title>
242
 
    <para>
243
 
    </para>
244
 
  </refsect1>  
245
 
  
246
 
  <refsect1 id="bugs">
247
 
    <title>BUGS</title>
248
 
    <para>
249
 
    </para>
250
 
  </refsect1>  
251
 
 
 
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
  
252
373
  <refsect1 id="example">
253
374
    <title>EXAMPLE</title>
254
375
    <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>.
255
380
    </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>
256
426
  </refsect1>
257
 
 
 
427
  
258
428
  <refsect1 id="security">
259
429
    <title>SECURITY</title>
260
430
    <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.
261
472
    </para>
262
473
  </refsect1>
263
 
 
 
474
  
264
475
  <refsect1 id="see_also">
265
476
    <title>SEE ALSO</title>
266
477
    <para>
 
478
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
479
      <manvolnum>8</manvolnum></citerefentry>,
 
480
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
481
      <manvolnum>5</manvolnum></citerefentry>,
267
482
      <citerefentry><refentrytitle>mandos</refentrytitle>
268
483
      <manvolnum>8</manvolnum></citerefentry>,
269
484
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
271
486
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
272
487
      <manvolnum>8mandos</manvolnum></citerefentry>
273
488
    </para>
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>
 
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>
310
604
  </refsect1>
311
 
 
312
605
</refentry>
 
606
 
313
607
<!-- Local Variables: -->
314
608
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
315
609
<!-- time-stamp-end: "[\"']>" -->