/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/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-04 07:30:58 UTC
  • mfrom: (24.1.87 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080904073058-h21spydersnh8jml
* README: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.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 COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2009-01-04">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
4
<!ENTITY VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
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>
47
45
  <refnamediv>
48
46
    <refname><command>&COMMANDNAME;</command></refname>
49
47
    <refpurpose>
50
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
57
55
      <group>
58
56
        <arg choice="plain"><option>--connect
59
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
60
58
        ><replaceable>PORT</replaceable></option></arg>
61
59
        <arg choice="plain"><option>-c
62
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
63
61
        ><replaceable>PORT</replaceable></option></arg>
64
62
      </group>
65
63
      <sbr/>
115
113
      </group>
116
114
    </cmdsynopsis>
117
115
  </refsynopsisdiv>
118
 
  
 
116
 
119
117
  <refsect1 id="description">
120
118
    <title>DESCRIPTION</title>
121
119
    <para>
126
124
      network connectivity, Zeroconf to find servers, and TLS with an
127
125
      OpenPGP key to ensure authenticity and confidentiality.  It
128
126
      keeps running, trying all servers on the network, until it
129
 
      receives a satisfactory reply or a TERM signal is received.
 
127
      receives a satisfactory reply or a TERM signal is recieved.
130
128
    </para>
131
129
    <para>
132
130
      This program is not meant to be run directly; it is really meant
217
215
          </para>
218
216
        </listitem>
219
217
      </varlistentry>
220
 
      
 
218
 
221
219
      <varlistentry>
222
220
        <term><option>--seckey=<replaceable
223
221
        >FILE</replaceable></option></term>
240
238
                      xpointer="priority"/>
241
239
        </listitem>
242
240
      </varlistentry>
243
 
      
 
241
 
244
242
      <varlistentry>
245
243
        <term><option>--dh-bits=<replaceable
246
244
        >BITS</replaceable></option></term>
286
284
          </para>
287
285
        </listitem>
288
286
      </varlistentry>
289
 
      
 
287
 
290
288
      <varlistentry>
291
289
        <term><option>--version</option></term>
292
290
        <term><option>-V</option></term>
298
296
      </varlistentry>
299
297
    </variablelist>
300
298
  </refsect1>
301
 
  
 
299
 
302
300
  <refsect1 id="overview">
303
301
    <title>OVERVIEW</title>
304
302
    <xi:include href="../overview.xml"/>
313
311
      <filename>/etc/crypttab</filename>, but it would then be
314
312
      impossible to enter a password for the encrypted root disk at
315
313
      the console, since this program does not read from the console
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.
 
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.
322
318
    </para>
323
319
  </refsect1>
324
320
  
331
327
      program will exit with a non-zero exit status only if a critical
332
328
      error occurs.  Otherwise, it will forever connect to new
333
329
      <application>Mandos</application> servers as they appear, trying
334
 
      to get a decryptable password and print it.
 
330
      to get a decryptable password.
335
331
    </para>
336
332
  </refsect1>
337
333
  
345
341
    </para>
346
342
  </refsect1>
347
343
  
348
 
  <refsect1 id="files">
 
344
  <refsect1 id="file">
349
345
    <title>FILES</title>
350
346
    <variablelist>
351
347
      <varlistentry>
370
366
<!--     <para> -->
371
367
<!--     </para> -->
372
368
<!--   </refsect1> -->
373
 
  
 
369
 
374
370
  <refsect1 id="example">
375
371
    <title>EXAMPLE</title>
376
372
    <para>
390
386
    </informalexample>
391
387
    <informalexample>
392
388
      <para>
393
 
        Search for Mandos servers (and connect to them) using another
394
 
        interface:
 
389
        Search for Mandos servers on another interface:
395
390
      </para>
396
391
      <para>
397
392
        <!-- do not wrap this line -->
425
420
      </para>
426
421
    </informalexample>
427
422
  </refsect1>
428
 
  
 
423
 
429
424
  <refsect1 id="security">
430
425
    <title>SECURITY</title>
431
426
    <para>
451
446
      The only remaining weak point is that someone with physical
452
447
      access to the client hard drive might turn off the client
453
448
      computer, read the OpenPGP keys directly from the hard drive,
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
 
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
459
454
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
460
455
    </para>
461
456
    <para>
472
467
      confidential.
473
468
    </para>
474
469
  </refsect1>
475
 
  
 
470
 
476
471
  <refsect1 id="see_also">
477
472
    <title>SEE ALSO</title>
478
473
    <para>
603
598
      </varlistentry>
604
599
    </variablelist>
605
600
  </refsect1>
 
601
 
606
602
</refentry>
607
 
 
608
603
<!-- Local Variables: -->
609
604
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
610
605
<!-- time-stamp-end: "[\"']>" -->