/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-30 11:39:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113954-sbvgeq7z0wkdvz17
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
* mandos.xml (ENVIRONMENT): - '' -

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