/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 20:31:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903203119-0q6dii46hj3uf4ni
* plugins.d/password-request.xml (SYNOPSYS): Removed "--keydir".
  (OPTIONS): Removed "--keydir" and changed text of "--pubkey" and
             "--seckey".
  (EXAMPLE): Altered not to use "--keydir" anymore.

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