/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

Merge from trunk.  Notable changes:

 1. Server package now depends on "python-gobject".
 2. Permission fix for /lib64.
 3. Support for DEVICE setting from initramfs.conf, kernel parameters
    "ip=" and "mandos=connect".
 4. Fix for the bug where the server would stop responding, with a
    zombie checker process.
 5. Add support for disabling IPv6 in the server
 6. Fix for the bug which made the server, plugin-runner and
    mandos-client fail to change group ID.
 7. Add GnuTLS debugging to server debug output.
 8. Fix for the bug of the "--options-for" option of plugin-runner,
    where it would cut the value at the first colon character.
 9. Stop using sscanf() throughout, since it does not detect overflow.
10. Fix for the bug where plugin-runner would not go to the fallback
    if all plugins failed.
11. Fix for the bug where mandos-client would not clean up after a
    signal.
12. Added support for connecting to IPv4 addresses in mandos-client.
13. Added support for not using a specific network interface in
    mandos-client.
14. Kernel log level will be lowered by mandos-client while bringing
    up the network interface.
15. Add an option for the maximum time for mandos-client to wait for
    the network interface to come up.
16. Fix for the bug where mandos-client would not clean the temporary
    directory on some filesystems.

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
4
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
 
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>
91
93
      </arg>
92
94
      <sbr/>
93
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
94
100
        <option>--debug</option>
95
101
      </arg>
96
102
    </cmdsynopsis>
113
119
      </group>
114
120
    </cmdsynopsis>
115
121
  </refsynopsisdiv>
116
 
 
 
122
  
117
123
  <refsect1 id="description">
118
124
    <title>DESCRIPTION</title>
119
125
    <para>
120
126
      <command>&COMMANDNAME;</command> is a client program that
121
127
      communicates with <citerefentry><refentrytitle
122
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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.
 
129
      to get a password.  In slightly more detail, this client program
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
 
134
      confidentiality.  This client program keeps running, trying all
 
135
      servers on the network, until it receives a satisfactory reply
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
128
139
    </para>
129
140
    <para>
130
141
      This program is not meant to be run directly; it is really meant
184
195
      </varlistentry>
185
196
      
186
197
      <varlistentry>
187
 
        <term><option>--interface=
188
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
189
200
        <term><option>-i
190
201
        <replaceable>NAME</replaceable></option></term>
191
202
        <listitem>
192
203
          <para>
193
204
            Network interface that will be brought up and scanned for
194
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
195
206
            <quote><literal>eth0</literal></quote>.
196
207
          </para>
197
208
          <para>
199
210
            specifies the interface to use to connect to the address
200
211
            given.
201
212
          </para>
 
213
          <para>
 
214
            Note that since this program will normally run in the
 
215
            initial RAM disk environment, the interface must be an
 
216
            interface which exists at that stage.  Thus, the interface
 
217
            can not be a pseudo-interface such as <quote>br0</quote>
 
218
            or <quote>tun0</quote>; such interfaces will not exist
 
219
            until much later in the boot process, and can not be used
 
220
            by this program.
 
221
          </para>
 
222
          <para>
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
 
226
            recommended, and only meant for advanced users.
 
227
          </para>
202
228
        </listitem>
203
229
      </varlistentry>
204
230
      
215
241
          </para>
216
242
        </listitem>
217
243
      </varlistentry>
218
 
 
 
244
      
219
245
      <varlistentry>
220
246
        <term><option>--seckey=<replaceable
221
247
        >FILE</replaceable></option></term>
238
264
                      xpointer="priority"/>
239
265
        </listitem>
240
266
      </varlistentry>
241
 
 
 
267
      
242
268
      <varlistentry>
243
269
        <term><option>--dh-bits=<replaceable
244
270
        >BITS</replaceable></option></term>
249
275
          </para>
250
276
        </listitem>
251
277
      </varlistentry>
 
278
 
 
279
      <varlistentry>
 
280
        <term><option>--delay=<replaceable
 
281
        >SECONDS</replaceable></option></term>
 
282
        <listitem>
 
283
          <para>
 
284
            After bringing the network interface up, the program waits
 
285
            for the interface to arrive in a <quote>running</quote>
 
286
            state before proceeding.  During this time, the kernel log
 
287
            level will be lowered to reduce clutter on the system
 
288
            console, alleviating any other plugins which might be
 
289
            using the system console.  This option sets the upper
 
290
            limit of seconds to wait.  The default is 2.5 seconds.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
252
294
      
253
295
      <varlistentry>
254
296
        <term><option>--debug</option></term>
284
326
          </para>
285
327
        </listitem>
286
328
      </varlistentry>
287
 
 
 
329
      
288
330
      <varlistentry>
289
331
        <term><option>--version</option></term>
290
332
        <term><option>-V</option></term>
296
338
      </varlistentry>
297
339
    </variablelist>
298
340
  </refsect1>
299
 
 
 
341
  
300
342
  <refsect1 id="overview">
301
343
    <title>OVERVIEW</title>
302
344
    <xi:include href="../overview.xml"/>
311
353
      <filename>/etc/crypttab</filename>, but it would then be
312
354
      impossible to enter a password for the encrypted root disk at
313
355
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin (<citerefentry>
315
 
      <refentrytitle>password-prompt</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallel to this one by the plugin runner.
 
356
      at all.  This is why a separate plugin runner (<citerefentry>
 
357
      <refentrytitle>plugin-runner</refentrytitle>
 
358
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
359
      both this program and others in in parallel,
 
360
      <emphasis>one</emphasis> of which will prompt for passwords on
 
361
      the system console.
318
362
    </para>
319
363
  </refsect1>
320
364
  
327
371
      program will exit with a non-zero exit status only if a critical
328
372
      error occurs.  Otherwise, it will forever connect to new
329
373
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
374
      to get a decryptable password and print it.
331
375
    </para>
332
376
  </refsect1>
333
377
  
341
385
    </para>
342
386
  </refsect1>
343
387
  
344
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
345
389
    <title>FILES</title>
346
390
    <variablelist>
347
391
      <varlistentry>
366
410
<!--     <para> -->
367
411
<!--     </para> -->
368
412
<!--   </refsect1> -->
369
 
 
 
413
  
370
414
  <refsect1 id="example">
371
415
    <title>EXAMPLE</title>
372
416
    <para>
408
452
    <informalexample>
409
453
      <para>
410
454
        Run in debug mode, with a custom key, and do not use Zeroconf
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:
 
455
        to locate a server; connect directly to the IPv6 link-local
 
456
        address <quote><systemitem class="ipaddress"
 
457
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
458
        using interface eth2:
415
459
      </para>
416
460
      <para>
417
461
 
418
462
<!-- do not wrap this line -->
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>
 
463
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
420
464
 
421
465
      </para>
422
466
    </informalexample>
423
467
  </refsect1>
424
 
 
 
468
  
425
469
  <refsect1 id="security">
426
470
    <title>SECURITY</title>
427
471
    <para>
447
491
      The only remaining weak point is that someone with physical
448
492
      access to the client hard drive might turn off the client
449
493
      computer, read the OpenPGP keys directly from the hard drive,
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
 
494
      and communicate with the server.  To safeguard against this, the
 
495
      server is supposed to notice the client disappearing and stop
 
496
      giving out the encrypted data.  Therefore, it is important to
 
497
      set the timeout and checker interval values tightly on the
 
498
      server.  See <citerefentry><refentrytitle
455
499
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
456
500
    </para>
457
501
    <para>
468
512
      confidential.
469
513
    </para>
470
514
  </refsect1>
471
 
 
 
515
  
472
516
  <refsect1 id="see_also">
473
517
    <title>SEE ALSO</title>
474
518
    <para>
599
643
      </varlistentry>
600
644
    </variablelist>
601
645
  </refsect1>
602
 
 
603
646
</refentry>
 
647
 
604
648
<!-- Local Variables: -->
605
649
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
606
650
<!-- time-stamp-end: "[\"']>" -->