/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: Björn Påhlsson
  • Date: 2012-07-03 20:55:09 UTC
  • Revision ID: belorn@recompile.se-20120703205509-fkeb6uqy4i6gt4b6
added note messages when mandos-monitor starts without running server,
or a server with no clients.

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 "2009-12-09">
 
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>
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>
 
106
      <sbr/>
 
107
      <arg><option>--foreground</option></arg>
92
108
    </cmdsynopsis>
93
109
    <cmdsynopsis>
94
110
      <command>&COMMANDNAME;</command>
112
128
    <para>
113
129
      <command>&COMMANDNAME;</command> is a server daemon which
114
130
      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.
 
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.
123
141
    </para>
124
142
  </refsect1>
125
143
  
194
212
      </varlistentry>
195
213
      
196
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>
197
233
        <term><option>--priority <replaceable>
198
234
        PRIORITY</replaceable></option></term>
199
235
        <listitem>
250
286
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
287
        </listitem>
252
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
      
253
324
    </variablelist>
254
325
  </refsect1>
255
326
  
329
400
      for some time, the client is assumed to be compromised and is no
330
401
      longer eligible to receive the encrypted password.  (Manual
331
402
      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>
 
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>.
 
407
    </para>
 
408
  </refsect1>
 
409
  
 
410
  <refsect1 id="approval">
 
411
    <title>APPROVAL</title>
 
412
    <para>
 
413
      The server can be configured to require manual approval for a
 
414
      client before it is sent its secret.  The delay to wait for such
 
415
      approval and the default action (approve or deny) can be
 
416
      configured both globally and per client; see <citerefentry>
334
417
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
336
 
      receiving its password will also be treated as a successful
337
 
      checker run.
338
 
    </para>
 
418
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
419
      will be approved immediately without delay.
 
420
    </para>
 
421
    <para>
 
422
      This can be used to deny a client its secret if not manually
 
423
      approved within a specified time.  It can also be used to make
 
424
      the server delay before giving a client its secret, allowing
 
425
      optional manual denying of this specific client.
 
426
    </para>
 
427
    
339
428
  </refsect1>
340
429
  
341
430
  <refsect1 id="logging">
342
431
    <title>LOGGING</title>
343
432
    <para>
344
433
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
434
      <filename class="devicefile">/dev/log</filename>.  With the
346
435
      <option>--debug</option> option, it will log even more messages,
347
436
      and also show them on the console.
348
437
    </para>
349
438
  </refsect1>
350
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
  
351
452
  <refsect1 id="dbus_interface">
352
453
    <title>D-BUS INTERFACE</title>
353
454
    <para>
354
455
      The server will by default provide a D-Bus system bus interface.
355
456
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.
357
 
      <!-- XXX -->
 
457
      Mandos-specific user, if such a user exists.  For documentation
 
458
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
459
    </para>
359
460
  </refsect1>
360
461
  
418
519
        <term><filename>/var/run/mandos.pid</filename></term>
419
520
        <listitem>
420
521
          <para>
421
 
            The file containing the process id of
422
 
            <command>&COMMANDNAME;</command>.
 
522
            The file containing the process id of the
 
523
            <command>&COMMANDNAME;</command> process started last.
 
524
          </para>
 
525
        </listitem>
 
526
      </varlistentry>
 
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.
423
538
          </para>
424
539
        </listitem>
425
540
      </varlistentry>
453
568
      backtrace.  This could be considered a feature.
454
569
    </para>
455
570
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
459
 
    </para>
460
 
    <para>
461
 
      There is currently no way of querying the server of the current
462
 
      status of clients, other than analyzing its <systemitem
463
 
      class="service">syslog</systemitem> output.
464
 
    </para>
465
 
    <para>
466
571
      There is no fine-grained control over logging and debug output.
467
572
    </para>
468
573
    <para>
469
 
      Debug mode is conflated with running in the foreground.
470
 
    </para>
471
 
    <para>
472
 
      The console log messages do not show a time stamp.
473
 
    </para>
474
 
    <para>
475
574
      This server does not check the expire time of clients’ OpenPGP
476
575
      keys.
477
576
    </para>
490
589
    <informalexample>
491
590
      <para>
492
591
        Run the server in debug mode, read configuration files from
493
 
        the <filename>~/mandos</filename> directory, and use the
494
 
        Zeroconf service name <quote>Test</quote> to not collide with
495
 
        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:
496
595
      </para>
497
596
      <para>
498
597
 
547
646
        compromised if they are gone for too long.
548
647
      </para>
549
648
      <para>
550
 
        If a client is compromised, its downtime should be duly noted
551
 
        by the server which would therefore disable the client.  But
552
 
        if the server was ever restarted, it would re-read its client
553
 
        list from its configuration file and again regard all clients
554
 
        therein as enabled, and hence eligible to receive their
555
 
        passwords.  Therefore, be careful when restarting servers if
556
 
        it is suspected that a client has, in fact, been compromised
557
 
        by parties who may now be running a fake Mandos client with
558
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
559
 
        image of the client host.  What should be done in that case
560
 
        (if restarting the server program really is necessary) is to
561
 
        stop the server program, edit the configuration file to omit
562
 
        any suspect clients, and restart the server program.
563
 
      </para>
564
 
      <para>
565
649
        For more details on client-side security, see
566
650
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
567
651
        <manvolnum>8mandos</manvolnum></citerefentry>.
572
656
  <refsect1 id="see_also">
573
657
    <title>SEE ALSO</title>
574
658
    <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>
 
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>
584
669
    </para>
585
670
    <variablelist>
586
671
      <varlistentry>