/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2012-05-17 01:55:58 UTC
  • Revision ID: teddy@recompile.se-20120517015558-5703p8nkquc2rhgd
* .bzrignore (statedir): Added.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
 
6
<!ENTITY % common SYSTEM "../common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2012</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="../legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8mandos</manvolnum>
45
48
  <refnamediv>
46
49
    <refname><command>&COMMANDNAME;</command></refname>
47
50
    <refpurpose>
48
 
      Client for mandos
 
51
      Client for <application>Mandos</application>
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
55
58
      <group>
56
59
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
60
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
61
        ><replaceable>PORT</replaceable></option></arg>
59
62
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
63
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
64
        ><replaceable>PORT</replaceable></option></arg>
62
65
      </group>
63
66
      <sbr/>
64
67
      <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>
72
68
        <arg choice="plain"><option>--interface
73
69
        <replaceable>NAME</replaceable></option></arg>
74
70
        <arg choice="plain"><option>-i
98
94
      </arg>
99
95
      <sbr/>
100
96
      <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>
101
110
        <option>--debug</option>
102
111
      </arg>
103
112
    </cmdsynopsis>
120
129
      </group>
121
130
    </cmdsynopsis>
122
131
  </refsynopsisdiv>
123
 
 
 
132
  
124
133
  <refsect1 id="description">
125
134
    <title>DESCRIPTION</title>
126
135
    <para>
127
136
      <command>&COMMANDNAME;</command> is a client program that
128
137
      communicates with <citerefentry><refentrytitle
129
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
 
      to get a password.  It uses IPv6 link-local addresses to get
131
 
      network connectivity, Zeroconf to find servers, and TLS with an
132
 
      OpenPGP key to ensure authenticity and confidentiality.  It
133
 
      keeps running, trying all servers on the network, until it
134
 
      receives a satisfactory reply or a TERM signal is recieved.
 
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"/>.
135
169
    </para>
136
170
    <para>
137
171
      This program is not meant to be run directly; it is really meant
191
225
      </varlistentry>
192
226
      
193
227
      <varlistentry>
194
 
        <term><option>--keydir=<replaceable
195
 
        >DIRECTORY</replaceable></option></term>
196
 
        <term><option>-d
197
 
        <replaceable>DIRECTORY</replaceable></option></term>
198
 
        <listitem>
199
 
          <para>
200
 
            Directory to read the OpenPGP key files
201
 
            <filename>pubkey.txt</filename> and
202
 
            <filename>seckey.txt</filename> from.  The default is
203
 
            <filename>/conf/conf.d/mandos</filename> (in the initial
204
 
            <acronym>RAM</acronym> disk environment).
205
 
          </para>
206
 
        </listitem>
207
 
      </varlistentry>
208
 
 
209
 
      <varlistentry>
210
 
        <term><option>--interface=
211
 
        <replaceable>NAME</replaceable></option></term>
 
228
        <term><option>--interface=<replaceable
 
229
        >NAME</replaceable></option></term>
212
230
        <term><option>-i
213
231
        <replaceable>NAME</replaceable></option></term>
214
232
        <listitem>
215
233
          <para>
216
234
            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>.
 
235
            Mandos servers to connect to.  The default is the empty
 
236
            string, which will automatically choose an appropriate
 
237
            interface.
219
238
          </para>
220
239
          <para>
221
240
            If the <option>--connect</option> option is used, this
222
241
            specifies the interface to use to connect to the address
223
242
            given.
224
243
          </para>
 
244
          <para>
 
245
            Note that since this program will normally run in the
 
246
            initial RAM disk environment, the interface must be an
 
247
            interface which exists at that stage.  Thus, the interface
 
248
            can 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>
225
261
        </listitem>
226
262
      </varlistentry>
227
263
      
232
268
        <replaceable>FILE</replaceable></option></term>
233
269
        <listitem>
234
270
          <para>
235
 
            OpenPGP public key file base name.  This will be combined
236
 
            with the directory from the <option>--keydir</option>
237
 
            option to form an absolute file name.  The default name is
238
 
            <quote><literal>pubkey.txt</literal></quote>.
 
271
            OpenPGP public key file name.  The default name is
 
272
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
273
            ></quote>.
239
274
          </para>
240
275
        </listitem>
241
276
      </varlistentry>
242
 
 
 
277
      
243
278
      <varlistentry>
244
279
        <term><option>--seckey=<replaceable
245
280
        >FILE</replaceable></option></term>
247
282
        <replaceable>FILE</replaceable></option></term>
248
283
        <listitem>
249
284
          <para>
250
 
            OpenPGP secret key file base name.  This will be combined
251
 
            with the directory from the <option>--keydir</option>
252
 
            option to form an absolute file name.  The default name is
253
 
            <quote><literal>seckey.txt</literal></quote>.
 
285
            OpenPGP secret key file name.  The default name is
 
286
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
287
            ></quote>.
254
288
          </para>
255
289
        </listitem>
256
290
      </varlistentry>
263
297
                      xpointer="priority"/>
264
298
        </listitem>
265
299
      </varlistentry>
266
 
 
 
300
      
267
301
      <varlistentry>
268
302
        <term><option>--dh-bits=<replaceable
269
303
        >BITS</replaceable></option></term>
274
308
          </para>
275
309
        </listitem>
276
310
      </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>
277
352
      
278
353
      <varlistentry>
279
354
        <term><option>--debug</option></term>
309
384
          </para>
310
385
        </listitem>
311
386
      </varlistentry>
312
 
 
 
387
      
313
388
      <varlistentry>
314
389
        <term><option>--version</option></term>
315
390
        <term><option>-V</option></term>
321
396
      </varlistentry>
322
397
    </variablelist>
323
398
  </refsect1>
324
 
 
 
399
  
325
400
  <refsect1 id="overview">
326
401
    <title>OVERVIEW</title>
327
402
    <xi:include href="../overview.xml"/>
336
411
      <filename>/etc/crypttab</filename>, but it would then be
337
412
      impossible to enter a password for the encrypted root disk at
338
413
      the console, since this program does not read from the console
339
 
      at all.  This is why a separate plugin (<citerefentry>
 
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>
340
419
      <refentrytitle>password-prompt</refentrytitle>
341
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
342
 
      will be run in parallell to this one by the plugin runner.
 
420
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
421
      passwords on the system console.
343
422
    </para>
344
423
  </refsect1>
345
424
  
350
429
      server could be found and the password received from it could be
351
430
      successfully decrypted and output on standard output.  The
352
431
      program will exit with a non-zero exit status only if a critical
353
 
      error occurs.  Otherwise, it will forever connect to new
354
 
      <application>Mandos</application> servers as they appear, trying
355
 
      to get a decryptable password.
 
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.
356
435
    </para>
357
436
  </refsect1>
358
437
  
366
445
    </para>
367
446
  </refsect1>
368
447
  
369
 
  <refsect1 id="file">
 
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>.  Is
 
587
              only set if <envar>MODE</envar> is
 
588
              <quote><literal>start</literal></quote> or
 
589
              <quote><literal>stop</literal></quote>.
 
590
            </para>
 
591
          </listitem>
 
592
        </varlistentry>
 
593
        <varlistentry>
 
594
          <term><envar>CONNECT</envar></term>
 
595
          <listitem>
 
596
            <para>
 
597
              This will be the same as the <option>--connect</option>
 
598
              option passed to <command>&COMMANDNAME;</command>.  Is
 
599
              only set if <option>--connect</option> is passed and
 
600
              <envar>MODE</envar> is
 
601
              <quote><literal>start</literal></quote> or
 
602
              <quote><literal>stop</literal></quote>.
 
603
            </para>
 
604
          </listitem>
 
605
        </varlistentry>
 
606
      </variablelist>
 
607
      <para>
 
608
        A hook may not read from standard input, and should be
 
609
        restrictive in printing to standard output or standard error
 
610
        unless <varname>VERBOSITY</varname> is
 
611
        <quote><literal>1</literal></quote>.
 
612
      </para>
 
613
    </refsect2>
 
614
  </refsect1>
 
615
  
 
616
  <refsect1 id="files">
370
617
    <title>FILES</title>
371
618
    <variablelist>
372
619
      <varlistentry>
383
630
          </para>
384
631
        </listitem>
385
632
      </varlistentry>
 
633
      <varlistentry>
 
634
        <term><filename
 
635
        class="directory">/lib/mandos/network-hooks.d</filename></term>
 
636
        <listitem>
 
637
          <para>
 
638
            Directory where network hooks are located.  Change this
 
639
            with the <option>--network-hook-dir</option> option.  See
 
640
            <xref linkend="network-hooks"/>.
 
641
          </para>
 
642
        </listitem>
 
643
      </varlistentry>
386
644
    </variablelist>
387
645
  </refsect1>
388
646
  
391
649
<!--     <para> -->
392
650
<!--     </para> -->
393
651
<!--   </refsect1> -->
394
 
 
 
652
  
395
653
  <refsect1 id="example">
396
654
    <title>EXAMPLE</title>
397
655
    <para>
411
669
    </informalexample>
412
670
    <informalexample>
413
671
      <para>
414
 
        Search for Mandos servers on another interface:
 
672
        Search for Mandos servers (and connect to them) using another
 
673
        interface:
415
674
      </para>
416
675
      <para>
417
676
        <!-- do not wrap this line -->
420
679
    </informalexample>
421
680
    <informalexample>
422
681
      <para>
423
 
        Run in debug mode, and use a custom key directory:
 
682
        Run in debug mode, and use a custom key:
424
683
      </para>
425
684
      <para>
426
 
        <!-- do not wrap this line -->
427
 
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
685
 
 
686
<!-- do not wrap this line -->
 
687
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
688
 
428
689
      </para>
429
690
    </informalexample>
430
691
    <informalexample>
431
692
      <para>
432
 
        Run in debug mode, with a custom key directory, and do not use
433
 
        Zeroconf to locate a server; connect directly to the IPv6
 
693
        Run in debug mode, with a custom key, and do not use Zeroconf
 
694
        to locate a server; connect directly to the IPv6 link-local
434
695
        address <quote><systemitem class="ipaddress"
435
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
436
 
        port 4711, using interface eth2:
 
696
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
697
        using interface eth2:
437
698
      </para>
438
699
      <para>
439
700
 
440
701
<!-- do not wrap this line -->
441
 
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
702
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
442
703
 
443
704
      </para>
444
705
    </informalexample>
445
706
  </refsect1>
446
 
 
 
707
  
447
708
  <refsect1 id="security">
448
709
    <title>SECURITY</title>
449
710
    <para>
469
730
      The only remaining weak point is that someone with physical
470
731
      access to the client hard drive might turn off the client
471
732
      computer, read the OpenPGP keys directly from the hard drive,
472
 
      and communicate with the server.  The defense against this is
473
 
      that the server is supposed to notice the client disappearing
474
 
      and will stop giving out the encrypted data.  Therefore, it is
475
 
      important to set the timeout and checker interval values tightly
476
 
      on the server.  See <citerefentry><refentrytitle
 
733
      and communicate with the server.  To safeguard against this, the
 
734
      server is supposed to notice the client disappearing and stop
 
735
      giving out the encrypted data.  Therefore, it is important to
 
736
      set the timeout and checker interval values tightly on the
 
737
      server.  See <citerefentry><refentrytitle
477
738
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
478
739
    </para>
479
740
    <para>
490
751
      confidential.
491
752
    </para>
492
753
  </refsect1>
493
 
 
 
754
  
494
755
  <refsect1 id="see_also">
495
756
    <title>SEE ALSO</title>
496
757
    <para>
 
758
      <citerefentry><refentrytitle>intro</refentrytitle>
 
759
      <manvolnum>8mandos</manvolnum></citerefentry>,
497
760
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
498
761
      <manvolnum>8</manvolnum></citerefentry>,
499
762
      <citerefentry><refentrytitle>crypttab</refentrytitle>
621
884
      </varlistentry>
622
885
    </variablelist>
623
886
  </refsect1>
624
 
 
625
887
</refentry>
 
888
 
626
889
<!-- Local Variables: -->
627
890
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
628
891
<!-- time-stamp-end: "[\"']>" -->