/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

* plugins.d/mandos-client.xml (DESCRIPTION): Mention the bringing up
                                             of a network interface.

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-01-24">
 
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>
48
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>
113
115
      </group>
114
116
    </cmdsynopsis>
115
117
  </refsynopsisdiv>
116
 
 
 
118
  
117
119
  <refsect1 id="description">
118
120
    <title>DESCRIPTION</title>
119
121
    <para>
120
122
      <command>&COMMANDNAME;</command> is a client program that
121
123
      communicates with <citerefentry><refentrytitle
122
124
      >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.
 
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.
128
131
    </para>
129
132
    <para>
130
133
      This program is not meant to be run directly; it is really meant
215
218
          </para>
216
219
        </listitem>
217
220
      </varlistentry>
218
 
 
 
221
      
219
222
      <varlistentry>
220
223
        <term><option>--seckey=<replaceable
221
224
        >FILE</replaceable></option></term>
238
241
                      xpointer="priority"/>
239
242
        </listitem>
240
243
      </varlistentry>
241
 
 
 
244
      
242
245
      <varlistentry>
243
246
        <term><option>--dh-bits=<replaceable
244
247
        >BITS</replaceable></option></term>
284
287
          </para>
285
288
        </listitem>
286
289
      </varlistentry>
287
 
 
 
290
      
288
291
      <varlistentry>
289
292
        <term><option>--version</option></term>
290
293
        <term><option>-V</option></term>
296
299
      </varlistentry>
297
300
    </variablelist>
298
301
  </refsect1>
299
 
 
 
302
  
300
303
  <refsect1 id="overview">
301
304
    <title>OVERVIEW</title>
302
305
    <xi:include href="../overview.xml"/>
343
346
    </para>
344
347
  </refsect1>
345
348
  
346
 
  <refsect1 id="file">
 
349
  <refsect1 id="files">
347
350
    <title>FILES</title>
348
351
    <variablelist>
349
352
      <varlistentry>
368
371
<!--     <para> -->
369
372
<!--     </para> -->
370
373
<!--   </refsect1> -->
371
 
 
 
374
  
372
375
  <refsect1 id="example">
373
376
    <title>EXAMPLE</title>
374
377
    <para>
423
426
      </para>
424
427
    </informalexample>
425
428
  </refsect1>
426
 
 
 
429
  
427
430
  <refsect1 id="security">
428
431
    <title>SECURITY</title>
429
432
    <para>
449
452
      The only remaining weak point is that someone with physical
450
453
      access to the client hard drive might turn off the client
451
454
      computer, read the OpenPGP keys directly from the hard drive,
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
 
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
457
460
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
458
461
    </para>
459
462
    <para>
470
473
      confidential.
471
474
    </para>
472
475
  </refsect1>
473
 
 
 
476
  
474
477
  <refsect1 id="see_also">
475
478
    <title>SEE ALSO</title>
476
479
    <para>
601
604
      </varlistentry>
602
605
    </variablelist>
603
606
  </refsect1>
604
 
 
605
607
</refentry>
 
608
 
606
609
<!-- Local Variables: -->
607
610
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
611
<!-- time-stamp-end: "[\"']>" -->