/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 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
62
62
      </group>
63
63
      <sbr/>
64
64
      <group>
 
65
        <arg choice="plain"><option>--keydir
 
66
        <replaceable>DIRECTORY</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-d
 
68
        <replaceable>DIRECTORY</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
65
72
        <arg choice="plain"><option>--interface
66
73
        <replaceable>NAME</replaceable></option></arg>
67
74
        <arg choice="plain"><option>-i
121
128
      communicates with <citerefentry><refentrytitle
122
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
123
130
      to get a password.  It uses IPv6 link-local addresses to get
124
 
      network connectivity, Zeroconf to find servers, and TLS with an
125
 
      OpenPGP key to ensure authenticity and confidentiality.  It
 
131
      network connectivity, Zeroconf to find the server, and TLS with
 
132
      an OpenPGP key to ensure authenticity and confidentiality.  It
126
133
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is recieved.
 
134
      receives a satisfactory reply.
128
135
    </para>
129
136
    <para>
130
137
      This program is not meant to be run directly; it is really meant
184
191
      </varlistentry>
185
192
      
186
193
      <varlistentry>
 
194
        <term><option>--keydir=<replaceable
 
195
        >DIRECTORY</replaceable></option></term>
 
196
        <term><option>-d
 
197
        <replaceable>DIRECTORY</replaceable></option></term>
 
198
        <listitem>
 
199
          <para>
 
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).
 
205
          </para>
 
206
        </listitem>
 
207
      </varlistentry>
 
208
 
 
209
      <varlistentry>
187
210
        <term><option>--interface=
188
211
        <replaceable>NAME</replaceable></option></term>
189
212
        <term><option>-i
194
217
            Mandos servers to connect to.  The default it
195
218
            <quote><literal>eth0</literal></quote>.
196
219
          </para>
197
 
          <para>
198
 
            If the <option>--connect</option> option is used, this
199
 
            specifies the interface to use to connect to the address
200
 
            given.
201
 
          </para>
202
220
        </listitem>
203
221
      </varlistentry>
204
222
      
209
227
        <replaceable>FILE</replaceable></option></term>
210
228
        <listitem>
211
229
          <para>
212
 
            OpenPGP public key file name.  The default name is
213
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
214
 
            ></quote>.
 
230
            OpenPGP public key file base name.  This will be combined
 
231
            with the directory from the <option>--keydir</option>
 
232
            option to form an absolute file name.  The default name is
 
233
            <quote><literal>pubkey.txt</literal></quote>.
215
234
          </para>
216
235
        </listitem>
217
236
      </varlistentry>
223
242
        <replaceable>FILE</replaceable></option></term>
224
243
        <listitem>
225
244
          <para>
226
 
            OpenPGP secret key file name.  The default name is
227
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
228
 
            ></quote>.
 
245
            OpenPGP secret key file base name.  This will be combined
 
246
            with the directory from the <option>--keydir</option>
 
247
            option to form an absolute file name.  The default name is
 
248
            <quote><literal>seckey.txt</literal></quote>.
229
249
          </para>
230
250
        </listitem>
231
251
      </varlistentry>
309
329
    <para>
310
330
      This program could, theoretically, be used as a keyscript in
311
331
      <filename>/etc/crypttab</filename>, but it would then be
312
 
      impossible to enter a password for the encrypted root disk at
313
 
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
315
 
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallell to this one by the plugin runner.
 
332
      impossible to enter the encrypted root disk password at the
 
333
      console, since this program does not read from the console at
 
334
      all.  This is why a separate plugin does that, which will be run
 
335
      in parallell to this one.
318
336
    </para>
319
337
  </refsect1>
320
338
  
326
344
      successfully decrypted and output on standard output.  The
327
345
      program will exit with a non-zero exit status only if a critical
328
346
      error occurs.  Otherwise, it will forever connect to new
329
 
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
347
      <application>Mandosservers</application> servers as they appear,
 
348
      trying to get a decryptable password.
331
349
    </para>
332
350
  </refsect1>
333
351
  
343
361
  
344
362
  <refsect1 id="file">
345
363
    <title>FILES</title>
346
 
    <variablelist>
347
 
      <varlistentry>
348
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
349
 
        ></term>
350
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
351
 
        ></term>
352
 
        <listitem>
353
 
          <para>
354
 
            OpenPGP public and private key files, in <quote>ASCII
355
 
            Armor</quote> format.  These are the default file names,
356
 
            they can be changed with the <option>--pubkey</option> and
357
 
            <option>--seckey</option> options.
358
 
          </para>
359
 
        </listitem>
360
 
      </varlistentry>
361
 
    </variablelist>
 
364
    <para>
 
365
    </para>
362
366
  </refsect1>
363
367
  
364
 
<!--   <refsect1 id="bugs"> -->
365
 
<!--     <title>BUGS</title> -->
366
 
<!--     <para> -->
367
 
<!--     </para> -->
368
 
<!--   </refsect1> -->
 
368
  <refsect1 id="bugs">
 
369
    <title>BUGS</title>
 
370
    <para>
 
371
    </para>
 
372
  </refsect1>
369
373
 
370
374
  <refsect1 id="example">
371
375
    <title>EXAMPLE</title>
372
376
    <para>
373
 
      Note that normally, command line options will not be given
374
 
      directly, but via options for the Mandos <citerefentry
375
 
      ><refentrytitle>plugin-runner</refentrytitle>
376
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
377
377
    </para>
378
 
    <informalexample>
379
 
      <para>
380
 
        Normal invocation needs no options, if the network interface
381
 
        is <quote>eth0</quote>:
382
 
      </para>
383
 
      <para>
384
 
        <userinput>&COMMANDNAME;</userinput>
385
 
      </para>
386
 
    </informalexample>
387
 
    <informalexample>
388
 
      <para>
389
 
        Search for Mandos servers on another interface:
390
 
      </para>
391
 
      <para>
392
 
        <!-- do not wrap this line -->
393
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
394
 
      </para>
395
 
    </informalexample>
396
 
    <informalexample>
397
 
      <para>
398
 
        Run in debug mode, and use a custom key:
399
 
      </para>
400
 
      <para>
401
 
 
402
 
<!-- do not wrap this line -->
403
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
404
 
 
405
 
      </para>
406
 
    </informalexample>
407
 
    <informalexample>
408
 
      <para>
409
 
        Run in debug mode, with a custom key, and do not use Zeroconf
410
 
        to locate a server; connect directly to the IPv6 address
411
 
        <quote><systemitem class="ipaddress"
412
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
413
 
        port 4711, using interface eth2:
414
 
      </para>
415
 
      <para>
416
 
 
417
 
<!-- do not wrap this line -->
418
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
419
 
 
420
 
      </para>
421
 
    </informalexample>
422
378
  </refsect1>
423
379
 
424
380
  <refsect1 id="security">
425
381
    <title>SECURITY</title>
426
382
    <para>
427
 
      This program is set-uid to root, but will switch back to the
428
 
      original (and presumably non-privileged) user and group after
429
 
      bringing up the network interface.
430
 
    </para>
431
 
    <para>
432
 
      To use this program for its intended purpose (see <xref
433
 
      linkend="purpose"/>), the password for the root file system will
434
 
      have to be given out to be stored in a server computer, after
435
 
      having been encrypted using an OpenPGP key.  This encrypted data
436
 
      which will be stored in a server can only be decrypted by the
437
 
      OpenPGP key, and the data will only be given out to those
438
 
      clients who can prove they actually have that key.  This key,
439
 
      however, is stored unencrypted on the client side in its initial
440
 
      <acronym>RAM</acronym> disk image file system.  This is normally
441
 
      readable by all, but this is normally fixed during installation
442
 
      of this program; file permissions are set so that no-one is able
443
 
      to read that file.
444
 
    </para>
445
 
    <para>
446
 
      The only remaining weak point is that someone with physical
447
 
      access to the client hard drive might turn off the client
448
 
      computer, read the OpenPGP keys directly from the hard drive,
449
 
      and communicate with the server.  The defense against this is
450
 
      that the server is supposed to notice the client disappearing
451
 
      and will stop giving out the encrypted data.  Therefore, it is
452
 
      important to set the timeout and checker interval values tightly
453
 
      on the server.  See <citerefentry><refentrytitle
454
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
455
 
    </para>
456
 
    <para>
457
 
      It will also help if the checker program on the server is
458
 
      configured to request something from the client which can not be
459
 
      spoofed by someone else on the network, unlike unencrypted
460
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
461
 
    </para>
462
 
    <para>
463
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
464
 
      have <application >Mandos</application> clients which dual-boot
465
 
      to another operating system which is <emphasis>not</emphasis>
466
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
467
 
      confidential.
468
383
    </para>
469
384
  </refsect1>
470
385
 
471
386
  <refsect1 id="see_also">
472
387
    <title>SEE ALSO</title>
473
388
    <para>
474
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
475
 
      <manvolnum>8</manvolnum></citerefentry>,
476
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
477
 
      <manvolnum>5</manvolnum></citerefentry>,
478
389
      <citerefentry><refentrytitle>mandos</refentrytitle>
479
390
      <manvolnum>8</manvolnum></citerefentry>,
480
391
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
482
393
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
483
394
      <manvolnum>8mandos</manvolnum></citerefentry>
484
395
    </para>
485
 
    <variablelist>
486
 
      <varlistentry>
487
 
        <term>
488
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
489
 
        </term>
490
 
        <listitem>
491
 
          <para>
492
 
            Zeroconf is the network protocol standard used for finding
493
 
            Mandos servers on the local network.
494
 
          </para>
495
 
        </listitem>
496
 
      </varlistentry>
497
 
      <varlistentry>
498
 
        <term>
499
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
500
 
        </term>
501
 
      <listitem>
502
 
        <para>
503
 
          Avahi is the library this program calls to find Zeroconf
504
 
          services.
505
 
        </para>
506
 
      </listitem>
507
 
      </varlistentry>
508
 
      <varlistentry>
509
 
        <term>
510
 
          <ulink url="http://www.gnu.org/software/gnutls/"
511
 
          >GnuTLS</ulink>
512
 
        </term>
513
 
      <listitem>
514
 
        <para>
515
 
          GnuTLS is the library this client uses to implement TLS for
516
 
          communicating securely with the server, and at the same time
517
 
          send the public OpenPGP key to the server.
518
 
        </para>
519
 
      </listitem>
520
 
      </varlistentry>
521
 
      <varlistentry>
522
 
        <term>
523
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
524
 
                 >GPGME</ulink>
525
 
        </term>
526
 
        <listitem>
527
 
          <para>
528
 
            GPGME is the library used to decrypt the OpenPGP data sent
529
 
            by the server.
530
 
          </para>
531
 
        </listitem>
532
 
      </varlistentry>
533
 
      <varlistentry>
534
 
        <term>
535
 
          RFC 4291: <citetitle>IP Version 6 Addressing
536
 
          Architecture</citetitle>
537
 
        </term>
538
 
        <listitem>
539
 
          <variablelist>
540
 
            <varlistentry>
541
 
              <term>Section 2.2: <citetitle>Text Representation of
542
 
              Addresses</citetitle></term>
543
 
              <listitem><para/></listitem>
544
 
            </varlistentry>
545
 
            <varlistentry>
546
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
547
 
              Address</citetitle></term>
548
 
              <listitem><para/></listitem>
549
 
            </varlistentry>
550
 
            <varlistentry>
551
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
552
 
            Addresses</citetitle></term>
553
 
            <listitem>
554
 
              <para>
555
 
                This client uses IPv6 link-local addresses, which are
556
 
                immediately usable since a link-local addresses is
557
 
                automatically assigned to a network interfaces when it
558
 
                is brought up.
559
 
              </para>
560
 
            </listitem>
561
 
            </varlistentry>
562
 
          </variablelist>
563
 
        </listitem>
564
 
      </varlistentry>
565
 
      <varlistentry>
566
 
        <term>
567
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
568
 
          Protocol Version 1.1</citetitle>
569
 
        </term>
570
 
      <listitem>
571
 
        <para>
572
 
          TLS 1.1 is the protocol implemented by GnuTLS.
573
 
        </para>
574
 
      </listitem>
575
 
      </varlistentry>
576
 
      <varlistentry>
577
 
        <term>
578
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
579
 
        </term>
580
 
      <listitem>
581
 
        <para>
582
 
          The data received from the server is binary encrypted
583
 
          OpenPGP data.
584
 
        </para>
585
 
      </listitem>
586
 
      </varlistentry>
587
 
      <varlistentry>
588
 
        <term>
589
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
590
 
          Security</citetitle>
591
 
        </term>
592
 
      <listitem>
593
 
        <para>
594
 
          This is implemented by GnuTLS and used by this program so
595
 
          that OpenPGP keys can be used.
596
 
        </para>
597
 
      </listitem>
598
 
      </varlistentry>
599
 
    </variablelist>
 
396
    <itemizedlist>
 
397
      <listitem><para>
 
398
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
399
      </para></listitem>
 
400
      
 
401
      <listitem><para>
 
402
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
403
      </para></listitem>
 
404
      
 
405
      <listitem><para>
 
406
        <ulink
 
407
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
408
      </para></listitem>
 
409
      
 
410
      <listitem><para>
 
411
        <ulink
 
412
        url="http://www.gnupg.org/related_software/gpgme/"
 
413
        >GPGME</ulink>
 
414
      </para></listitem>
 
415
      
 
416
      <listitem><para>
 
417
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
418
        Format</citetitle></citation>
 
419
      </para></listitem>
 
420
      
 
421
      <listitem><para>
 
422
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
423
        Transport Layer Security</citetitle></citation>
 
424
      </para></listitem>
 
425
      
 
426
      <listitem><para>
 
427
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
428
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
429
        Unicast Addresses</citation>
 
430
      </para></listitem>
 
431
    </itemizedlist>
600
432
  </refsect1>
601
433
 
602
434
</refentry>