/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-03 19:37:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903193707-sas85ud9r37ubs9r
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
                                     whether it is a required or
                                     optional.

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-24">
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>
126
127
      <command>&COMMANDNAME;</command> is a client program that
127
128
      communicates with <citerefentry><refentrytitle
128
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
129
 
      to get a password.  In slightly more detail, this client program
130
 
      brings up a network interface, uses the interface’s IPv6
131
 
      link-local address to get network connectivity, uses Zeroconf to
132
 
      find servers on the local network, and communicates with servers
133
 
      using TLS with an OpenPGP key to ensure authenticity and
134
 
      confidentiality.  This client program keeps running, trying all
135
 
      servers on the network, until it receives a satisfactory reply
136
 
      or a TERM signal is received.  If no servers are found, or after
137
 
      all servers have been tried, it waits indefinitely for new
138
 
      servers to appear.
 
130
      to get a password.  It uses IPv6 link-local addresses to get
 
131
      network connectivity, Zeroconf to find servers, and TLS with an
 
132
      OpenPGP key to ensure authenticity and confidentiality.  It
 
133
      keeps running, trying all servers on the network, until it
 
134
      receives a satisfactory reply or a TERM signal is recieved.
139
135
    </para>
140
136
    <para>
141
137
      This program is not meant to be run directly; it is really meant
195
191
      </varlistentry>
196
192
      
197
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>
198
210
        <term><option>--interface=
199
211
        <replaceable>NAME</replaceable></option></term>
200
212
        <term><option>-i
210
222
            specifies the interface to use to connect to the address
211
223
            given.
212
224
          </para>
213
 
          <para>
214
 
            Note that since this program will normally run in the
215
 
            initial RAM disk environment, the interface must be an
216
 
            interface which exists at that stage.  Thus, the interface
217
 
            can not be a pseudo-interface such as <quote>br0</quote>
218
 
            or <quote>tun0</quote>; such interfaces will not exist
219
 
            until much later in the boot process, and can not be used
220
 
            by this program.
221
 
          </para>
222
225
        </listitem>
223
226
      </varlistentry>
224
227
      
229
232
        <replaceable>FILE</replaceable></option></term>
230
233
        <listitem>
231
234
          <para>
232
 
            OpenPGP public key file name.  The default name is
233
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
234
 
            ></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>.
235
239
          </para>
236
240
        </listitem>
237
241
      </varlistentry>
238
 
      
 
242
 
239
243
      <varlistentry>
240
244
        <term><option>--seckey=<replaceable
241
245
        >FILE</replaceable></option></term>
243
247
        <replaceable>FILE</replaceable></option></term>
244
248
        <listitem>
245
249
          <para>
246
 
            OpenPGP secret key file name.  The default name is
247
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
248
 
            ></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>.
249
254
          </para>
250
255
        </listitem>
251
256
      </varlistentry>
258
263
                      xpointer="priority"/>
259
264
        </listitem>
260
265
      </varlistentry>
261
 
      
 
266
 
262
267
      <varlistentry>
263
268
        <term><option>--dh-bits=<replaceable
264
269
        >BITS</replaceable></option></term>
269
274
          </para>
270
275
        </listitem>
271
276
      </varlistentry>
272
 
 
273
 
      <varlistentry>
274
 
        <term><option>--delay=<replaceable
275
 
        >SECONDS</replaceable></option></term>
276
 
        <listitem>
277
 
          <para>
278
 
            After bringing the network interface up, the program waits
279
 
            for the interface to arrive in a <quote>running</quote>
280
 
            state before proceeding.  During this time, the kernel log
281
 
            level will be lowered to reduce clutter on the system
282
 
            console, alleviating any other plugins which might be
283
 
            using the system console.  This option sets the upper
284
 
            limit of seconds to wait.  The default is 2.5 seconds.
285
 
          </para>
286
 
        </listitem>
287
 
      </varlistentry>
288
277
      
289
278
      <varlistentry>
290
279
        <term><option>--debug</option></term>
320
309
          </para>
321
310
        </listitem>
322
311
      </varlistentry>
323
 
      
 
312
 
324
313
      <varlistentry>
325
314
        <term><option>--version</option></term>
326
315
        <term><option>-V</option></term>
332
321
      </varlistentry>
333
322
    </variablelist>
334
323
  </refsect1>
335
 
  
 
324
 
336
325
  <refsect1 id="overview">
337
326
    <title>OVERVIEW</title>
338
327
    <xi:include href="../overview.xml"/>
347
336
      <filename>/etc/crypttab</filename>, but it would then be
348
337
      impossible to enter a password for the encrypted root disk at
349
338
      the console, since this program does not read from the console
350
 
      at all.  This is why a separate plugin runner (<citerefentry>
351
 
      <refentrytitle>plugin-runner</refentrytitle>
352
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
353
 
      both this program and others in in parallel,
354
 
      <emphasis>one</emphasis> of which will prompt for passwords on
355
 
      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.
356
343
    </para>
357
344
  </refsect1>
358
345
  
365
352
      program will exit with a non-zero exit status only if a critical
366
353
      error occurs.  Otherwise, it will forever connect to new
367
354
      <application>Mandos</application> servers as they appear, trying
368
 
      to get a decryptable password and print it.
 
355
      to get a decryptable password.
369
356
    </para>
370
357
  </refsect1>
371
358
  
379
366
    </para>
380
367
  </refsect1>
381
368
  
382
 
  <refsect1 id="files">
 
369
  <refsect1 id="file">
383
370
    <title>FILES</title>
384
371
    <variablelist>
385
372
      <varlistentry>
404
391
<!--     <para> -->
405
392
<!--     </para> -->
406
393
<!--   </refsect1> -->
407
 
  
 
394
 
408
395
  <refsect1 id="example">
409
396
    <title>EXAMPLE</title>
410
397
    <para>
424
411
    </informalexample>
425
412
    <informalexample>
426
413
      <para>
427
 
        Search for Mandos servers (and connect to them) using another
428
 
        interface:
 
414
        Search for Mandos servers on another interface:
429
415
      </para>
430
416
      <para>
431
417
        <!-- do not wrap this line -->
434
420
    </informalexample>
435
421
    <informalexample>
436
422
      <para>
437
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
438
424
      </para>
439
425
      <para>
440
 
 
441
 
<!-- do not wrap this line -->
442
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
443
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
444
428
      </para>
445
429
    </informalexample>
446
430
    <informalexample>
447
431
      <para>
448
 
        Run in debug mode, with a custom key, and do not use Zeroconf
449
 
        to locate a server; connect directly to the IPv6 address
450
 
        <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"
451
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
452
436
        port 4711, using interface eth2:
453
437
      </para>
454
438
      <para>
455
439
 
456
440
<!-- do not wrap this line -->
457
 
<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>
458
442
 
459
443
      </para>
460
444
    </informalexample>
461
445
  </refsect1>
462
 
  
 
446
 
463
447
  <refsect1 id="security">
464
448
    <title>SECURITY</title>
465
449
    <para>
485
469
      The only remaining weak point is that someone with physical
486
470
      access to the client hard drive might turn off the client
487
471
      computer, read the OpenPGP keys directly from the hard drive,
488
 
      and communicate with the server.  To safeguard against this, the
489
 
      server is supposed to notice the client disappearing and stop
490
 
      giving out the encrypted data.  Therefore, it is important to
491
 
      set the timeout and checker interval values tightly on the
492
 
      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
493
477
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
494
478
    </para>
495
479
    <para>
506
490
      confidential.
507
491
    </para>
508
492
  </refsect1>
509
 
  
 
493
 
510
494
  <refsect1 id="see_also">
511
495
    <title>SEE ALSO</title>
512
496
    <para>
637
621
      </varlistentry>
638
622
    </variablelist>
639
623
  </refsect1>
 
624
 
640
625
</refentry>
641
 
 
642
626
<!-- Local Variables: -->
643
627
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
644
628
<!-- time-stamp-end: "[\"']>" -->