/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-19 18:08:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919180819-e0zlzkhade0unvlr
* mandos-keygen (KEYNAME): Fall back to plain "hostname" if the
                           "hostname --fqdn" command should fail.

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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2010-09-11">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
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>
85
83
      <replaceable>DIRECTORY</replaceable></option></arg>
86
84
      <sbr/>
87
85
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
86
    </cmdsynopsis>
93
87
    <cmdsynopsis>
94
88
      <command>&COMMANDNAME;</command>
233
227
          </para>
234
228
        </listitem>
235
229
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
230
    </variablelist>
254
231
  </refsect1>
255
232
  
327
304
      The server will, by default, continually check that the clients
328
305
      are still up.  If a client has not been confirmed as being up
329
306
      for some time, the client is assumed to be compromised and is no
330
 
      longer eligible to receive the encrypted password.  (Manual
331
 
      intervention is required to re-enable a client.)  The timeout,
 
307
      longer eligible to receive the encrypted password.  The timeout,
332
308
      checker program, and interval between checks can be configured
333
309
      both globally and per client; see <citerefentry>
334
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
 
311
      <manvolnum>5</manvolnum></citerefentry>.
338
312
    </para>
339
313
  </refsect1>
340
314
  
348
322
    </para>
349
323
  </refsect1>
350
324
  
351
 
  <refsect1 id="dbus_interface">
352
 
    <title>D-BUS INTERFACE</title>
353
 
    <para>
354
 
      The server will by default provide a D-Bus system bus interface.
355
 
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.  For documentation
357
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
 
    </para>
359
 
  </refsect1>
360
 
  
361
325
  <refsect1 id="exit_status">
362
326
    <title>EXIT STATUS</title>
363
327
    <para>
386
350
    </variablelist>
387
351
  </refsect1>
388
352
  
389
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
390
354
    <title>FILES</title>
391
355
    <para>
392
356
      Use the <option>--configdir</option> option to change where
453
417
      backtrace.  This could be considered a feature.
454
418
    </para>
455
419
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
 
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.
459
429
    </para>
460
430
    <para>
461
431
      There is no fine-grained control over logging and debug output.
464
434
      Debug mode is conflated with running in the foreground.
465
435
    </para>
466
436
    <para>
467
 
      The console log messages do not show a time stamp.
 
437
      The console log messages does not show a time stamp.
468
438
    </para>
469
439
    <para>
470
440
      This server does not check the expire time of clients’ OpenPGP
512
482
  
513
483
  <refsect1 id="security">
514
484
    <title>SECURITY</title>
515
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
516
486
      <title>SERVER</title>
517
487
      <para>
518
488
        Running this <command>&COMMANDNAME;</command> server program
521
491
        soon after startup.
522
492
      </para>
523
493
    </refsect2>
524
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
525
495
      <title>CLIENTS</title>
526
496
      <para>
527
497
        The server only gives out its stored data to clients which
534
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
535
505
        <manvolnum>5</manvolnum></citerefentry>)
536
506
        <emphasis>must</emphasis> be made non-readable by anyone
537
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
538
508
      </para>
539
509
      <para>
540
510
        As detailed in <xref linkend="checking"/>, the status of all
543
513
      </para>
544
514
      <para>
545
515
        If a client is compromised, its downtime should be duly noted
546
 
        by the server which would therefore disable the client.  But
547
 
        if the server was ever restarted, it would re-read its client
548
 
        list from its configuration file and again regard all clients
549
 
        therein as enabled, and hence eligible to receive their
550
 
        passwords.  Therefore, be careful when restarting servers if
551
 
        it is suspected that a client has, in fact, been compromised
552
 
        by parties who may now be running a fake Mandos client with
553
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
554
 
        image of the client host.  What should be done in that case
555
 
        (if restarting the server program really is necessary) is to
556
 
        stop the server program, edit the configuration file to omit
557
 
        any suspect clients, and restart the server program.
 
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.
558
529
      </para>
559
530
      <para>
560
531
        For more details on client-side security, see