/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; miscellaneous small fixes.  Major points: A lintian
warning (long line in plugin-runner manual page) eliminated as
requested by sponsor, one bug fixed (bashism in mandos-keygen), and
one small inconsistency fixed (server is now started after install).

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 "2009-01-04">
 
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/>
113
115
      </group>
114
116
    </cmdsynopsis>
115
117
  </refsynopsisdiv>
116
 
 
 
118
  
117
119
  <refsect1 id="description">
118
120
    <title>DESCRIPTION</title>
119
121
    <para>
124
126
      network connectivity, Zeroconf to find servers, and TLS with an
125
127
      OpenPGP key to ensure authenticity and confidentiality.  It
126
128
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is recieved.
 
129
      receives a satisfactory reply or a TERM signal is received.
128
130
    </para>
129
131
    <para>
130
132
      This program is not meant to be run directly; it is really meant
215
217
          </para>
216
218
        </listitem>
217
219
      </varlistentry>
218
 
 
 
220
      
219
221
      <varlistentry>
220
222
        <term><option>--seckey=<replaceable
221
223
        >FILE</replaceable></option></term>
238
240
                      xpointer="priority"/>
239
241
        </listitem>
240
242
      </varlistentry>
241
 
 
 
243
      
242
244
      <varlistentry>
243
245
        <term><option>--dh-bits=<replaceable
244
246
        >BITS</replaceable></option></term>
284
286
          </para>
285
287
        </listitem>
286
288
      </varlistentry>
287
 
 
 
289
      
288
290
      <varlistentry>
289
291
        <term><option>--version</option></term>
290
292
        <term><option>-V</option></term>
296
298
      </varlistentry>
297
299
    </variablelist>
298
300
  </refsect1>
299
 
 
 
301
  
300
302
  <refsect1 id="overview">
301
303
    <title>OVERVIEW</title>
302
304
    <xi:include href="../overview.xml"/>
311
313
      <filename>/etc/crypttab</filename>, but it would then be
312
314
      impossible to enter a password for the encrypted root disk at
313
315
      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 parallell to this one by the plugin runner.
 
316
      at all.  This is why a separate plugin runner (<citerefentry>
 
317
      <refentrytitle>plugin-runner</refentrytitle>
 
318
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
319
      both this program and others in in parallel,
 
320
      <emphasis>one</emphasis> of which will prompt for passwords on
 
321
      the system console.
318
322
    </para>
319
323
  </refsect1>
320
324
  
327
331
      program will exit with a non-zero exit status only if a critical
328
332
      error occurs.  Otherwise, it will forever connect to new
329
333
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
334
      to get a decryptable password and print it.
331
335
    </para>
332
336
  </refsect1>
333
337
  
341
345
    </para>
342
346
  </refsect1>
343
347
  
344
 
  <refsect1 id="file">
 
348
  <refsect1 id="files">
345
349
    <title>FILES</title>
346
350
    <variablelist>
347
351
      <varlistentry>
366
370
<!--     <para> -->
367
371
<!--     </para> -->
368
372
<!--   </refsect1> -->
369
 
 
 
373
  
370
374
  <refsect1 id="example">
371
375
    <title>EXAMPLE</title>
372
376
    <para>
386
390
    </informalexample>
387
391
    <informalexample>
388
392
      <para>
389
 
        Search for Mandos servers on another interface:
 
393
        Search for Mandos servers (and connect to them) using another
 
394
        interface:
390
395
      </para>
391
396
      <para>
392
397
        <!-- do not wrap this line -->
420
425
      </para>
421
426
    </informalexample>
422
427
  </refsect1>
423
 
 
 
428
  
424
429
  <refsect1 id="security">
425
430
    <title>SECURITY</title>
426
431
    <para>
446
451
      The only remaining weak point is that someone with physical
447
452
      access to the client hard drive might turn off the client
448
453
      computer, read the OpenPGP keys directly from the hard drive,
449
 
      and communicate with the server.  The defense against this is
450
 
      that the server is supposed to notice the client disappearing
451
 
      and will stop giving out the encrypted data.  Therefore, it is
452
 
      important to set the timeout and checker interval values tightly
453
 
      on the server.  See <citerefentry><refentrytitle
 
454
      and communicate with the server.  To safeguard against this, the
 
455
      server is supposed to notice the client disappearing and stop
 
456
      giving out the encrypted data.  Therefore, it is important to
 
457
      set the timeout and checker interval values tightly on the
 
458
      server.  See <citerefentry><refentrytitle
454
459
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
455
460
    </para>
456
461
    <para>
467
472
      confidential.
468
473
    </para>
469
474
  </refsect1>
470
 
 
 
475
  
471
476
  <refsect1 id="see_also">
472
477
    <title>SEE ALSO</title>
473
478
    <para>
598
603
      </varlistentry>
599
604
    </variablelist>
600
605
  </refsect1>
601
 
 
602
606
</refentry>
 
607
 
603
608
<!-- Local Variables: -->
604
609
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
605
610
<!-- time-stamp-end: "[\"']>" -->