/mandos/release

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

« back to all changes in this revision

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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

Show diffs side-by-side

added added

removed removed

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