/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: Björn Påhlsson
  • Date: 2011-11-09 11:16:17 UTC
  • mto: (237.14.5 persistent-state-gpgme)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: belorn@fukt.bsnet.se-20111109111617-jpey2sy4dupqzabc
Persistent state: New feature. Client state is now stored when mandos
                  server exits, and restored when starting up. Secrets
                  are encrypted with key based on clients config file.
--no-restore: New argument to mandos server. Disables restore
              functionallity
minor changes: clients are now dicts!

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.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 COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2013-10-20">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
38
      <holder>Teddy Hogeborn</holder>
41
39
      <holder>Björn Påhlsson</holder>
42
40
    </copyright>
98
96
      <arg><option>--no-ipv6</option></arg>
99
97
      <sbr/>
100
98
      <arg><option>--no-restore</option></arg>
101
 
      <sbr/>
102
 
      <arg><option>--statedir
103
 
      <replaceable>DIRECTORY</replaceable></option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--socket
106
 
      <replaceable>FD</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--foreground</option></arg>
109
99
    </cmdsynopsis>
110
100
    <cmdsynopsis>
111
101
      <command>&COMMANDNAME;</command>
292
282
        <term><option>--no-restore</option></term>
293
283
        <listitem>
294
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
295
 
          <para>
296
 
            See also <xref linkend="persistent_state"/>.
297
 
          </para>
298
 
        </listitem>
299
 
      </varlistentry>
300
 
      
301
 
      <varlistentry>
302
 
        <term><option>--statedir
303
 
        <replaceable>DIRECTORY</replaceable></option></term>
304
 
        <listitem>
305
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--socket
311
 
        <replaceable>FD</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--foreground</option></term>
319
 
        <listitem>
320
 
          <xi:include href="mandos-options.xml"
321
 
                      xpointer="foreground"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
 
285
        </listitem>
 
286
      </varlistentry>
325
287
    </variablelist>
326
288
  </refsect1>
327
289
  
404
366
      extended timeout, checker program, and interval between checks
405
367
      can be configured both globally and per client; see
406
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
407
 
      <manvolnum>5</manvolnum></citerefentry>.
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
408
372
    </para>
409
373
  </refsect1>
410
374
  
432
396
    <title>LOGGING</title>
433
397
    <para>
434
398
      The server will send log message with various severity levels to
435
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
399
      <filename>/dev/log</filename>.  With the
436
400
      <option>--debug</option> option, it will log even more messages,
437
401
      and also show them on the console.
438
402
    </para>
439
403
  </refsect1>
440
404
  
441
 
  <refsect1 id="persistent_state">
442
 
    <title>PERSISTENT STATE</title>
443
 
    <para>
444
 
      Client settings, initially read from
445
 
      <filename>clients.conf</filename>, are persistent across
446
 
      restarts, and run-time changes will override settings in
447
 
      <filename>clients.conf</filename>.  However, if a setting is
448
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
449
 
      <filename>clients.conf</filename>, this will take precedence.
450
 
    </para>
451
 
  </refsect1>
452
 
  
453
405
  <refsect1 id="dbus_interface">
454
406
    <title>D-BUS INTERFACE</title>
455
407
    <para>
517
469
        </listitem>
518
470
      </varlistentry>
519
471
      <varlistentry>
520
 
        <term><filename>/run/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
521
473
        <listitem>
522
474
          <para>
523
475
            The file containing the process id of the
526
478
        </listitem>
527
479
      </varlistentry>
528
480
      <varlistentry>
529
 
        <term><filename class="devicefile">/dev/log</filename></term>
530
 
      </varlistentry>
531
 
      <varlistentry>
532
 
        <term><filename
533
 
        class="directory">/var/lib/mandos</filename></term>
534
 
        <listitem>
535
 
          <para>
536
 
            Directory where persistent state will be saved.  Change
537
 
            this with the <option>--statedir</option> option.  See
538
 
            also the <option>--no-restore</option> option.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
481
        <term><filename>/dev/log</filename></term>
544
482
        <listitem>
545
483
          <para>
569
507
      backtrace.  This could be considered a feature.
570
508
    </para>
571
509
    <para>
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
 
513
    </para>
 
514
    <para>
572
515
      There is no fine-grained control over logging and debug output.
573
516
    </para>
574
517
    <para>
 
518
      Debug mode is conflated with running in the foreground.
 
519
    </para>
 
520
    <para>
 
521
      The console log messages do not show a time stamp.
 
522
    </para>
 
523
    <para>
575
524
      This server does not check the expire time of clients’ OpenPGP
576
525
      keys.
577
526
    </para>
590
539
    <informalexample>
591
540
      <para>
592
541
        Run the server in debug mode, read configuration files from
593
 
        the <filename class="directory">~/mandos</filename> directory,
594
 
        and use the Zeroconf service name <quote>Test</quote> to not
595
 
        collide with any other official Mandos server on this host:
 
542
        the <filename>~/mandos</filename> directory, and use the
 
543
        Zeroconf service name <quote>Test</quote> to not collide with
 
544
        any other official Mandos server on this host:
596
545
      </para>
597
546
      <para>
598
547
 
647
596
        compromised if they are gone for too long.
648
597
      </para>
649
598
      <para>
 
599
        If a client is compromised, its downtime should be duly noted
 
600
        by the server which would therefore disable the client.  But
 
601
        if the server was ever restarted, it would re-read its client
 
602
        list from its configuration file and again regard all clients
 
603
        therein as enabled, and hence eligible to receive their
 
604
        passwords.  Therefore, be careful when restarting servers if
 
605
        it is suspected that a client has, in fact, been compromised
 
606
        by parties who may now be running a fake Mandos client with
 
607
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
608
        image of the client host.  What should be done in that case
 
609
        (if restarting the server program really is necessary) is to
 
610
        stop the server program, edit the configuration file to omit
 
611
        any suspect clients, and restart the server program.
 
612
      </para>
 
613
      <para>
650
614
        For more details on client-side security, see
651
615
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
652
616
        <manvolnum>8mandos</manvolnum></citerefentry>.