/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-01-24 14:24:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090124142454-32yvrhezuucam9vz
* 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
 
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
4
<!ENTITY COMMANDNAME "mandos-client">
 
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>
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>
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"/>
311
314
      <filename>/etc/crypttab</filename>, but it would then be
312
315
      impossible to enter a password for the encrypted root disk at
313
316
      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.
 
317
      at all.  This is why a separate plugin runner (<citerefentry>
 
318
      <refentrytitle>plugin-runner</refentrytitle>
 
319
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
320
      both this program and others in in parallel,
 
321
      <emphasis>one</emphasis> of which will prompt for passwords on
 
322
      the system console.
318
323
    </para>
319
324
  </refsect1>
320
325
  
327
332
      program will exit with a non-zero exit status only if a critical
328
333
      error occurs.  Otherwise, it will forever connect to new
329
334
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
335
      to get a decryptable password and print it.
331
336
    </para>
332
337
  </refsect1>
333
338
  
341
346
    </para>
342
347
  </refsect1>
343
348
  
344
 
  <refsect1 id="file">
 
349
  <refsect1 id="files">
345
350
    <title>FILES</title>
346
351
    <variablelist>
347
352
      <varlistentry>
366
371
<!--     <para> -->
367
372
<!--     </para> -->
368
373
<!--   </refsect1> -->
369
 
 
 
374
  
370
375
  <refsect1 id="example">
371
376
    <title>EXAMPLE</title>
372
377
    <para>
421
426
      </para>
422
427
    </informalexample>
423
428
  </refsect1>
424
 
 
 
429
  
425
430
  <refsect1 id="security">
426
431
    <title>SECURITY</title>
427
432
    <para>
447
452
      The only remaining weak point is that someone with physical
448
453
      access to the client hard drive might turn off the client
449
454
      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
 
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
455
460
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
456
461
    </para>
457
462
    <para>
468
473
      confidential.
469
474
    </para>
470
475
  </refsect1>
471
 
 
 
476
  
472
477
  <refsect1 id="see_also">
473
478
    <title>SEE ALSO</title>
474
479
    <para>
599
604
      </varlistentry>
600
605
    </variablelist>
601
606
  </refsect1>
602
 
 
603
607
</refentry>
 
608
 
604
609
<!-- Local Variables: -->
605
610
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
606
611
<!-- time-stamp-end: "[\"']>" -->