/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: 2009-01-18 00:18:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090118001850-pvg8xjwmbyt23fom
* debian/rules (install-indep): Removed "--no-start" from
                                dh_installinit.

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 "2011-10-22">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.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
36
      <holder>Teddy Hogeborn</holder>
39
37
      <holder>Björn Påhlsson</holder>
40
38
    </copyright>
88
86
      <sbr/>
89
87
      <arg><option>--debug</option></arg>
90
88
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
89
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
90
    </cmdsynopsis>
100
91
    <cmdsynopsis>
101
92
      <command>&COMMANDNAME;</command>
119
110
    <para>
120
111
      <command>&COMMANDNAME;</command> is a server daemon which
121
112
      handles incoming request for passwords for a pre-defined list of
122
 
      client host computers. For an introduction, see
123
 
      <citerefentry><refentrytitle>intro</refentrytitle>
124
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
 
      uses Zeroconf to announce itself on the local network, and uses
126
 
      TLS to communicate securely with and to authenticate the
127
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
128
 
      use IPv6 link-local addresses, since the clients will probably
129
 
      not have any other addresses configured (see <xref
130
 
      linkend="overview"/>).  Any authenticated client is then given
131
 
      the stored pre-encrypted password for that specific client.
 
113
      client host computers.  The Mandos server uses Zeroconf to
 
114
      announce itself on the local network, and uses TLS to
 
115
      communicate securely with and to authenticate the clients.  The
 
116
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
117
      link-local addresses, since the clients will probably not have
 
118
      any other addresses configured (see <xref linkend="overview"/>).
 
119
      Any authenticated client is then given the stored pre-encrypted
 
120
      password for that specific client.
132
121
    </para>
133
122
  </refsect1>
134
123
  
203
192
      </varlistentry>
204
193
      
205
194
      <varlistentry>
206
 
        <term><option>--debuglevel
207
 
        <replaceable>LEVEL</replaceable></option></term>
208
 
        <listitem>
209
 
          <para>
210
 
            Set the debugging log level.
211
 
            <replaceable>LEVEL</replaceable> is a string, one of
212
 
            <quote><literal>CRITICAL</literal></quote>,
213
 
            <quote><literal>ERROR</literal></quote>,
214
 
            <quote><literal>WARNING</literal></quote>,
215
 
            <quote><literal>INFO</literal></quote>, or
216
 
            <quote><literal>DEBUG</literal></quote>, in order of
217
 
            increasing verbosity.  The default level is
218
 
            <quote><literal>WARNING</literal></quote>.
219
 
          </para>
220
 
        </listitem>
221
 
      </varlistentry>
222
 
      
223
 
      <varlistentry>
224
195
        <term><option>--priority <replaceable>
225
196
        PRIORITY</replaceable></option></term>
226
197
        <listitem>
270
241
          </para>
271
242
        </listitem>
272
243
      </varlistentry>
273
 
      
274
 
      <varlistentry>
275
 
        <term><option>--no-ipv6</option></term>
276
 
        <listitem>
277
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-restore</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
285
 
        </listitem>
286
 
      </varlistentry>
287
244
    </variablelist>
288
245
  </refsect1>
289
246
  
361
318
      The server will, by default, continually check that the clients
362
319
      are still up.  If a client has not been confirmed as being up
363
320
      for some time, the client is assumed to be compromised and is no
364
 
      longer eligible to receive the encrypted password.  (Manual
365
 
      intervention is required to re-enable a client.)  The timeout,
366
 
      extended timeout, checker program, and interval between checks
367
 
      can be configured both globally and per client; see
368
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
370
 
      receiving its password will also be treated as a successful
371
 
      checker run.
372
 
    </para>
373
 
  </refsect1>
374
 
  
375
 
  <refsect1 id="approval">
376
 
    <title>APPROVAL</title>
377
 
    <para>
378
 
      The server can be configured to require manual approval for a
379
 
      client before it is sent its secret.  The delay to wait for such
380
 
      approval and the default action (approve or deny) can be
381
 
      configured both globally and per client; see <citerefentry>
 
321
      longer eligible to receive the encrypted password.  The timeout,
 
322
      checker program, and interval between checks can be configured
 
323
      both globally and per client; see <citerefentry>
382
324
      <refentrytitle>mandos-clients.conf</refentrytitle>
383
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
384
 
      will be approved immediately without delay.
385
 
    </para>
386
 
    <para>
387
 
      This can be used to deny a client its secret if not manually
388
 
      approved within a specified time.  It can also be used to make
389
 
      the server delay before giving a client its secret, allowing
390
 
      optional manual denying of this specific client.
391
 
    </para>
392
 
    
 
325
      <manvolnum>5</manvolnum></citerefentry>.
 
326
    </para>
393
327
  </refsect1>
394
328
  
395
329
  <refsect1 id="logging">
396
330
    <title>LOGGING</title>
397
331
    <para>
398
332
      The server will send log message with various severity levels to
399
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
333
      <filename>/dev/log</filename>.  With the
400
334
      <option>--debug</option> option, it will log even more messages,
401
335
      and also show them on the console.
402
336
    </para>
407
341
    <para>
408
342
      The server will by default provide a D-Bus system bus interface.
409
343
      This interface will only be accessible by the root user or a
410
 
      Mandos-specific user, if such a user exists.  For documentation
411
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
412
346
    </para>
413
347
  </refsect1>
414
 
  
 
348
 
415
349
  <refsect1 id="exit_status">
416
350
    <title>EXIT STATUS</title>
417
351
    <para>
472
406
        <term><filename>/var/run/mandos.pid</filename></term>
473
407
        <listitem>
474
408
          <para>
475
 
            The file containing the process id of the
476
 
            <command>&COMMANDNAME;</command> process started last.
 
409
            The file containing the process id of
 
410
            <command>&COMMANDNAME;</command>.
477
411
          </para>
478
412
        </listitem>
479
413
      </varlistentry>
480
414
      <varlistentry>
481
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
415
        <term><filename>/dev/log</filename></term>
482
416
        <listitem>
483
417
          <para>
484
418
            The Unix domain socket to where local syslog messages are
507
441
      backtrace.  This could be considered a feature.
508
442
    </para>
509
443
    <para>
510
 
      Currently, if a client is disabled due to having timed out, the
511
 
      server does not record this fact onto permanent storage.  This
512
 
      has some security implications, see <xref linkend="clients"/>.
 
444
      Currently, if a client is declared <quote>invalid</quote> due to
 
445
      having timed out, the server does not record this fact onto
 
446
      permanent storage.  This has some security implications, see
 
447
      <xref linkend="clients"/>.
 
448
    </para>
 
449
    <para>
 
450
      There is currently no way of querying the server of the current
 
451
      status of clients, other than analyzing its <systemitem
 
452
      class="service">syslog</systemitem> output.
513
453
    </para>
514
454
    <para>
515
455
      There is no fine-grained control over logging and debug output.
518
458
      Debug mode is conflated with running in the foreground.
519
459
    </para>
520
460
    <para>
 
461
      The console log messages does not show a time stamp.
 
462
    </para>
 
463
    <para>
521
464
      This server does not check the expire time of clients’ OpenPGP
522
465
      keys.
523
466
    </para>
594
537
      </para>
595
538
      <para>
596
539
        If a client is compromised, its downtime should be duly noted
597
 
        by the server which would therefore disable the client.  But
598
 
        if the server was ever restarted, it would re-read its client
599
 
        list from its configuration file and again regard all clients
600
 
        therein as enabled, and hence eligible to receive their
601
 
        passwords.  Therefore, be careful when restarting servers if
602
 
        it is suspected that a client has, in fact, been compromised
603
 
        by parties who may now be running a fake Mandos client with
604
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
605
 
        image of the client host.  What should be done in that case
606
 
        (if restarting the server program really is necessary) is to
607
 
        stop the server program, edit the configuration file to omit
608
 
        any suspect clients, and restart the server program.
 
540
        by the server which would therefore declare the client
 
541
        invalid.  But if the server was ever restarted, it would
 
542
        re-read its client list from its configuration file and again
 
543
        regard all clients therein as valid, and hence eligible to
 
544
        receive their passwords.  Therefore, be careful when
 
545
        restarting servers if it is suspected that a client has, in
 
546
        fact, been compromised by parties who may now be running a
 
547
        fake Mandos client with the keys from the non-encrypted
 
548
        initial <acronym>RAM</acronym> image of the client host.  What
 
549
        should be done in that case (if restarting the server program
 
550
        really is necessary) is to stop the server program, edit the
 
551
        configuration file to omit any suspect clients, and restart
 
552
        the server program.
609
553
      </para>
610
554
      <para>
611
555
        For more details on client-side security, see
618
562
  <refsect1 id="see_also">
619
563
    <title>SEE ALSO</title>
620
564
    <para>
621
 
      <citerefentry><refentrytitle>intro</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
 
      <manvolnum>5</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
628
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>sh</refentrytitle>
630
 
      <manvolnum>1</manvolnum></citerefentry>
 
565
      <citerefentry>
 
566
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
567
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
568
        <refentrytitle>mandos.conf</refentrytitle>
 
569
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
570
        <refentrytitle>mandos-client</refentrytitle>
 
571
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
572
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
573
      </citerefentry>
631
574
    </para>
632
575
    <variablelist>
633
576
      <varlistentry>