/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/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 17:11:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903171132-usevhlf0gi9rxqc3
* plugins.d/password-request.c (init_gnutls_global): Improved wording
                                                     in debug message.
                                                     Bug fix: Make
                                                     debug message
                                                     print to stderr,
                                                     not stdout.

* plugins.d/password-request.xml (SECURITY): Add text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.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 COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2012-06-13">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
4
<!ENTITY VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2012</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
37
    <xi:include href="../legalnotice.xml"/>
41
38
  </refentryinfo>
42
 
  
 
39
 
43
40
  <refmeta>
44
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
    <manvolnum>8mandos</manvolnum>
48
45
  <refnamediv>
49
46
    <refname><command>&COMMANDNAME;</command></refname>
50
47
    <refpurpose>
51
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
52
49
    </refpurpose>
53
50
  </refnamediv>
54
 
  
 
51
 
55
52
  <refsynopsisdiv>
56
53
    <cmdsynopsis>
57
54
      <command>&COMMANDNAME;</command>
58
55
      <group>
59
56
        <arg choice="plain"><option>--connect
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
61
58
        ><replaceable>PORT</replaceable></option></arg>
62
59
        <arg choice="plain"><option>-c
63
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
64
61
        ><replaceable>PORT</replaceable></option></arg>
65
62
      </group>
66
63
      <sbr/>
67
 
      <group rep='repeat'>
 
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>
68
72
        <arg choice="plain"><option>--interface
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>
 
73
        <replaceable>NAME</replaceable></option></arg>
 
74
        <arg choice="plain"><option>-i
 
75
        <replaceable>NAME</replaceable></option></arg>
74
76
      </group>
75
77
      <sbr/>
76
78
      <group>
96
98
      </arg>
97
99
      <sbr/>
98
100
      <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>
112
101
        <option>--debug</option>
113
102
      </arg>
114
103
    </cmdsynopsis>
131
120
      </group>
132
121
    </cmdsynopsis>
133
122
  </refsynopsisdiv>
134
 
  
 
123
 
135
124
  <refsect1 id="description">
136
125
    <title>DESCRIPTION</title>
137
126
    <para>
138
127
      <command>&COMMANDNAME;</command> is a client program that
139
128
      communicates with <citerefentry><refentrytitle
140
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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"/>.
 
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.
169
135
    </para>
170
136
    <para>
171
137
      This program is not meant to be run directly; it is really meant
225
191
      </varlistentry>
226
192
      
227
193
      <varlistentry>
228
 
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
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>
230
212
        <term><option>-i
231
213
        <replaceable>NAME</replaceable></option></term>
232
214
        <listitem>
233
215
          <para>
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.
 
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>.
238
219
          </para>
239
220
          <para>
240
221
            If the <option>--connect</option> option is used, this
241
222
            specifies the interface to use to connect to the address
242
223
            given.
243
224
          </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>
262
225
        </listitem>
263
226
      </varlistentry>
264
227
      
269
232
        <replaceable>FILE</replaceable></option></term>
270
233
        <listitem>
271
234
          <para>
272
 
            OpenPGP public key file name.  The default name is
273
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
274
 
            ></quote>.
 
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>.
275
239
          </para>
276
240
        </listitem>
277
241
      </varlistentry>
278
 
      
 
242
 
279
243
      <varlistentry>
280
244
        <term><option>--seckey=<replaceable
281
245
        >FILE</replaceable></option></term>
283
247
        <replaceable>FILE</replaceable></option></term>
284
248
        <listitem>
285
249
          <para>
286
 
            OpenPGP secret key file name.  The default name is
287
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
288
 
            ></quote>.
 
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>.
289
254
          </para>
290
255
        </listitem>
291
256
      </varlistentry>
298
263
                      xpointer="priority"/>
299
264
        </listitem>
300
265
      </varlistentry>
301
 
      
 
266
 
302
267
      <varlistentry>
303
268
        <term><option>--dh-bits=<replaceable
304
269
        >BITS</replaceable></option></term>
309
274
          </para>
310
275
        </listitem>
311
276
      </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>
353
277
      
354
278
      <varlistentry>
355
279
        <term><option>--debug</option></term>
385
309
          </para>
386
310
        </listitem>
387
311
      </varlistentry>
388
 
      
 
312
 
389
313
      <varlistentry>
390
314
        <term><option>--version</option></term>
391
315
        <term><option>-V</option></term>
397
321
      </varlistentry>
398
322
    </variablelist>
399
323
  </refsect1>
400
 
  
 
324
 
401
325
  <refsect1 id="overview">
402
326
    <title>OVERVIEW</title>
403
327
    <xi:include href="../overview.xml"/>
412
336
      <filename>/etc/crypttab</filename>, but it would then be
413
337
      impossible to enter a password for the encrypted root disk at
414
338
      the console, since this program does not read from the console
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.
 
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.
423
341
    </para>
424
342
  </refsect1>
425
343
  
430
348
      server could be found and the password received from it could be
431
349
      successfully decrypted and output on standard output.  The
432
350
      program will exit with a non-zero exit status only if a critical
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.
 
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.
436
354
    </para>
437
355
  </refsect1>
438
356
  
446
364
    </para>
447
365
  </refsect1>
448
366
  
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">
 
367
  <refsect1 id="file">
619
368
    <title>FILES</title>
620
369
    <variablelist>
621
370
      <varlistentry>
632
381
          </para>
633
382
        </listitem>
634
383
      </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>
646
384
    </variablelist>
647
385
  </refsect1>
648
386
  
651
389
<!--     <para> -->
652
390
<!--     </para> -->
653
391
<!--   </refsect1> -->
654
 
  
 
392
 
655
393
  <refsect1 id="example">
656
394
    <title>EXAMPLE</title>
657
395
    <para>
663
401
    <informalexample>
664
402
      <para>
665
403
        Normal invocation needs no options, if the network interface
666
 
        can be automatically determined:
 
404
        is <quote>eth0</quote>:
667
405
      </para>
668
406
      <para>
669
407
        <userinput>&COMMANDNAME;</userinput>
671
409
    </informalexample>
672
410
    <informalexample>
673
411
      <para>
674
 
        Search for Mandos servers (and connect to them) using another
675
 
        interface:
 
412
        Search for Mandos servers on another interface:
676
413
      </para>
677
414
      <para>
678
415
        <!-- do not wrap this line -->
681
418
    </informalexample>
682
419
    <informalexample>
683
420
      <para>
684
 
        Run in debug mode, and use a custom key:
 
421
        Run in debug mode, and use a custom key directory:
685
422
      </para>
686
423
      <para>
687
 
 
688
 
<!-- do not wrap this line -->
689
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
690
 
 
 
424
        <!-- do not wrap this line -->
 
425
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
691
426
      </para>
692
427
    </informalexample>
693
428
    <informalexample>
694
429
      <para>
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
 
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
697
432
        address <quote><systemitem class="ipaddress"
698
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
699
 
        using interface eth2:
 
433
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
434
        port 4711, using interface eth2:
700
435
      </para>
701
436
      <para>
702
437
 
703
438
<!-- do not wrap this line -->
704
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
705
440
 
706
441
      </para>
707
442
    </informalexample>
708
443
  </refsect1>
709
 
  
 
444
 
710
445
  <refsect1 id="security">
711
446
    <title>SECURITY</title>
712
447
    <para>
713
448
      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.
 
449
      original user and group after bringing up the network interface.
716
450
    </para>
717
451
    <para>
718
452
      To use this program for its intended purpose (see <xref
732
466
      The only remaining weak point is that someone with physical
733
467
      access to the client hard drive might turn off the client
734
468
      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
 
469
      and communicate with the server.  The defense against this is
 
470
      that the server is supposed to notice the client disappearing
 
471
      and will stop giving out the encrypted data.  Therefore, it is
 
472
      important to set the timeout and checker interval values tightly
 
473
      on the server.  See <citerefentry><refentrytitle
740
474
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
741
475
    </para>
742
476
    <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.
 
477
      <emphasis>Note</emphasis>: This makes it impossible to have
 
478
      <application >Mandos</application> clients which dual-boot to
 
479
      another operating system which does <emphasis>not</emphasis> run
 
480
      a <application>Mandos</application> client.
754
481
    </para>
755
482
  </refsect1>
756
 
  
 
483
 
757
484
  <refsect1 id="see_also">
758
485
    <title>SEE ALSO</title>
759
486
    <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>,
766
487
      <citerefentry><refentrytitle>mandos</refentrytitle>
767
488
      <manvolnum>8</manvolnum></citerefentry>,
768
489
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
770
491
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
771
492
      <manvolnum>8mandos</manvolnum></citerefentry>
772
493
    </para>
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>
 
494
    <itemizedlist>
 
495
      <listitem><para>
 
496
        <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
497
      </para></listitem>
 
498
      
 
499
      <listitem><para>
 
500
        <ulink url="http://www.avahi.org/">Avahi</ulink>
 
501
      </para></listitem>
 
502
      
 
503
      <listitem><para>
 
504
        <ulink
 
505
            url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
506
      </para></listitem>
 
507
      
 
508
      <listitem><para>
 
509
        <ulink
 
510
        url="http://www.gnupg.org/related_software/gpgme/"
 
511
        >GPGME</ulink>
 
512
      </para></listitem>
 
513
      
 
514
      <listitem><para>
 
515
        <citation>RFC 4880: <citetitle>OpenPGP Message
 
516
        Format</citetitle></citation>
 
517
      </para></listitem>
 
518
      
 
519
      <listitem><para>
 
520
        <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
521
        Transport Layer Security</citetitle></citation>
 
522
      </para></listitem>
 
523
      
 
524
      <listitem><para>
 
525
        <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
526
        Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
527
        Unicast Addresses</citation>
 
528
      </para></listitem>
 
529
    </itemizedlist>
888
530
  </refsect1>
 
531
 
889
532
</refentry>
890
 
 
891
533
<!-- Local Variables: -->
892
534
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
893
535
<!-- time-stamp-end: "[\"']>" -->