/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-09-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
124
124
  <refsect1 id="description">
125
125
    <title>DESCRIPTION</title>
126
126
    <para>
127
 
      <command>&COMMANDNAME;</command> is a mandos plugin that works
128
 
      like a client program that through avahi detects mandos servers,
129
 
      sets up a gnutls connect and request a encrypted password. Any
130
 
      passwords given is automaticly decrypted and passed to
131
 
      cryptsetup.
 
127
      <command>&COMMANDNAME;</command> is a client program that
 
128
      communicates with <citerefentry><refentrytitle
 
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 
130
      to get a password.  It uses IPv6 link-local addresses to get
 
131
      network connectivity, Zeroconf to find servers, and TLS with an
 
132
      OpenPGP key to ensure authenticity and confidentiality.  It
 
133
      keeps running, trying all servers on the network, until it
 
134
      receives a satisfactory reply or a TERM signal is recieved.
 
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.
132
155
    </para>
133
156
  </refsect1>
134
157
  
135
158
  <refsect1 id="options">
136
159
    <title>OPTIONS</title>
137
160
    <para>
138
 
      Commonly not invoked as command lines but from configuration
139
 
      file of plugin runner.
 
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.
140
168
    </para>
141
 
 
 
169
    
142
170
    <variablelist>
143
171
      <varlistentry>
144
172
        <term><option>--connect=<replaceable
145
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
173
        >ADDRESS</replaceable><literal>:</literal><replaceable
146
174
        >PORT</replaceable></option></term>
147
175
        <term><option>-c
148
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
176
        <replaceable>ADDRESS</replaceable><literal>:</literal
149
177
        ><replaceable>PORT</replaceable></option></term>
150
178
        <listitem>
151
179
          <para>
152
 
            Connect directly to a specified mandos server
 
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.
153
189
          </para>
154
190
        </listitem>
155
191
      </varlistentry>
156
 
 
 
192
      
157
193
      <varlistentry>
158
194
        <term><option>--keydir=<replaceable
159
195
        >DIRECTORY</replaceable></option></term>
161
197
        <replaceable>DIRECTORY</replaceable></option></term>
162
198
        <listitem>
163
199
          <para>
164
 
            Directory where the openpgp keyring is
 
200
            Directory to read the OpenPGP key files
 
201
            <filename>pubkey.txt</filename> and
 
202
            <filename>seckey.txt</filename> from.  The default is
 
203
            <filename>/conf/conf.d/mandos</filename> (in the initial
 
204
            <acronym>RAM</acronym> disk environment).
165
205
          </para>
166
206
        </listitem>
167
207
      </varlistentry>
173
213
        <replaceable>NAME</replaceable></option></term>
174
214
        <listitem>
175
215
          <para>
176
 
            Interface that Avahi will connect through
 
216
            Network interface that will be brought up and scanned for
 
217
            Mandos servers to connect to.  The default it
 
218
            <quote><literal>eth0</literal></quote>.
 
219
          </para>
 
220
          <para>
 
221
            If the <option>--connect</option> option is used, this
 
222
            specifies the interface to use to connect to the address
 
223
            given.
177
224
          </para>
178
225
        </listitem>
179
226
      </varlistentry>
180
 
 
 
227
      
181
228
      <varlistentry>
182
229
        <term><option>--pubkey=<replaceable
183
230
        >FILE</replaceable></option></term>
185
232
        <replaceable>FILE</replaceable></option></term>
186
233
        <listitem>
187
234
          <para>
188
 
            Public openpgp key for gnutls authentication
 
235
            OpenPGP public key file base name.  This will be combined
 
236
            with the directory from the <option>--keydir</option>
 
237
            option to form an absolute file name.  The default name is
 
238
            <quote><literal>pubkey.txt</literal></quote>.
189
239
          </para>
190
240
        </listitem>
191
241
      </varlistentry>
197
247
        <replaceable>FILE</replaceable></option></term>
198
248
        <listitem>
199
249
          <para>
200
 
            Secret OpenPGP key for GnuTLS authentication
 
250
            OpenPGP secret key file base name.  This will be combined
 
251
            with the directory from the <option>--keydir</option>
 
252
            option to form an absolute file name.  The default name is
 
253
            <quote><literal>seckey.txt</literal></quote>.
201
254
          </para>
202
255
        </listitem>
203
256
      </varlistentry>
206
259
        <term><option>--priority=<replaceable
207
260
        >STRING</replaceable></option></term>
208
261
        <listitem>
209
 
          <para>
210
 
            GnuTLS priority
211
 
          </para>
 
262
          <xi:include href="../mandos-options.xml"
 
263
                      xpointer="priority"/>
212
264
        </listitem>
213
265
      </varlistentry>
214
266
 
217
269
        >BITS</replaceable></option></term>
218
270
        <listitem>
219
271
          <para>
220
 
            DH bits to use in gnutls communication
 
272
            Sets the number of bits to use for the prime number in the
 
273
            TLS Diffie-Hellman key exchange.  Default is 1024.
221
274
          </para>
222
275
        </listitem>
223
276
      </varlistentry>
226
279
        <term><option>--debug</option></term>
227
280
        <listitem>
228
281
          <para>
229
 
            Debug mode
 
282
            Enable debug mode.  This will enable a lot of output to
 
283
            standard error about what the program is doing.  The
 
284
            program will still perform all other functions normally.
 
285
          </para>
 
286
          <para>
 
287
            It will also enable debug mode in the Avahi and GnuTLS
 
288
            libraries, making them print large amounts of debugging
 
289
            output.
230
290
          </para>
231
291
        </listitem>
232
292
      </varlistentry>
236
296
        <term><option>-?</option></term>
237
297
        <listitem>
238
298
          <para>
239
 
            Gives a help message
 
299
            Gives a help message about options and their meanings.
240
300
          </para>
241
301
        </listitem>
242
302
      </varlistentry>
245
305
        <term><option>--usage</option></term>
246
306
        <listitem>
247
307
          <para>
248
 
            Gives a short usage message
 
308
            Gives a short usage message.
249
309
          </para>
250
310
        </listitem>
251
311
      </varlistentry>
255
315
        <term><option>-V</option></term>
256
316
        <listitem>
257
317
          <para>
258
 
            Prints the program version
 
318
            Prints the program version.
259
319
          </para>
260
320
        </listitem>
261
321
      </varlistentry>
262
322
    </variablelist>
263
323
  </refsect1>
264
324
 
 
325
  <refsect1 id="overview">
 
326
    <title>OVERVIEW</title>
 
327
    <xi:include href="../overview.xml"/>
 
328
    <para>
 
329
      This program is the client part.  It is a plugin started by
 
330
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
331
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
332
      an initial <acronym>RAM</acronym> disk environment.
 
333
    </para>
 
334
    <para>
 
335
      This program could, theoretically, be used as a keyscript in
 
336
      <filename>/etc/crypttab</filename>, but it would then be
 
337
      impossible to enter a password for the encrypted root disk at
 
338
      the console, since this program does not read from the console
 
339
      at all.  This is why a separate plugin does that, which will be
 
340
      run in parallell to this one by the plugin runner.
 
341
    </para>
 
342
  </refsect1>
 
343
  
265
344
  <refsect1 id="exit_status">
266
345
    <title>EXIT STATUS</title>
267
346
    <para>
 
347
      This program will exit with a successful (zero) exit status if a
 
348
      server could be found and the password received from it could be
 
349
      successfully decrypted and output on standard output.  The
 
350
      program will exit with a non-zero exit status only if a critical
 
351
      error occurs.  Otherwise, it will forever connect to new
 
352
      <application>Mandos</application> servers as they appear, trying
 
353
      to get a decryptable password.
268
354
    </para>
269
355
  </refsect1>
270
 
 
 
356
  
271
357
  <refsect1 id="environment">
272
358
    <title>ENVIRONMENT</title>
273
359
    <para>
 
360
      This program does not use any environment variables, not even
 
361
      the ones provided by <citerefentry><refentrytitle
 
362
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
363
    </citerefentry>.
274
364
    </para>
275
365
  </refsect1>
276
 
 
 
366
  
277
367
  <refsect1 id="file">
278
368
    <title>FILES</title>
279
 
    <para>
280
 
    </para>
 
369
    <variablelist>
 
370
      <varlistentry>
 
371
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
372
        ></term>
 
373
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
374
        ></term>
 
375
        <listitem>
 
376
          <para>
 
377
            OpenPGP public and private key files, in <quote>ASCII
 
378
            Armor</quote> format.  These are the default file names,
 
379
            they can be changed with the <option>--pubkey</option> and
 
380
            <option>--seckey</option> options.
 
381
          </para>
 
382
        </listitem>
 
383
      </varlistentry>
 
384
    </variablelist>
281
385
  </refsect1>
282
386
  
283
 
  <refsect1 id="bugs">
284
 
    <title>BUGS</title>
285
 
    <para>
286
 
    </para>
287
 
  </refsect1>
 
387
<!--   <refsect1 id="bugs"> -->
 
388
<!--     <title>BUGS</title> -->
 
389
<!--     <para> -->
 
390
<!--     </para> -->
 
391
<!--   </refsect1> -->
288
392
 
289
393
  <refsect1 id="example">
290
394
    <title>EXAMPLE</title>
291
395
    <para>
 
396
      Note that normally, command line options will not be given
 
397
      directly, but via options for the Mandos <citerefentry
 
398
      ><refentrytitle>plugin-runner</refentrytitle>
 
399
      <manvolnum>8mandos</manvolnum></citerefentry>.
292
400
    </para>
 
401
    <informalexample>
 
402
      <para>
 
403
        Normal invocation needs no options, if the network interface
 
404
        is <quote>eth0</quote>:
 
405
      </para>
 
406
      <para>
 
407
        <userinput>&COMMANDNAME;</userinput>
 
408
      </para>
 
409
    </informalexample>
 
410
    <informalexample>
 
411
      <para>
 
412
        Search for Mandos servers on another interface:
 
413
      </para>
 
414
      <para>
 
415
        <!-- do not wrap this line -->
 
416
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
417
      </para>
 
418
    </informalexample>
 
419
    <informalexample>
 
420
      <para>
 
421
        Run in debug mode, and use a custom key directory:
 
422
      </para>
 
423
      <para>
 
424
        <!-- do not wrap this line -->
 
425
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
426
      </para>
 
427
    </informalexample>
 
428
    <informalexample>
 
429
      <para>
 
430
        Run in debug mode, with a custom key directory, and do not use
 
431
        Zeroconf to locate a server; connect directly to the IPv6
 
432
        address <quote><systemitem class="ipaddress"
 
433
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
434
        port 4711, using interface eth2:
 
435
      </para>
 
436
      <para>
 
437
 
 
438
<!-- do not wrap this line -->
 
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
440
 
 
441
      </para>
 
442
    </informalexample>
293
443
  </refsect1>
294
444
 
295
445
  <refsect1 id="security">
324
474
      
325
475
      <listitem><para>
326
476
        <ulink
327
 
        url="http://www.gnupg.org/related_software/gpgme/">
328
 
        GPGME</ulink>
 
477
        url="http://www.gnupg.org/related_software/gpgme/"
 
478
        >GPGME</ulink>
329
479
      </para></listitem>
330
480
      
331
481
      <listitem><para>