/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

* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
                                                 "--network-hook-dir"
                                                 option.

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 "2011-10-03">
 
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>2011</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<replaceable>DIR</replaceable></option>
 
106
      </arg>
 
107
      <sbr/>
 
108
      <arg>
101
109
        <option>--debug</option>
102
110
      </arg>
103
111
    </cmdsynopsis>
120
128
      </group>
121
129
    </cmdsynopsis>
122
130
  </refsynopsisdiv>
123
 
 
 
131
  
124
132
  <refsect1 id="description">
125
133
    <title>DESCRIPTION</title>
126
134
    <para>
127
135
      <command>&COMMANDNAME;</command> is a client program that
128
136
      communicates with <citerefentry><refentrytitle
129
137
      >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.
 
138
      to get a password.  In slightly more detail, this client program
 
139
      brings up a network interface, uses the interface’s IPv6
 
140
      link-local address to get network connectivity, uses Zeroconf to
 
141
      find servers on the local network, and communicates with servers
 
142
      using TLS with an OpenPGP key to ensure authenticity and
 
143
      confidentiality.  This client program keeps running, trying all
 
144
      servers on the network, until it receives a satisfactory reply
 
145
      or a TERM signal.  After all servers have been tried, all
 
146
      servers are periodically retried.  If no servers are found it
 
147
      will wait indefinitely for new servers to appear.
135
148
    </para>
136
149
    <para>
137
150
      This program is not meant to be run directly; it is really meant
191
204
      </varlistentry>
192
205
      
193
206
      <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>
 
207
        <term><option>--interface=<replaceable
 
208
        >NAME</replaceable></option></term>
212
209
        <term><option>-i
213
210
        <replaceable>NAME</replaceable></option></term>
214
211
        <listitem>
215
212
          <para>
216
213
            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>.
 
214
            Mandos servers to connect to.  The default is the empty
 
215
            string, which will automatically choose an appropriate
 
216
            interface.
219
217
          </para>
220
218
          <para>
221
219
            If the <option>--connect</option> option is used, this
222
220
            specifies the interface to use to connect to the address
223
221
            given.
224
222
          </para>
 
223
          <para>
 
224
            Note that since this program will normally run in the
 
225
            initial RAM disk environment, the interface must be an
 
226
            interface which exists at that stage.  Thus, the interface
 
227
            can not be a pseudo-interface such as <quote>br0</quote>
 
228
            or <quote>tun0</quote>; such interfaces will not exist
 
229
            until much later in the boot process, and can not be used
 
230
            by this program.
 
231
          </para>
 
232
          <para>
 
233
            <replaceable>NAME</replaceable> can be the string
 
234
            <quote><literal>none</literal></quote>; this will not use
 
235
            any specific interface, and will not bring up an interface
 
236
            on startup.  This is not recommended, and only meant for
 
237
            advanced users.
 
238
          </para>
225
239
        </listitem>
226
240
      </varlistentry>
227
241
      
232
246
        <replaceable>FILE</replaceable></option></term>
233
247
        <listitem>
234
248
          <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>.
 
249
            OpenPGP public key file name.  The default name is
 
250
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
251
            ></quote>.
239
252
          </para>
240
253
        </listitem>
241
254
      </varlistentry>
242
 
 
 
255
      
243
256
      <varlistentry>
244
257
        <term><option>--seckey=<replaceable
245
258
        >FILE</replaceable></option></term>
247
260
        <replaceable>FILE</replaceable></option></term>
248
261
        <listitem>
249
262
          <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>.
 
263
            OpenPGP secret key file name.  The default name is
 
264
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
265
            ></quote>.
254
266
          </para>
255
267
        </listitem>
256
268
      </varlistentry>
263
275
                      xpointer="priority"/>
264
276
        </listitem>
265
277
      </varlistentry>
266
 
 
 
278
      
267
279
      <varlistentry>
268
280
        <term><option>--dh-bits=<replaceable
269
281
        >BITS</replaceable></option></term>
274
286
          </para>
275
287
        </listitem>
276
288
      </varlistentry>
 
289
 
 
290
      <varlistentry>
 
291
        <term><option>--delay=<replaceable
 
292
        >SECONDS</replaceable></option></term>
 
293
        <listitem>
 
294
          <para>
 
295
            After bringing the network interface up, the program waits
 
296
            for the interface to arrive in a <quote>running</quote>
 
297
            state before proceeding.  During this time, the kernel log
 
298
            level will be lowered to reduce clutter on the system
 
299
            console, alleviating any other plugins which might be
 
300
            using the system console.  This option sets the upper
 
301
            limit of seconds to wait.  The default is 2.5 seconds.
 
302
          </para>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
 
 
306
      <varlistentry>
 
307
        <term><option>--retry=<replaceable
 
308
        >SECONDS</replaceable></option></term>
 
309
        <listitem>
 
310
          <para>
 
311
            All Mandos servers are tried repeatedly until a password
 
312
            is received.  This value specifies, in seconds, how long
 
313
            between each successive try <emphasis>for the same
 
314
            server</emphasis>.  The default is 10 seconds.
 
315
          </para>
 
316
        </listitem>
 
317
      </varlistentry>
 
318
 
 
319
      <varlistentry>
 
320
        <term><option>--network-hook-dir=<replaceable
 
321
        >DIR</replaceable></option></term>
 
322
        <listitem>
 
323
          <para>
 
324
            Network hook directory.  The default directory is
 
325
            <quote><directory class="directory"
 
326
            >/lib/mandos/network-hooks.d</directory></quote>.
 
327
          </para>
 
328
        </listitem>
 
329
      </varlistentry>
277
330
      
278
331
      <varlistentry>
279
332
        <term><option>--debug</option></term>
309
362
          </para>
310
363
        </listitem>
311
364
      </varlistentry>
312
 
 
 
365
      
313
366
      <varlistentry>
314
367
        <term><option>--version</option></term>
315
368
        <term><option>-V</option></term>
321
374
      </varlistentry>
322
375
    </variablelist>
323
376
  </refsect1>
324
 
 
 
377
  
325
378
  <refsect1 id="overview">
326
379
    <title>OVERVIEW</title>
327
380
    <xi:include href="../overview.xml"/>
336
389
      <filename>/etc/crypttab</filename>, but it would then be
337
390
      impossible to enter a password for the encrypted root disk at
338
391
      the console, since this program does not read from the console
339
 
      at all.  This is why a separate plugin (<citerefentry>
340
 
      <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.
 
392
      at all.  This is why a separate plugin runner (<citerefentry>
 
393
      <refentrytitle>plugin-runner</refentrytitle>
 
394
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
395
      both this program and others in in parallel,
 
396
      <emphasis>one</emphasis> of which will prompt for passwords on
 
397
      the system console.
343
398
    </para>
344
399
  </refsect1>
345
400
  
350
405
      server could be found and the password received from it could be
351
406
      successfully decrypted and output on standard output.  The
352
407
      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.
 
408
      error occurs.  Otherwise, it will forever connect to any
 
409
      discovered <application>Mandos</application> servers, trying to
 
410
      get a decryptable password and print it.
356
411
    </para>
357
412
  </refsect1>
358
413
  
366
421
    </para>
367
422
  </refsect1>
368
423
  
369
 
  <refsect1 id="file">
 
424
  <refsect1 id="files">
370
425
    <title>FILES</title>
371
426
    <variablelist>
372
427
      <varlistentry>
391
446
<!--     <para> -->
392
447
<!--     </para> -->
393
448
<!--   </refsect1> -->
394
 
 
 
449
  
395
450
  <refsect1 id="example">
396
451
    <title>EXAMPLE</title>
397
452
    <para>
411
466
    </informalexample>
412
467
    <informalexample>
413
468
      <para>
414
 
        Search for Mandos servers on another interface:
 
469
        Search for Mandos servers (and connect to them) using another
 
470
        interface:
415
471
      </para>
416
472
      <para>
417
473
        <!-- do not wrap this line -->
420
476
    </informalexample>
421
477
    <informalexample>
422
478
      <para>
423
 
        Run in debug mode, and use a custom key directory:
 
479
        Run in debug mode, and use a custom key:
424
480
      </para>
425
481
      <para>
426
 
        <!-- do not wrap this line -->
427
 
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
482
 
 
483
<!-- do not wrap this line -->
 
484
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
485
 
428
486
      </para>
429
487
    </informalexample>
430
488
    <informalexample>
431
489
      <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
 
490
        Run in debug mode, with a custom key, and do not use Zeroconf
 
491
        to locate a server; connect directly to the IPv6 link-local
434
492
        address <quote><systemitem class="ipaddress"
435
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
436
 
        port 4711, using interface eth2:
 
493
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
494
        using interface eth2:
437
495
      </para>
438
496
      <para>
439
497
 
440
498
<!-- do not wrap this line -->
441
 
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
499
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
442
500
 
443
501
      </para>
444
502
    </informalexample>
445
503
  </refsect1>
446
 
 
 
504
  
447
505
  <refsect1 id="security">
448
506
    <title>SECURITY</title>
449
507
    <para>
469
527
      The only remaining weak point is that someone with physical
470
528
      access to the client hard drive might turn off the client
471
529
      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
 
530
      and communicate with the server.  To safeguard against this, the
 
531
      server is supposed to notice the client disappearing and stop
 
532
      giving out the encrypted data.  Therefore, it is important to
 
533
      set the timeout and checker interval values tightly on the
 
534
      server.  See <citerefentry><refentrytitle
477
535
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
478
536
    </para>
479
537
    <para>
490
548
      confidential.
491
549
    </para>
492
550
  </refsect1>
493
 
 
 
551
  
494
552
  <refsect1 id="see_also">
495
553
    <title>SEE ALSO</title>
496
554
    <para>
 
555
      <citerefentry><refentrytitle>intro</refentrytitle>
 
556
      <manvolnum>8mandos</manvolnum></citerefentry>,
497
557
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
498
558
      <manvolnum>8</manvolnum></citerefentry>,
499
559
      <citerefentry><refentrytitle>crypttab</refentrytitle>
621
681
      </varlistentry>
622
682
    </variablelist>
623
683
  </refsect1>
624
 
 
625
684
</refentry>
 
685
 
626
686
<!-- Local Variables: -->
627
687
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
628
688
<!-- time-stamp-end: "[\"']>" -->