/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: 2013-10-20 23:27:38 UTC
  • Revision ID: teddy@recompile.se-20131020232738-5gjw6auqqxnp4v7t
* mandos (PGPEngine.password_encode): Bug fix: GnuPG can't handle
                                      really long passphrases - encode
                                      those differently.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2013-10-20">
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>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
94
96
      <arg><option>--no-dbus</option></arg>
95
97
      <sbr/>
96
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>
97
109
    </cmdsynopsis>
98
110
    <cmdsynopsis>
99
111
      <command>&COMMANDNAME;</command>
117
129
    <para>
118
130
      <command>&COMMANDNAME;</command> is a server daemon which
119
131
      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.
 
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.
128
142
    </para>
129
143
  </refsect1>
130
144
  
273
287
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
288
        </listitem>
275
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-restore</option></term>
 
293
        <listitem>
 
294
          <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
      
276
325
    </variablelist>
277
326
  </refsect1>
278
327
  
352
401
      for some time, the client is assumed to be compromised and is no
353
402
      longer eligible to receive the encrypted password.  (Manual
354
403
      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>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
 
404
      extended timeout, checker program, and interval between checks
 
405
      can be configured both globally and per client; see
 
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
407
      <manvolnum>5</manvolnum></citerefentry>.
361
408
    </para>
362
409
  </refsect1>
363
410
  
385
432
    <title>LOGGING</title>
386
433
    <para>
387
434
      The server will send log message with various severity levels to
388
 
      <filename>/dev/log</filename>.  With the
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
389
436
      <option>--debug</option> option, it will log even more messages,
390
437
      and also show them on the console.
391
438
    </para>
392
439
  </refsect1>
393
440
  
 
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
  
394
453
  <refsect1 id="dbus_interface">
395
454
    <title>D-BUS INTERFACE</title>
396
455
    <para>
458
517
        </listitem>
459
518
      </varlistentry>
460
519
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
520
        <term><filename>/run/mandos.pid</filename></term>
462
521
        <listitem>
463
522
          <para>
464
523
            The file containing the process id of the
467
526
        </listitem>
468
527
      </varlistentry>
469
528
      <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>
470
543
        <term><filename>/dev/log</filename></term>
471
544
        <listitem>
472
545
          <para>
496
569
      backtrace.  This could be considered a feature.
497
570
    </para>
498
571
    <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
572
      There is no fine-grained control over logging and debug output.
505
573
    </para>
506
574
    <para>
507
 
      Debug mode is conflated with running in the foreground.
508
 
    </para>
509
 
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
575
      This server does not check the expire time of clients’ OpenPGP
514
576
      keys.
515
577
    </para>
528
590
    <informalexample>
529
591
      <para>
530
592
        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:
 
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:
534
596
      </para>
535
597
      <para>
536
598
 
585
647
        compromised if they are gone for too long.
586
648
      </para>
587
649
      <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
650
        For more details on client-side security, see
604
651
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
605
652
        <manvolnum>8mandos</manvolnum></citerefentry>.
610
657
  <refsect1 id="see_also">
611
658
    <title>SEE ALSO</title>
612
659
    <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>
 
660
      <citerefentry><refentrytitle>intro</refentrytitle>
 
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
663
      <manvolnum>5</manvolnum></citerefentry>,
 
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
665
      <manvolnum>5</manvolnum></citerefentry>,
 
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
668
      <citerefentry><refentrytitle>sh</refentrytitle>
 
669
      <manvolnum>1</manvolnum></citerefentry>
622
670
    </para>
623
671
    <variablelist>
624
672
      <varlistentry>