/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: 2011-07-16 00:29:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110716002919-r77yikuiulj42o40
* initramfs-tools-script: Abort if plugin-runner is missing.  Removed
                          workaround for Debian bug #633582; the
                          workaround required getopt, which can not be
                          guaranteed.
* plugin-runner.c (main): Work around Debian bug #633582.
* plugins.d/mandos-client.c (main): - '' -

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 "2010-09-26">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="../legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8mandos</manvolnum>
45
47
  <refnamediv>
46
48
    <refname><command>&COMMANDNAME;</command></refname>
47
49
    <refpurpose>
48
 
      Client for mandos
 
50
      Client for <application>Mandos</application>
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
55
57
      <group>
56
58
        <arg choice="plain"><option>--connect
57
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
59
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
60
        ><replaceable>PORT</replaceable></option></arg>
59
61
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
62
        <replaceable>ADDRESS</replaceable><literal>:</literal
61
63
        ><replaceable>PORT</replaceable></option></arg>
62
64
      </group>
63
65
      <sbr/>
64
66
      <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
67
        <arg choice="plain"><option>--interface
73
68
        <replaceable>NAME</replaceable></option></arg>
74
69
        <arg choice="plain"><option>-i
98
93
      </arg>
99
94
      <sbr/>
100
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
 
100
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
101
      </arg>
 
102
      <sbr/>
 
103
      <arg>
101
104
        <option>--debug</option>
102
105
      </arg>
103
106
    </cmdsynopsis>
120
123
      </group>
121
124
    </cmdsynopsis>
122
125
  </refsynopsisdiv>
123
 
 
 
126
  
124
127
  <refsect1 id="description">
125
128
    <title>DESCRIPTION</title>
126
129
    <para>
127
130
      <command>&COMMANDNAME;</command> is a client program that
128
131
      communicates with <citerefentry><refentrytitle
129
132
      >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.
 
133
      to get a password.  In slightly more detail, this client program
 
134
      brings up a network interface, uses the interface’s IPv6
 
135
      link-local address to get network connectivity, uses Zeroconf to
 
136
      find servers on the local network, and communicates with servers
 
137
      using TLS with an OpenPGP key to ensure authenticity and
 
138
      confidentiality.  This client program keeps running, trying all
 
139
      servers on the network, until it receives a satisfactory reply
 
140
      or a TERM signal is received.  If no servers are found, or after
 
141
      all servers have been tried, it waits indefinitely for new
 
142
      servers to appear.
135
143
    </para>
136
144
    <para>
137
145
      This program is not meant to be run directly; it is really meant
191
199
      </varlistentry>
192
200
      
193
201
      <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>
 
202
        <term><option>--interface=<replaceable
 
203
        >NAME</replaceable></option></term>
212
204
        <term><option>-i
213
205
        <replaceable>NAME</replaceable></option></term>
214
206
        <listitem>
215
207
          <para>
216
208
            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>.
 
209
            Mandos servers to connect to.  The default is the empty
 
210
            string, which will automatically choose an appropriate
 
211
            interface.
219
212
          </para>
220
213
          <para>
221
214
            If the <option>--connect</option> option is used, this
222
215
            specifies the interface to use to connect to the address
223
216
            given.
224
217
          </para>
 
218
          <para>
 
219
            Note that since this program will normally run in the
 
220
            initial RAM disk environment, the interface must be an
 
221
            interface which exists at that stage.  Thus, the interface
 
222
            can not be a pseudo-interface such as <quote>br0</quote>
 
223
            or <quote>tun0</quote>; such interfaces will not exist
 
224
            until much later in the boot process, and can not be used
 
225
            by this program.
 
226
          </para>
 
227
          <para>
 
228
            <replaceable>NAME</replaceable> can be the string
 
229
            <quote><literal>none</literal></quote>; this will not use
 
230
            any specific interface, and will not bring up an interface
 
231
            on startup.  This is not recommended, and only meant for
 
232
            advanced users.
 
233
          </para>
225
234
        </listitem>
226
235
      </varlistentry>
227
236
      
232
241
        <replaceable>FILE</replaceable></option></term>
233
242
        <listitem>
234
243
          <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>.
 
244
            OpenPGP public key file name.  The default name is
 
245
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
246
            ></quote>.
239
247
          </para>
240
248
        </listitem>
241
249
      </varlistentry>
242
 
 
 
250
      
243
251
      <varlistentry>
244
252
        <term><option>--seckey=<replaceable
245
253
        >FILE</replaceable></option></term>
247
255
        <replaceable>FILE</replaceable></option></term>
248
256
        <listitem>
249
257
          <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>.
 
258
            OpenPGP secret key file name.  The default name is
 
259
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
260
            ></quote>.
254
261
          </para>
255
262
        </listitem>
256
263
      </varlistentry>
263
270
                      xpointer="priority"/>
264
271
        </listitem>
265
272
      </varlistentry>
266
 
 
 
273
      
267
274
      <varlistentry>
268
275
        <term><option>--dh-bits=<replaceable
269
276
        >BITS</replaceable></option></term>
274
281
          </para>
275
282
        </listitem>
276
283
      </varlistentry>
 
284
 
 
285
      <varlistentry>
 
286
        <term><option>--delay=<replaceable
 
287
        >SECONDS</replaceable></option></term>
 
288
        <listitem>
 
289
          <para>
 
290
            After bringing the network interface up, the program waits
 
291
            for the interface to arrive in a <quote>running</quote>
 
292
            state before proceeding.  During this time, the kernel log
 
293
            level will be lowered to reduce clutter on the system
 
294
            console, alleviating any other plugins which might be
 
295
            using the system console.  This option sets the upper
 
296
            limit of seconds to wait.  The default is 2.5 seconds.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
 
 
301
      <varlistentry>
 
302
        <term><option>--retry=<replaceable
 
303
        >SECONDS</replaceable></option></term>
 
304
        <listitem>
 
305
          <para>
 
306
            All Mandos servers servers are tried repeatedly until a
 
307
            password is received.  This value specifies, in seconds,
 
308
            how long between each successive try <emphasis>for the
 
309
            same server</emphasis>.  The default is 10 seconds.
 
310
          </para>
 
311
        </listitem>
 
312
      </varlistentry>
277
313
      
278
314
      <varlistentry>
279
315
        <term><option>--debug</option></term>
309
345
          </para>
310
346
        </listitem>
311
347
      </varlistentry>
312
 
 
 
348
      
313
349
      <varlistentry>
314
350
        <term><option>--version</option></term>
315
351
        <term><option>-V</option></term>
321
357
      </varlistentry>
322
358
    </variablelist>
323
359
  </refsect1>
324
 
 
 
360
  
325
361
  <refsect1 id="overview">
326
362
    <title>OVERVIEW</title>
327
363
    <xi:include href="../overview.xml"/>
336
372
      <filename>/etc/crypttab</filename>, but it would then be
337
373
      impossible to enter a password for the encrypted root disk at
338
374
      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.
 
375
      at all.  This is why a separate plugin runner (<citerefentry>
 
376
      <refentrytitle>plugin-runner</refentrytitle>
 
377
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
378
      both this program and others in in parallel,
 
379
      <emphasis>one</emphasis> of which will prompt for passwords on
 
380
      the system console.
343
381
    </para>
344
382
  </refsect1>
345
383
  
352
390
      program will exit with a non-zero exit status only if a critical
353
391
      error occurs.  Otherwise, it will forever connect to new
354
392
      <application>Mandos</application> servers as they appear, trying
355
 
      to get a decryptable password.
 
393
      to get a decryptable password and print it.
356
394
    </para>
357
395
  </refsect1>
358
396
  
366
404
    </para>
367
405
  </refsect1>
368
406
  
369
 
  <refsect1 id="file">
 
407
  <refsect1 id="files">
370
408
    <title>FILES</title>
371
409
    <variablelist>
372
410
      <varlistentry>
391
429
<!--     <para> -->
392
430
<!--     </para> -->
393
431
<!--   </refsect1> -->
394
 
 
 
432
  
395
433
  <refsect1 id="example">
396
434
    <title>EXAMPLE</title>
397
435
    <para>
411
449
    </informalexample>
412
450
    <informalexample>
413
451
      <para>
414
 
        Search for Mandos servers on another interface:
 
452
        Search for Mandos servers (and connect to them) using another
 
453
        interface:
415
454
      </para>
416
455
      <para>
417
456
        <!-- do not wrap this line -->
420
459
    </informalexample>
421
460
    <informalexample>
422
461
      <para>
423
 
        Run in debug mode, and use a custom key directory:
 
462
        Run in debug mode, and use a custom key:
424
463
      </para>
425
464
      <para>
426
 
        <!-- do not wrap this line -->
427
 
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
465
 
 
466
<!-- do not wrap this line -->
 
467
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
468
 
428
469
      </para>
429
470
    </informalexample>
430
471
    <informalexample>
431
472
      <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
 
473
        Run in debug mode, with a custom key, and do not use Zeroconf
 
474
        to locate a server; connect directly to the IPv6 link-local
434
475
        address <quote><systemitem class="ipaddress"
435
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
436
 
        port 4711, using interface eth2:
 
476
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
477
        using interface eth2:
437
478
      </para>
438
479
      <para>
439
480
 
440
481
<!-- do not wrap this line -->
441
 
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
482
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
442
483
 
443
484
      </para>
444
485
    </informalexample>
445
486
  </refsect1>
446
 
 
 
487
  
447
488
  <refsect1 id="security">
448
489
    <title>SECURITY</title>
449
490
    <para>
469
510
      The only remaining weak point is that someone with physical
470
511
      access to the client hard drive might turn off the client
471
512
      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
 
513
      and communicate with the server.  To safeguard against this, the
 
514
      server is supposed to notice the client disappearing and stop
 
515
      giving out the encrypted data.  Therefore, it is important to
 
516
      set the timeout and checker interval values tightly on the
 
517
      server.  See <citerefentry><refentrytitle
477
518
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
478
519
    </para>
479
520
    <para>
490
531
      confidential.
491
532
    </para>
492
533
  </refsect1>
493
 
 
 
534
  
494
535
  <refsect1 id="see_also">
495
536
    <title>SEE ALSO</title>
496
537
    <para>
621
662
      </varlistentry>
622
663
    </variablelist>
623
664
  </refsect1>
624
 
 
625
665
</refentry>
 
666
 
626
667
<!-- Local Variables: -->
627
668
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
628
669
<!-- time-stamp-end: "[\"']>" -->