/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: 2012-06-06 14:12:50 UTC
  • Revision ID: teddy@recompile.se-20120606141250-5zxn3syowzb4t437
* Makefile (DOCBOOKTOMAN): Don't show errors from "locale".

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 "2009-09-10">
 
5
<!ENTITY TIMESTAMP "2012-05-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>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
36
39
      <holder>Teddy Hogeborn</holder>
37
40
      <holder>Björn Påhlsson</holder>
38
41
    </copyright>
86
89
      <sbr/>
87
90
      <arg><option>--debug</option></arg>
88
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
89
95
      <arg><option>--no-dbus</option></arg>
90
96
      <sbr/>
91
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>
92
106
    </cmdsynopsis>
93
107
    <cmdsynopsis>
94
108
      <command>&COMMANDNAME;</command>
112
126
    <para>
113
127
      <command>&COMMANDNAME;</command> is a server daemon which
114
128
      handles incoming request for passwords for a pre-defined list of
115
 
      client host computers.  The Mandos server uses Zeroconf to
116
 
      announce itself on the local network, and uses TLS to
117
 
      communicate securely with and to authenticate the clients.  The
118
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
 
      link-local addresses, since the clients will probably not have
120
 
      any other addresses configured (see <xref linkend="overview"/>).
121
 
      Any authenticated client is then given the stored pre-encrypted
122
 
      password for that specific client.
 
129
      client host computers. For an introduction, see
 
130
      <citerefentry><refentrytitle>intro</refentrytitle>
 
131
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
132
      uses Zeroconf to announce itself on the local network, and uses
 
133
      TLS to communicate securely with and to authenticate the
 
134
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
135
      use IPv6 link-local addresses, since the clients will probably
 
136
      not have any other addresses configured (see <xref
 
137
      linkend="overview"/>).  Any authenticated client is then given
 
138
      the stored pre-encrypted password for that specific client.
123
139
    </para>
124
140
  </refsect1>
125
141
  
194
210
      </varlistentry>
195
211
      
196
212
      <varlistentry>
 
213
        <term><option>--debuglevel
 
214
        <replaceable>LEVEL</replaceable></option></term>
 
215
        <listitem>
 
216
          <para>
 
217
            Set the debugging log level.
 
218
            <replaceable>LEVEL</replaceable> is a string, one of
 
219
            <quote><literal>CRITICAL</literal></quote>,
 
220
            <quote><literal>ERROR</literal></quote>,
 
221
            <quote><literal>WARNING</literal></quote>,
 
222
            <quote><literal>INFO</literal></quote>, or
 
223
            <quote><literal>DEBUG</literal></quote>, in order of
 
224
            increasing verbosity.  The default level is
 
225
            <quote><literal>WARNING</literal></quote>.
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
      
 
230
      <varlistentry>
197
231
        <term><option>--priority <replaceable>
198
232
        PRIORITY</replaceable></option></term>
199
233
        <listitem>
250
284
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
285
        </listitem>
252
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
 
289
        <term><option>--no-restore</option></term>
 
290
        <listitem>
 
291
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
292
          <para>
 
293
            See also <xref linkend="persistent_state"/>.
 
294
          </para>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>--statedir
 
300
        <replaceable>DIRECTORY</replaceable></option></term>
 
301
        <listitem>
 
302
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
303
        </listitem>
 
304
      </varlistentry>
 
305
      
 
306
      <varlistentry>
 
307
        <term><option>--socket
 
308
        <replaceable>FD</replaceable></option></term>
 
309
        <listitem>
 
310
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
253
314
    </variablelist>
254
315
  </refsect1>
255
316
  
329
390
      for some time, the client is assumed to be compromised and is no
330
391
      longer eligible to receive the encrypted password.  (Manual
331
392
      intervention is required to re-enable a client.)  The timeout,
332
 
      checker program, and interval between checks can be configured
333
 
      both globally and per client; see <citerefentry>
 
393
      extended timeout, checker program, and interval between checks
 
394
      can be configured both globally and per client; see
 
395
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
396
      <manvolnum>5</manvolnum></citerefentry>.
 
397
    </para>
 
398
  </refsect1>
 
399
  
 
400
  <refsect1 id="approval">
 
401
    <title>APPROVAL</title>
 
402
    <para>
 
403
      The server can be configured to require manual approval for a
 
404
      client before it is sent its secret.  The delay to wait for such
 
405
      approval and the default action (approve or deny) can be
 
406
      configured both globally and per client; see <citerefentry>
334
407
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.
336
 
    </para>
 
408
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
409
      will be approved immediately without delay.
 
410
    </para>
 
411
    <para>
 
412
      This can be used to deny a client its secret if not manually
 
413
      approved within a specified time.  It can also be used to make
 
414
      the server delay before giving a client its secret, allowing
 
415
      optional manual denying of this specific client.
 
416
    </para>
 
417
    
337
418
  </refsect1>
338
419
  
339
420
  <refsect1 id="logging">
340
421
    <title>LOGGING</title>
341
422
    <para>
342
423
      The server will send log message with various severity levels to
343
 
      <filename>/dev/log</filename>.  With the
 
424
      <filename class="devicefile">/dev/log</filename>.  With the
344
425
      <option>--debug</option> option, it will log even more messages,
345
426
      and also show them on the console.
346
427
    </para>
347
428
  </refsect1>
348
429
  
 
430
  <refsect1 id="persistent_state">
 
431
    <title>PERSISTENT STATE</title>
 
432
    <para>
 
433
      Client settings, initially read from
 
434
      <filename>clients.conf</filename>, are persistent across
 
435
      restarts, and run-time changes will override settings in
 
436
      <filename>clients.conf</filename>.  However, if a setting is
 
437
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
438
      <filename>clients.conf</filename>, this will take precedence.
 
439
    </para>
 
440
  </refsect1>
 
441
  
349
442
  <refsect1 id="dbus_interface">
350
443
    <title>D-BUS INTERFACE</title>
351
444
    <para>
352
445
      The server will by default provide a D-Bus system bus interface.
353
446
      This interface will only be accessible by the root user or a
354
 
      Mandos-specific user, if such a user exists.
355
 
      <!-- XXX -->
 
447
      Mandos-specific user, if such a user exists.  For documentation
 
448
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
356
449
    </para>
357
450
  </refsect1>
358
451
  
416
509
        <term><filename>/var/run/mandos.pid</filename></term>
417
510
        <listitem>
418
511
          <para>
419
 
            The file containing the process id of
420
 
            <command>&COMMANDNAME;</command>.
 
512
            The file containing the process id of the
 
513
            <command>&COMMANDNAME;</command> process started last.
 
514
          </para>
 
515
        </listitem>
 
516
      </varlistentry>
 
517
      <varlistentry>
 
518
        <term><filename class="devicefile">/dev/log</filename></term>
 
519
      </varlistentry>
 
520
      <varlistentry>
 
521
        <term><filename
 
522
        class="directory">/var/lib/mandos</filename></term>
 
523
        <listitem>
 
524
          <para>
 
525
            Directory where persistent state will be saved.  Change
 
526
            this with the <option>--statedir</option> option.  See
 
527
            also the <option>--no-restore</option> option.
421
528
          </para>
422
529
        </listitem>
423
530
      </varlistentry>
451
558
      backtrace.  This could be considered a feature.
452
559
    </para>
453
560
    <para>
454
 
      Currently, if a client is declared <quote>invalid</quote> due to
455
 
      having timed out, the server does not record this fact onto
456
 
      permanent storage.  This has some security implications, see
457
 
      <xref linkend="clients"/>.
458
 
    </para>
459
 
    <para>
460
 
      There is currently no way of querying the server of the current
461
 
      status of clients, other than analyzing its <systemitem
462
 
      class="service">syslog</systemitem> output.
463
 
    </para>
464
 
    <para>
465
561
      There is no fine-grained control over logging and debug output.
466
562
    </para>
467
563
    <para>
468
564
      Debug mode is conflated with running in the foreground.
469
565
    </para>
470
566
    <para>
471
 
      The console log messages do not show a time stamp.
472
 
    </para>
473
 
    <para>
474
567
      This server does not check the expire time of clients’ OpenPGP
475
568
      keys.
476
569
    </para>
489
582
    <informalexample>
490
583
      <para>
491
584
        Run the server in debug mode, read configuration files from
492
 
        the <filename>~/mandos</filename> directory, and use the
493
 
        Zeroconf service name <quote>Test</quote> to not collide with
494
 
        any other official Mandos server on this host:
 
585
        the <filename class="directory">~/mandos</filename> directory,
 
586
        and use the Zeroconf service name <quote>Test</quote> to not
 
587
        collide with any other official Mandos server on this host:
495
588
      </para>
496
589
      <para>
497
590
 
546
639
        compromised if they are gone for too long.
547
640
      </para>
548
641
      <para>
549
 
        If a client is compromised, its downtime should be duly noted
550
 
        by the server which would therefore declare the client
551
 
        invalid.  But if the server was ever restarted, it would
552
 
        re-read its client list from its configuration file and again
553
 
        regard all clients therein as valid, and hence eligible to
554
 
        receive their passwords.  Therefore, be careful when
555
 
        restarting servers if it is suspected that a client has, in
556
 
        fact, been compromised by parties who may now be running a
557
 
        fake Mandos client with the keys from the non-encrypted
558
 
        initial <acronym>RAM</acronym> image of the client host.  What
559
 
        should be done in that case (if restarting the server program
560
 
        really is necessary) is to stop the server program, edit the
561
 
        configuration file to omit any suspect clients, and restart
562
 
        the server program.
563
 
      </para>
564
 
      <para>
565
642
        For more details on client-side security, see
566
643
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
567
644
        <manvolnum>8mandos</manvolnum></citerefentry>.
572
649
  <refsect1 id="see_also">
573
650
    <title>SEE ALSO</title>
574
651
    <para>
575
 
      <citerefentry>
576
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
577
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
 
        <refentrytitle>mandos.conf</refentrytitle>
579
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
 
        <refentrytitle>mandos-client</refentrytitle>
581
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
 
      </citerefentry>
 
652
      <citerefentry><refentrytitle>intro</refentrytitle>
 
653
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
654
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
655
      <manvolnum>5</manvolnum></citerefentry>,
 
656
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
657
      <manvolnum>5</manvolnum></citerefentry>,
 
658
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
659
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
660
      <citerefentry><refentrytitle>sh</refentrytitle>
 
661
      <manvolnum>1</manvolnum></citerefentry>
584
662
    </para>
585
663
    <variablelist>
586
664
      <varlistentry>