/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: 2012-06-13 22:06:57 UTC
  • mto: This revision was merged to the branch mainline in revision 596.
  • Revision ID: teddy@recompile.se-20120613220657-qvq7c7nrndl3t413
* plugins.d/mandos-client.c (get_flags): Don't clobber errno.
  (up_interface): Removed; replaced with "interface_is_up".
  (interface_is_up, interface_is_running,
   lower_privileges_permanently, take_down_interface): New.
  (bring_up_interface): Return "error_t".  Use new functions
                        "interface_is_up", "get_flags", and
                        "interface_is_running".
  (main): Save all interfaces either autodetected or specified with
          --interface in argz vector "interfaces".  Save interfaces to
          take down on exit in argz vector "interfaces_to_take_down".
          Save interface names for DEVICE variable to network hooks as
          argz_vector "interfaces_hooks".  Bug fix: Be privileged
          while stopping network hooks.
* plugins.d/mandos-client.xml (SYNOPSIS): Changed --interface synopsis.
  (DESCRIPTION): Updated to document use of all interfaces.
  (OPTIONS): Updated description of "--interface".
* network-hooks.d/bridge: Parse comma-separated DEVICE environment
                          variable.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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