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