/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: 2011-11-26 22:22:20 UTC
  • mto: (237.12.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 290.
  • Revision ID: teddy@recompile.se-20111126222220-1ubwjpb5ugqnrhec
Directory with persistent state can now be changed with the "statedir"
option.  The state directory /var/lib/mandos now gets created on
installation.  Added documentation about "restore" and "statedir"
options.

* Makefile (USER, GROUP, STATEDIR): New.
  (maintainer-clean): Also remove "statedir".
  (run-server): Replaced "--no-restore" with "--statedir=statedir".
  (statedir): New.
  (install-server): Make $(STATEDIR) directory.
* debian/mandos.dirs (var/lib/mandos): Added.
* debian/mandos.postinst: Fix ownership of /var/lib/mandos.
* mandos: New --statedir option.
  (stored_state_path): Not global anymore.
  (stored_state_file): New global.
* mandos.conf: Fix whitespace.
  (restore, statedir): Added.
* mandos.conf.xml (OPTIONS, EXAMPLE): Added "restore" and "statedir".
  mandos.xml (SYNOPSIS, OPTIONS): Added "--statedir".
  (FILES): Added "/var/lib/mandos".

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 "2011-02-27">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
94
94
      <arg><option>--no-dbus</option></arg>
95
95
      <sbr/>
96
96
      <arg><option>--no-ipv6</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--statedir
 
101
      <replaceable>DIRECTORY</replaceable></option></arg>
97
102
    </cmdsynopsis>
98
103
    <cmdsynopsis>
99
104
      <command>&COMMANDNAME;</command>
117
122
    <para>
118
123
      <command>&COMMANDNAME;</command> is a server daemon which
119
124
      handles incoming request for passwords for a pre-defined list of
120
 
      client host computers.  The Mandos server uses Zeroconf to
121
 
      announce itself on the local network, and uses TLS to
122
 
      communicate securely with and to authenticate the clients.  The
123
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
124
 
      link-local addresses, since the clients will probably not have
125
 
      any other addresses configured (see <xref linkend="overview"/>).
126
 
      Any authenticated client is then given the stored pre-encrypted
127
 
      password for that specific client.
 
125
      client host computers. For an introduction, see
 
126
      <citerefentry><refentrytitle>intro</refentrytitle>
 
127
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
128
      uses Zeroconf to announce itself on the local network, and uses
 
129
      TLS to communicate securely with and to authenticate the
 
130
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
131
      use IPv6 link-local addresses, since the clients will probably
 
132
      not have any other addresses configured (see <xref
 
133
      linkend="overview"/>).  Any authenticated client is then given
 
134
      the stored pre-encrypted password for that specific client.
128
135
    </para>
129
136
  </refsect1>
130
137
  
273
280
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
281
        </listitem>
275
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-restore</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--statedir
 
293
        <replaceable>DIRECTORY</replaceable></option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
296
        </listitem>
 
297
      </varlistentry>
276
298
    </variablelist>
277
299
  </refsect1>
278
300
  
352
374
      for some time, the client is assumed to be compromised and is no
353
375
      longer eligible to receive the encrypted password.  (Manual
354
376
      intervention is required to re-enable a client.)  The timeout,
355
 
      checker program, and interval between checks can be configured
356
 
      both globally and per client; see <citerefentry>
357
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
377
      extended timeout, checker program, and interval between checks
 
378
      can be configured both globally and per client; see
 
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
358
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
381
      receiving its password will also be treated as a successful
360
382
      checker run.
467
489
        </listitem>
468
490
      </varlistentry>
469
491
      <varlistentry>
 
492
        <term><filename
 
493
        class="directory">/var/lib/mandos</filename></term>
 
494
        <listitem>
 
495
          <para>
 
496
            Directory where persistent state will be saved.  Change
 
497
            this with the <option>--statedir</option> option.  See
 
498
            also the <option>--no-restore</option> option.
 
499
          </para>
 
500
        </listitem>
 
501
      </varlistentry>
 
502
      <varlistentry>
470
503
        <term><filename>/dev/log</filename></term>
471
504
        <listitem>
472
505
          <para>
496
529
      backtrace.  This could be considered a feature.
497
530
    </para>
498
531
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
502
 
    </para>
503
 
    <para>
504
532
      There is no fine-grained control over logging and debug output.
505
533
    </para>
506
534
    <para>
507
535
      Debug mode is conflated with running in the foreground.
508
536
    </para>
509
537
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
538
      This server does not check the expire time of clients’ OpenPGP
514
539
      keys.
515
540
    </para>
528
553
    <informalexample>
529
554
      <para>
530
555
        Run the server in debug mode, read configuration files from
531
 
        the <filename>~/mandos</filename> directory, and use the
532
 
        Zeroconf service name <quote>Test</quote> to not collide with
533
 
        any other official Mandos server on this host:
 
556
        the <filename class="directory">~/mandos</filename> directory,
 
557
        and use the Zeroconf service name <quote>Test</quote> to not
 
558
        collide with any other official Mandos server on this host:
534
559
      </para>
535
560
      <para>
536
561
 
585
610
        compromised if they are gone for too long.
586
611
      </para>
587
612
      <para>
588
 
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
601
 
      </para>
602
 
      <para>
603
613
        For more details on client-side security, see
604
614
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
605
615
        <manvolnum>8mandos</manvolnum></citerefentry>.
610
620
  <refsect1 id="see_also">
611
621
    <title>SEE ALSO</title>
612
622
    <para>
613
 
      <citerefentry>
614
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
615
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
 
        <refentrytitle>mandos.conf</refentrytitle>
617
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
619
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
 
      </citerefentry>
 
623
      <citerefentry><refentrytitle>intro</refentrytitle>
 
624
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
628
      <manvolnum>5</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
630
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
631
      <citerefentry><refentrytitle>sh</refentrytitle>
 
632
      <manvolnum>1</manvolnum></citerefentry>
622
633
    </para>
623
634
    <variablelist>
624
635
      <varlistentry>