/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: 2013-10-24 20:21:45 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131024202145-456a9y6x910a2vhb
* debian/control (Build-Depends): Changed debhelper version to (>= 9)
                                  to match debian/compat.
* mandos-options.xml (priority): Changed back to normal priority.
  (priority_compat): New option; for the server which needs to a
                     priority string compatible with old keys.
* mandos-conf.xml (OPTIONS/priority): Include "priority_compat".
* mandos.xml (OPTIONS/priority): - '' -

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 "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2013-10-23">
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>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
93
96
      <arg><option>--no-dbus</option></arg>
94
97
      <sbr/>
95
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <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>
96
109
    </cmdsynopsis>
97
110
    <cmdsynopsis>
98
111
      <command>&COMMANDNAME;</command>
116
129
    <para>
117
130
      <command>&COMMANDNAME;</command> is a server daemon which
118
131
      handles incoming request for passwords for a pre-defined list of
119
 
      client host computers.  The Mandos server uses Zeroconf to
120
 
      announce itself on the local network, and uses TLS to
121
 
      communicate securely with and to authenticate the clients.  The
122
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
123
 
      link-local addresses, since the clients will probably not have
124
 
      any other addresses configured (see <xref linkend="overview"/>).
125
 
      Any authenticated client is then given the stored pre-encrypted
126
 
      password for that specific client.
 
132
      client host computers. For an introduction, see
 
133
      <citerefentry><refentrytitle>intro</refentrytitle>
 
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
135
      uses Zeroconf to announce itself on the local network, and uses
 
136
      TLS to communicate securely with and to authenticate the
 
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
138
      use IPv6 link-local addresses, since the clients will probably
 
139
      not have any other addresses configured (see <xref
 
140
      linkend="overview"/>).  Any authenticated client is then given
 
141
      the stored pre-encrypted password for that specific client.
127
142
    </para>
128
143
  </refsect1>
129
144
  
219
234
        <term><option>--priority <replaceable>
220
235
        PRIORITY</replaceable></option></term>
221
236
        <listitem>
222
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="mandos-options.xml"
 
238
                      xpointer="priority_compat"/>
223
239
        </listitem>
224
240
      </varlistentry>
225
241
      
272
288
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
289
        </listitem>
274
290
      </varlistentry>
 
291
      
 
292
      <varlistentry>
 
293
        <term><option>--no-restore</option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
296
          <para>
 
297
            See also <xref linkend="persistent_state"/>.
 
298
          </para>
 
299
        </listitem>
 
300
      </varlistentry>
 
301
      
 
302
      <varlistentry>
 
303
        <term><option>--statedir
 
304
        <replaceable>DIRECTORY</replaceable></option></term>
 
305
        <listitem>
 
306
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
307
        </listitem>
 
308
      </varlistentry>
 
309
      
 
310
      <varlistentry>
 
311
        <term><option>--socket
 
312
        <replaceable>FD</replaceable></option></term>
 
313
        <listitem>
 
314
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
315
        </listitem>
 
316
      </varlistentry>
 
317
      
 
318
      <varlistentry>
 
319
        <term><option>--foreground</option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml"
 
322
                      xpointer="foreground"/>
 
323
        </listitem>
 
324
      </varlistentry>
 
325
      
275
326
    </variablelist>
276
327
  </refsect1>
277
328
  
351
402
      for some time, the client is assumed to be compromised and is no
352
403
      longer eligible to receive the encrypted password.  (Manual
353
404
      intervention is required to re-enable a client.)  The timeout,
354
 
      checker program, and interval between checks can be configured
355
 
      both globally and per client; see <citerefentry>
356
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
357
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
358
 
      receiving its password will also be treated as a successful
359
 
      checker run.
 
405
      extended timeout, checker program, and interval between checks
 
406
      can be configured both globally and per client; see
 
407
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
408
      <manvolnum>5</manvolnum></citerefentry>.
360
409
    </para>
361
410
  </refsect1>
362
411
  
384
433
    <title>LOGGING</title>
385
434
    <para>
386
435
      The server will send log message with various severity levels to
387
 
      <filename>/dev/log</filename>.  With the
 
436
      <filename class="devicefile">/dev/log</filename>.  With the
388
437
      <option>--debug</option> option, it will log even more messages,
389
438
      and also show them on the console.
390
439
    </para>
391
440
  </refsect1>
392
441
  
 
442
  <refsect1 id="persistent_state">
 
443
    <title>PERSISTENT STATE</title>
 
444
    <para>
 
445
      Client settings, initially read from
 
446
      <filename>clients.conf</filename>, are persistent across
 
447
      restarts, and run-time changes will override settings in
 
448
      <filename>clients.conf</filename>.  However, if a setting is
 
449
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
450
      <filename>clients.conf</filename>, this will take precedence.
 
451
    </para>
 
452
  </refsect1>
 
453
  
393
454
  <refsect1 id="dbus_interface">
394
455
    <title>D-BUS INTERFACE</title>
395
456
    <para>
457
518
        </listitem>
458
519
      </varlistentry>
459
520
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
521
        <term><filename>/run/mandos.pid</filename></term>
461
522
        <listitem>
462
523
          <para>
463
524
            The file containing the process id of the
466
527
        </listitem>
467
528
      </varlistentry>
468
529
      <varlistentry>
 
530
        <term><filename class="devicefile">/dev/log</filename></term>
 
531
      </varlistentry>
 
532
      <varlistentry>
 
533
        <term><filename
 
534
        class="directory">/var/lib/mandos</filename></term>
 
535
        <listitem>
 
536
          <para>
 
537
            Directory where persistent state will be saved.  Change
 
538
            this with the <option>--statedir</option> option.  See
 
539
            also the <option>--no-restore</option> option.
 
540
          </para>
 
541
        </listitem>
 
542
      </varlistentry>
 
543
      <varlistentry>
469
544
        <term><filename>/dev/log</filename></term>
470
545
        <listitem>
471
546
          <para>
495
570
      backtrace.  This could be considered a feature.
496
571
    </para>
497
572
    <para>
498
 
      Currently, if a client is disabled due to having timed out, the
499
 
      server does not record this fact onto permanent storage.  This
500
 
      has some security implications, see <xref linkend="clients"/>.
501
 
    </para>
502
 
    <para>
503
573
      There is no fine-grained control over logging and debug output.
504
574
    </para>
505
575
    <para>
506
 
      Debug mode is conflated with running in the foreground.
507
 
    </para>
508
 
    <para>
509
 
      The console log messages do not show a time stamp.
510
 
    </para>
511
 
    <para>
512
576
      This server does not check the expire time of clients’ OpenPGP
513
577
      keys.
514
578
    </para>
527
591
    <informalexample>
528
592
      <para>
529
593
        Run the server in debug mode, read configuration files from
530
 
        the <filename>~/mandos</filename> directory, and use the
531
 
        Zeroconf service name <quote>Test</quote> to not collide with
532
 
        any other official Mandos server on this host:
 
594
        the <filename class="directory">~/mandos</filename> directory,
 
595
        and use the Zeroconf service name <quote>Test</quote> to not
 
596
        collide with any other official Mandos server on this host:
533
597
      </para>
534
598
      <para>
535
599
 
584
648
        compromised if they are gone for too long.
585
649
      </para>
586
650
      <para>
587
 
        If a client is compromised, its downtime should be duly noted
588
 
        by the server which would therefore disable the client.  But
589
 
        if the server was ever restarted, it would re-read its client
590
 
        list from its configuration file and again regard all clients
591
 
        therein as enabled, and hence eligible to receive their
592
 
        passwords.  Therefore, be careful when restarting servers if
593
 
        it is suspected that a client has, in fact, been compromised
594
 
        by parties who may now be running a fake Mandos client with
595
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
596
 
        image of the client host.  What should be done in that case
597
 
        (if restarting the server program really is necessary) is to
598
 
        stop the server program, edit the configuration file to omit
599
 
        any suspect clients, and restart the server program.
600
 
      </para>
601
 
      <para>
602
651
        For more details on client-side security, see
603
652
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
604
653
        <manvolnum>8mandos</manvolnum></citerefentry>.
609
658
  <refsect1 id="see_also">
610
659
    <title>SEE ALSO</title>
611
660
    <para>
612
 
      <citerefentry>
613
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
614
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
 
        <refentrytitle>mandos.conf</refentrytitle>
616
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
618
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
 
      </citerefentry>
 
661
      <citerefentry><refentrytitle>intro</refentrytitle>
 
662
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
663
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
664
      <manvolnum>5</manvolnum></citerefentry>,
 
665
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
666
      <manvolnum>5</manvolnum></citerefentry>,
 
667
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
668
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
669
      <citerefentry><refentrytitle>sh</refentrytitle>
 
670
      <manvolnum>1</manvolnum></citerefentry>
621
671
    </para>
622
672
    <variablelist>
623
673
      <varlistentry>