/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-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

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 "2011-08-08">
6
 
<!ENTITY % common SYSTEM "../common.ent">
7
 
%common;
 
4
<!ENTITY VERSION "1.0">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-04">
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
 
      <year>2011</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
37
    <xi:include href="../legalnotice.xml"/>
41
38
  </refentryinfo>
42
 
  
 
39
 
43
40
  <refmeta>
44
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
    <manvolnum>8mandos</manvolnum>
48
45
  <refnamediv>
49
46
    <refname><command>&COMMANDNAME;</command></refname>
50
47
    <refpurpose>
51
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
52
49
    </refpurpose>
53
50
  </refnamediv>
54
 
  
 
51
 
55
52
  <refsynopsisdiv>
56
53
    <cmdsynopsis>
57
54
      <command>&COMMANDNAME;</command>
94
91
      </arg>
95
92
      <sbr/>
96
93
      <arg>
97
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
 
      </arg>
99
 
      <sbr/>
100
 
      <arg>
101
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
94
        <option>--debug</option>
106
95
      </arg>
107
96
    </cmdsynopsis>
124
113
      </group>
125
114
    </cmdsynopsis>
126
115
  </refsynopsisdiv>
127
 
  
 
116
 
128
117
  <refsect1 id="description">
129
118
    <title>DESCRIPTION</title>
130
119
    <para>
131
120
      <command>&COMMANDNAME;</command> is a client program that
132
121
      communicates with <citerefentry><refentrytitle
133
122
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
134
 
      to get a password.  In slightly more detail, this client program
135
 
      brings up a network interface, uses the interface’s IPv6
136
 
      link-local address to get network connectivity, uses Zeroconf to
137
 
      find servers on the local network, and communicates with servers
138
 
      using TLS with an OpenPGP key to ensure authenticity and
139
 
      confidentiality.  This client program keeps running, trying all
140
 
      servers on the network, until it receives a satisfactory reply
141
 
      or a TERM signal.  After all servers have been tried, all
142
 
      servers are periodically retried.  If no servers are found it
143
 
      will wait indefinitely for new servers to appear.
 
123
      to get a password.  It uses IPv6 link-local addresses to get
 
124
      network connectivity, Zeroconf to find servers, and TLS with an
 
125
      OpenPGP key to ensure authenticity and confidentiality.  It
 
126
      keeps running, trying all servers on the network, until it
 
127
      receives a satisfactory reply or a TERM signal is received.
144
128
    </para>
145
129
    <para>
146
130
      This program is not meant to be run directly; it is really meant
200
184
      </varlistentry>
201
185
      
202
186
      <varlistentry>
203
 
        <term><option>--interface=<replaceable
204
 
        >NAME</replaceable></option></term>
 
187
        <term><option>--interface=
 
188
        <replaceable>NAME</replaceable></option></term>
205
189
        <term><option>-i
206
190
        <replaceable>NAME</replaceable></option></term>
207
191
        <listitem>
208
192
          <para>
209
193
            Network interface that will be brought up and scanned for
210
 
            Mandos servers to connect to.  The default is the empty
211
 
            string, which will automatically choose an appropriate
212
 
            interface.
 
194
            Mandos servers to connect to.  The default it
 
195
            <quote><literal>eth0</literal></quote>.
213
196
          </para>
214
197
          <para>
215
198
            If the <option>--connect</option> option is used, this
216
199
            specifies the interface to use to connect to the address
217
200
            given.
218
201
          </para>
219
 
          <para>
220
 
            Note that since this program will normally run in the
221
 
            initial RAM disk environment, the interface must be an
222
 
            interface which exists at that stage.  Thus, the interface
223
 
            can not be a pseudo-interface such as <quote>br0</quote>
224
 
            or <quote>tun0</quote>; such interfaces will not exist
225
 
            until much later in the boot process, and can not be used
226
 
            by this program.
227
 
          </para>
228
 
          <para>
229
 
            <replaceable>NAME</replaceable> can be the string
230
 
            <quote><literal>none</literal></quote>; this will not use
231
 
            any specific interface, and will not bring up an interface
232
 
            on startup.  This is not recommended, and only meant for
233
 
            advanced users.
234
 
          </para>
235
202
        </listitem>
236
203
      </varlistentry>
237
204
      
248
215
          </para>
249
216
        </listitem>
250
217
      </varlistentry>
251
 
      
 
218
 
252
219
      <varlistentry>
253
220
        <term><option>--seckey=<replaceable
254
221
        >FILE</replaceable></option></term>
271
238
                      xpointer="priority"/>
272
239
        </listitem>
273
240
      </varlistentry>
274
 
      
 
241
 
275
242
      <varlistentry>
276
243
        <term><option>--dh-bits=<replaceable
277
244
        >BITS</replaceable></option></term>
282
249
          </para>
283
250
        </listitem>
284
251
      </varlistentry>
285
 
 
286
 
      <varlistentry>
287
 
        <term><option>--delay=<replaceable
288
 
        >SECONDS</replaceable></option></term>
289
 
        <listitem>
290
 
          <para>
291
 
            After bringing the network interface up, the program waits
292
 
            for the interface to arrive in a <quote>running</quote>
293
 
            state before proceeding.  During this time, the kernel log
294
 
            level will be lowered to reduce clutter on the system
295
 
            console, alleviating any other plugins which might be
296
 
            using the system console.  This option sets the upper
297
 
            limit of seconds to wait.  The default is 2.5 seconds.
298
 
          </para>
299
 
        </listitem>
300
 
      </varlistentry>
301
 
 
302
 
      <varlistentry>
303
 
        <term><option>--retry=<replaceable
304
 
        >SECONDS</replaceable></option></term>
305
 
        <listitem>
306
 
          <para>
307
 
            All Mandos servers are tried repeatedly until a password
308
 
            is received.  This value specifies, in seconds, how long
309
 
            between each successive try <emphasis>for the same
310
 
            server</emphasis>.  The default is 10 seconds.
311
 
          </para>
312
 
        </listitem>
313
 
      </varlistentry>
314
252
      
315
253
      <varlistentry>
316
254
        <term><option>--debug</option></term>
346
284
          </para>
347
285
        </listitem>
348
286
      </varlistentry>
349
 
      
 
287
 
350
288
      <varlistentry>
351
289
        <term><option>--version</option></term>
352
290
        <term><option>-V</option></term>
358
296
      </varlistentry>
359
297
    </variablelist>
360
298
  </refsect1>
361
 
  
 
299
 
362
300
  <refsect1 id="overview">
363
301
    <title>OVERVIEW</title>
364
302
    <xi:include href="../overview.xml"/>
373
311
      <filename>/etc/crypttab</filename>, but it would then be
374
312
      impossible to enter a password for the encrypted root disk at
375
313
      the console, since this program does not read from the console
376
 
      at all.  This is why a separate plugin runner (<citerefentry>
377
 
      <refentrytitle>plugin-runner</refentrytitle>
378
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
379
 
      both this program and others in in parallel,
380
 
      <emphasis>one</emphasis> of which will prompt for passwords on
381
 
      the system 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 parallel to this one by the plugin runner.
382
318
    </para>
383
319
  </refsect1>
384
320
  
389
325
      server could be found and the password received from it could be
390
326
      successfully decrypted and output on standard output.  The
391
327
      program will exit with a non-zero exit status only if a critical
392
 
      error occurs.  Otherwise, it will forever connect to any
393
 
      discovered <application>Mandos</application> servers, trying to
394
 
      get a decryptable password and print it.
 
328
      error occurs.  Otherwise, it will forever connect to new
 
329
      <application>Mandos</application> servers as they appear, trying
 
330
      to get a decryptable password.
395
331
    </para>
396
332
  </refsect1>
397
333
  
405
341
    </para>
406
342
  </refsect1>
407
343
  
408
 
  <refsect1 id="files">
 
344
  <refsect1 id="file">
409
345
    <title>FILES</title>
410
346
    <variablelist>
411
347
      <varlistentry>
430
366
<!--     <para> -->
431
367
<!--     </para> -->
432
368
<!--   </refsect1> -->
433
 
  
 
369
 
434
370
  <refsect1 id="example">
435
371
    <title>EXAMPLE</title>
436
372
    <para>
450
386
    </informalexample>
451
387
    <informalexample>
452
388
      <para>
453
 
        Search for Mandos servers (and connect to them) using another
454
 
        interface:
 
389
        Search for Mandos servers on another interface:
455
390
      </para>
456
391
      <para>
457
392
        <!-- do not wrap this line -->
472
407
    <informalexample>
473
408
      <para>
474
409
        Run in debug mode, with a custom key, and do not use Zeroconf
475
 
        to locate a server; connect directly to the IPv6 link-local
476
 
        address <quote><systemitem class="ipaddress"
477
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
478
 
        using interface eth2:
 
410
        to locate a server; connect directly to the IPv6 address
 
411
        <quote><systemitem class="ipaddress"
 
412
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
413
        port 4711, using interface eth2:
479
414
      </para>
480
415
      <para>
481
416
 
482
417
<!-- do not wrap this line -->
483
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
418
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
484
419
 
485
420
      </para>
486
421
    </informalexample>
487
422
  </refsect1>
488
 
  
 
423
 
489
424
  <refsect1 id="security">
490
425
    <title>SECURITY</title>
491
426
    <para>
511
446
      The only remaining weak point is that someone with physical
512
447
      access to the client hard drive might turn off the client
513
448
      computer, read the OpenPGP keys directly from the hard drive,
514
 
      and communicate with the server.  To safeguard against this, the
515
 
      server is supposed to notice the client disappearing and stop
516
 
      giving out the encrypted data.  Therefore, it is important to
517
 
      set the timeout and checker interval values tightly on the
518
 
      server.  See <citerefentry><refentrytitle
 
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
519
454
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
520
455
    </para>
521
456
    <para>
532
467
      confidential.
533
468
    </para>
534
469
  </refsect1>
535
 
  
 
470
 
536
471
  <refsect1 id="see_also">
537
472
    <title>SEE ALSO</title>
538
473
    <para>
539
 
      <citerefentry><refentrytitle>intro</refentrytitle>
540
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
541
474
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
475
      <manvolnum>8</manvolnum></citerefentry>,
543
476
      <citerefentry><refentrytitle>crypttab</refentrytitle>
665
598
      </varlistentry>
666
599
    </variablelist>
667
600
  </refsect1>
 
601
 
668
602
</refentry>
669
 
 
670
603
<!-- Local Variables: -->
671
604
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
672
605
<!-- time-stamp-end: "[\"']>" -->