/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: 2008-09-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.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 "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
 
5
<!ENTITY COMMANDNAME "mandos-client">
 
6
<!ENTITY TIMESTAMP "2008-09-06">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Client for mandos
 
48
      Client for <application>Mandos</application>
49
49
    </refpurpose>
50
50
  </refnamediv>
51
51
 
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group>
56
56
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
57
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
58
        ><replaceable>PORT</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
60
        <replaceable>ADDRESS</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>
72
65
        <arg choice="plain"><option>--interface
73
66
        <replaceable>NAME</replaceable></option></arg>
74
67
        <arg choice="plain"><option>-i
128
121
      communicates with <citerefentry><refentrytitle
129
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
123
      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
 
124
      network connectivity, Zeroconf to find servers, and TLS with an
 
125
      OpenPGP key to ensure authenticity and confidentiality.  It
133
126
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply.
 
127
      receives a satisfactory reply or a TERM signal is received.
135
128
    </para>
136
129
    <para>
137
130
      This program is not meant to be run directly; it is really meant
138
131
      to run as a plugin of the <application>Mandos</application>
139
132
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
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.
 
133
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
134
      initial <acronym>RAM</acronym> disk environment because it is
 
135
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
136
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
137
      </citerefentry> file.
144
138
    </para>
145
139
  </refsect1>
146
140
  
154
148
    </para>
155
149
  </refsect1>
156
150
  
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
 
  
176
151
  <refsect1 id="options">
177
152
    <title>OPTIONS</title>
178
153
    <para>
188
163
    <variablelist>
189
164
      <varlistentry>
190
165
        <term><option>--connect=<replaceable
191
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
166
        >ADDRESS</replaceable><literal>:</literal><replaceable
192
167
        >PORT</replaceable></option></term>
193
168
        <term><option>-c
194
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
169
        <replaceable>ADDRESS</replaceable><literal>:</literal
195
170
        ><replaceable>PORT</replaceable></option></term>
196
171
        <listitem>
197
172
          <para>
202
177
            assumed to separate the address from the port number.
203
178
          </para>
204
179
          <para>
205
 
            This option is normally only useful for debugging.
 
180
            This option is normally only useful for testing and
 
181
            debugging.
206
182
          </para>
207
183
        </listitem>
208
184
      </varlistentry>
209
185
      
210
186
      <varlistentry>
211
 
        <term><option>--keydir=<replaceable
212
 
        >DIRECTORY</replaceable></option></term>
213
 
        <term><option>-d
214
 
        <replaceable>DIRECTORY</replaceable></option></term>
215
 
        <listitem>
216
 
          <para>
217
 
            Directory to read the OpenPGP key files
218
 
            <filename>pubkey.txt</filename> and
219
 
            <filename>seckey.txt</filename> from.  The default is
220
 
            <filename>/conf/conf.d/mandos</filename> (in the initial
221
 
            <acronym>RAM</acronym> disk environment).
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
 
226
 
      <varlistentry>
227
187
        <term><option>--interface=
228
188
        <replaceable>NAME</replaceable></option></term>
229
189
        <term><option>-i
234
194
            Mandos servers to connect to.  The default it
235
195
            <quote><literal>eth0</literal></quote>.
236
196
          </para>
 
197
          <para>
 
198
            If the <option>--connect</option> option is used, this
 
199
            specifies the interface to use to connect to the address
 
200
            given.
 
201
          </para>
237
202
        </listitem>
238
203
      </varlistentry>
239
204
      
244
209
        <replaceable>FILE</replaceable></option></term>
245
210
        <listitem>
246
211
          <para>
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
250
 
            <quote><literal>pubkey.txt</literal></quote>.
 
212
            OpenPGP public key file name.  The default name is
 
213
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
214
            ></quote>.
251
215
          </para>
252
216
        </listitem>
253
217
      </varlistentry>
259
223
        <replaceable>FILE</replaceable></option></term>
260
224
        <listitem>
261
225
          <para>
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
265
 
            <quote><literal>seckey.txt</literal></quote>.
 
226
            OpenPGP secret key file name.  The default name is
 
227
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
228
            ></quote>.
266
229
          </para>
267
230
        </listitem>
268
231
      </varlistentry>
271
234
        <term><option>--priority=<replaceable
272
235
        >STRING</replaceable></option></term>
273
236
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="../mandos-options.xml"
 
238
                      xpointer="priority"/>
275
239
        </listitem>
276
240
      </varlistentry>
277
241
 
333
297
    </variablelist>
334
298
  </refsect1>
335
299
 
 
300
  <refsect1 id="overview">
 
301
    <title>OVERVIEW</title>
 
302
    <xi:include href="../overview.xml"/>
 
303
    <para>
 
304
      This program is the client part.  It is a plugin started by
 
305
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
306
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
307
      an initial <acronym>RAM</acronym> disk environment.
 
308
    </para>
 
309
    <para>
 
310
      This program could, theoretically, be used as a keyscript in
 
311
      <filename>/etc/crypttab</filename>, but it would then be
 
312
      impossible to enter a password for the encrypted root disk at
 
313
      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.
 
320
    </para>
 
321
  </refsect1>
 
322
  
336
323
  <refsect1 id="exit_status">
337
324
    <title>EXIT STATUS</title>
338
325
    <para>
341
328
      successfully decrypted and output on standard output.  The
342
329
      program will exit with a non-zero exit status only if a critical
343
330
      error occurs.  Otherwise, it will forever connect to new
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> -->
 
331
      <application>Mandos</application> servers as they appear, trying
 
332
      to get a decryptable password and print it.
 
333
    </para>
 
334
  </refsect1>
 
335
  
 
336
  <refsect1 id="environment">
 
337
    <title>ENVIRONMENT</title>
 
338
    <para>
 
339
      This program does not use any environment variables, not even
 
340
      the ones provided by <citerefentry><refentrytitle
 
341
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
342
    </citerefentry>.
 
343
    </para>
 
344
  </refsect1>
 
345
  
 
346
  <refsect1 id="file">
 
347
    <title>FILES</title>
 
348
    <variablelist>
 
349
      <varlistentry>
 
350
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
351
        ></term>
 
352
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
353
        ></term>
 
354
        <listitem>
 
355
          <para>
 
356
            OpenPGP public and private key files, in <quote>ASCII
 
357
            Armor</quote> format.  These are the default file names,
 
358
            they can be changed with the <option>--pubkey</option> and
 
359
            <option>--seckey</option> options.
 
360
          </para>
 
361
        </listitem>
 
362
      </varlistentry>
 
363
    </variablelist>
 
364
  </refsect1>
 
365
  
 
366
<!--   <refsect1 id="bugs"> -->
 
367
<!--     <title>BUGS</title> -->
351
368
<!--     <para> -->
352
 
<!--       This program does not use any environment variables. -->
353
369
<!--     </para> -->
354
370
<!--   </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>
367
371
 
368
372
  <refsect1 id="example">
369
373
    <title>EXAMPLE</title>
370
374
    <para>
 
375
      Note that normally, command line options will not be given
 
376
      directly, but via options for the Mandos <citerefentry
 
377
      ><refentrytitle>plugin-runner</refentrytitle>
 
378
      <manvolnum>8mandos</manvolnum></citerefentry>.
371
379
    </para>
 
380
    <informalexample>
 
381
      <para>
 
382
        Normal invocation needs no options, if the network interface
 
383
        is <quote>eth0</quote>:
 
384
      </para>
 
385
      <para>
 
386
        <userinput>&COMMANDNAME;</userinput>
 
387
      </para>
 
388
    </informalexample>
 
389
    <informalexample>
 
390
      <para>
 
391
        Search for Mandos servers (and connect to them) using another
 
392
        interface:
 
393
      </para>
 
394
      <para>
 
395
        <!-- do not wrap this line -->
 
396
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
397
      </para>
 
398
    </informalexample>
 
399
    <informalexample>
 
400
      <para>
 
401
        Run in debug mode, and use a custom key:
 
402
      </para>
 
403
      <para>
 
404
 
 
405
<!-- do not wrap this line -->
 
406
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
407
 
 
408
      </para>
 
409
    </informalexample>
 
410
    <informalexample>
 
411
      <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"
 
415
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
416
        port 4711, using interface eth2:
 
417
      </para>
 
418
      <para>
 
419
 
 
420
<!-- 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>
 
422
 
 
423
      </para>
 
424
    </informalexample>
372
425
  </refsect1>
373
426
 
374
427
  <refsect1 id="security">
375
428
    <title>SECURITY</title>
376
429
    <para>
 
430
      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.
 
433
    </para>
 
434
    <para>
 
435
      To use this program for its intended purpose (see <xref
 
436
      linkend="purpose"/>), the password for the root file system will
 
437
      have to be given out to be stored in a server computer, after
 
438
      having been encrypted using an OpenPGP key.  This encrypted data
 
439
      which will be stored in a server can only be decrypted by the
 
440
      OpenPGP key, and the data will only be given out to those
 
441
      clients who can prove they actually have that key.  This key,
 
442
      however, is stored unencrypted on the client side in its initial
 
443
      <acronym>RAM</acronym> disk image file system.  This is normally
 
444
      readable by all, but this is normally fixed during installation
 
445
      of this program; file permissions are set so that no-one is able
 
446
      to read that file.
 
447
    </para>
 
448
    <para>
 
449
      The only remaining weak point is that someone with physical
 
450
      access to the client hard drive might turn off the client
 
451
      computer, read the OpenPGP keys directly from the hard drive,
 
452
      and communicate with the server.  The defense against this is
 
453
      that the server is supposed to notice the client disappearing
 
454
      and will stop giving out the encrypted data.  Therefore, it is
 
455
      important to set the timeout and checker interval values tightly
 
456
      on the server.  See <citerefentry><refentrytitle
 
457
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
458
    </para>
 
459
    <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.
377
471
    </para>
378
472
  </refsect1>
379
473
 
380
474
  <refsect1 id="see_also">
381
475
    <title>SEE ALSO</title>
382
476
    <para>
 
477
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
478
      <manvolnum>8</manvolnum></citerefentry>,
 
479
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
480
      <manvolnum>5</manvolnum></citerefentry>,
383
481
      <citerefentry><refentrytitle>mandos</refentrytitle>
384
482
      <manvolnum>8</manvolnum></citerefentry>,
385
483
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
387
485
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
388
486
      <manvolnum>8mandos</manvolnum></citerefentry>
389
487
    </para>
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>
 
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>
426
603
  </refsect1>
427
604
 
428
605
</refentry>