/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-06 16:33:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906163308-ciy82qw6jollqrjd
* plugins.d/mandos-client.xml (NAME, OVERVIEW, EXIT STATUS): Improved
                                                             wording.

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">
4
5
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2009-01-24">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-06">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
37
    <xi:include href="../legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8mandos</manvolnum>
50
48
      Client for <application>Mandos</application>
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
115
113
      </group>
116
114
    </cmdsynopsis>
117
115
  </refsynopsisdiv>
118
 
  
 
116
 
119
117
  <refsect1 id="description">
120
118
    <title>DESCRIPTION</title>
121
119
    <para>
122
120
      <command>&COMMANDNAME;</command> is a client program that
123
121
      communicates with <citerefentry><refentrytitle
124
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
125
 
      to get a password.  It brings up a network interface, uses its
126
 
      IPv6 link-local address to get network connectivity, uses
127
 
      Zeroconf to find servers, and uses TLS with an OpenPGP key to
128
 
      ensure authenticity and confidentiality.  It keeps running,
129
 
      trying all servers on the network, until it receives a
130
 
      satisfactory reply or a TERM signal is received.
 
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.
131
128
    </para>
132
129
    <para>
133
130
      This program is not meant to be run directly; it is really meant
218
215
          </para>
219
216
        </listitem>
220
217
      </varlistentry>
221
 
      
 
218
 
222
219
      <varlistentry>
223
220
        <term><option>--seckey=<replaceable
224
221
        >FILE</replaceable></option></term>
241
238
                      xpointer="priority"/>
242
239
        </listitem>
243
240
      </varlistentry>
244
 
      
 
241
 
245
242
      <varlistentry>
246
243
        <term><option>--dh-bits=<replaceable
247
244
        >BITS</replaceable></option></term>
287
284
          </para>
288
285
        </listitem>
289
286
      </varlistentry>
290
 
      
 
287
 
291
288
      <varlistentry>
292
289
        <term><option>--version</option></term>
293
290
        <term><option>-V</option></term>
299
296
      </varlistentry>
300
297
    </variablelist>
301
298
  </refsect1>
302
 
  
 
299
 
303
300
  <refsect1 id="overview">
304
301
    <title>OVERVIEW</title>
305
302
    <xi:include href="../overview.xml"/>
346
343
    </para>
347
344
  </refsect1>
348
345
  
349
 
  <refsect1 id="files">
 
346
  <refsect1 id="file">
350
347
    <title>FILES</title>
351
348
    <variablelist>
352
349
      <varlistentry>
371
368
<!--     <para> -->
372
369
<!--     </para> -->
373
370
<!--   </refsect1> -->
374
 
  
 
371
 
375
372
  <refsect1 id="example">
376
373
    <title>EXAMPLE</title>
377
374
    <para>
426
423
      </para>
427
424
    </informalexample>
428
425
  </refsect1>
429
 
  
 
426
 
430
427
  <refsect1 id="security">
431
428
    <title>SECURITY</title>
432
429
    <para>
452
449
      The only remaining weak point is that someone with physical
453
450
      access to the client hard drive might turn off the client
454
451
      computer, read the OpenPGP keys directly from the hard drive,
455
 
      and communicate with the server.  To safeguard against this, the
456
 
      server is supposed to notice the client disappearing and stop
457
 
      giving out the encrypted data.  Therefore, it is important to
458
 
      set the timeout and checker interval values tightly on the
459
 
      server.  See <citerefentry><refentrytitle
 
452
      and communicate with the server.  The defense against this is
 
453
      that the server is supposed to notice the client disappearing
 
454
      and will stop giving out the encrypted data.  Therefore, it is
 
455
      important to set the timeout and checker interval values tightly
 
456
      on the server.  See <citerefentry><refentrytitle
460
457
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
461
458
    </para>
462
459
    <para>
473
470
      confidential.
474
471
    </para>
475
472
  </refsect1>
476
 
  
 
473
 
477
474
  <refsect1 id="see_also">
478
475
    <title>SEE ALSO</title>
479
476
    <para>
604
601
      </varlistentry>
605
602
    </variablelist>
606
603
  </refsect1>
 
604
 
607
605
</refentry>
608
 
 
609
606
<!-- Local Variables: -->
610
607
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
611
608
<!-- time-stamp-end: "[\"']>" -->