/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

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/>
91
93
      </arg>
92
94
      <sbr/>
93
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
94
100
        <option>--debug</option>
95
101
      </arg>
96
102
    </cmdsynopsis>
113
119
      </group>
114
120
    </cmdsynopsis>
115
121
  </refsynopsisdiv>
116
 
 
 
122
  
117
123
  <refsect1 id="description">
118
124
    <title>DESCRIPTION</title>
119
125
    <para>
124
130
      network connectivity, Zeroconf to find servers, and TLS with an
125
131
      OpenPGP key to ensure authenticity and confidentiality.  It
126
132
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is recieved.
 
133
      receives a satisfactory reply or a TERM signal is received.
128
134
    </para>
129
135
    <para>
130
136
      This program is not meant to be run directly; it is really meant
215
221
          </para>
216
222
        </listitem>
217
223
      </varlistentry>
218
 
 
 
224
      
219
225
      <varlistentry>
220
226
        <term><option>--seckey=<replaceable
221
227
        >FILE</replaceable></option></term>
238
244
                      xpointer="priority"/>
239
245
        </listitem>
240
246
      </varlistentry>
241
 
 
 
247
      
242
248
      <varlistentry>
243
249
        <term><option>--dh-bits=<replaceable
244
250
        >BITS</replaceable></option></term>
249
255
          </para>
250
256
        </listitem>
251
257
      </varlistentry>
 
258
 
 
259
      <varlistentry>
 
260
        <term><option>--delay=<replaceable
 
261
        >SECONDS</replaceable></option></term>
 
262
        <listitem>
 
263
          <para>
 
264
            After bringing the network interface up, the program waits
 
265
            for the interface to arrive in a <quote>running</quote>
 
266
            state before proceeding.  During this time, the kernel log
 
267
            level will be lowered to reduce clutter on the system
 
268
            console, alleviating any other plugins which might be
 
269
            using the system console.  This option sets the upper
 
270
            limit of seconds to wait.  The default is 2.5 seconds.
 
271
          </para>
 
272
        </listitem>
 
273
      </varlistentry>
252
274
      
253
275
      <varlistentry>
254
276
        <term><option>--debug</option></term>
284
306
          </para>
285
307
        </listitem>
286
308
      </varlistentry>
287
 
 
 
309
      
288
310
      <varlistentry>
289
311
        <term><option>--version</option></term>
290
312
        <term><option>-V</option></term>
296
318
      </varlistentry>
297
319
    </variablelist>
298
320
  </refsect1>
299
 
 
 
321
  
300
322
  <refsect1 id="overview">
301
323
    <title>OVERVIEW</title>
302
324
    <xi:include href="../overview.xml"/>
311
333
      <filename>/etc/crypttab</filename>, but it would then be
312
334
      impossible to enter a password for the encrypted root disk at
313
335
      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.
 
336
      at all.  This is why a separate plugin runner (<citerefentry>
 
337
      <refentrytitle>plugin-runner</refentrytitle>
 
338
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
339
      both this program and others in in parallel,
 
340
      <emphasis>one</emphasis> of which will prompt for passwords on
 
341
      the system console.
318
342
    </para>
319
343
  </refsect1>
320
344
  
327
351
      program will exit with a non-zero exit status only if a critical
328
352
      error occurs.  Otherwise, it will forever connect to new
329
353
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
354
      to get a decryptable password and print it.
331
355
    </para>
332
356
  </refsect1>
333
357
  
341
365
    </para>
342
366
  </refsect1>
343
367
  
344
 
  <refsect1 id="file">
 
368
  <refsect1 id="files">
345
369
    <title>FILES</title>
346
370
    <variablelist>
347
371
      <varlistentry>
366
390
<!--     <para> -->
367
391
<!--     </para> -->
368
392
<!--   </refsect1> -->
369
 
 
 
393
  
370
394
  <refsect1 id="example">
371
395
    <title>EXAMPLE</title>
372
396
    <para>
386
410
    </informalexample>
387
411
    <informalexample>
388
412
      <para>
389
 
        Search for Mandos servers on another interface:
 
413
        Search for Mandos servers (and connect to them) using another
 
414
        interface:
390
415
      </para>
391
416
      <para>
392
417
        <!-- do not wrap this line -->
420
445
      </para>
421
446
    </informalexample>
422
447
  </refsect1>
423
 
 
 
448
  
424
449
  <refsect1 id="security">
425
450
    <title>SECURITY</title>
426
451
    <para>
446
471
      The only remaining weak point is that someone with physical
447
472
      access to the client hard drive might turn off the client
448
473
      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
 
474
      and communicate with the server.  To safeguard against this, the
 
475
      server is supposed to notice the client disappearing and stop
 
476
      giving out the encrypted data.  Therefore, it is important to
 
477
      set the timeout and checker interval values tightly on the
 
478
      server.  See <citerefentry><refentrytitle
454
479
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
455
480
    </para>
456
481
    <para>
467
492
      confidential.
468
493
    </para>
469
494
  </refsect1>
470
 
 
 
495
  
471
496
  <refsect1 id="see_also">
472
497
    <title>SEE ALSO</title>
473
498
    <para>
598
623
      </varlistentry>
599
624
    </variablelist>
600
625
  </refsect1>
601
 
 
602
626
</refentry>
 
627
 
603
628
<!-- Local Variables: -->
604
629
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
605
630
<!-- time-stamp-end: "[\"']>" -->