/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-13 16:57:10 UTC
  • mfrom: (624 trunk)
  • mto: This revision was merged to the branch mainline in revision 625.
  • Revision ID: teddy@recompile.se-20131013165710-y695wckw4jmujvma
Merge from trunk.

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 "2012-06-17">
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>
37
39
      <holder>Teddy Hogeborn</holder>
38
40
      <holder>Björn Påhlsson</holder>
39
41
    </copyright>
87
89
      <sbr/>
88
90
      <arg><option>--debug</option></arg>
89
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
90
95
      <arg><option>--no-dbus</option></arg>
91
96
      <sbr/>
92
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--socket
 
105
      <replaceable>FD</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--foreground</option></arg>
93
108
    </cmdsynopsis>
94
109
    <cmdsynopsis>
95
110
      <command>&COMMANDNAME;</command>
113
128
    <para>
114
129
      <command>&COMMANDNAME;</command> is a server daemon which
115
130
      handles incoming request for passwords for a pre-defined list of
116
 
      client host computers.  The Mandos server uses Zeroconf to
117
 
      announce itself on the local network, and uses TLS to
118
 
      communicate securely with and to authenticate the clients.  The
119
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
120
 
      link-local addresses, since the clients will probably not have
121
 
      any other addresses configured (see <xref linkend="overview"/>).
122
 
      Any authenticated client is then given the stored pre-encrypted
123
 
      password for that specific client.
 
131
      client host computers. For an introduction, see
 
132
      <citerefentry><refentrytitle>intro</refentrytitle>
 
133
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
134
      uses Zeroconf to announce itself on the local network, and uses
 
135
      TLS to communicate securely with and to authenticate the
 
136
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
137
      use IPv6 link-local addresses, since the clients will probably
 
138
      not have any other addresses configured (see <xref
 
139
      linkend="overview"/>).  Any authenticated client is then given
 
140
      the stored pre-encrypted password for that specific client.
124
141
    </para>
125
142
  </refsect1>
126
143
  
195
212
      </varlistentry>
196
213
      
197
214
      <varlistentry>
 
215
        <term><option>--debuglevel
 
216
        <replaceable>LEVEL</replaceable></option></term>
 
217
        <listitem>
 
218
          <para>
 
219
            Set the debugging log level.
 
220
            <replaceable>LEVEL</replaceable> is a string, one of
 
221
            <quote><literal>CRITICAL</literal></quote>,
 
222
            <quote><literal>ERROR</literal></quote>,
 
223
            <quote><literal>WARNING</literal></quote>,
 
224
            <quote><literal>INFO</literal></quote>, or
 
225
            <quote><literal>DEBUG</literal></quote>, in order of
 
226
            increasing verbosity.  The default level is
 
227
            <quote><literal>WARNING</literal></quote>.
 
228
          </para>
 
229
        </listitem>
 
230
      </varlistentry>
 
231
      
 
232
      <varlistentry>
198
233
        <term><option>--priority <replaceable>
199
234
        PRIORITY</replaceable></option></term>
200
235
        <listitem>
251
286
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
252
287
        </listitem>
253
288
      </varlistentry>
 
289
      
 
290
      <varlistentry>
 
291
        <term><option>--no-restore</option></term>
 
292
        <listitem>
 
293
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
294
          <para>
 
295
            See also <xref linkend="persistent_state"/>.
 
296
          </para>
 
297
        </listitem>
 
298
      </varlistentry>
 
299
      
 
300
      <varlistentry>
 
301
        <term><option>--statedir
 
302
        <replaceable>DIRECTORY</replaceable></option></term>
 
303
        <listitem>
 
304
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
305
        </listitem>
 
306
      </varlistentry>
 
307
      
 
308
      <varlistentry>
 
309
        <term><option>--socket
 
310
        <replaceable>FD</replaceable></option></term>
 
311
        <listitem>
 
312
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
313
        </listitem>
 
314
      </varlistentry>
 
315
      
 
316
      <varlistentry>
 
317
        <term><option>--foreground</option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml"
 
320
                      xpointer="foreground"/>
 
321
        </listitem>
 
322
      </varlistentry>
 
323
      
254
324
    </variablelist>
255
325
  </refsect1>
256
326
  
330
400
      for some time, the client is assumed to be compromised and is no
331
401
      longer eligible to receive the encrypted password.  (Manual
332
402
      intervention is required to re-enable a client.)  The timeout,
333
 
      checker program, and interval between checks can be configured
334
 
      both globally and per client; see <citerefentry>
335
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
336
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
337
 
      receiving its password will also be treated as a successful
338
 
      checker run.
 
403
      extended timeout, checker program, and interval between checks
 
404
      can be configured both globally and per client; see
 
405
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
406
      <manvolnum>5</manvolnum></citerefentry>.
339
407
    </para>
340
408
  </refsect1>
341
409
  
363
431
    <title>LOGGING</title>
364
432
    <para>
365
433
      The server will send log message with various severity levels to
366
 
      <filename>/dev/log</filename>.  With the
 
434
      <filename class="devicefile">/dev/log</filename>.  With the
367
435
      <option>--debug</option> option, it will log even more messages,
368
436
      and also show them on the console.
369
437
    </para>
370
438
  </refsect1>
371
439
  
 
440
  <refsect1 id="persistent_state">
 
441
    <title>PERSISTENT STATE</title>
 
442
    <para>
 
443
      Client settings, initially read from
 
444
      <filename>clients.conf</filename>, are persistent across
 
445
      restarts, and run-time changes will override settings in
 
446
      <filename>clients.conf</filename>.  However, if a setting is
 
447
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
448
      <filename>clients.conf</filename>, this will take precedence.
 
449
    </para>
 
450
  </refsect1>
 
451
  
372
452
  <refsect1 id="dbus_interface">
373
453
    <title>D-BUS INTERFACE</title>
374
454
    <para>
445
525
        </listitem>
446
526
      </varlistentry>
447
527
      <varlistentry>
 
528
        <term><filename class="devicefile">/dev/log</filename></term>
 
529
      </varlistentry>
 
530
      <varlistentry>
 
531
        <term><filename
 
532
        class="directory">/var/lib/mandos</filename></term>
 
533
        <listitem>
 
534
          <para>
 
535
            Directory where persistent state will be saved.  Change
 
536
            this with the <option>--statedir</option> option.  See
 
537
            also the <option>--no-restore</option> option.
 
538
          </para>
 
539
        </listitem>
 
540
      </varlistentry>
 
541
      <varlistentry>
448
542
        <term><filename>/dev/log</filename></term>
449
543
        <listitem>
450
544
          <para>
474
568
      backtrace.  This could be considered a feature.
475
569
    </para>
476
570
    <para>
477
 
      Currently, if a client is disabled due to having timed out, the
478
 
      server does not record this fact onto permanent storage.  This
479
 
      has some security implications, see <xref linkend="clients"/>.
480
 
    </para>
481
 
    <para>
482
571
      There is no fine-grained control over logging and debug output.
483
572
    </para>
484
573
    <para>
485
 
      Debug mode is conflated with running in the foreground.
486
 
    </para>
487
 
    <para>
488
 
      The console log messages do not show a time stamp.
489
 
    </para>
490
 
    <para>
491
574
      This server does not check the expire time of clients’ OpenPGP
492
575
      keys.
493
576
    </para>
506
589
    <informalexample>
507
590
      <para>
508
591
        Run the server in debug mode, read configuration files from
509
 
        the <filename>~/mandos</filename> directory, and use the
510
 
        Zeroconf service name <quote>Test</quote> to not collide with
511
 
        any other official Mandos server on this host:
 
592
        the <filename class="directory">~/mandos</filename> directory,
 
593
        and use the Zeroconf service name <quote>Test</quote> to not
 
594
        collide with any other official Mandos server on this host:
512
595
      </para>
513
596
      <para>
514
597
 
563
646
        compromised if they are gone for too long.
564
647
      </para>
565
648
      <para>
566
 
        If a client is compromised, its downtime should be duly noted
567
 
        by the server which would therefore disable the client.  But
568
 
        if the server was ever restarted, it would re-read its client
569
 
        list from its configuration file and again regard all clients
570
 
        therein as enabled, and hence eligible to receive their
571
 
        passwords.  Therefore, be careful when restarting servers if
572
 
        it is suspected that a client has, in fact, been compromised
573
 
        by parties who may now be running a fake Mandos client with
574
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
575
 
        image of the client host.  What should be done in that case
576
 
        (if restarting the server program really is necessary) is to
577
 
        stop the server program, edit the configuration file to omit
578
 
        any suspect clients, and restart the server program.
579
 
      </para>
580
 
      <para>
581
649
        For more details on client-side security, see
582
650
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
583
651
        <manvolnum>8mandos</manvolnum></citerefentry>.
588
656
  <refsect1 id="see_also">
589
657
    <title>SEE ALSO</title>
590
658
    <para>
591
 
      <citerefentry>
592
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
593
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
594
 
        <refentrytitle>mandos.conf</refentrytitle>
595
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
596
 
        <refentrytitle>mandos-client</refentrytitle>
597
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
598
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
599
 
      </citerefentry>
 
659
      <citerefentry><refentrytitle>intro</refentrytitle>
 
660
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
661
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
662
      <manvolnum>5</manvolnum></citerefentry>,
 
663
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
664
      <manvolnum>5</manvolnum></citerefentry>,
 
665
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
666
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
667
      <citerefentry><refentrytitle>sh</refentrytitle>
 
668
      <manvolnum>1</manvolnum></citerefentry>
600
669
    </para>
601
670
    <variablelist>
602
671
      <varlistentry>