/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
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
4
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="../legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
  
 
39
 
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8mandos</manvolnum>
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
  
 
51
 
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group>
56
56
        <arg choice="plain"><option>--connect
57
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
58
58
        ><replaceable>PORT</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-c
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
61
61
        ><replaceable>PORT</replaceable></option></arg>
62
62
      </group>
63
63
      <sbr/>
64
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>
65
72
        <arg choice="plain"><option>--interface
66
73
        <replaceable>NAME</replaceable></option></arg>
67
74
        <arg choice="plain"><option>-i
113
120
      </group>
114
121
    </cmdsynopsis>
115
122
  </refsynopsisdiv>
116
 
  
 
123
 
117
124
  <refsect1 id="description">
118
125
    <title>DESCRIPTION</title>
119
126
    <para>
124
131
      network connectivity, Zeroconf to find servers, and TLS with an
125
132
      OpenPGP key to ensure authenticity and confidentiality.  It
126
133
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
 
134
      receives a satisfactory reply or a TERM signal is recieved.
128
135
    </para>
129
136
    <para>
130
137
      This program is not meant to be run directly; it is really meant
184
191
      </varlistentry>
185
192
      
186
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>
187
210
        <term><option>--interface=
188
211
        <replaceable>NAME</replaceable></option></term>
189
212
        <term><option>-i
209
232
        <replaceable>FILE</replaceable></option></term>
210
233
        <listitem>
211
234
          <para>
212
 
            OpenPGP public key file name.  The default name is
213
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
214
 
            ></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>.
215
239
          </para>
216
240
        </listitem>
217
241
      </varlistentry>
218
 
      
 
242
 
219
243
      <varlistentry>
220
244
        <term><option>--seckey=<replaceable
221
245
        >FILE</replaceable></option></term>
223
247
        <replaceable>FILE</replaceable></option></term>
224
248
        <listitem>
225
249
          <para>
226
 
            OpenPGP secret key file name.  The default name is
227
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
228
 
            ></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>.
229
254
          </para>
230
255
        </listitem>
231
256
      </varlistentry>
238
263
                      xpointer="priority"/>
239
264
        </listitem>
240
265
      </varlistentry>
241
 
      
 
266
 
242
267
      <varlistentry>
243
268
        <term><option>--dh-bits=<replaceable
244
269
        >BITS</replaceable></option></term>
284
309
          </para>
285
310
        </listitem>
286
311
      </varlistentry>
287
 
      
 
312
 
288
313
      <varlistentry>
289
314
        <term><option>--version</option></term>
290
315
        <term><option>-V</option></term>
296
321
      </varlistentry>
297
322
    </variablelist>
298
323
  </refsect1>
299
 
  
 
324
 
300
325
  <refsect1 id="overview">
301
326
    <title>OVERVIEW</title>
302
327
    <xi:include href="../overview.xml"/>
311
336
      <filename>/etc/crypttab</filename>, but it would then be
312
337
      impossible to enter a password for the encrypted root disk at
313
338
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin runner (<citerefentry>
315
 
      <refentrytitle>plugin-runner</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
 
      both this program and others in in parallel,
318
 
      <emphasis>one</emphasis> of which will prompt for passwords on
319
 
      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.
320
343
    </para>
321
344
  </refsect1>
322
345
  
329
352
      program will exit with a non-zero exit status only if a critical
330
353
      error occurs.  Otherwise, it will forever connect to new
331
354
      <application>Mandos</application> servers as they appear, trying
332
 
      to get a decryptable password and print it.
 
355
      to get a decryptable password.
333
356
    </para>
334
357
  </refsect1>
335
358
  
368
391
<!--     <para> -->
369
392
<!--     </para> -->
370
393
<!--   </refsect1> -->
371
 
  
 
394
 
372
395
  <refsect1 id="example">
373
396
    <title>EXAMPLE</title>
374
397
    <para>
388
411
    </informalexample>
389
412
    <informalexample>
390
413
      <para>
391
 
        Search for Mandos servers (and connect to them) using another
392
 
        interface:
 
414
        Search for Mandos servers on another interface:
393
415
      </para>
394
416
      <para>
395
417
        <!-- do not wrap this line -->
398
420
    </informalexample>
399
421
    <informalexample>
400
422
      <para>
401
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
402
424
      </para>
403
425
      <para>
404
 
 
405
 
<!-- do not wrap this line -->
406
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
407
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
408
428
      </para>
409
429
    </informalexample>
410
430
    <informalexample>
411
431
      <para>
412
 
        Run in debug mode, with a custom key, and do not use Zeroconf
413
 
        to locate a server; connect directly to the IPv6 address
414
 
        <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"
415
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
416
436
        port 4711, using interface eth2:
417
437
      </para>
418
438
      <para>
419
439
 
420
440
<!-- do not wrap this line -->
421
 
<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>
422
442
 
423
443
      </para>
424
444
    </informalexample>
425
445
  </refsect1>
426
 
  
 
446
 
427
447
  <refsect1 id="security">
428
448
    <title>SECURITY</title>
429
449
    <para>
470
490
      confidential.
471
491
    </para>
472
492
  </refsect1>
473
 
  
 
493
 
474
494
  <refsect1 id="see_also">
475
495
    <title>SEE ALSO</title>
476
496
    <para>
601
621
      </varlistentry>
602
622
    </variablelist>
603
623
  </refsect1>
 
624
 
604
625
</refentry>
605
 
 
606
626
<!-- Local Variables: -->
607
627
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
628
<!-- time-stamp-end: "[\"']>" -->