/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-01-08 03:54:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090108035406-01uqkv9xqgxlnw7c
Change the default value of the "checker" option command to make the
checker command be run-time dependent on the "host" client attribute
instead of reading it only once on startup:

* clients.conf (checker): Changed default commented-out value to
                          "fping -q -- %%(host)s".
* mandos (main): Changed default value for the "checker" config option
                 to "fping -q -- %%(host)s".
* mandos-clients.conf.xml (OPTIONS): Document changed default value.
  (EXAMPLE): Changed value of "checker".

* plugins.d/password-prompt.c: Whitespace changes only.

Show diffs side-by-side

added added

removed removed

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