/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-18 03:50:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818035028-su31apqs2pv2147v
* mandos-keygen.xml: Removed <?xml-stylesheet>.  New entity
                     "&OVERVIEW;" referring to "overview.xml".
  (PURPOSE, OVERVIEW): New sections, same as in mandos(8).
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* mandos.xml (OPTIONS, CLIENTS): Slight wording change.

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