/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

merge

Show diffs side-by-side

added added

removed removed

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