/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 17:11:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903171132-usevhlf0gi9rxqc3
* plugins.d/password-request.c (init_gnutls_global): Improved wording
                                                     in debug message.
                                                     Bug fix: Make
                                                     debug message
                                                     print to stderr,
                                                     not stdout.

* plugins.d/password-request.xml (SECURITY): Add text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
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
4
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="../legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
  
 
39
 
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8mandos</manvolnum>
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
  
 
51
 
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group>
56
56
        <arg choice="plain"><option>--connect
57
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
58
58
        ><replaceable>PORT</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-c
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
61
61
        ><replaceable>PORT</replaceable></option></arg>
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
113
120
      </group>
114
121
    </cmdsynopsis>
115
122
  </refsynopsisdiv>
116
 
  
 
123
 
117
124
  <refsect1 id="description">
118
125
    <title>DESCRIPTION</title>
119
126
    <para>
124
131
      network connectivity, Zeroconf to find servers, and TLS with an
125
132
      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 received.
 
134
      receives a satisfactory reply or a TERM signal is recieved.
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
209
232
        <replaceable>FILE</replaceable></option></term>
210
233
        <listitem>
211
234
          <para>
212
 
            OpenPGP public key file name.  The default name is
213
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
214
 
            ></quote>.
 
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>.
215
239
          </para>
216
240
        </listitem>
217
241
      </varlistentry>
218
 
      
 
242
 
219
243
      <varlistentry>
220
244
        <term><option>--seckey=<replaceable
221
245
        >FILE</replaceable></option></term>
223
247
        <replaceable>FILE</replaceable></option></term>
224
248
        <listitem>
225
249
          <para>
226
 
            OpenPGP secret key file name.  The default name is
227
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
228
 
            ></quote>.
 
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>.
229
254
          </para>
230
255
        </listitem>
231
256
      </varlistentry>
238
263
                      xpointer="priority"/>
239
264
        </listitem>
240
265
      </varlistentry>
241
 
      
 
266
 
242
267
      <varlistentry>
243
268
        <term><option>--dh-bits=<replaceable
244
269
        >BITS</replaceable></option></term>
284
309
          </para>
285
310
        </listitem>
286
311
      </varlistentry>
287
 
      
 
312
 
288
313
      <varlistentry>
289
314
        <term><option>--version</option></term>
290
315
        <term><option>-V</option></term>
296
321
      </varlistentry>
297
322
    </variablelist>
298
323
  </refsect1>
299
 
  
 
324
 
300
325
  <refsect1 id="overview">
301
326
    <title>OVERVIEW</title>
302
327
    <xi:include href="../overview.xml"/>
311
336
      <filename>/etc/crypttab</filename>, but it would then be
312
337
      impossible to enter a password for the encrypted root disk at
313
338
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin runner (<citerefentry>
315
 
      <refentrytitle>plugin-runner</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
 
      both this program and others in in parallel,
318
 
      <emphasis>one</emphasis> of which will prompt for passwords on
319
 
      the system 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.
320
341
    </para>
321
342
  </refsect1>
322
343
  
329
350
      program will exit with a non-zero exit status only if a critical
330
351
      error occurs.  Otherwise, it will forever connect to new
331
352
      <application>Mandos</application> servers as they appear, trying
332
 
      to get a decryptable password and print it.
 
353
      to get a decryptable password.
333
354
    </para>
334
355
  </refsect1>
335
356
  
368
389
<!--     <para> -->
369
390
<!--     </para> -->
370
391
<!--   </refsect1> -->
371
 
  
 
392
 
372
393
  <refsect1 id="example">
373
394
    <title>EXAMPLE</title>
374
395
    <para>
388
409
    </informalexample>
389
410
    <informalexample>
390
411
      <para>
391
 
        Search for Mandos servers (and connect to them) using another
392
 
        interface:
 
412
        Search for Mandos servers on another interface:
393
413
      </para>
394
414
      <para>
395
415
        <!-- do not wrap this line -->
398
418
    </informalexample>
399
419
    <informalexample>
400
420
      <para>
401
 
        Run in debug mode, and use a custom key:
 
421
        Run in debug mode, and use a custom key directory:
402
422
      </para>
403
423
      <para>
404
 
 
405
 
<!-- do not wrap this line -->
406
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
407
 
 
 
424
        <!-- do not wrap this line -->
 
425
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
408
426
      </para>
409
427
    </informalexample>
410
428
    <informalexample>
411
429
      <para>
412
 
        Run in debug mode, with a custom key, and do not use Zeroconf
413
 
        to locate a server; connect directly to the IPv6 address
414
 
        <quote><systemitem class="ipaddress"
 
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"
415
433
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
434
        port 4711, using interface eth2:
417
435
      </para>
418
436
      <para>
419
437
 
420
438
<!-- do not wrap this line -->
421
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
422
440
 
423
441
      </para>
424
442
    </informalexample>
425
443
  </refsect1>
426
 
  
 
444
 
427
445
  <refsect1 id="security">
428
446
    <title>SECURITY</title>
429
447
    <para>
430
448
      This program is set-uid to root, but will switch back to the
431
 
      original (and presumably non-privileged) user and group after
432
 
      bringing up the network interface.
 
449
      original user and group after bringing up the network interface.
433
450
    </para>
434
451
    <para>
435
452
      To use this program for its intended purpose (see <xref
457
474
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
475
    </para>
459
476
    <para>
460
 
      It will also help if the checker program on the server is
461
 
      configured to request something from the client which can not be
462
 
      spoofed by someone else on the network, unlike unencrypted
463
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
464
 
    </para>
465
 
    <para>
466
 
      <emphasis>Note</emphasis>: This makes it completely insecure to
467
 
      have <application >Mandos</application> clients which dual-boot
468
 
      to another operating system which is <emphasis>not</emphasis>
469
 
      trusted to keep the initial <acronym>RAM</acronym> disk image
470
 
      confidential.
 
477
      <emphasis>Note</emphasis>: This makes it impossible to have
 
478
      <application >Mandos</application> clients which dual-boot to
 
479
      another operating system which does <emphasis>not</emphasis> run
 
480
      a <application>Mandos</application> client.
471
481
    </para>
472
482
  </refsect1>
473
 
  
 
483
 
474
484
  <refsect1 id="see_also">
475
485
    <title>SEE ALSO</title>
476
486
    <para>
477
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
478
 
      <manvolnum>8</manvolnum></citerefentry>,
479
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
480
 
      <manvolnum>5</manvolnum></citerefentry>,
481
487
      <citerefentry><refentrytitle>mandos</refentrytitle>
482
488
      <manvolnum>8</manvolnum></citerefentry>,
483
489
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
485
491
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
486
492
      <manvolnum>8mandos</manvolnum></citerefentry>
487
493
    </para>
488
 
    <variablelist>
489
 
      <varlistentry>
490
 
        <term>
491
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
492
 
        </term>
493
 
        <listitem>
494
 
          <para>
495
 
            Zeroconf is the network protocol standard used for finding
496
 
            Mandos servers on the local network.
497
 
          </para>
498
 
        </listitem>
499
 
      </varlistentry>
500
 
      <varlistentry>
501
 
        <term>
502
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
503
 
        </term>
504
 
      <listitem>
505
 
        <para>
506
 
          Avahi is the library this program calls to find Zeroconf
507
 
          services.
508
 
        </para>
509
 
      </listitem>
510
 
      </varlistentry>
511
 
      <varlistentry>
512
 
        <term>
513
 
          <ulink url="http://www.gnu.org/software/gnutls/"
514
 
          >GnuTLS</ulink>
515
 
        </term>
516
 
      <listitem>
517
 
        <para>
518
 
          GnuTLS is the library this client uses to implement TLS for
519
 
          communicating securely with the server, and at the same time
520
 
          send the public OpenPGP key to the server.
521
 
        </para>
522
 
      </listitem>
523
 
      </varlistentry>
524
 
      <varlistentry>
525
 
        <term>
526
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
527
 
                 >GPGME</ulink>
528
 
        </term>
529
 
        <listitem>
530
 
          <para>
531
 
            GPGME is the library used to decrypt the OpenPGP data sent
532
 
            by the server.
533
 
          </para>
534
 
        </listitem>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
 
        <term>
538
 
          RFC 4291: <citetitle>IP Version 6 Addressing
539
 
          Architecture</citetitle>
540
 
        </term>
541
 
        <listitem>
542
 
          <variablelist>
543
 
            <varlistentry>
544
 
              <term>Section 2.2: <citetitle>Text Representation of
545
 
              Addresses</citetitle></term>
546
 
              <listitem><para/></listitem>
547
 
            </varlistentry>
548
 
            <varlistentry>
549
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
550
 
              Address</citetitle></term>
551
 
              <listitem><para/></listitem>
552
 
            </varlistentry>
553
 
            <varlistentry>
554
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
555
 
            Addresses</citetitle></term>
556
 
            <listitem>
557
 
              <para>
558
 
                This client uses IPv6 link-local addresses, which are
559
 
                immediately usable since a link-local addresses is
560
 
                automatically assigned to a network interfaces when it
561
 
                is brought up.
562
 
              </para>
563
 
            </listitem>
564
 
            </varlistentry>
565
 
          </variablelist>
566
 
        </listitem>
567
 
      </varlistentry>
568
 
      <varlistentry>
569
 
        <term>
570
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
571
 
          Protocol Version 1.1</citetitle>
572
 
        </term>
573
 
      <listitem>
574
 
        <para>
575
 
          TLS 1.1 is the protocol implemented by GnuTLS.
576
 
        </para>
577
 
      </listitem>
578
 
      </varlistentry>
579
 
      <varlistentry>
580
 
        <term>
581
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
582
 
        </term>
583
 
      <listitem>
584
 
        <para>
585
 
          The data received from the server is binary encrypted
586
 
          OpenPGP data.
587
 
        </para>
588
 
      </listitem>
589
 
      </varlistentry>
590
 
      <varlistentry>
591
 
        <term>
592
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
593
 
          Security</citetitle>
594
 
        </term>
595
 
      <listitem>
596
 
        <para>
597
 
          This is implemented by GnuTLS and used by this program so
598
 
          that OpenPGP keys can be used.
599
 
        </para>
600
 
      </listitem>
601
 
      </varlistentry>
602
 
    </variablelist>
 
494
    <itemizedlist>
 
495
      <listitem><para>
 
496
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
497
      </para></listitem>
 
498
      
 
499
      <listitem><para>
 
500
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
501
      </para></listitem>
 
502
      
 
503
      <listitem><para>
 
504
        <ulink
 
505
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
506
      </para></listitem>
 
507
      
 
508
      <listitem><para>
 
509
        <ulink
 
510
        url="http://www.gnupg.org/related_software/gpgme/"
 
511
        >GPGME</ulink>
 
512
      </para></listitem>
 
513
      
 
514
      <listitem><para>
 
515
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
516
        Format</citetitle></citation>
 
517
      </para></listitem>
 
518
      
 
519
      <listitem><para>
 
520
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
521
        Transport Layer Security</citetitle></citation>
 
522
      </para></listitem>
 
523
      
 
524
      <listitem><para>
 
525
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
526
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
527
        Unicast Addresses</citation>
 
528
      </para></listitem>
 
529
    </itemizedlist>
603
530
  </refsect1>
 
531
 
604
532
</refentry>
605
 
 
606
533
<!-- Local Variables: -->
607
534
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
535
<!-- time-stamp-end: "[\"']>" -->