/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

Tags: version-1.0.14-1
* Makefile (version): Changed to "1.0.14".
* NEWS (Version 1.0.14): New entry.
* debian/changelog (1.0.14-1): - '' -

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-03">
 
5
<!ENTITY TIMESTAMP "2009-09-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@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
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
89
      <arg><option>--no-ipv6</option></arg>
97
90
    </cmdsynopsis>
98
91
    <cmdsynopsis>
117
110
    <para>
118
111
      <command>&COMMANDNAME;</command> is a server daemon which
119
112
      handles incoming request for passwords for a pre-defined list of
120
 
      client host computers. For an introduction, see
121
 
      <citerefentry><refentrytitle>intro</refentrytitle>
122
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
123
 
      uses Zeroconf to announce itself on the local network, and uses
124
 
      TLS to communicate securely with and to authenticate the
125
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
126
 
      use IPv6 link-local addresses, since the clients will probably
127
 
      not have any other addresses configured (see <xref
128
 
      linkend="overview"/>).  Any authenticated client is then given
129
 
      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.
130
121
    </para>
131
122
  </refsect1>
132
123
  
201
192
      </varlistentry>
202
193
      
203
194
      <varlistentry>
204
 
        <term><option>--debuglevel
205
 
        <replaceable>LEVEL</replaceable></option></term>
206
 
        <listitem>
207
 
          <para>
208
 
            Set the debugging log level.
209
 
            <replaceable>LEVEL</replaceable> is a string, one of
210
 
            <quote><literal>CRITICAL</literal></quote>,
211
 
            <quote><literal>ERROR</literal></quote>,
212
 
            <quote><literal>WARNING</literal></quote>,
213
 
            <quote><literal>INFO</literal></quote>, or
214
 
            <quote><literal>DEBUG</literal></quote>, in order of
215
 
            increasing verbosity.  The default level is
216
 
            <quote><literal>WARNING</literal></quote>.
217
 
          </para>
218
 
        </listitem>
219
 
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
195
        <term><option>--priority <replaceable>
223
196
        PRIORITY</replaceable></option></term>
224
197
        <listitem>
260
233
      </varlistentry>
261
234
      
262
235
      <varlistentry>
263
 
        <term><option>--no-dbus</option></term>
264
 
        <listitem>
265
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
266
 
          <para>
267
 
            See also <xref linkend="dbus_interface"/>.
268
 
          </para>
269
 
        </listitem>
270
 
      </varlistentry>
271
 
      
272
 
      <varlistentry>
273
236
        <term><option>--no-ipv6</option></term>
274
237
        <listitem>
275
238
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
354
317
      for some time, the client is assumed to be compromised and is no
355
318
      longer eligible to receive the encrypted password.  (Manual
356
319
      intervention is required to re-enable a client.)  The timeout,
357
 
      extended timeout, checker program, and interval between checks
358
 
      can be configured both globally and per client; see
359
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
320
      checker program, and interval between checks can be configured
 
321
      both globally and per client; see <citerefentry>
 
322
      <refentrytitle>mandos-clients.conf</refentrytitle>
360
323
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
361
324
      receiving its password will also be treated as a successful
362
325
      checker run.
363
326
    </para>
364
327
  </refsect1>
365
328
  
366
 
  <refsect1 id="approval">
367
 
    <title>APPROVAL</title>
368
 
    <para>
369
 
      The server can be configured to require manual approval for a
370
 
      client before it is sent its secret.  The delay to wait for such
371
 
      approval and the default action (approve or deny) can be
372
 
      configured both globally and per client; see <citerefentry>
373
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
374
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
375
 
      will be approved immediately without delay.
376
 
    </para>
377
 
    <para>
378
 
      This can be used to deny a client its secret if not manually
379
 
      approved within a specified time.  It can also be used to make
380
 
      the server delay before giving a client its secret, allowing
381
 
      optional manual denying of this specific client.
382
 
    </para>
383
 
    
384
 
  </refsect1>
385
 
  
386
329
  <refsect1 id="logging">
387
330
    <title>LOGGING</title>
388
331
    <para>
393
336
    </para>
394
337
  </refsect1>
395
338
  
396
 
  <refsect1 id="dbus_interface">
397
 
    <title>D-BUS INTERFACE</title>
398
 
    <para>
399
 
      The server will by default provide a D-Bus system bus interface.
400
 
      This interface will only be accessible by the root user or a
401
 
      Mandos-specific user, if such a user exists.  For documentation
402
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
403
 
    </para>
404
 
  </refsect1>
405
 
  
406
339
  <refsect1 id="exit_status">
407
340
    <title>EXIT STATUS</title>
408
341
    <para>
463
396
        <term><filename>/var/run/mandos.pid</filename></term>
464
397
        <listitem>
465
398
          <para>
466
 
            The file containing the process id of the
467
 
            <command>&COMMANDNAME;</command> process started last.
 
399
            The file containing the process id of
 
400
            <command>&COMMANDNAME;</command>.
468
401
          </para>
469
402
        </listitem>
470
403
      </varlistentry>
498
431
      backtrace.  This could be considered a feature.
499
432
    </para>
500
433
    <para>
501
 
      Currently, if a client is disabled due to having timed out, the
502
 
      server does not record this fact onto permanent storage.  This
503
 
      has some security implications, see <xref linkend="clients"/>.
 
434
      Currently, if a client is declared <quote>invalid</quote> due to
 
435
      having timed out, the server does not record this fact onto
 
436
      permanent storage.  This has some security implications, see
 
437
      <xref linkend="clients"/>.
 
438
    </para>
 
439
    <para>
 
440
      There is currently no way of querying the server of the current
 
441
      status of clients, other than analyzing its <systemitem
 
442
      class="service">syslog</systemitem> output.
504
443
    </para>
505
444
    <para>
506
445
      There is no fine-grained control over logging and debug output.
588
527
      </para>
589
528
      <para>
590
529
        If a client is compromised, its downtime should be duly noted
591
 
        by the server which would therefore disable the client.  But
592
 
        if the server was ever restarted, it would re-read its client
593
 
        list from its configuration file and again regard all clients
594
 
        therein as enabled, and hence eligible to receive their
595
 
        passwords.  Therefore, be careful when restarting servers if
596
 
        it is suspected that a client has, in fact, been compromised
597
 
        by parties who may now be running a fake Mandos client with
598
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
599
 
        image of the client host.  What should be done in that case
600
 
        (if restarting the server program really is necessary) is to
601
 
        stop the server program, edit the configuration file to omit
602
 
        any suspect clients, and restart the server program.
 
530
        by the server which would therefore declare the client
 
531
        invalid.  But if the server was ever restarted, it would
 
532
        re-read its client list from its configuration file and again
 
533
        regard all clients therein as valid, and hence eligible to
 
534
        receive their passwords.  Therefore, be careful when
 
535
        restarting servers if it is suspected that a client has, in
 
536
        fact, been compromised by parties who may now be running a
 
537
        fake Mandos client with the keys from the non-encrypted
 
538
        initial <acronym>RAM</acronym> image of the client host.  What
 
539
        should be done in that case (if restarting the server program
 
540
        really is necessary) is to stop the server program, edit the
 
541
        configuration file to omit any suspect clients, and restart
 
542
        the server program.
603
543
      </para>
604
544
      <para>
605
545
        For more details on client-side security, see
612
552
  <refsect1 id="see_also">
613
553
    <title>SEE ALSO</title>
614
554
    <para>
615
 
      <citerefentry><refentrytitle>intro</refentrytitle>
616
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
617
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
618
 
      <manvolnum>5</manvolnum></citerefentry>,
619
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
620
 
      <manvolnum>5</manvolnum></citerefentry>,
621
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
622
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
623
 
      <citerefentry><refentrytitle>sh</refentrytitle>
624
 
      <manvolnum>1</manvolnum></citerefentry>
 
555
      <citerefentry>
 
556
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
557
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
558
        <refentrytitle>mandos.conf</refentrytitle>
 
559
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
560
        <refentrytitle>mandos-client</refentrytitle>
 
561
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
562
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
563
      </citerefentry>
625
564
    </para>
626
565
    <variablelist>
627
566
      <varlistentry>