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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 19:13:50 UTC
  • mfrom: (24.1.83 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080903191350-la2y2wuxt67xjslb
* mandos-keygen.xml (BUGS): Commented out.

* mandos.xml (BUGS): Note non-checking of expire time of OpenPGP keys.

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/>
66
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>
67
72
        <arg choice="plain"><option>--interface
68
73
        <replaceable>NAME</replaceable></option></arg>
69
74
        <arg choice="plain"><option>-i
93
98
      </arg>
94
99
      <sbr/>
95
100
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
101
        <option>--debug</option>
101
102
      </arg>
102
103
    </cmdsynopsis>
119
120
      </group>
120
121
    </cmdsynopsis>
121
122
  </refsynopsisdiv>
122
 
  
 
123
 
123
124
  <refsect1 id="description">
124
125
    <title>DESCRIPTION</title>
125
126
    <para>
130
131
      network connectivity, Zeroconf to find servers, and TLS with an
131
132
      OpenPGP key to ensure authenticity and confidentiality.  It
132
133
      keeps running, trying all servers on the network, until it
133
 
      receives a satisfactory reply or a TERM signal is received.
 
134
      receives a satisfactory reply or a TERM signal is recieved.
134
135
    </para>
135
136
    <para>
136
137
      This program is not meant to be run directly; it is really meant
190
191
      </varlistentry>
191
192
      
192
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>
193
210
        <term><option>--interface=
194
211
        <replaceable>NAME</replaceable></option></term>
195
212
        <term><option>-i
215
232
        <replaceable>FILE</replaceable></option></term>
216
233
        <listitem>
217
234
          <para>
218
 
            OpenPGP public key file name.  The default name is
219
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
220
 
            ></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>.
221
239
          </para>
222
240
        </listitem>
223
241
      </varlistentry>
224
 
      
 
242
 
225
243
      <varlistentry>
226
244
        <term><option>--seckey=<replaceable
227
245
        >FILE</replaceable></option></term>
229
247
        <replaceable>FILE</replaceable></option></term>
230
248
        <listitem>
231
249
          <para>
232
 
            OpenPGP secret key file name.  The default name is
233
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
234
 
            ></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>.
235
254
          </para>
236
255
        </listitem>
237
256
      </varlistentry>
244
263
                      xpointer="priority"/>
245
264
        </listitem>
246
265
      </varlistentry>
247
 
      
 
266
 
248
267
      <varlistentry>
249
268
        <term><option>--dh-bits=<replaceable
250
269
        >BITS</replaceable></option></term>
255
274
          </para>
256
275
        </listitem>
257
276
      </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>
274
277
      
275
278
      <varlistentry>
276
279
        <term><option>--debug</option></term>
306
309
          </para>
307
310
        </listitem>
308
311
      </varlistentry>
309
 
      
 
312
 
310
313
      <varlistentry>
311
314
        <term><option>--version</option></term>
312
315
        <term><option>-V</option></term>
318
321
      </varlistentry>
319
322
    </variablelist>
320
323
  </refsect1>
321
 
  
 
324
 
322
325
  <refsect1 id="overview">
323
326
    <title>OVERVIEW</title>
324
327
    <xi:include href="../overview.xml"/>
333
336
      <filename>/etc/crypttab</filename>, but it would then be
334
337
      impossible to enter a password for the encrypted root disk at
335
338
      the console, since this program does not read from the console
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.
 
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.
342
343
    </para>
343
344
  </refsect1>
344
345
  
351
352
      program will exit with a non-zero exit status only if a critical
352
353
      error occurs.  Otherwise, it will forever connect to new
353
354
      <application>Mandos</application> servers as they appear, trying
354
 
      to get a decryptable password and print it.
 
355
      to get a decryptable password.
355
356
    </para>
356
357
  </refsect1>
357
358
  
365
366
    </para>
366
367
  </refsect1>
367
368
  
368
 
  <refsect1 id="files">
 
369
  <refsect1 id="file">
369
370
    <title>FILES</title>
370
371
    <variablelist>
371
372
      <varlistentry>
390
391
<!--     <para> -->
391
392
<!--     </para> -->
392
393
<!--   </refsect1> -->
393
 
  
 
394
 
394
395
  <refsect1 id="example">
395
396
    <title>EXAMPLE</title>
396
397
    <para>
410
411
    </informalexample>
411
412
    <informalexample>
412
413
      <para>
413
 
        Search for Mandos servers (and connect to them) using another
414
 
        interface:
 
414
        Search for Mandos servers on another interface:
415
415
      </para>
416
416
      <para>
417
417
        <!-- do not wrap this line -->
420
420
    </informalexample>
421
421
    <informalexample>
422
422
      <para>
423
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
424
424
      </para>
425
425
      <para>
426
 
 
427
 
<!-- do not wrap this line -->
428
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
429
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
430
428
      </para>
431
429
    </informalexample>
432
430
    <informalexample>
433
431
      <para>
434
 
        Run in debug mode, with a custom key, and do not use Zeroconf
435
 
        to locate a server; connect directly to the IPv6 address
436
 
        <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"
437
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
438
436
        port 4711, using interface eth2:
439
437
      </para>
440
438
      <para>
441
439
 
442
440
<!-- do not wrap this line -->
443
 
<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>
444
442
 
445
443
      </para>
446
444
    </informalexample>
447
445
  </refsect1>
448
 
  
 
446
 
449
447
  <refsect1 id="security">
450
448
    <title>SECURITY</title>
451
449
    <para>
471
469
      The only remaining weak point is that someone with physical
472
470
      access to the client hard drive might turn off the client
473
471
      computer, read the OpenPGP keys directly from the hard drive,
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
 
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
479
477
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
480
478
    </para>
481
479
    <para>
492
490
      confidential.
493
491
    </para>
494
492
  </refsect1>
495
 
  
 
493
 
496
494
  <refsect1 id="see_also">
497
495
    <title>SEE ALSO</title>
498
496
    <para>
623
621
      </varlistentry>
624
622
    </variablelist>
625
623
  </refsect1>
 
624
 
626
625
</refentry>
627
 
 
628
626
<!-- Local Variables: -->
629
627
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
630
628
<!-- time-stamp-end: "[\"']>" -->