/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 05:08:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050824-x38ghzu01vkfrpb4
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
  (EXIT STATUS): Fixed typos.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2009-02-09">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
4
<!ENTITY VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
37
    <xi:include href="../legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8mandos</manvolnum>
47
45
  <refnamediv>
48
46
    <refname><command>&COMMANDNAME;</command></refname>
49
47
    <refpurpose>
50
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
57
55
      <group>
58
56
        <arg choice="plain"><option>--connect
59
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
60
58
        ><replaceable>PORT</replaceable></option></arg>
61
59
        <arg choice="plain"><option>-c
62
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
63
61
        ><replaceable>PORT</replaceable></option></arg>
64
62
      </group>
65
63
      <sbr/>
66
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>
67
72
        <arg choice="plain"><option>--interface
68
73
        <replaceable>NAME</replaceable></option></arg>
69
74
        <arg choice="plain"><option>-i
93
98
      </arg>
94
99
      <sbr/>
95
100
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
101
        <option>--debug</option>
101
102
      </arg>
102
103
    </cmdsynopsis>
119
120
      </group>
120
121
    </cmdsynopsis>
121
122
  </refsynopsisdiv>
122
 
  
 
123
 
123
124
  <refsect1 id="description">
124
125
    <title>DESCRIPTION</title>
125
126
    <para>
126
127
      <command>&COMMANDNAME;</command> is a client program that
127
128
      communicates with <citerefentry><refentrytitle
128
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
 
      to get a password.  In slightly more detail, this client program
130
 
      brings up a network interface, uses the interface’s IPv6
131
 
      link-local address to get network connectivity, uses Zeroconf to
132
 
      find servers on the local network, and communicates with servers
133
 
      using TLS with an OpenPGP key to ensure authenticity and
134
 
      confidentiality.  This client program keeps running, trying all
135
 
      servers on the network, until it receives a satisfactory reply
136
 
      or a TERM signal is received.  If no servers are found, or after
137
 
      all servers have been tried, it waits indefinitely for new
138
 
      servers to appear.
 
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
 
133
      keeps running, trying all servers on the network, until it
 
134
      receives a satisfactory reply.
139
135
    </para>
140
136
    <para>
141
137
      This program is not meant to be run directly; it is really meant
195
191
      </varlistentry>
196
192
      
197
193
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
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>
 
210
        <term><option>--interface=
 
211
        <replaceable>NAME</replaceable></option></term>
200
212
        <term><option>-i
201
213
        <replaceable>NAME</replaceable></option></term>
202
214
        <listitem>
203
215
          <para>
204
216
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is the empty
206
 
            string, which will automatically choose an appropriate
207
 
            interface.
208
 
          </para>
209
 
          <para>
210
 
            If the <option>--connect</option> option is used, this
211
 
            specifies the interface to use to connect to the address
212
 
            given.
213
 
          </para>
214
 
          <para>
215
 
            Note that since this program will normally run in the
216
 
            initial RAM disk environment, the interface must be an
217
 
            interface which exists at that stage.  Thus, the interface
218
 
            can not be a pseudo-interface such as <quote>br0</quote>
219
 
            or <quote>tun0</quote>; such interfaces will not exist
220
 
            until much later in the boot process, and can not be used
221
 
            by this program.
222
 
          </para>
223
 
          <para>
224
 
            <replaceable>NAME</replaceable> can be the string
225
 
            <quote><literal>none</literal></quote>; this will not use
226
 
            any specific interface, and will not bring up an interface
227
 
            on startup.  This is not recommended, and only meant for
228
 
            advanced users.
 
217
            Mandos servers to connect to.  The default it
 
218
            <quote><literal>eth0</literal></quote>.
229
219
          </para>
230
220
        </listitem>
231
221
      </varlistentry>
237
227
        <replaceable>FILE</replaceable></option></term>
238
228
        <listitem>
239
229
          <para>
240
 
            OpenPGP public key file name.  The default name is
241
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
242
 
            ></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>.
243
234
          </para>
244
235
        </listitem>
245
236
      </varlistentry>
246
 
      
 
237
 
247
238
      <varlistentry>
248
239
        <term><option>--seckey=<replaceable
249
240
        >FILE</replaceable></option></term>
251
242
        <replaceable>FILE</replaceable></option></term>
252
243
        <listitem>
253
244
          <para>
254
 
            OpenPGP secret key file name.  The default name is
255
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
256
 
            ></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>.
257
249
          </para>
258
250
        </listitem>
259
251
      </varlistentry>
266
258
                      xpointer="priority"/>
267
259
        </listitem>
268
260
      </varlistentry>
269
 
      
 
261
 
270
262
      <varlistentry>
271
263
        <term><option>--dh-bits=<replaceable
272
264
        >BITS</replaceable></option></term>
277
269
          </para>
278
270
        </listitem>
279
271
      </varlistentry>
280
 
 
281
 
      <varlistentry>
282
 
        <term><option>--delay=<replaceable
283
 
        >SECONDS</replaceable></option></term>
284
 
        <listitem>
285
 
          <para>
286
 
            After bringing the network interface up, the program waits
287
 
            for the interface to arrive in a <quote>running</quote>
288
 
            state before proceeding.  During this time, the kernel log
289
 
            level will be lowered to reduce clutter on the system
290
 
            console, alleviating any other plugins which might be
291
 
            using the system console.  This option sets the upper
292
 
            limit of seconds to wait.  The default is 2.5 seconds.
293
 
          </para>
294
 
        </listitem>
295
 
      </varlistentry>
296
272
      
297
273
      <varlistentry>
298
274
        <term><option>--debug</option></term>
328
304
          </para>
329
305
        </listitem>
330
306
      </varlistentry>
331
 
      
 
307
 
332
308
      <varlistentry>
333
309
        <term><option>--version</option></term>
334
310
        <term><option>-V</option></term>
340
316
      </varlistentry>
341
317
    </variablelist>
342
318
  </refsect1>
343
 
  
 
319
 
344
320
  <refsect1 id="overview">
345
321
    <title>OVERVIEW</title>
346
322
    <xi:include href="../overview.xml"/>
355
331
      <filename>/etc/crypttab</filename>, but it would then be
356
332
      impossible to enter a password for the encrypted root disk at
357
333
      the console, since this program does not read from the console
358
 
      at all.  This is why a separate plugin runner (<citerefentry>
359
 
      <refentrytitle>plugin-runner</refentrytitle>
360
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
361
 
      both this program and others in in parallel,
362
 
      <emphasis>one</emphasis> of which will prompt for passwords on
363
 
      the system console.
 
334
      at all.  This is why a separate plugin does that, which will be
 
335
      run in parallell to this one by the plugin runner.
364
336
    </para>
365
337
  </refsect1>
366
338
  
373
345
      program will exit with a non-zero exit status only if a critical
374
346
      error occurs.  Otherwise, it will forever connect to new
375
347
      <application>Mandos</application> servers as they appear, trying
376
 
      to get a decryptable password and print it.
 
348
      to get a decryptable password.
377
349
    </para>
378
350
  </refsect1>
379
351
  
387
359
    </para>
388
360
  </refsect1>
389
361
  
390
 
  <refsect1 id="files">
 
362
  <refsect1 id="file">
391
363
    <title>FILES</title>
392
 
    <variablelist>
393
 
      <varlistentry>
394
 
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
395
 
        ></term>
396
 
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
397
 
        ></term>
398
 
        <listitem>
399
 
          <para>
400
 
            OpenPGP public and private key files, in <quote>ASCII
401
 
            Armor</quote> format.  These are the default file names,
402
 
            they can be changed with the <option>--pubkey</option> and
403
 
            <option>--seckey</option> options.
404
 
          </para>
405
 
        </listitem>
406
 
      </varlistentry>
407
 
    </variablelist>
408
 
  </refsect1>
409
 
  
410
 
<!--   <refsect1 id="bugs"> -->
411
 
<!--     <title>BUGS</title> -->
412
 
<!--     <para> -->
413
 
<!--     </para> -->
414
 
<!--   </refsect1> -->
415
 
  
 
364
    <para>
 
365
    </para>
 
366
  </refsect1>
 
367
  
 
368
  <refsect1 id="bugs">
 
369
    <title>BUGS</title>
 
370
    <para>
 
371
    </para>
 
372
  </refsect1>
 
373
 
416
374
  <refsect1 id="example">
417
375
    <title>EXAMPLE</title>
418
376
    <para>
419
 
      Note that normally, command line options will not be given
420
 
      directly, but via options for the Mandos <citerefentry
421
 
      ><refentrytitle>plugin-runner</refentrytitle>
422
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
423
377
    </para>
424
 
    <informalexample>
425
 
      <para>
426
 
        Normal invocation needs no options, if the network interface
427
 
        is <quote>eth0</quote>:
428
 
      </para>
429
 
      <para>
430
 
        <userinput>&COMMANDNAME;</userinput>
431
 
      </para>
432
 
    </informalexample>
433
 
    <informalexample>
434
 
      <para>
435
 
        Search for Mandos servers (and connect to them) using another
436
 
        interface:
437
 
      </para>
438
 
      <para>
439
 
        <!-- do not wrap this line -->
440
 
        <userinput>&COMMANDNAME; --interface eth1</userinput>
441
 
      </para>
442
 
    </informalexample>
443
 
    <informalexample>
444
 
      <para>
445
 
        Run in debug mode, and use a custom key:
446
 
      </para>
447
 
      <para>
448
 
 
449
 
<!-- do not wrap this line -->
450
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
451
 
 
452
 
      </para>
453
 
    </informalexample>
454
 
    <informalexample>
455
 
      <para>
456
 
        Run in debug mode, with a custom key, and do not use Zeroconf
457
 
        to locate a server; connect directly to the IPv6 link-local
458
 
        address <quote><systemitem class="ipaddress"
459
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
460
 
        using interface eth2:
461
 
      </para>
462
 
      <para>
463
 
 
464
 
<!-- do not wrap this line -->
465
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
466
 
 
467
 
      </para>
468
 
    </informalexample>
469
378
  </refsect1>
470
 
  
 
379
 
471
380
  <refsect1 id="security">
472
381
    <title>SECURITY</title>
473
382
    <para>
474
 
      This program is set-uid to root, but will switch back to the
475
 
      original (and presumably non-privileged) user and group after
476
 
      bringing up the network interface.
477
 
    </para>
478
 
    <para>
479
 
      To use this program for its intended purpose (see <xref
480
 
      linkend="purpose"/>), the password for the root file system will
481
 
      have to be given out to be stored in a server computer, after
482
 
      having been encrypted using an OpenPGP key.  This encrypted data
483
 
      which will be stored in a server can only be decrypted by the
484
 
      OpenPGP key, and the data will only be given out to those
485
 
      clients who can prove they actually have that key.  This key,
486
 
      however, is stored unencrypted on the client side in its initial
487
 
      <acronym>RAM</acronym> disk image file system.  This is normally
488
 
      readable by all, but this is normally fixed during installation
489
 
      of this program; file permissions are set so that no-one is able
490
 
      to read that file.
491
 
    </para>
492
 
    <para>
493
 
      The only remaining weak point is that someone with physical
494
 
      access to the client hard drive might turn off the client
495
 
      computer, read the OpenPGP keys directly from the hard drive,
496
 
      and communicate with the server.  To safeguard against this, the
497
 
      server is supposed to notice the client disappearing and stop
498
 
      giving out the encrypted data.  Therefore, it is important to
499
 
      set the timeout and checker interval values tightly on the
500
 
      server.  See <citerefentry><refentrytitle
501
 
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
502
 
    </para>
503
 
    <para>
504
 
      It will also help if the checker program on the server is
505
 
      configured to request something from the client which can not be
506
 
      spoofed by someone else on the network, unlike unencrypted
507
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
508
 
    </para>
509
 
    <para>
510
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
511
 
      have <application >Mandos</application> clients which dual-boot
512
 
      to another operating system which is <emphasis>not</emphasis>
513
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
514
 
      confidential.
515
383
    </para>
516
384
  </refsect1>
517
 
  
 
385
 
518
386
  <refsect1 id="see_also">
519
387
    <title>SEE ALSO</title>
520
388
    <para>
521
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
522
 
      <manvolnum>8</manvolnum></citerefentry>,
523
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
524
 
      <manvolnum>5</manvolnum></citerefentry>,
525
389
      <citerefentry><refentrytitle>mandos</refentrytitle>
526
390
      <manvolnum>8</manvolnum></citerefentry>,
527
391
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
529
393
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
530
394
      <manvolnum>8mandos</manvolnum></citerefentry>
531
395
    </para>
532
 
    <variablelist>
533
 
      <varlistentry>
534
 
        <term>
535
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
536
 
        </term>
537
 
        <listitem>
538
 
          <para>
539
 
            Zeroconf is the network protocol standard used for finding
540
 
            Mandos servers on the local network.
541
 
          </para>
542
 
        </listitem>
543
 
      </varlistentry>
544
 
      <varlistentry>
545
 
        <term>
546
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
547
 
        </term>
548
 
      <listitem>
549
 
        <para>
550
 
          Avahi is the library this program calls to find Zeroconf
551
 
          services.
552
 
        </para>
553
 
      </listitem>
554
 
      </varlistentry>
555
 
      <varlistentry>
556
 
        <term>
557
 
          <ulink url="http://www.gnu.org/software/gnutls/"
558
 
          >GnuTLS</ulink>
559
 
        </term>
560
 
      <listitem>
561
 
        <para>
562
 
          GnuTLS is the library this client uses to implement TLS for
563
 
          communicating securely with the server, and at the same time
564
 
          send the public OpenPGP key to the server.
565
 
        </para>
566
 
      </listitem>
567
 
      </varlistentry>
568
 
      <varlistentry>
569
 
        <term>
570
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
571
 
                 >GPGME</ulink>
572
 
        </term>
573
 
        <listitem>
574
 
          <para>
575
 
            GPGME is the library used to decrypt the OpenPGP data sent
576
 
            by the server.
577
 
          </para>
578
 
        </listitem>
579
 
      </varlistentry>
580
 
      <varlistentry>
581
 
        <term>
582
 
          RFC 4291: <citetitle>IP Version 6 Addressing
583
 
          Architecture</citetitle>
584
 
        </term>
585
 
        <listitem>
586
 
          <variablelist>
587
 
            <varlistentry>
588
 
              <term>Section 2.2: <citetitle>Text Representation of
589
 
              Addresses</citetitle></term>
590
 
              <listitem><para/></listitem>
591
 
            </varlistentry>
592
 
            <varlistentry>
593
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
594
 
              Address</citetitle></term>
595
 
              <listitem><para/></listitem>
596
 
            </varlistentry>
597
 
            <varlistentry>
598
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
599
 
            Addresses</citetitle></term>
600
 
            <listitem>
601
 
              <para>
602
 
                This client uses IPv6 link-local addresses, which are
603
 
                immediately usable since a link-local addresses is
604
 
                automatically assigned to a network interfaces when it
605
 
                is brought up.
606
 
              </para>
607
 
            </listitem>
608
 
            </varlistentry>
609
 
          </variablelist>
610
 
        </listitem>
611
 
      </varlistentry>
612
 
      <varlistentry>
613
 
        <term>
614
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
615
 
          Protocol Version 1.1</citetitle>
616
 
        </term>
617
 
      <listitem>
618
 
        <para>
619
 
          TLS 1.1 is the protocol implemented by GnuTLS.
620
 
        </para>
621
 
      </listitem>
622
 
      </varlistentry>
623
 
      <varlistentry>
624
 
        <term>
625
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
626
 
        </term>
627
 
      <listitem>
628
 
        <para>
629
 
          The data received from the server is binary encrypted
630
 
          OpenPGP data.
631
 
        </para>
632
 
      </listitem>
633
 
      </varlistentry>
634
 
      <varlistentry>
635
 
        <term>
636
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
637
 
          Security</citetitle>
638
 
        </term>
639
 
      <listitem>
640
 
        <para>
641
 
          This is implemented by GnuTLS and used by this program so
642
 
          that OpenPGP keys can be used.
643
 
        </para>
644
 
      </listitem>
645
 
      </varlistentry>
646
 
    </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>
647
432
  </refsect1>
 
433
 
648
434
</refentry>
649
 
 
650
435
<!-- Local Variables: -->
651
436
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
652
437
<!-- time-stamp-end: "[\"']>" -->