/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-02-09 02:17:59 UTC
  • mfrom: (24.1.133 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090209021759-15raw68l6q0yegtc
Merge from Björn:

* mandos-ctl: Changed domain to "se.bsnet.fukt".

* plugin-runner.c (main): Bug fix: remove pseudo-plugin for global
                          plugin arguments after it is no longer
                          needed.

* plugins.d/mandos-client.c (adjustbuffer): Renamed to "incbuffer",
                                            all callers changed.

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-02-09">
 
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
98
93
      </arg>
99
94
      <sbr/>
100
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
101
100
        <option>--debug</option>
102
101
      </arg>
103
102
    </cmdsynopsis>
120
119
      </group>
121
120
    </cmdsynopsis>
122
121
  </refsynopsisdiv>
123
 
 
 
122
  
124
123
  <refsect1 id="description">
125
124
    <title>DESCRIPTION</title>
126
125
    <para>
127
126
      <command>&COMMANDNAME;</command> is a client program that
128
127
      communicates with <citerefentry><refentrytitle
129
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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
133
 
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply or a TERM signal is recieved.
 
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.
135
139
    </para>
136
140
    <para>
137
141
      This program is not meant to be run directly; it is really meant
191
195
      </varlistentry>
192
196
      
193
197
      <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
 
        <term><option>--interface=
211
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
212
200
        <term><option>-i
213
201
        <replaceable>NAME</replaceable></option></term>
214
202
        <listitem>
215
203
          <para>
216
204
            Network interface that will be brought up and scanned for
217
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
218
206
            <quote><literal>eth0</literal></quote>.
219
207
          </para>
220
208
          <para>
222
210
            specifies the interface to use to connect to the address
223
211
            given.
224
212
          </para>
 
213
          <para>
 
214
            Note that since this program will normally run in the
 
215
            initial RAM disk environment, the interface must be an
 
216
            interface which exists at that stage.  Thus, the interface
 
217
            can not be a pseudo-interface such as <quote>br0</quote>
 
218
            or <quote>tun0</quote>; such interfaces will not exist
 
219
            until much later in the boot process, and can not be used
 
220
            by this program.
 
221
          </para>
 
222
          <para>
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
 
226
            recommended, and only meant for advanced users.
 
227
          </para>
225
228
        </listitem>
226
229
      </varlistentry>
227
230
      
232
235
        <replaceable>FILE</replaceable></option></term>
233
236
        <listitem>
234
237
          <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>.
 
238
            OpenPGP public key file name.  The default name is
 
239
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
240
            ></quote>.
239
241
          </para>
240
242
        </listitem>
241
243
      </varlistentry>
242
 
 
 
244
      
243
245
      <varlistentry>
244
246
        <term><option>--seckey=<replaceable
245
247
        >FILE</replaceable></option></term>
247
249
        <replaceable>FILE</replaceable></option></term>
248
250
        <listitem>
249
251
          <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>.
 
252
            OpenPGP secret key file name.  The default name is
 
253
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
254
            ></quote>.
254
255
          </para>
255
256
        </listitem>
256
257
      </varlistentry>
263
264
                      xpointer="priority"/>
264
265
        </listitem>
265
266
      </varlistentry>
266
 
 
 
267
      
267
268
      <varlistentry>
268
269
        <term><option>--dh-bits=<replaceable
269
270
        >BITS</replaceable></option></term>
274
275
          </para>
275
276
        </listitem>
276
277
      </varlistentry>
 
278
 
 
279
      <varlistentry>
 
280
        <term><option>--delay=<replaceable
 
281
        >SECONDS</replaceable></option></term>
 
282
        <listitem>
 
283
          <para>
 
284
            After bringing the network interface up, the program waits
 
285
            for the interface to arrive in a <quote>running</quote>
 
286
            state before proceeding.  During this time, the kernel log
 
287
            level will be lowered to reduce clutter on the system
 
288
            console, alleviating any other plugins which might be
 
289
            using the system console.  This option sets the upper
 
290
            limit of seconds to wait.  The default is 2.5 seconds.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
277
294
      
278
295
      <varlistentry>
279
296
        <term><option>--debug</option></term>
309
326
          </para>
310
327
        </listitem>
311
328
      </varlistentry>
312
 
 
 
329
      
313
330
      <varlistentry>
314
331
        <term><option>--version</option></term>
315
332
        <term><option>-V</option></term>
321
338
      </varlistentry>
322
339
    </variablelist>
323
340
  </refsect1>
324
 
 
 
341
  
325
342
  <refsect1 id="overview">
326
343
    <title>OVERVIEW</title>
327
344
    <xi:include href="../overview.xml"/>
336
353
      <filename>/etc/crypttab</filename>, but it would then be
337
354
      impossible to enter a password for the encrypted root disk at
338
355
      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.
 
356
      at all.  This is why a separate plugin runner (<citerefentry>
 
357
      <refentrytitle>plugin-runner</refentrytitle>
 
358
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
359
      both this program and others in in parallel,
 
360
      <emphasis>one</emphasis> of which will prompt for passwords on
 
361
      the system console.
341
362
    </para>
342
363
  </refsect1>
343
364
  
350
371
      program will exit with a non-zero exit status only if a critical
351
372
      error occurs.  Otherwise, it will forever connect to new
352
373
      <application>Mandos</application> servers as they appear, trying
353
 
      to get a decryptable password.
 
374
      to get a decryptable password and print it.
354
375
    </para>
355
376
  </refsect1>
356
377
  
364
385
    </para>
365
386
  </refsect1>
366
387
  
367
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
368
389
    <title>FILES</title>
369
390
    <variablelist>
370
391
      <varlistentry>
389
410
<!--     <para> -->
390
411
<!--     </para> -->
391
412
<!--   </refsect1> -->
392
 
 
 
413
  
393
414
  <refsect1 id="example">
394
415
    <title>EXAMPLE</title>
395
416
    <para>
409
430
    </informalexample>
410
431
    <informalexample>
411
432
      <para>
412
 
        Search for Mandos servers on another interface:
 
433
        Search for Mandos servers (and connect to them) using another
 
434
        interface:
413
435
      </para>
414
436
      <para>
415
437
        <!-- do not wrap this line -->
418
440
    </informalexample>
419
441
    <informalexample>
420
442
      <para>
421
 
        Run in debug mode, and use a custom key directory:
 
443
        Run in debug mode, and use a custom key:
422
444
      </para>
423
445
      <para>
424
 
        <!-- do not wrap this line -->
425
 
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
446
 
 
447
<!-- do not wrap this line -->
 
448
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
449
 
426
450
      </para>
427
451
    </informalexample>
428
452
    <informalexample>
429
453
      <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
 
454
        Run in debug mode, with a custom key, and do not use Zeroconf
 
455
        to locate a server; connect directly to the IPv6 link-local
432
456
        address <quote><systemitem class="ipaddress"
433
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
434
 
        port 4711, using interface eth2:
 
457
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
458
        using interface eth2:
435
459
      </para>
436
460
      <para>
437
461
 
438
462
<!-- do not wrap this line -->
439
 
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
463
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
440
464
 
441
465
      </para>
442
466
    </informalexample>
443
467
  </refsect1>
444
 
 
 
468
  
445
469
  <refsect1 id="security">
446
470
    <title>SECURITY</title>
447
471
    <para>
448
472
      This program is set-uid to root, but will switch back to the
449
 
      original user and group after bringing up the network interface.
 
473
      original (and presumably non-privileged) user and group after
 
474
      bringing up the network interface.
450
475
    </para>
451
476
    <para>
452
477
      To use this program for its intended purpose (see <xref
466
491
      The only remaining weak point is that someone with physical
467
492
      access to the client hard drive might turn off the client
468
493
      computer, read the OpenPGP keys directly from the hard drive,
469
 
      and communicate with the server.  The defense against this is
470
 
      that the server is supposed to notice the client disappearing
471
 
      and will stop giving out the encrypted data.  Therefore, it is
472
 
      important to set the timeout and checker interval values tightly
473
 
      on the server.  See <citerefentry><refentrytitle
 
494
      and communicate with the server.  To safeguard against this, the
 
495
      server is supposed to notice the client disappearing and stop
 
496
      giving out the encrypted data.  Therefore, it is important to
 
497
      set the timeout and checker interval values tightly on the
 
498
      server.  See <citerefentry><refentrytitle
474
499
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
475
500
    </para>
476
501
    <para>
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.
 
502
      It will also help if the checker program on the server is
 
503
      configured to request something from the client which can not be
 
504
      spoofed by someone else on the network, unlike unencrypted
 
505
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
506
    </para>
 
507
    <para>
 
508
      <emphasis>Note</emphasis>: This makes it completely insecure to
 
509
      have <application >Mandos</application> clients which dual-boot
 
510
      to another operating system which is <emphasis>not</emphasis>
 
511
      trusted to keep the initial <acronym>RAM</acronym> disk image
 
512
      confidential.
481
513
    </para>
482
514
  </refsect1>
483
 
 
 
515
  
484
516
  <refsect1 id="see_also">
485
517
    <title>SEE ALSO</title>
486
518
    <para>
 
519
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
520
      <manvolnum>8</manvolnum></citerefentry>,
 
521
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
522
      <manvolnum>5</manvolnum></citerefentry>,
487
523
      <citerefentry><refentrytitle>mandos</refentrytitle>
488
524
      <manvolnum>8</manvolnum></citerefentry>,
489
525
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
491
527
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
492
528
      <manvolnum>8mandos</manvolnum></citerefentry>
493
529
    </para>
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>
 
530
    <variablelist>
 
531
      <varlistentry>
 
532
        <term>
 
533
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
534
        </term>
 
535
        <listitem>
 
536
          <para>
 
537
            Zeroconf is the network protocol standard used for finding
 
538
            Mandos servers on the local network.
 
539
          </para>
 
540
        </listitem>
 
541
      </varlistentry>
 
542
      <varlistentry>
 
543
        <term>
 
544
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
545
        </term>
 
546
      <listitem>
 
547
        <para>
 
548
          Avahi is the library this program calls to find Zeroconf
 
549
          services.
 
550
        </para>
 
551
      </listitem>
 
552
      </varlistentry>
 
553
      <varlistentry>
 
554
        <term>
 
555
          <ulink url="http://www.gnu.org/software/gnutls/"
 
556
          >GnuTLS</ulink>
 
557
        </term>
 
558
      <listitem>
 
559
        <para>
 
560
          GnuTLS is the library this client uses to implement TLS for
 
561
          communicating securely with the server, and at the same time
 
562
          send the public OpenPGP key to the server.
 
563
        </para>
 
564
      </listitem>
 
565
      </varlistentry>
 
566
      <varlistentry>
 
567
        <term>
 
568
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
569
                 >GPGME</ulink>
 
570
        </term>
 
571
        <listitem>
 
572
          <para>
 
573
            GPGME is the library used to decrypt the OpenPGP data sent
 
574
            by the server.
 
575
          </para>
 
576
        </listitem>
 
577
      </varlistentry>
 
578
      <varlistentry>
 
579
        <term>
 
580
          RFC 4291: <citetitle>IP Version 6 Addressing
 
581
          Architecture</citetitle>
 
582
        </term>
 
583
        <listitem>
 
584
          <variablelist>
 
585
            <varlistentry>
 
586
              <term>Section 2.2: <citetitle>Text Representation of
 
587
              Addresses</citetitle></term>
 
588
              <listitem><para/></listitem>
 
589
            </varlistentry>
 
590
            <varlistentry>
 
591
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
592
              Address</citetitle></term>
 
593
              <listitem><para/></listitem>
 
594
            </varlistentry>
 
595
            <varlistentry>
 
596
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
597
            Addresses</citetitle></term>
 
598
            <listitem>
 
599
              <para>
 
600
                This client uses IPv6 link-local addresses, which are
 
601
                immediately usable since a link-local addresses is
 
602
                automatically assigned to a network interfaces when it
 
603
                is brought up.
 
604
              </para>
 
605
            </listitem>
 
606
            </varlistentry>
 
607
          </variablelist>
 
608
        </listitem>
 
609
      </varlistentry>
 
610
      <varlistentry>
 
611
        <term>
 
612
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
613
          Protocol Version 1.1</citetitle>
 
614
        </term>
 
615
      <listitem>
 
616
        <para>
 
617
          TLS 1.1 is the protocol implemented by GnuTLS.
 
618
        </para>
 
619
      </listitem>
 
620
      </varlistentry>
 
621
      <varlistentry>
 
622
        <term>
 
623
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
624
        </term>
 
625
      <listitem>
 
626
        <para>
 
627
          The data received from the server is binary encrypted
 
628
          OpenPGP data.
 
629
        </para>
 
630
      </listitem>
 
631
      </varlistentry>
 
632
      <varlistentry>
 
633
        <term>
 
634
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
635
          Security</citetitle>
 
636
        </term>
 
637
      <listitem>
 
638
        <para>
 
639
          This is implemented by GnuTLS and used by this program so
 
640
          that OpenPGP keys can be used.
 
641
        </para>
 
642
      </listitem>
 
643
      </varlistentry>
 
644
    </variablelist>
530
645
  </refsect1>
531
 
 
532
646
</refentry>
 
647
 
533
648
<!-- Local Variables: -->
534
649
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
535
650
<!-- time-stamp-end: "[\"']>" -->