/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 mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2010-09-26 18:32:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926183258-n31ux2r8d06m1hi1
Update copyright year to "2010" wherever appropriate.

* DBUS-API: Added copyright and license statement.
* README: Mention new "plymouth" plugin.
* debian/control: Depend on python-2.6 or python-multiprocessing.
* debian/mandos-client.README.Debian: Update info about DEVICE setting
                                      of initramfs.conf.
* mandos-ctl: Added copyright and license statement.
* mandos-monitor: - '' -
* plugins.d/plymouth.c: - '' -

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 VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-06">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
37
40
    <xi:include href="legalnotice.xml"/>
38
41
  </refentryinfo>
39
 
 
 
42
  
40
43
  <refmeta>
41
44
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
45
    <manvolnum>8</manvolnum>
48
51
      Gives encrypted passwords to authenticated Mandos clients
49
52
    </refpurpose>
50
53
  </refnamediv>
51
 
 
 
54
  
52
55
  <refsynopsisdiv>
53
56
    <cmdsynopsis>
54
57
      <command>&COMMANDNAME;</command>
83
86
      <replaceable>DIRECTORY</replaceable></option></arg>
84
87
      <sbr/>
85
88
      <arg><option>--debug</option></arg>
 
89
      <sbr/>
 
90
      <arg><option>--no-dbus</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--no-ipv6</option></arg>
86
93
    </cmdsynopsis>
87
94
    <cmdsynopsis>
88
95
      <command>&COMMANDNAME;</command>
100
107
      <arg choice="plain"><option>--check</option></arg>
101
108
    </cmdsynopsis>
102
109
  </refsynopsisdiv>
103
 
 
 
110
  
104
111
  <refsect1 id="description">
105
112
    <title>DESCRIPTION</title>
106
113
    <para>
186
193
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
194
        </listitem>
188
195
      </varlistentry>
189
 
 
 
196
      
190
197
      <varlistentry>
191
198
        <term><option>--priority <replaceable>
192
199
        PRIORITY</replaceable></option></term>
194
201
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
202
        </listitem>
196
203
      </varlistentry>
197
 
 
 
204
      
198
205
      <varlistentry>
199
206
        <term><option>--servicename
200
207
        <replaceable>NAME</replaceable></option></term>
203
210
                      xpointer="servicename"/>
204
211
        </listitem>
205
212
      </varlistentry>
206
 
 
 
213
      
207
214
      <varlistentry>
208
215
        <term><option>--configdir
209
216
        <replaceable>DIRECTORY</replaceable></option></term>
218
225
          </para>
219
226
        </listitem>
220
227
      </varlistentry>
221
 
 
 
228
      
222
229
      <varlistentry>
223
230
        <term><option>--version</option></term>
224
231
        <listitem>
227
234
          </para>
228
235
        </listitem>
229
236
      </varlistentry>
 
237
      
 
238
      <varlistentry>
 
239
        <term><option>--no-dbus</option></term>
 
240
        <listitem>
 
241
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
242
          <para>
 
243
            See also <xref linkend="dbus_interface"/>.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
      
 
248
      <varlistentry>
 
249
        <term><option>--no-ipv6</option></term>
 
250
        <listitem>
 
251
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
252
        </listitem>
 
253
      </varlistentry>
230
254
    </variablelist>
231
255
  </refsect1>
232
 
 
 
256
  
233
257
  <refsect1 id="overview">
234
258
    <title>OVERVIEW</title>
235
259
    <xi:include href="overview.xml"/>
239
263
      <acronym>RAM</acronym> disk environment.
240
264
    </para>
241
265
  </refsect1>
242
 
 
 
266
  
243
267
  <refsect1 id="protocol">
244
268
    <title>NETWORK PROTOCOL</title>
245
269
    <para>
297
321
      </row>
298
322
    </tbody></tgroup></table>
299
323
  </refsect1>
300
 
 
 
324
  
301
325
  <refsect1 id="checking">
302
326
    <title>CHECKING</title>
303
327
    <para>
304
328
      The server will, by default, continually check that the clients
305
329
      are still up.  If a client has not been confirmed as being up
306
330
      for some time, the client is assumed to be compromised and is no
307
 
      longer eligible to receive the encrypted password.  The timeout,
 
331
      longer eligible to receive the encrypted password.  (Manual
 
332
      intervention is required to re-enable a client.)  The timeout,
308
333
      checker program, and interval between checks can be configured
309
334
      both globally and per client; see <citerefentry>
310
335
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
313
 
  </refsect1>
314
 
 
 
336
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
337
      receiving its password will also be treated as a successful
 
338
      checker run.
 
339
    </para>
 
340
  </refsect1>
 
341
  
 
342
  <refsect1 id="approval">
 
343
    <title>APPROVAL</title>
 
344
    <para>
 
345
      The server can be configured to require manual approval for a
 
346
      client before it is sent its secret.  The delay to wait for such
 
347
      approval and the default action (approve or deny) can be
 
348
      configured both globally and per client; see <citerefentry>
 
349
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
350
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
351
      will be approved immediately without delay.
 
352
    </para>
 
353
    <para>
 
354
      This can be used to deny a client its secret if not manually
 
355
      approved within a specified time.  It can also be used to make
 
356
      the server delay before giving a client its secret, allowing
 
357
      optional manual denying of this specific client.
 
358
    </para>
 
359
    
 
360
  </refsect1>
 
361
  
315
362
  <refsect1 id="logging">
316
363
    <title>LOGGING</title>
317
364
    <para>
321
368
      and also show them on the console.
322
369
    </para>
323
370
  </refsect1>
324
 
 
 
371
  
 
372
  <refsect1 id="dbus_interface">
 
373
    <title>D-BUS INTERFACE</title>
 
374
    <para>
 
375
      The server will by default provide a D-Bus system bus interface.
 
376
      This interface will only be accessible by the root user or a
 
377
      Mandos-specific user, if such a user exists.  For documentation
 
378
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
379
    </para>
 
380
  </refsect1>
 
381
  
325
382
  <refsect1 id="exit_status">
326
383
    <title>EXIT STATUS</title>
327
384
    <para>
329
386
      critical error is encountered.
330
387
    </para>
331
388
  </refsect1>
332
 
 
 
389
  
333
390
  <refsect1 id="environment">
334
391
    <title>ENVIRONMENT</title>
335
392
    <variablelist>
349
406
      </varlistentry>
350
407
    </variablelist>
351
408
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
409
  
 
410
  <refsect1 id="files">
354
411
    <title>FILES</title>
355
412
    <para>
356
413
      Use the <option>--configdir</option> option to change where
382
439
        <term><filename>/var/run/mandos.pid</filename></term>
383
440
        <listitem>
384
441
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
442
            The file containing the process id of the
 
443
            <command>&COMMANDNAME;</command> process started last.
387
444
          </para>
388
445
        </listitem>
389
446
      </varlistentry>
417
474
      backtrace.  This could be considered a feature.
418
475
    </para>
419
476
    <para>
420
 
      Currently, if a client is declared <quote>invalid</quote> due to
421
 
      having timed out, the server does not record this fact onto
422
 
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
424
 
    </para>
425
 
    <para>
426
 
      There is currently no way of querying the server of the current
427
 
      status of clients, other than analyzing its <systemitem
428
 
      class="service">syslog</systemitem> output.
 
477
      Currently, if a client is disabled due to having timed out, the
 
478
      server does not record this fact onto permanent storage.  This
 
479
      has some security implications, see <xref linkend="clients"/>.
429
480
    </para>
430
481
    <para>
431
482
      There is no fine-grained control over logging and debug output.
434
485
      Debug mode is conflated with running in the foreground.
435
486
    </para>
436
487
    <para>
437
 
      The console log messages does not show a time stamp.
 
488
      The console log messages do not show a time stamp.
438
489
    </para>
439
490
    <para>
440
491
      This server does not check the expire time of clients’ OpenPGP
479
530
      </para>
480
531
    </informalexample>
481
532
  </refsect1>
482
 
 
 
533
  
483
534
  <refsect1 id="security">
484
535
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
536
    <refsect2 id="server">
486
537
      <title>SERVER</title>
487
538
      <para>
488
539
        Running this <command>&COMMANDNAME;</command> server program
491
542
        soon after startup.
492
543
      </para>
493
544
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
545
    <refsect2 id="clients">
495
546
      <title>CLIENTS</title>
496
547
      <para>
497
548
        The server only gives out its stored data to clients which
504
555
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
556
        <manvolnum>5</manvolnum></citerefentry>)
506
557
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
558
        except the user starting the server (usually root).
508
559
      </para>
509
560
      <para>
510
561
        As detailed in <xref linkend="checking"/>, the status of all
513
564
      </para>
514
565
      <para>
515
566
        If a client is compromised, its downtime should be duly noted
516
 
        by the server which would therefore declare the client
517
 
        invalid.  But if the server was ever restarted, it would
518
 
        re-read its client list from its configuration file and again
519
 
        regard all clients therein as valid, and hence eligible to
520
 
        receive their passwords.  Therefore, be careful when
521
 
        restarting servers if it is suspected that a client has, in
522
 
        fact, been compromised by parties who may now be running a
523
 
        fake Mandos client with the keys from the non-encrypted
524
 
        initial <acronym>RAM</acronym> image of the client host.  What
525
 
        should be done in that case (if restarting the server program
526
 
        really is necessary) is to stop the server program, edit the
527
 
        configuration file to omit any suspect clients, and restart
528
 
        the server program.
 
567
        by the server which would therefore disable the client.  But
 
568
        if the server was ever restarted, it would re-read its client
 
569
        list from its configuration file and again regard all clients
 
570
        therein as enabled, and hence eligible to receive their
 
571
        passwords.  Therefore, be careful when restarting servers if
 
572
        it is suspected that a client has, in fact, been compromised
 
573
        by parties who may now be running a fake Mandos client with
 
574
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
575
        image of the client host.  What should be done in that case
 
576
        (if restarting the server program really is necessary) is to
 
577
        stop the server program, edit the configuration file to omit
 
578
        any suspect clients, and restart the server program.
529
579
      </para>
530
580
      <para>
531
581
        For more details on client-side security, see
534
584
      </para>
535
585
    </refsect2>
536
586
  </refsect1>
537
 
 
 
587
  
538
588
  <refsect1 id="see_also">
539
589
    <title>SEE ALSO</title>
540
590
    <para>