/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:
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-02-09">
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>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
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>
 
210
        <term><option>--interface=
 
211
        <replaceable>NAME</replaceable></option></term>
200
212
        <term><option>-i
201
213
        <replaceable>NAME</replaceable></option></term>
202
214
        <listitem>
203
215
          <para>
204
216
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
 
217
            Mandos servers to connect to.  The default it
206
218
            <quote><literal>eth0</literal></quote>.
207
219
          </para>
208
220
          <para>
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
 
          <para>
223
 
            <replaceable>NAME</replaceable> can be the empty string;
224
 
            this will not use any specific interface, and will not
225
 
            bring up an interface on startup.  This is not
226
 
            recommended, and only meant for advanced users.
227
 
          </para>
228
225
        </listitem>
229
226
      </varlistentry>
230
227
      
235
232
        <replaceable>FILE</replaceable></option></term>
236
233
        <listitem>
237
234
          <para>
238
 
            OpenPGP public key file name.  The default name is
239
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
240
 
            ></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>.
241
239
          </para>
242
240
        </listitem>
243
241
      </varlistentry>
244
 
      
 
242
 
245
243
      <varlistentry>
246
244
        <term><option>--seckey=<replaceable
247
245
        >FILE</replaceable></option></term>
249
247
        <replaceable>FILE</replaceable></option></term>
250
248
        <listitem>
251
249
          <para>
252
 
            OpenPGP secret key file name.  The default name is
253
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
254
 
            ></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>.
255
254
          </para>
256
255
        </listitem>
257
256
      </varlistentry>
264
263
                      xpointer="priority"/>
265
264
        </listitem>
266
265
      </varlistentry>
267
 
      
 
266
 
268
267
      <varlistentry>
269
268
        <term><option>--dh-bits=<replaceable
270
269
        >BITS</replaceable></option></term>
275
274
          </para>
276
275
        </listitem>
277
276
      </varlistentry>
278
 
 
279
 
      <varlistentry>
280
 
        <term><option>--delay=<replaceable
281
 
        >SECONDS</replaceable></option></term>
282
 
        <listitem>
283
 
          <para>
284
 
            After bringing the network interface up, the program waits
285
 
            for the interface to arrive in a <quote>running</quote>
286
 
            state before proceeding.  During this time, the kernel log
287
 
            level will be lowered to reduce clutter on the system
288
 
            console, alleviating any other plugins which might be
289
 
            using the system console.  This option sets the upper
290
 
            limit of seconds to wait.  The default is 2.5 seconds.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
277
      
295
278
      <varlistentry>
296
279
        <term><option>--debug</option></term>
326
309
          </para>
327
310
        </listitem>
328
311
      </varlistentry>
329
 
      
 
312
 
330
313
      <varlistentry>
331
314
        <term><option>--version</option></term>
332
315
        <term><option>-V</option></term>
338
321
      </varlistentry>
339
322
    </variablelist>
340
323
  </refsect1>
341
 
  
 
324
 
342
325
  <refsect1 id="overview">
343
326
    <title>OVERVIEW</title>
344
327
    <xi:include href="../overview.xml"/>
353
336
      <filename>/etc/crypttab</filename>, but it would then be
354
337
      impossible to enter a password for the encrypted root disk at
355
338
      the console, since this program does not read from the console
356
 
      at all.  This is why a separate plugin runner (<citerefentry>
357
 
      <refentrytitle>plugin-runner</refentrytitle>
358
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
359
 
      both this program and others in in parallel,
360
 
      <emphasis>one</emphasis> of which will prompt for passwords on
361
 
      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.
362
343
    </para>
363
344
  </refsect1>
364
345
  
371
352
      program will exit with a non-zero exit status only if a critical
372
353
      error occurs.  Otherwise, it will forever connect to new
373
354
      <application>Mandos</application> servers as they appear, trying
374
 
      to get a decryptable password and print it.
 
355
      to get a decryptable password.
375
356
    </para>
376
357
  </refsect1>
377
358
  
385
366
    </para>
386
367
  </refsect1>
387
368
  
388
 
  <refsect1 id="files">
 
369
  <refsect1 id="file">
389
370
    <title>FILES</title>
390
371
    <variablelist>
391
372
      <varlistentry>
410
391
<!--     <para> -->
411
392
<!--     </para> -->
412
393
<!--   </refsect1> -->
413
 
  
 
394
 
414
395
  <refsect1 id="example">
415
396
    <title>EXAMPLE</title>
416
397
    <para>
430
411
    </informalexample>
431
412
    <informalexample>
432
413
      <para>
433
 
        Search for Mandos servers (and connect to them) using another
434
 
        interface:
 
414
        Search for Mandos servers on another interface:
435
415
      </para>
436
416
      <para>
437
417
        <!-- do not wrap this line -->
440
420
    </informalexample>
441
421
    <informalexample>
442
422
      <para>
443
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
444
424
      </para>
445
425
      <para>
446
 
 
447
 
<!-- do not wrap this line -->
448
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
449
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
450
428
      </para>
451
429
    </informalexample>
452
430
    <informalexample>
453
431
      <para>
454
 
        Run in debug mode, with a custom key, and do not use Zeroconf
455
 
        to locate a server; connect directly to the IPv6 link-local
 
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
456
434
        address <quote><systemitem class="ipaddress"
457
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
458
 
        using interface eth2:
 
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
436
        port 4711, using interface eth2:
459
437
      </para>
460
438
      <para>
461
439
 
462
440
<!-- do not wrap this line -->
463
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
441
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
464
442
 
465
443
      </para>
466
444
    </informalexample>
467
445
  </refsect1>
468
 
  
 
446
 
469
447
  <refsect1 id="security">
470
448
    <title>SECURITY</title>
471
449
    <para>
491
469
      The only remaining weak point is that someone with physical
492
470
      access to the client hard drive might turn off the client
493
471
      computer, read the OpenPGP keys directly from the hard drive,
494
 
      and communicate with the server.  To safeguard against this, the
495
 
      server is supposed to notice the client disappearing and stop
496
 
      giving out the encrypted data.  Therefore, it is important to
497
 
      set the timeout and checker interval values tightly on the
498
 
      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
499
477
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
500
478
    </para>
501
479
    <para>
512
490
      confidential.
513
491
    </para>
514
492
  </refsect1>
515
 
  
 
493
 
516
494
  <refsect1 id="see_also">
517
495
    <title>SEE ALSO</title>
518
496
    <para>
643
621
      </varlistentry>
644
622
    </variablelist>
645
623
  </refsect1>
 
624
 
646
625
</refentry>
647
 
 
648
626
<!-- Local Variables: -->
649
627
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
650
628
<!-- time-stamp-end: "[\"']>" -->