/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-05 16:24:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080905162433-58fgx91ae9foxlh1
* Makefile (PIDDIR, USER, GROUP): Removed.
  (install-server): Do not create $(PIDDIR).
  (uninstall-server): Do not remove $(PIDDIR).

* init.d-mandos (PIDFILE): Changed to "/var/run/$NAME.pid".

* mandos (IPv6_TCPServer.enabled): New attribute.
  (IPv6_TCPServer.server_activate): Only call method of superclass if
                                    "self.enabled".
  (IPv6_TCPServer.enable): Set "self.enabled" to True.
  (main): Create client Set() early.  Create IPv6_TCPServer object
          early.  Switch to user and group "mandos", "nobody" or
          65534, if possible.  Enable IPv6_TCPServer *after* switching
          user.

* mandos-keygen (KEYDIR): Changed to "/etc/keys/mandos".

* mandos.xml (FILES): Changed PID file.
  (SECURITY): The server does need to be privileged, but switches to a
              non-privileged user.

* plugin-runner.xml (EXAMPLE): Changed long example to something more
                               realistic.

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 "2016-07-10">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
4
<!ENTITY VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-04">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
46
37
    <xi:include href="../legalnotice.xml"/>
47
38
  </refentryinfo>
48
 
  
 
39
 
49
40
  <refmeta>
50
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
51
42
    <manvolnum>8mandos</manvolnum>
54
45
  <refnamediv>
55
46
    <refname><command>&COMMANDNAME;</command></refname>
56
47
    <refpurpose>
57
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
58
49
    </refpurpose>
59
50
  </refnamediv>
60
 
  
 
51
 
61
52
  <refsynopsisdiv>
62
53
    <cmdsynopsis>
63
54
      <command>&COMMANDNAME;</command>
70
61
        ><replaceable>PORT</replaceable></option></arg>
71
62
      </group>
72
63
      <sbr/>
73
 
      <group rep='repeat'>
 
64
      <group>
74
65
        <arg choice="plain"><option>--interface
75
 
        <replaceable>NAME</replaceable><arg rep='repeat'
76
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
77
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
78
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
79
 
        ></option></arg>
 
66
        <replaceable>NAME</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-i
 
68
        <replaceable>NAME</replaceable></option></arg>
80
69
      </group>
81
70
      <sbr/>
82
71
      <group>
102
91
      </arg>
103
92
      <sbr/>
104
93
      <arg>
105
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
106
 
      </arg>
107
 
      <sbr/>
108
 
      <arg>
109
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
110
 
      </arg>
111
 
      <sbr/>
112
 
      <arg>
113
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
114
 
      </arg>
115
 
      <sbr/>
116
 
      <arg>
117
 
        <option>--network-hook-dir
118
 
        <replaceable>DIR</replaceable></option>
119
 
      </arg>
120
 
      <sbr/>
121
 
      <arg>
122
94
        <option>--debug</option>
123
95
      </arg>
124
96
    </cmdsynopsis>
141
113
      </group>
142
114
    </cmdsynopsis>
143
115
  </refsynopsisdiv>
144
 
  
 
116
 
145
117
  <refsect1 id="description">
146
118
    <title>DESCRIPTION</title>
147
119
    <para>
148
120
      <command>&COMMANDNAME;</command> is a client program that
149
121
      communicates with <citerefentry><refentrytitle
150
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
151
 
      to get a password.  In slightly more detail, this client program
152
 
      brings up network interfaces, uses the interfaces’ IPv6
153
 
      link-local addresses to get network connectivity, uses Zeroconf
154
 
      to find servers on the local network, and communicates with
155
 
      servers using TLS with an OpenPGP key to ensure authenticity and
156
 
      confidentiality.  This client program keeps running, trying all
157
 
      servers on the network, until it receives a satisfactory reply
158
 
      or a TERM signal.  After all servers have been tried, all
159
 
      servers are periodically retried.  If no servers are found it
160
 
      will wait indefinitely for new servers to appear.
161
 
    </para>
162
 
    <para>
163
 
      The network interfaces are selected like this: If any interfaces
164
 
      are specified using the <option>--interface</option> option,
165
 
      those interface are used.  Otherwise,
166
 
      <command>&COMMANDNAME;</command> will use all interfaces that
167
 
      are not loopback interfaces, are not point-to-point interfaces,
168
 
      are capable of broadcasting and do not have the NOARP flag (see
169
 
      <citerefentry><refentrytitle>netdevice</refentrytitle>
170
 
      <manvolnum>7</manvolnum></citerefentry>).  (If the
171
 
      <option>--connect</option> option is used, point-to-point
172
 
      interfaces and non-broadcast interfaces are accepted.)  If any
173
 
      used interfaces are not up and running, they are first taken up
174
 
      (and later taken down again on program exit).
175
 
    </para>
176
 
    <para>
177
 
      Before network interfaces are selected, all <quote>network
178
 
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
 
123
      to get a password.  It uses IPv6 link-local addresses to get
 
124
      network connectivity, Zeroconf to find servers, and TLS with an
 
125
      OpenPGP key to ensure authenticity and confidentiality.  It
 
126
      keeps running, trying all servers on the network, until it
 
127
      receives a satisfactory reply or a TERM signal is received.
179
128
    </para>
180
129
    <para>
181
130
      This program is not meant to be run directly; it is really meant
228
177
            assumed to separate the address from the port number.
229
178
          </para>
230
179
          <para>
231
 
            Normally, Zeroconf would be used to locate Mandos servers,
232
 
            in which case this option would only be used when testing
233
 
            and debugging.
 
180
            This option is normally only useful for testing and
 
181
            debugging.
234
182
          </para>
235
183
        </listitem>
236
184
      </varlistentry>
237
185
      
238
186
      <varlistentry>
239
 
        <term><option>--interface=<replaceable
240
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
241
 
        >NAME</replaceable></arg></option></term>
 
187
        <term><option>--interface=
 
188
        <replaceable>NAME</replaceable></option></term>
242
189
        <term><option>-i
243
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
244
 
        >NAME</replaceable></arg></option></term>
 
190
        <replaceable>NAME</replaceable></option></term>
245
191
        <listitem>
246
192
          <para>
247
 
            Comma separated list of network interfaces that will be
248
 
            brought up and scanned for Mandos servers to connect to.
249
 
            The default is the empty string, which will automatically
250
 
            use all appropriate interfaces.
251
 
          </para>
252
 
          <para>
253
 
            If the <option>--connect</option> option is used, and
254
 
            exactly one interface name is specified (except
255
 
            <quote><literal>none</literal></quote>), this specifies
256
 
            the interface to use to connect to the address given.
257
 
          </para>
258
 
          <para>
259
 
            Note that since this program will normally run in the
260
 
            initial RAM disk environment, the interface must be an
261
 
            interface which exists at that stage.  Thus, the interface
262
 
            can normally not be a pseudo-interface such as
263
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
264
 
            will not exist until much later in the boot process, and
265
 
            can not be used by this program, unless created by a
266
 
            <quote>network hook</quote> — see <xref
267
 
            linkend="network-hooks"/>.
268
 
          </para>
269
 
          <para>
270
 
            <replaceable>NAME</replaceable> can be the string
271
 
            <quote><literal>none</literal></quote>; this will make
272
 
            <command>&COMMANDNAME;</command> only bring up interfaces
273
 
            specified <emphasis>before</emphasis> this string.  This
274
 
            is not recommended, and only meant for advanced users.
 
193
            Network interface that will be brought up and scanned for
 
194
            Mandos servers to connect to.  The default it
 
195
            <quote><literal>eth0</literal></quote>.
 
196
          </para>
 
197
          <para>
 
198
            If the <option>--connect</option> option is used, this
 
199
            specifies the interface to use to connect to the address
 
200
            given.
275
201
          </para>
276
202
        </listitem>
277
203
      </varlistentry>
289
215
          </para>
290
216
        </listitem>
291
217
      </varlistentry>
292
 
      
 
218
 
293
219
      <varlistentry>
294
220
        <term><option>--seckey=<replaceable
295
221
        >FILE</replaceable></option></term>
312
238
                      xpointer="priority"/>
313
239
        </listitem>
314
240
      </varlistentry>
315
 
      
 
241
 
316
242
      <varlistentry>
317
243
        <term><option>--dh-bits=<replaceable
318
244
        >BITS</replaceable></option></term>
319
245
        <listitem>
320
246
          <para>
321
247
            Sets the number of bits to use for the prime number in the
322
 
            TLS Diffie-Hellman key exchange.  The default value is
323
 
            selected automatically based on the OpenPGP key.  Note
324
 
            that if the <option>--dh-params</option> option is used,
325
 
            the values from that file will be used instead.
326
 
          </para>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--dh-params=<replaceable
332
 
        >FILE</replaceable></option></term>
333
 
        <listitem>
334
 
          <para>
335
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
336
 
            needed by the TLS Diffie-Hellman key exchange from.  If
337
 
            this option is not given, or if the file for some reason
338
 
            could not be used, the parameters will be generated on
339
 
            startup, which will take some time and processing power.
340
 
            Those using servers running under time, power or processor
341
 
            constraints may want to generate such a file in advance
342
 
            and use this option.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
 
 
347
 
      <varlistentry>
348
 
        <term><option>--delay=<replaceable
349
 
        >SECONDS</replaceable></option></term>
350
 
        <listitem>
351
 
          <para>
352
 
            After bringing a network interface up, the program waits
353
 
            for the interface to arrive in a <quote>running</quote>
354
 
            state before proceeding.  During this time, the kernel log
355
 
            level will be lowered to reduce clutter on the system
356
 
            console, alleviating any other plugins which might be
357
 
            using the system console.  This option sets the upper
358
 
            limit of seconds to wait.  The default is 2.5 seconds.
359
 
          </para>
360
 
        </listitem>
361
 
      </varlistentry>
362
 
 
363
 
      <varlistentry>
364
 
        <term><option>--retry=<replaceable
365
 
        >SECONDS</replaceable></option></term>
366
 
        <listitem>
367
 
          <para>
368
 
            All Mandos servers are tried repeatedly until a password
369
 
            is received.  This value specifies, in seconds, how long
370
 
            between each successive try <emphasis>for the same
371
 
            server</emphasis>.  The default is 10 seconds.
372
 
          </para>
373
 
        </listitem>
374
 
      </varlistentry>
375
 
 
376
 
      <varlistentry>
377
 
        <term><option>--network-hook-dir=<replaceable
378
 
        >DIR</replaceable></option></term>
379
 
        <listitem>
380
 
          <para>
381
 
            Network hook directory.  The default directory is
382
 
            <quote><filename class="directory"
383
 
            >/lib/mandos/network-hooks.d</filename></quote>.
 
248
            TLS Diffie-Hellman key exchange.  Default is 1024.
384
249
          </para>
385
250
        </listitem>
386
251
      </varlistentry>
419
284
          </para>
420
285
        </listitem>
421
286
      </varlistentry>
422
 
      
 
287
 
423
288
      <varlistentry>
424
289
        <term><option>--version</option></term>
425
290
        <term><option>-V</option></term>
431
296
      </varlistentry>
432
297
    </variablelist>
433
298
  </refsect1>
434
 
  
 
299
 
435
300
  <refsect1 id="overview">
436
301
    <title>OVERVIEW</title>
437
302
    <xi:include href="../overview.xml"/>
446
311
      <filename>/etc/crypttab</filename>, but it would then be
447
312
      impossible to enter a password for the encrypted root disk at
448
313
      the console, since this program does not read from the console
449
 
      at all.  This is why a separate plugin runner (<citerefentry>
450
 
      <refentrytitle>plugin-runner</refentrytitle>
451
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
452
 
      both this program and others in in parallel,
453
 
      <emphasis>one</emphasis> of which (<citerefentry>
 
314
      at all.  This is why a separate plugin (<citerefentry>
454
315
      <refentrytitle>password-prompt</refentrytitle>
455
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
456
 
      passwords on the system console.
 
316
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
 
317
      will be run in parallel to this one by the plugin runner.
457
318
    </para>
458
319
  </refsect1>
459
320
  
464
325
      server could be found and the password received from it could be
465
326
      successfully decrypted and output on standard output.  The
466
327
      program will exit with a non-zero exit status only if a critical
467
 
      error occurs.  Otherwise, it will forever connect to any
468
 
      discovered <application>Mandos</application> servers, trying to
469
 
      get a decryptable password and print it.
 
328
      error occurs.  Otherwise, it will forever connect to new
 
329
      <application>Mandos</application> servers as they appear, trying
 
330
      to get a decryptable password.
470
331
    </para>
471
332
  </refsect1>
472
333
  
473
334
  <refsect1 id="environment">
474
335
    <title>ENVIRONMENT</title>
475
 
    <variablelist>
476
 
      <varlistentry>
477
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
478
 
        <listitem>
479
 
          <para>
480
 
            This environment variable will be assumed to contain the
481
 
            directory containing any helper executables.  The use and
482
 
            nature of these helper executables, if any, is
483
 
            purposefully not documented.
484
 
        </para>
485
 
        </listitem>
486
 
      </varlistentry>
487
 
    </variablelist>
488
336
    <para>
489
 
      This program does not use any other environment variables, not
490
 
      even the ones provided by <citerefentry><refentrytitle
 
337
      This program does not use any environment variables, not even
 
338
      the ones provided by <citerefentry><refentrytitle
491
339
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
492
340
    </citerefentry>.
493
341
    </para>
494
342
  </refsect1>
495
343
  
496
 
  <refsect1 id="network-hooks">
497
 
    <title>NETWORK HOOKS</title>
498
 
    <para>
499
 
      If a network interface like a bridge or tunnel is required to
500
 
      find a Mandos server, this requires the interface to be up and
501
 
      running before <command>&COMMANDNAME;</command> starts looking
502
 
      for Mandos servers.  This can be accomplished by creating a
503
 
      <quote>network hook</quote> program, and placing it in a special
504
 
      directory.
505
 
    </para>
506
 
    <para>
507
 
      Before the network is used (and again before program exit), any
508
 
      runnable programs found in the network hook directory are run
509
 
      with the argument <quote><literal>start</literal></quote> or
510
 
      <quote><literal>stop</literal></quote>.  This should bring up or
511
 
      down, respectively, any network interface which
512
 
      <command>&COMMANDNAME;</command> should use.
513
 
    </para>
514
 
    <refsect2 id="hook-requirements">
515
 
      <title>REQUIREMENTS</title>
516
 
      <para>
517
 
        A network hook must be an executable file, and its name must
518
 
        consist entirely of upper and lower case letters, digits,
519
 
        underscores, periods, and hyphens.
520
 
      </para>
521
 
      <para>
522
 
        A network hook will receive one argument, which can be one of
523
 
        the following:
524
 
      </para>
525
 
      <variablelist>
526
 
        <varlistentry>
527
 
          <term><literal>start</literal></term>
528
 
          <listitem>
529
 
            <para>
530
 
              This should make the network hook create (if necessary)
531
 
              and bring up a network interface.
532
 
            </para>
533
 
          </listitem>
534
 
        </varlistentry>
535
 
        <varlistentry>
536
 
          <term><literal>stop</literal></term>
537
 
          <listitem>
538
 
            <para>
539
 
              This should make the network hook take down a network
540
 
              interface, and delete it if it did not exist previously.
541
 
            </para>
542
 
          </listitem>
543
 
        </varlistentry>
544
 
        <varlistentry>
545
 
          <term><literal>files</literal></term>
546
 
          <listitem>
547
 
            <para>
548
 
              This should make the network hook print, <emphasis>one
549
 
              file per line</emphasis>, all the files needed for it to
550
 
              run.  (These files will be copied into the initial RAM
551
 
              filesystem.)  Typical use is for a network hook which is
552
 
              a shell script to print its needed binaries.
553
 
            </para>
554
 
            <para>
555
 
              It is not necessary to print any non-executable files
556
 
              already in the network hook directory, these will be
557
 
              copied implicitly if they otherwise satisfy the name
558
 
              requirements.
559
 
            </para>
560
 
          </listitem>
561
 
        </varlistentry>
562
 
        <varlistentry>
563
 
          <term><literal>modules</literal></term>
564
 
          <listitem>
565
 
            <para>
566
 
              This should make the network hook print, <emphasis>on
567
 
              separate lines</emphasis>, all the kernel modules needed
568
 
              for it to run.  (These modules will be copied into the
569
 
              initial RAM filesystem.)  For instance, a tunnel
570
 
              interface needs the
571
 
              <quote><literal>tun</literal></quote> module.
572
 
            </para>
573
 
          </listitem>
574
 
        </varlistentry>
575
 
      </variablelist>
576
 
      <para>
577
 
        The network hook will be provided with a number of environment
578
 
        variables:
579
 
      </para>
580
 
      <variablelist>
581
 
        <varlistentry>
582
 
          <term><envar>MANDOSNETHOOKDIR</envar></term>
583
 
          <listitem>
584
 
            <para>
585
 
              The network hook directory, specified to
586
 
              <command>&COMMANDNAME;</command> by the
587
 
              <option>--network-hook-dir</option> option.  Note: this
588
 
              should <emphasis>always</emphasis> be used by the
589
 
              network hook to refer to itself or any files in the hook
590
 
              directory it may require.
591
 
            </para>
592
 
          </listitem>
593
 
        </varlistentry>
594
 
        <varlistentry>
595
 
          <term><envar>DEVICE</envar></term>
596
 
          <listitem>
597
 
            <para>
598
 
              The network interfaces, as specified to
599
 
              <command>&COMMANDNAME;</command> by the
600
 
              <option>--interface</option> option, combined to one
601
 
              string and separated by commas.  If this is set, and
602
 
              does not contain the interface a hook will bring up,
603
 
              there is no reason for a hook to continue.
604
 
            </para>
605
 
          </listitem>
606
 
        </varlistentry>
607
 
        <varlistentry>
608
 
          <term><envar>MODE</envar></term>
609
 
          <listitem>
610
 
            <para>
611
 
              This will be the same as the first argument;
612
 
              i.e. <quote><literal>start</literal></quote>,
613
 
              <quote><literal>stop</literal></quote>,
614
 
              <quote><literal>files</literal></quote>, or
615
 
              <quote><literal>modules</literal></quote>.
616
 
            </para>
617
 
          </listitem>
618
 
        </varlistentry>
619
 
        <varlistentry>
620
 
          <term><envar>VERBOSITY</envar></term>
621
 
          <listitem>
622
 
            <para>
623
 
              This will be the <quote><literal>1</literal></quote> if
624
 
              the <option>--debug</option> option is passed to
625
 
              <command>&COMMANDNAME;</command>, otherwise
626
 
              <quote><literal>0</literal></quote>.
627
 
            </para>
628
 
          </listitem>
629
 
        </varlistentry>
630
 
        <varlistentry>
631
 
          <term><envar>DELAY</envar></term>
632
 
          <listitem>
633
 
            <para>
634
 
              This will be the same as the <option>--delay</option>
635
 
              option passed to <command>&COMMANDNAME;</command>.  Is
636
 
              only set if <envar>MODE</envar> is
637
 
              <quote><literal>start</literal></quote> or
638
 
              <quote><literal>stop</literal></quote>.
639
 
            </para>
640
 
          </listitem>
641
 
        </varlistentry>
642
 
        <varlistentry>
643
 
          <term><envar>CONNECT</envar></term>
644
 
          <listitem>
645
 
            <para>
646
 
              This will be the same as the <option>--connect</option>
647
 
              option passed to <command>&COMMANDNAME;</command>.  Is
648
 
              only set if <option>--connect</option> is passed and
649
 
              <envar>MODE</envar> is
650
 
              <quote><literal>start</literal></quote> or
651
 
              <quote><literal>stop</literal></quote>.
652
 
            </para>
653
 
          </listitem>
654
 
        </varlistentry>
655
 
      </variablelist>
656
 
      <para>
657
 
        A hook may not read from standard input, and should be
658
 
        restrictive in printing to standard output or standard error
659
 
        unless <varname>VERBOSITY</varname> is
660
 
        <quote><literal>1</literal></quote>.
661
 
      </para>
662
 
    </refsect2>
663
 
  </refsect1>
664
 
  
665
 
  <refsect1 id="files">
 
344
  <refsect1 id="file">
666
345
    <title>FILES</title>
667
346
    <variablelist>
668
347
      <varlistentry>
679
358
          </para>
680
359
        </listitem>
681
360
      </varlistentry>
682
 
      <varlistentry>
683
 
        <term><filename
684
 
        class="directory">/lib/mandos/network-hooks.d</filename></term>
685
 
        <listitem>
686
 
          <para>
687
 
            Directory where network hooks are located.  Change this
688
 
            with the <option>--network-hook-dir</option> option.  See
689
 
            <xref linkend="network-hooks"/>.
690
 
          </para>
691
 
        </listitem>
692
 
      </varlistentry>
693
361
    </variablelist>
694
362
  </refsect1>
695
363
  
696
 
  <refsect1 id="bugs">
697
 
    <title>BUGS</title>
698
 
    <xi:include href="../bugs.xml"/>
699
 
  </refsect1>
700
 
  
 
364
<!--   <refsect1 id="bugs"> -->
 
365
<!--     <title>BUGS</title> -->
 
366
<!--     <para> -->
 
367
<!--     </para> -->
 
368
<!--   </refsect1> -->
 
369
 
701
370
  <refsect1 id="example">
702
371
    <title>EXAMPLE</title>
703
372
    <para>
708
377
    </para>
709
378
    <informalexample>
710
379
      <para>
711
 
        Normal invocation needs no options, if the network interfaces
712
 
        can be automatically determined:
 
380
        Normal invocation needs no options, if the network interface
 
381
        is <quote>eth0</quote>:
713
382
      </para>
714
383
      <para>
715
384
        <userinput>&COMMANDNAME;</userinput>
717
386
    </informalexample>
718
387
    <informalexample>
719
388
      <para>
720
 
        Search for Mandos servers (and connect to them) using one
721
 
        specific interface:
 
389
        Search for Mandos servers (and connect to them) using another
 
390
        interface:
722
391
      </para>
723
392
      <para>
724
393
        <!-- do not wrap this line -->
739
408
    <informalexample>
740
409
      <para>
741
410
        Run in debug mode, with a custom key, and do not use Zeroconf
742
 
        to locate a server; connect directly to the IPv6 link-local
743
 
        address <quote><systemitem class="ipaddress"
744
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
745
 
        using interface eth2:
 
411
        to locate a server; connect directly to the IPv6 address
 
412
        <quote><systemitem class="ipaddress"
 
413
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
414
        port 4711, using interface eth2:
746
415
      </para>
747
416
      <para>
748
417
 
749
418
<!-- do not wrap this line -->
750
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
419
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
751
420
 
752
421
      </para>
753
422
    </informalexample>
754
423
  </refsect1>
755
 
  
 
424
 
756
425
  <refsect1 id="security">
757
426
    <title>SECURITY</title>
758
427
    <para>
778
447
      The only remaining weak point is that someone with physical
779
448
      access to the client hard drive might turn off the client
780
449
      computer, read the OpenPGP keys directly from the hard drive,
781
 
      and communicate with the server.  To safeguard against this, the
782
 
      server is supposed to notice the client disappearing and stop
783
 
      giving out the encrypted data.  Therefore, it is important to
784
 
      set the timeout and checker interval values tightly on the
785
 
      server.  See <citerefentry><refentrytitle
 
450
      and communicate with the server.  The defense against this is
 
451
      that the server is supposed to notice the client disappearing
 
452
      and will stop giving out the encrypted data.  Therefore, it is
 
453
      important to set the timeout and checker interval values tightly
 
454
      on the server.  See <citerefentry><refentrytitle
786
455
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
456
    </para>
788
457
    <para>
789
458
      It will also help if the checker program on the server is
790
459
      configured to request something from the client which can not be
791
 
      spoofed by someone else on the network, like SSH server key
792
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
793
 
      echo (<quote>ping</quote>) replies.
 
460
      spoofed by someone else on the network, unlike unencrypted
 
461
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
794
462
    </para>
795
463
    <para>
796
464
      <emphasis>Note</emphasis>: This makes it completely insecure to
800
468
      confidential.
801
469
    </para>
802
470
  </refsect1>
803
 
  
 
471
 
804
472
  <refsect1 id="see_also">
805
473
    <title>SEE ALSO</title>
806
474
    <para>
807
 
      <citerefentry><refentrytitle>intro</refentrytitle>
808
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
809
475
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
810
476
      <manvolnum>8</manvolnum></citerefentry>,
811
477
      <citerefentry><refentrytitle>crypttab</refentrytitle>
842
508
      </varlistentry>
843
509
      <varlistentry>
844
510
        <term>
845
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
511
          <ulink url="http://www.gnu.org/software/gnutls/"
 
512
          >GnuTLS</ulink>
846
513
        </term>
847
514
      <listitem>
848
515
        <para>
854
521
      </varlistentry>
855
522
      <varlistentry>
856
523
        <term>
857
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
524
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
858
525
                 >GPGME</ulink>
859
526
        </term>
860
527
        <listitem>
888
555
              <para>
889
556
                This client uses IPv6 link-local addresses, which are
890
557
                immediately usable since a link-local addresses is
891
 
                automatically assigned to a network interface when it
 
558
                automatically assigned to a network interfaces when it
892
559
                is brought up.
893
560
              </para>
894
561
            </listitem>
898
565
      </varlistentry>
899
566
      <varlistentry>
900
567
        <term>
901
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
902
 
          Protocol Version 1.2</citetitle>
 
568
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
569
          Protocol Version 1.1</citetitle>
903
570
        </term>
904
571
      <listitem>
905
572
        <para>
906
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
573
          TLS 1.1 is the protocol implemented by GnuTLS.
907
574
        </para>
908
575
      </listitem>
909
576
      </varlistentry>
920
587
      </varlistentry>
921
588
      <varlistentry>
922
589
        <term>
923
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
590
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
924
591
          Security</citetitle>
925
592
        </term>
926
593
      <listitem>
932
599
      </varlistentry>
933
600
    </variablelist>
934
601
  </refsect1>
 
602
 
935
603
</refentry>
936
 
 
937
604
<!-- Local Variables: -->
938
605
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
939
606
<!-- time-stamp-end: "[\"']>" -->