/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

  • Committer: Teddy Hogeborn
  • Date: 2014-05-11 20:18:48 UTC
  • Revision ID: teddy@recompile.se-20140511201848-blw9pl5c76upkhdc
Tags: version-1.6.5-1
* Makefile (version): Changed to "1.6.5".
* NEWS (Version 1.6.5): New entry.
* debian/changelog (1.6.5-1): - '' -

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