/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

removed old/unspecified todo's

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 "2008-10-03">
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>
37
36
    </copyright>
38
37
    <xi:include href="../legalnotice.xml"/>
39
38
  </refentryinfo>
40
 
  
 
39
 
41
40
  <refmeta>
42
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
42
    <manvolnum>8mandos</manvolnum>
46
45
  <refnamediv>
47
46
    <refname><command>&COMMANDNAME;</command></refname>
48
47
    <refpurpose>
49
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
50
49
    </refpurpose>
51
50
  </refnamediv>
52
 
  
 
51
 
53
52
  <refsynopsisdiv>
54
53
    <cmdsynopsis>
55
54
      <command>&COMMANDNAME;</command>
56
55
      <group>
57
56
        <arg choice="plain"><option>--connect
58
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
59
58
        ><replaceable>PORT</replaceable></option></arg>
60
59
        <arg choice="plain"><option>-c
61
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
62
61
        ><replaceable>PORT</replaceable></option></arg>
63
62
      </group>
64
63
      <sbr/>
65
64
      <group>
 
65
        <arg choice="plain"><option>--keydir
 
66
        <replaceable>DIRECTORY</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-d
 
68
        <replaceable>DIRECTORY</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
66
72
        <arg choice="plain"><option>--interface
67
73
        <replaceable>NAME</replaceable></option></arg>
68
74
        <arg choice="plain"><option>-i
114
120
      </group>
115
121
    </cmdsynopsis>
116
122
  </refsynopsisdiv>
117
 
  
 
123
 
118
124
  <refsect1 id="description">
119
125
    <title>DESCRIPTION</title>
120
126
    <para>
125
131
      network connectivity, Zeroconf to find servers, and TLS with an
126
132
      OpenPGP key to ensure authenticity and confidentiality.  It
127
133
      keeps running, trying all servers on the network, until it
128
 
      receives a satisfactory reply or a TERM signal is received.
 
134
      receives a satisfactory reply or a TERM signal is recieved.
129
135
    </para>
130
136
    <para>
131
137
      This program is not meant to be run directly; it is really meant
185
191
      </varlistentry>
186
192
      
187
193
      <varlistentry>
 
194
        <term><option>--keydir=<replaceable
 
195
        >DIRECTORY</replaceable></option></term>
 
196
        <term><option>-d
 
197
        <replaceable>DIRECTORY</replaceable></option></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Directory to read the OpenPGP key files
 
201
            <filename>pubkey.txt</filename> and
 
202
            <filename>seckey.txt</filename> from.  The default is
 
203
            <filename>/conf/conf.d/mandos</filename> (in the initial
 
204
            <acronym>RAM</acronym> disk environment).
 
205
          </para>
 
206
        </listitem>
 
207
      </varlistentry>
 
208
 
 
209
      <varlistentry>
188
210
        <term><option>--interface=
189
211
        <replaceable>NAME</replaceable></option></term>
190
212
        <term><option>-i
210
232
        <replaceable>FILE</replaceable></option></term>
211
233
        <listitem>
212
234
          <para>
213
 
            OpenPGP public key file name.  The default name is
214
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
215
 
            ></quote>.
 
235
            OpenPGP public key file base name.  This will be combined
 
236
            with the directory from the <option>--keydir</option>
 
237
            option to form an absolute file name.  The default name is
 
238
            <quote><literal>pubkey.txt</literal></quote>.
216
239
          </para>
217
240
        </listitem>
218
241
      </varlistentry>
219
 
      
 
242
 
220
243
      <varlistentry>
221
244
        <term><option>--seckey=<replaceable
222
245
        >FILE</replaceable></option></term>
224
247
        <replaceable>FILE</replaceable></option></term>
225
248
        <listitem>
226
249
          <para>
227
 
            OpenPGP secret key file name.  The default name is
228
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
229
 
            ></quote>.
 
250
            OpenPGP secret key file base name.  This will be combined
 
251
            with the directory from the <option>--keydir</option>
 
252
            option to form an absolute file name.  The default name is
 
253
            <quote><literal>seckey.txt</literal></quote>.
230
254
          </para>
231
255
        </listitem>
232
256
      </varlistentry>
239
263
                      xpointer="priority"/>
240
264
        </listitem>
241
265
      </varlistentry>
242
 
      
 
266
 
243
267
      <varlistentry>
244
268
        <term><option>--dh-bits=<replaceable
245
269
        >BITS</replaceable></option></term>
285
309
          </para>
286
310
        </listitem>
287
311
      </varlistentry>
288
 
      
 
312
 
289
313
      <varlistentry>
290
314
        <term><option>--version</option></term>
291
315
        <term><option>-V</option></term>
297
321
      </varlistentry>
298
322
    </variablelist>
299
323
  </refsect1>
300
 
  
 
324
 
301
325
  <refsect1 id="overview">
302
326
    <title>OVERVIEW</title>
303
327
    <xi:include href="../overview.xml"/>
312
336
      <filename>/etc/crypttab</filename>, but it would then be
313
337
      impossible to enter a password for the encrypted root disk at
314
338
      the console, since this program does not read from the console
315
 
      at all.  This is why a separate plugin runner (<citerefentry>
316
 
      <refentrytitle>plugin-runner</refentrytitle>
317
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
318
 
      both this program and others in in parallel,
319
 
      <emphasis>one</emphasis> of which will prompt for passwords on
320
 
      the system console.
 
339
      at all.  This is why a separate plugin (<citerefentry>
 
340
      <refentrytitle>password-prompt</refentrytitle>
 
341
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
 
342
      will be run in parallell to this one by the plugin runner.
321
343
    </para>
322
344
  </refsect1>
323
345
  
330
352
      program will exit with a non-zero exit status only if a critical
331
353
      error occurs.  Otherwise, it will forever connect to new
332
354
      <application>Mandos</application> servers as they appear, trying
333
 
      to get a decryptable password and print it.
 
355
      to get a decryptable password.
334
356
    </para>
335
357
  </refsect1>
336
358
  
344
366
    </para>
345
367
  </refsect1>
346
368
  
347
 
  <refsect1 id="files">
 
369
  <refsect1 id="file">
348
370
    <title>FILES</title>
349
371
    <variablelist>
350
372
      <varlistentry>
369
391
<!--     <para> -->
370
392
<!--     </para> -->
371
393
<!--   </refsect1> -->
372
 
  
 
394
 
373
395
  <refsect1 id="example">
374
396
    <title>EXAMPLE</title>
375
397
    <para>
389
411
    </informalexample>
390
412
    <informalexample>
391
413
      <para>
392
 
        Search for Mandos servers (and connect to them) using another
393
 
        interface:
 
414
        Search for Mandos servers on another interface:
394
415
      </para>
395
416
      <para>
396
417
        <!-- do not wrap this line -->
399
420
    </informalexample>
400
421
    <informalexample>
401
422
      <para>
402
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
403
424
      </para>
404
425
      <para>
405
 
 
406
 
<!-- do not wrap this line -->
407
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
408
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
409
428
      </para>
410
429
    </informalexample>
411
430
    <informalexample>
412
431
      <para>
413
 
        Run in debug mode, with a custom key, and do not use Zeroconf
414
 
        to locate a server; connect directly to the IPv6 address
415
 
        <quote><systemitem class="ipaddress"
 
432
        Run in debug mode, with a custom key directory, and do not use
 
433
        Zeroconf to locate a server; connect directly to the IPv6
 
434
        address <quote><systemitem class="ipaddress"
416
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
417
436
        port 4711, using interface eth2:
418
437
      </para>
419
438
      <para>
420
439
 
421
440
<!-- do not wrap this line -->
422
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
441
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
423
442
 
424
443
      </para>
425
444
    </informalexample>
426
445
  </refsect1>
427
 
  
 
446
 
428
447
  <refsect1 id="security">
429
448
    <title>SECURITY</title>
430
449
    <para>
450
469
      The only remaining weak point is that someone with physical
451
470
      access to the client hard drive might turn off the client
452
471
      computer, read the OpenPGP keys directly from the hard drive,
453
 
      and communicate with the server.  To safeguard against this, the
454
 
      server is supposed to notice the client disappearing and stop
455
 
      giving out the encrypted data.  Therefore, it is important to
456
 
      set the timeout and checker interval values tightly on the
457
 
      server.  See <citerefentry><refentrytitle
 
472
      and communicate with the server.  The defense against this is
 
473
      that the server is supposed to notice the client disappearing
 
474
      and will stop giving out the encrypted data.  Therefore, it is
 
475
      important to set the timeout and checker interval values tightly
 
476
      on the server.  See <citerefentry><refentrytitle
458
477
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
459
478
    </para>
460
479
    <para>
471
490
      confidential.
472
491
    </para>
473
492
  </refsect1>
474
 
  
 
493
 
475
494
  <refsect1 id="see_also">
476
495
    <title>SEE ALSO</title>
477
496
    <para>
602
621
      </varlistentry>
603
622
    </variablelist>
604
623
  </refsect1>
 
624
 
605
625
</refentry>
606
 
 
607
626
<!-- Local Variables: -->
608
627
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
609
628
<!-- time-stamp-end: "[\"']>" -->