/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-02 17:42:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902174253-p3wxrq7z6ccnv7fs
* plugins.d/password-request.c (main): Change default GnuTLS priority
                                       string to
                             "SECURE256":!CTYPE-X.509:+CTYPE-OPENPGP".

* plugins.d/password-request.xml (DESCRIPTION): Improve wording.
  (PURPOSE, OVERVIEW): New sections.
  (OPTIONS): Improved wording.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Commented out.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-09-03">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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 servers, and TLS with an
132
 
      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
133
133
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply or a TERM signal is recieved.
 
134
      receives a satisfactory reply.
135
135
    </para>
136
136
    <para>
137
137
      This program is not meant to be run directly; it is really meant
138
138
      to run as a plugin of the <application>Mandos</application>
139
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.
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn
 
141
      runs as a <quote>keyscript</quote> specified in the
 
142
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
143
      <manvolnum>5</manvolnum></citerefentry> file.
145
144
    </para>
146
145
  </refsect1>
147
146
  
155
154
    </para>
156
155
  </refsect1>
157
156
  
 
157
  <refsect1 id="overview">
 
158
    <title>OVERVIEW</title>
 
159
    <xi:include href="overview.xml"/>
 
160
    <para>
 
161
      This program is the client part.  It is a plugin started by
 
162
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
163
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
164
      an initial <acronym>RAM</acronym> disk environment.
 
165
    </para>
 
166
    <para>
 
167
      This program could, theoretically, be used as a keyscript in
 
168
      <filename>/etc/crypttab</filename>, but it would then be
 
169
      impossible to enter the encrypted root disk password at the
 
170
      console, since this program does not read from the console at
 
171
      all.  This is why a separate plugin does that, which will be run
 
172
      in parallell to this one.
 
173
    </para>
 
174
  </refsect1>
 
175
  
158
176
  <refsect1 id="options">
159
177
    <title>OPTIONS</title>
160
178
    <para>
170
188
    <variablelist>
171
189
      <varlistentry>
172
190
        <term><option>--connect=<replaceable
173
 
        >ADDRESS</replaceable><literal>:</literal><replaceable
 
191
        >IPADDR</replaceable><literal>:</literal><replaceable
174
192
        >PORT</replaceable></option></term>
175
193
        <term><option>-c
176
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
194
        <replaceable>IPADDR</replaceable><literal>:</literal
177
195
        ><replaceable>PORT</replaceable></option></term>
178
196
        <listitem>
179
197
          <para>
184
202
            assumed to separate the address from the port number.
185
203
          </para>
186
204
          <para>
187
 
            This option is normally only useful for testing and
188
 
            debugging.
 
205
            This option is normally only useful for debugging.
189
206
          </para>
190
207
        </listitem>
191
208
      </varlistentry>
217
234
            Mandos servers to connect to.  The default it
218
235
            <quote><literal>eth0</literal></quote>.
219
236
          </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>
225
237
        </listitem>
226
238
      </varlistentry>
227
239
      
232
244
        <replaceable>FILE</replaceable></option></term>
233
245
        <listitem>
234
246
          <para>
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
 
247
            OpenPGP public key file name.  This will be combined with
 
248
            the directory from the <option>--keydir</option> option to
 
249
            form an absolute file name.  The default name is
238
250
            <quote><literal>pubkey.txt</literal></quote>.
239
251
          </para>
240
252
        </listitem>
247
259
        <replaceable>FILE</replaceable></option></term>
248
260
        <listitem>
249
261
          <para>
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
 
262
            OpenPGP secret key file name.  This will be combined with
 
263
            the directory from the <option>--keydir</option> option to
 
264
            form an absolute file name.  The default name is
253
265
            <quote><literal>seckey.txt</literal></quote>.
254
266
          </para>
255
267
        </listitem>
259
271
        <term><option>--priority=<replaceable
260
272
        >STRING</replaceable></option></term>
261
273
        <listitem>
262
 
          <xi:include href="../mandos-options.xml"
263
 
                      xpointer="priority"/>
 
274
          <xi:include href="mandos-options.xml" xpointer="priority"/>
264
275
        </listitem>
265
276
      </varlistentry>
266
277
 
322
333
    </variablelist>
323
334
  </refsect1>
324
335
 
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 (<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.
343
 
    </para>
344
 
  </refsect1>
345
 
  
346
336
  <refsect1 id="exit_status">
347
337
    <title>EXIT STATUS</title>
348
338
    <para>
351
341
      successfully decrypted and output on standard output.  The
352
342
      program will exit with a non-zero exit status only if a critical
353
343
      error occurs.  Otherwise, it will forever connect to new
354
 
      <application>Mandos</application> servers as they appear, trying
355
 
      to get a decryptable password.
356
 
    </para>
357
 
  </refsect1>
358
 
  
359
 
  <refsect1 id="environment">
360
 
    <title>ENVIRONMENT</title>
361
 
    <para>
362
 
      This program does not use any environment variables, not even
363
 
      the ones provided by <citerefentry><refentrytitle
364
 
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
365
 
    </citerefentry>.
366
 
    </para>
367
 
  </refsect1>
368
 
  
369
 
  <refsect1 id="file">
370
 
    <title>FILES</title>
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>
387
 
  </refsect1>
388
 
  
389
 
<!--   <refsect1 id="bugs"> -->
390
 
<!--     <title>BUGS</title> -->
 
344
      <application>Mandosservers</application> servers as they appear,
 
345
      trying to get a decryptable password.
 
346
    </para>
 
347
  </refsect1>
 
348
  
 
349
<!--   <refsect1 id="environment"> -->
 
350
<!--     <title>ENVIRONMENT</title> -->
391
351
<!--     <para> -->
 
352
<!--       This program does not use any environment variables. -->
392
353
<!--     </para> -->
393
354
<!--   </refsect1> -->
 
355
  
 
356
  <refsect1 id="file">
 
357
    <title>FILES</title>
 
358
    <para>
 
359
    </para>
 
360
  </refsect1>
 
361
  
 
362
  <refsect1 id="bugs">
 
363
    <title>BUGS</title>
 
364
    <para>
 
365
    </para>
 
366
  </refsect1>
394
367
 
395
368
  <refsect1 id="example">
396
369
    <title>EXAMPLE</title>
397
370
    <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>.
402
371
    </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>
445
372
  </refsect1>
446
373
 
447
374
  <refsect1 id="security">
448
375
    <title>SECURITY</title>
449
376
    <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.
491
377
    </para>
492
378
  </refsect1>
493
379
 
494
380
  <refsect1 id="see_also">
495
381
    <title>SEE ALSO</title>
496
382
    <para>
497
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
498
 
      <manvolnum>8</manvolnum></citerefentry>,
499
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
500
 
      <manvolnum>5</manvolnum></citerefentry>,
501
383
      <citerefentry><refentrytitle>mandos</refentrytitle>
502
384
      <manvolnum>8</manvolnum></citerefentry>,
503
385
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
505
387
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
506
388
      <manvolnum>8mandos</manvolnum></citerefentry>
507
389
    </para>
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>
 
390
    <itemizedlist>
 
391
      <listitem><para>
 
392
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
393
      </para></listitem>
 
394
      
 
395
      <listitem><para>
 
396
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
397
      </para></listitem>
 
398
      
 
399
      <listitem><para>
 
400
        <ulink
 
401
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
402
      </para></listitem>
 
403
      
 
404
      <listitem><para>
 
405
        <ulink
 
406
        url="http://www.gnupg.org/related_software/gpgme/">
 
407
        GPGME</ulink>
 
408
      </para></listitem>
 
409
      
 
410
      <listitem><para>
 
411
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
412
        Format</citetitle></citation>
 
413
      </para></listitem>
 
414
      
 
415
      <listitem><para>
 
416
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
417
        Transport Layer Security</citetitle></citation>
 
418
      </para></listitem>
 
419
      
 
420
      <listitem><para>
 
421
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
422
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
423
        Unicast Addresses</citation>
 
424
      </para></listitem>
 
425
    </itemizedlist>
623
426
  </refsect1>
624
427
 
625
428
</refentry>