/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: 2009-02-13 05:38:21 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090213053821-03e696gckk4nbjps
Support not using IPv6 in server:

* mandos (AvahiService.__init__): Take new "protocol" parameter.  All
                                  callers changed.
  (IPv6_TCPServer.__init__): Take new "use_ipv6" parameter.  All
                             callers changed.
  (IPv6_TCPServer.server_bind): Create IPv4 socket if not using IPv6.
  (main): New "--no-ipv6" command line option.  New "use_ipv6" config
          option.
* mandos-options.xml ([@id="address"]): Document conditional IPv4
                                        address support.
  ([@id="ipv6"]): New paragraph.
* mandos.conf (use_ipv6): New config option.
* mandos.conf.xml (OPTIONS): Document new "use_dbus" option.
  (EXAMPLE): Changed to use IPv6 link-local address.  Added "use_ipv6"
             option.
* mandos.xml (SYNOPSIS): New "--no-ipv6" option.
  (OPTIONS): Document new "--no-ipv6" option.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "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>
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>
101
100
        <option>--debug</option>
102
101
      </arg>
103
102
    </cmdsynopsis>
120
119
      </group>
121
120
    </cmdsynopsis>
122
121
  </refsynopsisdiv>
123
 
 
 
122
  
124
123
  <refsect1 id="description">
125
124
    <title>DESCRIPTION</title>
126
125
    <para>
127
126
      <command>&COMMANDNAME;</command> is a client program that
128
127
      communicates with <citerefentry><refentrytitle
129
128
      >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.
 
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.
135
139
    </para>
136
140
    <para>
137
141
      This program is not meant to be run directly; it is really meant
191
195
      </varlistentry>
192
196
      
193
197
      <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>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
212
200
        <term><option>-i
213
201
        <replaceable>NAME</replaceable></option></term>
214
202
        <listitem>
215
203
          <para>
216
204
            Network interface that will be brought up and scanned for
217
 
            Mandos servers to connect to.  The default it
 
205
            Mandos servers to connect to.  The default is
218
206
            <quote><literal>eth0</literal></quote>.
219
207
          </para>
220
208
          <para>
222
210
            specifies the interface to use to connect to the address
223
211
            given.
224
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>
225
228
        </listitem>
226
229
      </varlistentry>
227
230
      
232
235
        <replaceable>FILE</replaceable></option></term>
233
236
        <listitem>
234
237
          <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>.
 
238
            OpenPGP public key file name.  The default name is
 
239
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
240
            ></quote>.
239
241
          </para>
240
242
        </listitem>
241
243
      </varlistentry>
242
 
 
 
244
      
243
245
      <varlistentry>
244
246
        <term><option>--seckey=<replaceable
245
247
        >FILE</replaceable></option></term>
247
249
        <replaceable>FILE</replaceable></option></term>
248
250
        <listitem>
249
251
          <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>.
 
252
            OpenPGP secret key file name.  The default name is
 
253
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
 
254
            ></quote>.
254
255
          </para>
255
256
        </listitem>
256
257
      </varlistentry>
263
264
                      xpointer="priority"/>
264
265
        </listitem>
265
266
      </varlistentry>
266
 
 
 
267
      
267
268
      <varlistentry>
268
269
        <term><option>--dh-bits=<replaceable
269
270
        >BITS</replaceable></option></term>
274
275
          </para>
275
276
        </listitem>
276
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>
277
294
      
278
295
      <varlistentry>
279
296
        <term><option>--debug</option></term>
309
326
          </para>
310
327
        </listitem>
311
328
      </varlistentry>
312
 
 
 
329
      
313
330
      <varlistentry>
314
331
        <term><option>--version</option></term>
315
332
        <term><option>-V</option></term>
321
338
      </varlistentry>
322
339
    </variablelist>
323
340
  </refsect1>
324
 
 
 
341
  
325
342
  <refsect1 id="overview">
326
343
    <title>OVERVIEW</title>
327
344
    <xi:include href="../overview.xml"/>
336
353
      <filename>/etc/crypttab</filename>, but it would then be
337
354
      impossible to enter a password for the encrypted root disk at
338
355
      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.
 
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.
343
362
    </para>
344
363
  </refsect1>
345
364
  
352
371
      program will exit with a non-zero exit status only if a critical
353
372
      error occurs.  Otherwise, it will forever connect to new
354
373
      <application>Mandos</application> servers as they appear, trying
355
 
      to get a decryptable password.
 
374
      to get a decryptable password and print it.
356
375
    </para>
357
376
  </refsect1>
358
377
  
366
385
    </para>
367
386
  </refsect1>
368
387
  
369
 
  <refsect1 id="file">
 
388
  <refsect1 id="files">
370
389
    <title>FILES</title>
371
390
    <variablelist>
372
391
      <varlistentry>
391
410
<!--     <para> -->
392
411
<!--     </para> -->
393
412
<!--   </refsect1> -->
394
 
 
 
413
  
395
414
  <refsect1 id="example">
396
415
    <title>EXAMPLE</title>
397
416
    <para>
411
430
    </informalexample>
412
431
    <informalexample>
413
432
      <para>
414
 
        Search for Mandos servers on another interface:
 
433
        Search for Mandos servers (and connect to them) using another
 
434
        interface:
415
435
      </para>
416
436
      <para>
417
437
        <!-- do not wrap this line -->
420
440
    </informalexample>
421
441
    <informalexample>
422
442
      <para>
423
 
        Run in debug mode, and use a custom key directory:
 
443
        Run in debug mode, and use a custom key:
424
444
      </para>
425
445
      <para>
426
 
        <!-- do not wrap this line -->
427
 
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
446
 
 
447
<!-- do not wrap this line -->
 
448
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
449
 
428
450
      </para>
429
451
    </informalexample>
430
452
    <informalexample>
431
453
      <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
 
454
        Run in debug mode, with a custom key, and do not use Zeroconf
 
455
        to locate a server; connect directly to the IPv6 link-local
434
456
        address <quote><systemitem class="ipaddress"
435
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
436
 
        port 4711, using interface eth2:
 
457
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
458
        using interface eth2:
437
459
      </para>
438
460
      <para>
439
461
 
440
462
<!-- do not wrap this line -->
441
 
<userinput>&COMMANDNAME; --debug --keydir keydir --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>
442
464
 
443
465
      </para>
444
466
    </informalexample>
445
467
  </refsect1>
446
 
 
 
468
  
447
469
  <refsect1 id="security">
448
470
    <title>SECURITY</title>
449
471
    <para>
469
491
      The only remaining weak point is that someone with physical
470
492
      access to the client hard drive might turn off the client
471
493
      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
 
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
477
499
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
478
500
    </para>
479
501
    <para>
490
512
      confidential.
491
513
    </para>
492
514
  </refsect1>
493
 
 
 
515
  
494
516
  <refsect1 id="see_also">
495
517
    <title>SEE ALSO</title>
496
518
    <para>
621
643
      </varlistentry>
622
644
    </variablelist>
623
645
  </refsect1>
624
 
 
625
646
</refentry>
 
647
 
626
648
<!-- Local Variables: -->
627
649
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
628
650
<!-- time-stamp-end: "[\"']>" -->