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