/mandos/trunk

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-20 00:35:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820003541-zxymabnc6yfj8y7t
* mandos-keygen.xml (SEE ALSO): Remove "and".

* mandos.conf.xml (SEE ALSO): New section.

* mandos.xml (SEE ALSO): Changed man page references to a comma-
                         separated list, as per man-pages(7).  Added
                         reference to sh(1).

Show diffs side-by-side

added added

removed removed

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