/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-06 00:19:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906001953-5nk5uti6shzuyqdr
* plugins.d/password-prompt.c (main): If successful, output an extra
                                      newline to the console before
                                      exiting, to change to a new line
                                      away from the prompt.

* plugins.d/password-request.c (main): Bug fix: Moved calls to
                                       "init_gnutls_global()",
                                       "mkdtemp()", and "init_gpgme()"
                                       to *after* changing user &
                                       group.

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-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-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
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>
93
91
      </arg>
94
92
      <sbr/>
95
93
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
94
        <option>--debug</option>
101
95
      </arg>
102
96
    </cmdsynopsis>
119
113
      </group>
120
114
    </cmdsynopsis>
121
115
  </refsynopsisdiv>
122
 
  
 
116
 
123
117
  <refsect1 id="description">
124
118
    <title>DESCRIPTION</title>
125
119
    <para>
126
120
      <command>&COMMANDNAME;</command> is a client program that
127
121
      communicates with <citerefentry><refentrytitle
128
122
      >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.
 
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.
139
128
    </para>
140
129
    <para>
141
130
      This program is not meant to be run directly; it is really meant
195
184
      </varlistentry>
196
185
      
197
186
      <varlistentry>
198
 
        <term><option>--interface=<replaceable
199
 
        >NAME</replaceable></option></term>
 
187
        <term><option>--interface=
 
188
        <replaceable>NAME</replaceable></option></term>
200
189
        <term><option>-i
201
190
        <replaceable>NAME</replaceable></option></term>
202
191
        <listitem>
203
192
          <para>
204
193
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is the empty
206
 
            string, which will automatically choose an appropriate
207
 
            interface.
 
194
            Mandos servers to connect to.  The default it
 
195
            <quote><literal>eth0</literal></quote>.
208
196
          </para>
209
197
          <para>
210
198
            If the <option>--connect</option> option is used, this
211
199
            specifies the interface to use to connect to the address
212
200
            given.
213
201
          </para>
214
 
          <para>
215
 
            Note that since this program will normally run in the
216
 
            initial RAM disk environment, the interface must be an
217
 
            interface which exists at that stage.  Thus, the interface
218
 
            can not be a pseudo-interface such as <quote>br0</quote>
219
 
            or <quote>tun0</quote>; such interfaces will not exist
220
 
            until much later in the boot process, and can not be used
221
 
            by this program.
222
 
          </para>
223
 
          <para>
224
 
            <replaceable>NAME</replaceable> can be the string
225
 
            <quote><literal>none</literal></quote>; this will not use
226
 
            any specific interface, and will not bring up an interface
227
 
            on startup.  This is not recommended, and only meant for
228
 
            advanced users.
229
 
          </para>
230
202
        </listitem>
231
203
      </varlistentry>
232
204
      
243
215
          </para>
244
216
        </listitem>
245
217
      </varlistentry>
246
 
      
 
218
 
247
219
      <varlistentry>
248
220
        <term><option>--seckey=<replaceable
249
221
        >FILE</replaceable></option></term>
266
238
                      xpointer="priority"/>
267
239
        </listitem>
268
240
      </varlistentry>
269
 
      
 
241
 
270
242
      <varlistentry>
271
243
        <term><option>--dh-bits=<replaceable
272
244
        >BITS</replaceable></option></term>
277
249
          </para>
278
250
        </listitem>
279
251
      </varlistentry>
280
 
 
281
 
      <varlistentry>
282
 
        <term><option>--delay=<replaceable
283
 
        >SECONDS</replaceable></option></term>
284
 
        <listitem>
285
 
          <para>
286
 
            After bringing the network interface up, the program waits
287
 
            for the interface to arrive in a <quote>running</quote>
288
 
            state before proceeding.  During this time, the kernel log
289
 
            level will be lowered to reduce clutter on the system
290
 
            console, alleviating any other plugins which might be
291
 
            using the system console.  This option sets the upper
292
 
            limit of seconds to wait.  The default is 2.5 seconds.
293
 
          </para>
294
 
        </listitem>
295
 
      </varlistentry>
296
252
      
297
253
      <varlistentry>
298
254
        <term><option>--debug</option></term>
328
284
          </para>
329
285
        </listitem>
330
286
      </varlistentry>
331
 
      
 
287
 
332
288
      <varlistentry>
333
289
        <term><option>--version</option></term>
334
290
        <term><option>-V</option></term>
340
296
      </varlistentry>
341
297
    </variablelist>
342
298
  </refsect1>
343
 
  
 
299
 
344
300
  <refsect1 id="overview">
345
301
    <title>OVERVIEW</title>
346
302
    <xi:include href="../overview.xml"/>
355
311
      <filename>/etc/crypttab</filename>, but it would then be
356
312
      impossible to enter a password for the encrypted root disk at
357
313
      the console, since this program does not read from the console
358
 
      at all.  This is why a separate plugin runner (<citerefentry>
359
 
      <refentrytitle>plugin-runner</refentrytitle>
360
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
361
 
      both this program and others in in parallel,
362
 
      <emphasis>one</emphasis> of which will prompt for passwords on
363
 
      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.
364
318
    </para>
365
319
  </refsect1>
366
320
  
373
327
      program will exit with a non-zero exit status only if a critical
374
328
      error occurs.  Otherwise, it will forever connect to new
375
329
      <application>Mandos</application> servers as they appear, trying
376
 
      to get a decryptable password and print it.
 
330
      to get a decryptable password.
377
331
    </para>
378
332
  </refsect1>
379
333
  
387
341
    </para>
388
342
  </refsect1>
389
343
  
390
 
  <refsect1 id="files">
 
344
  <refsect1 id="file">
391
345
    <title>FILES</title>
392
346
    <variablelist>
393
347
      <varlistentry>
412
366
<!--     <para> -->
413
367
<!--     </para> -->
414
368
<!--   </refsect1> -->
415
 
  
 
369
 
416
370
  <refsect1 id="example">
417
371
    <title>EXAMPLE</title>
418
372
    <para>
454
408
    <informalexample>
455
409
      <para>
456
410
        Run in debug mode, with a custom key, and do not use Zeroconf
457
 
        to locate a server; connect directly to the IPv6 link-local
458
 
        address <quote><systemitem class="ipaddress"
459
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
460
 
        using interface eth2:
 
411
        to locate a server; connect directly to the IPv6 address
 
412
        <quote><systemitem class="ipaddress"
 
413
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
414
        port 4711, using interface eth2:
461
415
      </para>
462
416
      <para>
463
417
 
464
418
<!-- do not wrap this line -->
465
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
419
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
466
420
 
467
421
      </para>
468
422
    </informalexample>
469
423
  </refsect1>
470
 
  
 
424
 
471
425
  <refsect1 id="security">
472
426
    <title>SECURITY</title>
473
427
    <para>
493
447
      The only remaining weak point is that someone with physical
494
448
      access to the client hard drive might turn off the client
495
449
      computer, read the OpenPGP keys directly from the hard drive,
496
 
      and communicate with the server.  To safeguard against this, the
497
 
      server is supposed to notice the client disappearing and stop
498
 
      giving out the encrypted data.  Therefore, it is important to
499
 
      set the timeout and checker interval values tightly on the
500
 
      server.  See <citerefentry><refentrytitle
 
450
      and communicate with the server.  The defense against this is
 
451
      that the server is supposed to notice the client disappearing
 
452
      and will stop giving out the encrypted data.  Therefore, it is
 
453
      important to set the timeout and checker interval values tightly
 
454
      on the server.  See <citerefentry><refentrytitle
501
455
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
502
456
    </para>
503
457
    <para>
514
468
      confidential.
515
469
    </para>
516
470
  </refsect1>
517
 
  
 
471
 
518
472
  <refsect1 id="see_also">
519
473
    <title>SEE ALSO</title>
520
474
    <para>
645
599
      </varlistentry>
646
600
    </variablelist>
647
601
  </refsect1>
 
602
 
648
603
</refentry>
649
 
 
650
604
<!-- Local Variables: -->
651
605
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
652
606
<!-- time-stamp-end: "[\"']>" -->