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

* initramfs-tools-hook: Set DEVICE for network hooks.

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 "2011-11-27">
 
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>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="../legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8mandos</manvolnum>
45
48
  <refnamediv>
46
49
    <refname><command>&COMMANDNAME;</command></refname>
47
50
    <refpurpose>
48
 
      Client for mandos
 
51
      Client for <application>Mandos</application>
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
55
58
      <group>
56
59
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
60
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
61
        ><replaceable>PORT</replaceable></option></arg>
59
62
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
63
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
64
        ><replaceable>PORT</replaceable></option></arg>
62
65
      </group>
63
66
      <sbr/>
64
67
      <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
68
        <arg choice="plain"><option>--interface
73
69
        <replaceable>NAME</replaceable></option></arg>
74
70
        <arg choice="plain"><option>-i
98
94
      </arg>
99
95
      <sbr/>
100
96
      <arg>
 
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
98
      </arg>
 
99
      <sbr/>
 
100
      <arg>
 
101
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
102
      </arg>
 
103
      <sbr/>
 
104
      <arg>
 
105
        <option>--network-hook-dir
 
106
        <replaceable>DIR</replaceable></option>
 
107
      </arg>
 
108
      <sbr/>
 
109
      <arg>
101
110
        <option>--debug</option>
102
111
      </arg>
103
112
    </cmdsynopsis>
120
129
      </group>
121
130
    </cmdsynopsis>
122
131
  </refsynopsisdiv>
123
 
 
 
132
  
124
133
  <refsect1 id="description">
125
134
    <title>DESCRIPTION</title>
126
135
    <para>
127
136
      <command>&COMMANDNAME;</command> is a client program that
128
137
      communicates with <citerefentry><refentrytitle
129
138
      >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.
 
139
      to get a password.  In slightly more detail, this client program
 
140
      brings up a network interface, uses the interface’s IPv6
 
141
      link-local address to get network connectivity, uses Zeroconf to
 
142
      find servers on the local network, and communicates with servers
 
143
      using TLS with an OpenPGP key to ensure authenticity and
 
144
      confidentiality.  This client program keeps running, trying all
 
145
      servers on the network, until it receives a satisfactory reply
 
146
      or a TERM signal.  After all servers have been tried, all
 
147
      servers are periodically retried.  If no servers are found it
 
148
      will wait indefinitely for new servers to appear.
 
149
    </para>
 
150
    <para>
 
151
      The network interface is selected like this: If an interface is
 
152
      specified using the <option>--interface</option> option, that
 
153
      interface is used.  Otherwise, <command>&COMMANDNAME;</command>
 
154
      will choose any interface that is up and running and is not a
 
155
      loopback interface, is not a point-to-point interface, is
 
156
      capable of broadcasting and does not have the NOARP flag (see
 
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
 
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
 
159
      <option>--connect</option> option is used, point-to-point
 
160
      interfaces and non-broadcast interfaces are accepted.)  If no
 
161
      acceptable interfaces are found, re-run the check but without
 
162
      the <quote>up and running</quote> requirement, and manually take
 
163
      the selected interface up (and later take it down on program
 
164
      exit).
 
165
    </para>
 
166
    <para>
 
167
      Before a network interface is selected, all <quote>network
 
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
135
169
    </para>
136
170
    <para>
137
171
      This program is not meant to be run directly; it is really meant
191
225
      </varlistentry>
192
226
      
193
227
      <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>
 
228
        <term><option>--interface=<replaceable
 
229
        >NAME</replaceable></option></term>
212
230
        <term><option>-i
213
231
        <replaceable>NAME</replaceable></option></term>
214
232
        <listitem>
215
233
          <para>
216
234
            Network interface that will be brought up and scanned for
217
 
            Mandos servers to connect to.  The default it
218
 
            <quote><literal>eth0</literal></quote>.
 
235
            Mandos servers to connect to.  The default is the empty
 
236
            string, which will automatically choose an appropriate
 
237
            interface.
 
238
          </para>
 
239
          <para>
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
 
243
          </para>
 
244
          <para>
 
245
            Note that since this program will normally run in the
 
246
            initial RAM disk environment, the interface must be an
 
247
            interface which exists at that stage.  Thus, the interface
 
248
            can not be a pseudo-interface such as <quote>br0</quote>
 
249
            or <quote>tun0</quote>; such interfaces will not exist
 
250
            until much later in the boot process, and can not be used
 
251
            by this program, unless created by a <quote>network
 
252
            hook</quote> — see <xref linkend="network-hooks"/>.
 
253
          </para>
 
254
          <para>
 
255
            <replaceable>NAME</replaceable> can be the string
 
256
            <quote><literal>none</literal></quote>; this will not use
 
257
            any specific interface, and will not bring up an interface
 
258
            on startup.  This is not recommended, and only meant for
 
259
            advanced users.
219
260
          </para>
220
261
        </listitem>
221
262
      </varlistentry>
227
268
        <replaceable>FILE</replaceable></option></term>
228
269
        <listitem>
229
270
          <para>
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>.
 
271
            OpenPGP public key file name.  The default name is
 
272
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
273
            ></quote>.
234
274
          </para>
235
275
        </listitem>
236
276
      </varlistentry>
237
 
 
 
277
      
238
278
      <varlistentry>
239
279
        <term><option>--seckey=<replaceable
240
280
        >FILE</replaceable></option></term>
242
282
        <replaceable>FILE</replaceable></option></term>
243
283
        <listitem>
244
284
          <para>
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>.
 
285
            OpenPGP secret key file name.  The default name is
 
286
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
287
            ></quote>.
249
288
          </para>
250
289
        </listitem>
251
290
      </varlistentry>
258
297
                      xpointer="priority"/>
259
298
        </listitem>
260
299
      </varlistentry>
261
 
 
 
300
      
262
301
      <varlistentry>
263
302
        <term><option>--dh-bits=<replaceable
264
303
        >BITS</replaceable></option></term>
269
308
          </para>
270
309
        </listitem>
271
310
      </varlistentry>
 
311
 
 
312
      <varlistentry>
 
313
        <term><option>--delay=<replaceable
 
314
        >SECONDS</replaceable></option></term>
 
315
        <listitem>
 
316
          <para>
 
317
            After bringing the network interface up, the program waits
 
318
            for the interface to arrive in a <quote>running</quote>
 
319
            state before proceeding.  During this time, the kernel log
 
320
            level will be lowered to reduce clutter on the system
 
321
            console, alleviating any other plugins which might be
 
322
            using the system console.  This option sets the upper
 
323
            limit of seconds to wait.  The default is 2.5 seconds.
 
324
          </para>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
 
 
328
      <varlistentry>
 
329
        <term><option>--retry=<replaceable
 
330
        >SECONDS</replaceable></option></term>
 
331
        <listitem>
 
332
          <para>
 
333
            All Mandos servers are tried repeatedly until a password
 
334
            is received.  This value specifies, in seconds, how long
 
335
            between each successive try <emphasis>for the same
 
336
            server</emphasis>.  The default is 10 seconds.
 
337
          </para>
 
338
        </listitem>
 
339
      </varlistentry>
 
340
 
 
341
      <varlistentry>
 
342
        <term><option>--network-hook-dir=<replaceable
 
343
        >DIR</replaceable></option></term>
 
344
        <listitem>
 
345
          <para>
 
346
            Network hook directory.  The default directory is
 
347
            <quote><filename class="directory"
 
348
            >/lib/mandos/network-hooks.d</filename></quote>.
 
349
          </para>
 
350
        </listitem>
 
351
      </varlistentry>
272
352
      
273
353
      <varlistentry>
274
354
        <term><option>--debug</option></term>
304
384
          </para>
305
385
        </listitem>
306
386
      </varlistentry>
307
 
 
 
387
      
308
388
      <varlistentry>
309
389
        <term><option>--version</option></term>
310
390
        <term><option>-V</option></term>
316
396
      </varlistentry>
317
397
    </variablelist>
318
398
  </refsect1>
319
 
 
 
399
  
320
400
  <refsect1 id="overview">
321
401
    <title>OVERVIEW</title>
322
402
    <xi:include href="../overview.xml"/>
331
411
      <filename>/etc/crypttab</filename>, but it would then be
332
412
      impossible to enter a password for the encrypted root disk at
333
413
      the console, since this program does not read from the 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.
 
414
      at all.  This is why a separate plugin runner (<citerefentry>
 
415
      <refentrytitle>plugin-runner</refentrytitle>
 
416
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
417
      both this program and others in in parallel,
 
418
      <emphasis>one</emphasis> of which (<citerefentry>
 
419
      <refentrytitle>password-prompt</refentrytitle>
 
420
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
421
      passwords on the system console.
336
422
    </para>
337
423
  </refsect1>
338
424
  
343
429
      server could be found and the password received from it could be
344
430
      successfully decrypted and output on standard output.  The
345
431
      program will exit with a non-zero exit status only if a critical
346
 
      error occurs.  Otherwise, it will forever connect to new
347
 
      <application>Mandos</application> servers as they appear, trying
348
 
      to get a decryptable password.
 
432
      error occurs.  Otherwise, it will forever connect to any
 
433
      discovered <application>Mandos</application> servers, trying to
 
434
      get a decryptable password and print it.
349
435
    </para>
350
436
  </refsect1>
351
437
  
359
445
    </para>
360
446
  </refsect1>
361
447
  
362
 
  <refsect1 id="file">
 
448
  <refsect1 id="network-hooks">
 
449
    <title>NETWORK HOOKS</title>
 
450
    <para>
 
451
      If a network interface like a bridge or tunnel is required to
 
452
      find a Mandos server, this requires the interface to be up and
 
453
      running before <command>&COMMANDNAME;</command> starts looking
 
454
      for Mandos servers.  This can be accomplished by creating a
 
455
      <quote>network hook</quote> program, and placing it in a special
 
456
      directory.
 
457
    </para>
 
458
    <para>
 
459
      Before the network is used (and again before program exit), any
 
460
      runnable programs found in the network hook directory are run
 
461
      with the argument <quote><literal>start</literal></quote> or
 
462
      <quote><literal>stop</literal></quote>.  This should bring up or
 
463
      down, respectively, any network interface which
 
464
      <command>&COMMANDNAME;</command> should use.
 
465
    </para>
 
466
    <refsect2 id="hook-requirements">
 
467
      <title>REQUIREMENTS</title>
 
468
      <para>
 
469
        A network hook must be an executable file, and its name must
 
470
        consist entirely of upper and lower case letters, digits,
 
471
        underscores, periods, and hyphens.
 
472
      </para>
 
473
      <para>
 
474
        A network hook will receive one argument, which can be one of
 
475
        the following:
 
476
      </para>
 
477
      <variablelist>
 
478
        <varlistentry>
 
479
          <term><literal>start</literal></term>
 
480
          <listitem>
 
481
            <para>
 
482
              This should make the network hook create (if necessary)
 
483
              and bring up a network interface.
 
484
            </para>
 
485
          </listitem>
 
486
        </varlistentry>
 
487
        <varlistentry>
 
488
          <term><literal>stop</literal></term>
 
489
          <listitem>
 
490
            <para>
 
491
              This should make the network hook take down a network
 
492
              interface, and delete it if it did not exist previously.
 
493
            </para>
 
494
          </listitem>
 
495
        </varlistentry>
 
496
        <varlistentry>
 
497
          <term><literal>files</literal></term>
 
498
          <listitem>
 
499
            <para>
 
500
              This should make the network hook print, <emphasis>one
 
501
              file per line</emphasis>, all the files needed for it to
 
502
              run.  (These files will be copied into the initial RAM
 
503
              filesystem.)  Typical use is for a network hook which is
 
504
              a shell script to print its needed binaries.
 
505
            </para>
 
506
            <para>
 
507
              It is not necessary to print any non-executable files
 
508
              already in the network hook directory, these will be
 
509
              copied implicitly if they otherwise satisfy the name
 
510
              requirement.
 
511
            </para>
 
512
          </listitem>
 
513
        </varlistentry>
 
514
        <varlistentry>
 
515
          <term><literal>modules</literal></term>
 
516
          <listitem>
 
517
            <para>
 
518
              This should make the network hook print, <emphasis>on
 
519
              separate lines</emphasis>, all the kernel modules needed
 
520
              for it to run.  (These modules will be copied into the
 
521
              initial RAM filesystem.)  For instance, a tunnel
 
522
              interface needs the
 
523
              <quote><literal>tun</literal></quote> module.
 
524
            </para>
 
525
          </listitem>
 
526
        </varlistentry>
 
527
      </variablelist>
 
528
      <para>
 
529
        The network hook will be provided with a number of environment
 
530
        variables:
 
531
      </para>
 
532
      <variablelist>
 
533
        <varlistentry>
 
534
          <term><envar>MANDOSNETHOOKDIR</envar></term>
 
535
          <listitem>
 
536
            <para>
 
537
              The network hook directory, specified to
 
538
              <command>&COMMANDNAME;</command> by the
 
539
              <option>--network-hook-dir</option> option.  Note: this
 
540
              should <emphasis>always</emphasis> be used by the
 
541
              network hook to refer to itself or any files in the hook
 
542
              directory it may require.
 
543
            </para>
 
544
          </listitem>
 
545
        </varlistentry>
 
546
        <varlistentry>
 
547
          <term><envar>DEVICE</envar></term>
 
548
          <listitem>
 
549
            <para>
 
550
              The network interface, as specified to
 
551
              <command>&COMMANDNAME;</command> by the
 
552
              <option>--interface</option> option.  If this is not the
 
553
              interface a hook will bring up, there is no reason for a
 
554
              hook to continue.
 
555
            </para>
 
556
          </listitem>
 
557
        </varlistentry>
 
558
        <varlistentry>
 
559
          <term><envar>MODE</envar></term>
 
560
          <listitem>
 
561
            <para>
 
562
              This will be the same as the first argument;
 
563
              i.e. <quote><literal>start</literal></quote>,
 
564
              <quote><literal>stop</literal></quote>,
 
565
              <quote><literal>files</literal></quote>, or
 
566
              <quote><literal>modules</literal></quote>.
 
567
            </para>
 
568
          </listitem>
 
569
        </varlistentry>
 
570
        <varlistentry>
 
571
          <term><envar>VERBOSITY</envar></term>
 
572
          <listitem>
 
573
            <para>
 
574
              This will be the <quote><literal>1</literal></quote> if
 
575
              the <option>--debug</option> option is passed to
 
576
              <command>&COMMANDNAME;</command>, otherwise
 
577
              <quote><literal>0</literal></quote>.
 
578
            </para>
 
579
          </listitem>
 
580
        </varlistentry>
 
581
        <varlistentry>
 
582
          <term><envar>DELAY</envar></term>
 
583
          <listitem>
 
584
            <para>
 
585
              This will be the same as the <option>--delay</option>
 
586
              option passed to <command>&COMMANDNAME;</command>.
 
587
            </para>
 
588
          </listitem>
 
589
        </varlistentry>
 
590
      </variablelist>
 
591
      <para>
 
592
        A hook may not read from standard input, and should be
 
593
        restrictive in printing to standard output or standard error
 
594
        unless <varname>VERBOSITY</varname> is
 
595
        <quote><literal>1</literal></quote>.
 
596
      </para>
 
597
    </refsect2>
 
598
  </refsect1>
 
599
  
 
600
  <refsect1 id="files">
363
601
    <title>FILES</title>
364
 
    <para>
365
 
    </para>
366
 
  </refsect1>
367
 
  
368
 
  <refsect1 id="bugs">
369
 
    <title>BUGS</title>
370
 
    <para>
371
 
    </para>
372
 
  </refsect1>
373
 
 
 
602
    <variablelist>
 
603
      <varlistentry>
 
604
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
605
        ></term>
 
606
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
607
        ></term>
 
608
        <listitem>
 
609
          <para>
 
610
            OpenPGP public and private key files, in <quote>ASCII
 
611
            Armor</quote> format.  These are the default file names,
 
612
            they can be changed with the <option>--pubkey</option> and
 
613
            <option>--seckey</option> options.
 
614
          </para>
 
615
        </listitem>
 
616
      </varlistentry>
 
617
      <varlistentry>
 
618
        <term><filename
 
619
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
620
        <listitem>
 
621
          <para>
 
622
            Directory where network hooks are located.  Change this
 
623
            with the <option>--network-hook-dir</option> option.  See
 
624
            <xref linkend="network-hooks"/>.
 
625
          </para>
 
626
        </listitem>
 
627
      </varlistentry>
 
628
    </variablelist>
 
629
  </refsect1>
 
630
  
 
631
<!--   <refsect1 id="bugs"> -->
 
632
<!--     <title>BUGS</title> -->
 
633
<!--     <para> -->
 
634
<!--     </para> -->
 
635
<!--   </refsect1> -->
 
636
  
374
637
  <refsect1 id="example">
375
638
    <title>EXAMPLE</title>
376
639
    <para>
 
640
      Note that normally, command line options will not be given
 
641
      directly, but via options for the Mandos <citerefentry
 
642
      ><refentrytitle>plugin-runner</refentrytitle>
 
643
      <manvolnum>8mandos</manvolnum></citerefentry>.
377
644
    </para>
 
645
    <informalexample>
 
646
      <para>
 
647
        Normal invocation needs no options, if the network interface
 
648
        is <quote>eth0</quote>:
 
649
      </para>
 
650
      <para>
 
651
        <userinput>&COMMANDNAME;</userinput>
 
652
      </para>
 
653
    </informalexample>
 
654
    <informalexample>
 
655
      <para>
 
656
        Search for Mandos servers (and connect to them) using another
 
657
        interface:
 
658
      </para>
 
659
      <para>
 
660
        <!-- do not wrap this line -->
 
661
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
662
      </para>
 
663
    </informalexample>
 
664
    <informalexample>
 
665
      <para>
 
666
        Run in debug mode, and use a custom key:
 
667
      </para>
 
668
      <para>
 
669
 
 
670
<!-- do not wrap this line -->
 
671
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
672
 
 
673
      </para>
 
674
    </informalexample>
 
675
    <informalexample>
 
676
      <para>
 
677
        Run in debug mode, with a custom key, and do not use Zeroconf
 
678
        to locate a server; connect directly to the IPv6 link-local
 
679
        address <quote><systemitem class="ipaddress"
 
680
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
681
        using interface eth2:
 
682
      </para>
 
683
      <para>
 
684
 
 
685
<!-- do not wrap this line -->
 
686
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
687
 
 
688
      </para>
 
689
    </informalexample>
378
690
  </refsect1>
379
 
 
 
691
  
380
692
  <refsect1 id="security">
381
693
    <title>SECURITY</title>
382
694
    <para>
 
695
      This program is set-uid to root, but will switch back to the
 
696
      original (and presumably non-privileged) user and group after
 
697
      bringing up the network interface.
 
698
    </para>
 
699
    <para>
 
700
      To use this program for its intended purpose (see <xref
 
701
      linkend="purpose"/>), the password for the root file system will
 
702
      have to be given out to be stored in a server computer, after
 
703
      having been encrypted using an OpenPGP key.  This encrypted data
 
704
      which will be stored in a server can only be decrypted by the
 
705
      OpenPGP key, and the data will only be given out to those
 
706
      clients who can prove they actually have that key.  This key,
 
707
      however, is stored unencrypted on the client side in its initial
 
708
      <acronym>RAM</acronym> disk image file system.  This is normally
 
709
      readable by all, but this is normally fixed during installation
 
710
      of this program; file permissions are set so that no-one is able
 
711
      to read that file.
 
712
    </para>
 
713
    <para>
 
714
      The only remaining weak point is that someone with physical
 
715
      access to the client hard drive might turn off the client
 
716
      computer, read the OpenPGP keys directly from the hard drive,
 
717
      and communicate with the server.  To safeguard against this, the
 
718
      server is supposed to notice the client disappearing and stop
 
719
      giving out the encrypted data.  Therefore, it is important to
 
720
      set the timeout and checker interval values tightly on the
 
721
      server.  See <citerefentry><refentrytitle
 
722
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
723
    </para>
 
724
    <para>
 
725
      It will also help if the checker program on the server is
 
726
      configured to request something from the client which can not be
 
727
      spoofed by someone else on the network, unlike unencrypted
 
728
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
729
    </para>
 
730
    <para>
 
731
      <emphasis>Note</emphasis>: This makes it completely insecure to
 
732
      have <application >Mandos</application> clients which dual-boot
 
733
      to another operating system which is <emphasis>not</emphasis>
 
734
      trusted to keep the initial <acronym>RAM</acronym> disk image
 
735
      confidential.
383
736
    </para>
384
737
  </refsect1>
385
 
 
 
738
  
386
739
  <refsect1 id="see_also">
387
740
    <title>SEE ALSO</title>
388
741
    <para>
 
742
      <citerefentry><refentrytitle>intro</refentrytitle>
 
743
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
744
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
745
      <manvolnum>8</manvolnum></citerefentry>,
 
746
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
747
      <manvolnum>5</manvolnum></citerefentry>,
389
748
      <citerefentry><refentrytitle>mandos</refentrytitle>
390
749
      <manvolnum>8</manvolnum></citerefentry>,
391
750
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
393
752
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
394
753
      <manvolnum>8mandos</manvolnum></citerefentry>
395
754
    </para>
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>
 
755
    <variablelist>
 
756
      <varlistentry>
 
757
        <term>
 
758
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
759
        </term>
 
760
        <listitem>
 
761
          <para>
 
762
            Zeroconf is the network protocol standard used for finding
 
763
            Mandos servers on the local network.
 
764
          </para>
 
765
        </listitem>
 
766
      </varlistentry>
 
767
      <varlistentry>
 
768
        <term>
 
769
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
770
        </term>
 
771
      <listitem>
 
772
        <para>
 
773
          Avahi is the library this program calls to find Zeroconf
 
774
          services.
 
775
        </para>
 
776
      </listitem>
 
777
      </varlistentry>
 
778
      <varlistentry>
 
779
        <term>
 
780
          <ulink url="http://www.gnu.org/software/gnutls/"
 
781
          >GnuTLS</ulink>
 
782
        </term>
 
783
      <listitem>
 
784
        <para>
 
785
          GnuTLS is the library this client uses to implement TLS for
 
786
          communicating securely with the server, and at the same time
 
787
          send the public OpenPGP key to the server.
 
788
        </para>
 
789
      </listitem>
 
790
      </varlistentry>
 
791
      <varlistentry>
 
792
        <term>
 
793
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
794
                 >GPGME</ulink>
 
795
        </term>
 
796
        <listitem>
 
797
          <para>
 
798
            GPGME is the library used to decrypt the OpenPGP data sent
 
799
            by the server.
 
800
          </para>
 
801
        </listitem>
 
802
      </varlistentry>
 
803
      <varlistentry>
 
804
        <term>
 
805
          RFC 4291: <citetitle>IP Version 6 Addressing
 
806
          Architecture</citetitle>
 
807
        </term>
 
808
        <listitem>
 
809
          <variablelist>
 
810
            <varlistentry>
 
811
              <term>Section 2.2: <citetitle>Text Representation of
 
812
              Addresses</citetitle></term>
 
813
              <listitem><para/></listitem>
 
814
            </varlistentry>
 
815
            <varlistentry>
 
816
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
817
              Address</citetitle></term>
 
818
              <listitem><para/></listitem>
 
819
            </varlistentry>
 
820
            <varlistentry>
 
821
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
822
            Addresses</citetitle></term>
 
823
            <listitem>
 
824
              <para>
 
825
                This client uses IPv6 link-local addresses, which are
 
826
                immediately usable since a link-local addresses is
 
827
                automatically assigned to a network interfaces when it
 
828
                is brought up.
 
829
              </para>
 
830
            </listitem>
 
831
            </varlistentry>
 
832
          </variablelist>
 
833
        </listitem>
 
834
      </varlistentry>
 
835
      <varlistentry>
 
836
        <term>
 
837
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
838
          Protocol Version 1.1</citetitle>
 
839
        </term>
 
840
      <listitem>
 
841
        <para>
 
842
          TLS 1.1 is the protocol implemented by GnuTLS.
 
843
        </para>
 
844
      </listitem>
 
845
      </varlistentry>
 
846
      <varlistentry>
 
847
        <term>
 
848
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
849
        </term>
 
850
      <listitem>
 
851
        <para>
 
852
          The data received from the server is binary encrypted
 
853
          OpenPGP data.
 
854
        </para>
 
855
      </listitem>
 
856
      </varlistentry>
 
857
      <varlistentry>
 
858
        <term>
 
859
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
860
          Security</citetitle>
 
861
        </term>
 
862
      <listitem>
 
863
        <para>
 
864
          This is implemented by GnuTLS and used by this program so
 
865
          that OpenPGP keys can be used.
 
866
        </para>
 
867
      </listitem>
 
868
      </varlistentry>
 
869
    </variablelist>
432
870
  </refsect1>
433
 
 
434
871
</refentry>
 
872
 
435
873
<!-- Local Variables: -->
436
874
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
437
875
<!-- time-stamp-end: "[\"']>" -->