/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.3-1
* Makefile (version): Changed to "1.0.3".
* NEWS (Version 1.0.3): New entry.
* debian/changelog (1.0.3-1): New entry.

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-11-26">
 
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>
87
85
      <replaceable>DIRECTORY</replaceable></option></arg>
88
86
      <sbr/>
89
87
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <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
 
      <sbr/>
100
 
      <arg><option>--statedir
101
 
      <replaceable>DIRECTORY</replaceable></option></arg>
102
88
    </cmdsynopsis>
103
89
    <cmdsynopsis>
104
90
      <command>&COMMANDNAME;</command>
122
108
    <para>
123
109
      <command>&COMMANDNAME;</command> is a server daemon which
124
110
      handles incoming request for passwords for a pre-defined list of
125
 
      client host computers. For an introduction, see
126
 
      <citerefentry><refentrytitle>intro</refentrytitle>
127
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
 
      uses Zeroconf to announce itself on the local network, and uses
129
 
      TLS to communicate securely with and to authenticate the
130
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
131
 
      use IPv6 link-local addresses, since the clients will probably
132
 
      not have any other addresses configured (see <xref
133
 
      linkend="overview"/>).  Any authenticated client is then given
134
 
      the stored pre-encrypted password for that specific client.
 
111
      client host computers.  The Mandos server uses Zeroconf to
 
112
      announce itself on the local network, and uses TLS to
 
113
      communicate securely with and to authenticate the clients.  The
 
114
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
115
      link-local addresses, since the clients will probably not have
 
116
      any other addresses configured (see <xref linkend="overview"/>).
 
117
      Any authenticated client is then given the stored pre-encrypted
 
118
      password for that specific client.
135
119
    </para>
136
120
  </refsect1>
137
121
  
206
190
      </varlistentry>
207
191
      
208
192
      <varlistentry>
209
 
        <term><option>--debuglevel
210
 
        <replaceable>LEVEL</replaceable></option></term>
211
 
        <listitem>
212
 
          <para>
213
 
            Set the debugging log level.
214
 
            <replaceable>LEVEL</replaceable> is a string, one of
215
 
            <quote><literal>CRITICAL</literal></quote>,
216
 
            <quote><literal>ERROR</literal></quote>,
217
 
            <quote><literal>WARNING</literal></quote>,
218
 
            <quote><literal>INFO</literal></quote>, or
219
 
            <quote><literal>DEBUG</literal></quote>, in order of
220
 
            increasing verbosity.  The default level is
221
 
            <quote><literal>WARNING</literal></quote>.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      
226
 
      <varlistentry>
227
193
        <term><option>--priority <replaceable>
228
194
        PRIORITY</replaceable></option></term>
229
195
        <listitem>
263
229
          </para>
264
230
        </listitem>
265
231
      </varlistentry>
266
 
      
267
 
      <varlistentry>
268
 
        <term><option>--no-dbus</option></term>
269
 
        <listitem>
270
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
271
 
          <para>
272
 
            See also <xref linkend="dbus_interface"/>.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-ipv6</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
 
        </listitem>
282
 
      </varlistentry>
283
 
      
284
 
      <varlistentry>
285
 
        <term><option>--no-restore</option></term>
286
 
        <listitem>
287
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--statedir
293
 
        <replaceable>DIRECTORY</replaceable></option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
 
        </listitem>
297
 
      </varlistentry>
298
232
    </variablelist>
299
233
  </refsect1>
300
234
  
372
306
      The server will, by default, continually check that the clients
373
307
      are still up.  If a client has not been confirmed as being up
374
308
      for some time, the client is assumed to be compromised and is no
375
 
      longer eligible to receive the encrypted password.  (Manual
376
 
      intervention is required to re-enable a client.)  The timeout,
377
 
      extended timeout, checker program, and interval between checks
378
 
      can be configured both globally and per client; see
379
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="approval">
387
 
    <title>APPROVAL</title>
388
 
    <para>
389
 
      The server can be configured to require manual approval for a
390
 
      client before it is sent its secret.  The delay to wait for such
391
 
      approval and the default action (approve or deny) can be
392
 
      configured both globally and per client; see <citerefentry>
 
309
      longer eligible to receive the encrypted password.  The timeout,
 
310
      checker program, and interval between checks can be configured
 
311
      both globally and per client; see <citerefentry>
393
312
      <refentrytitle>mandos-clients.conf</refentrytitle>
394
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
395
 
      will be approved immediately without delay.
396
 
    </para>
397
 
    <para>
398
 
      This can be used to deny a client its secret if not manually
399
 
      approved within a specified time.  It can also be used to make
400
 
      the server delay before giving a client its secret, allowing
401
 
      optional manual denying of this specific client.
402
 
    </para>
403
 
    
 
313
      <manvolnum>5</manvolnum></citerefentry>.
 
314
    </para>
404
315
  </refsect1>
405
316
  
406
317
  <refsect1 id="logging">
413
324
    </para>
414
325
  </refsect1>
415
326
  
416
 
  <refsect1 id="dbus_interface">
417
 
    <title>D-BUS INTERFACE</title>
418
 
    <para>
419
 
      The server will by default provide a D-Bus system bus interface.
420
 
      This interface will only be accessible by the root user or a
421
 
      Mandos-specific user, if such a user exists.  For documentation
422
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
426
327
  <refsect1 id="exit_status">
427
328
    <title>EXIT STATUS</title>
428
329
    <para>
483
384
        <term><filename>/var/run/mandos.pid</filename></term>
484
385
        <listitem>
485
386
          <para>
486
 
            The file containing the process id of the
487
 
            <command>&COMMANDNAME;</command> process started last.
488
 
          </para>
489
 
        </listitem>
490
 
      </varlistentry>
491
 
      <varlistentry>
492
 
        <term><filename
493
 
        class="directory">/var/lib/mandos</filename></term>
494
 
        <listitem>
495
 
          <para>
496
 
            Directory where persistent state will be saved.  Change
497
 
            this with the <option>--statedir</option> option.  See
498
 
            also the <option>--no-restore</option> option.
 
387
            The file containing the process id of
 
388
            <command>&COMMANDNAME;</command>.
499
389
          </para>
500
390
        </listitem>
501
391
      </varlistentry>
529
419
      backtrace.  This could be considered a feature.
530
420
    </para>
531
421
    <para>
 
422
      Currently, if a client is declared <quote>invalid</quote> due to
 
423
      having timed out, the server does not record this fact onto
 
424
      permanent storage.  This has some security implications, see
 
425
      <xref linkend="clients"/>.
 
426
    </para>
 
427
    <para>
 
428
      There is currently no way of querying the server of the current
 
429
      status of clients, other than analyzing its <systemitem
 
430
      class="service">syslog</systemitem> output.
 
431
    </para>
 
432
    <para>
532
433
      There is no fine-grained control over logging and debug output.
533
434
    </para>
534
435
    <para>
535
436
      Debug mode is conflated with running in the foreground.
536
437
    </para>
537
438
    <para>
 
439
      The console log messages does not show a time stamp.
 
440
    </para>
 
441
    <para>
538
442
      This server does not check the expire time of clients’ OpenPGP
539
443
      keys.
540
444
    </para>
553
457
    <informalexample>
554
458
      <para>
555
459
        Run the server in debug mode, read configuration files from
556
 
        the <filename class="directory">~/mandos</filename> directory,
557
 
        and use the Zeroconf service name <quote>Test</quote> to not
558
 
        collide with any other official Mandos server on this host:
 
460
        the <filename>~/mandos</filename> directory, and use the
 
461
        Zeroconf service name <quote>Test</quote> to not collide with
 
462
        any other official Mandos server on this host:
559
463
      </para>
560
464
      <para>
561
465
 
610
514
        compromised if they are gone for too long.
611
515
      </para>
612
516
      <para>
 
517
        If a client is compromised, its downtime should be duly noted
 
518
        by the server which would therefore declare the client
 
519
        invalid.  But if the server was ever restarted, it would
 
520
        re-read its client list from its configuration file and again
 
521
        regard all clients therein as valid, and hence eligible to
 
522
        receive their passwords.  Therefore, be careful when
 
523
        restarting servers if it is suspected that a client has, in
 
524
        fact, been compromised by parties who may now be running a
 
525
        fake Mandos client with the keys from the non-encrypted
 
526
        initial <acronym>RAM</acronym> image of the client host.  What
 
527
        should be done in that case (if restarting the server program
 
528
        really is necessary) is to stop the server program, edit the
 
529
        configuration file to omit any suspect clients, and restart
 
530
        the server program.
 
531
      </para>
 
532
      <para>
613
533
        For more details on client-side security, see
614
534
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
615
535
        <manvolnum>8mandos</manvolnum></citerefentry>.
620
540
  <refsect1 id="see_also">
621
541
    <title>SEE ALSO</title>
622
542
    <para>
623
 
      <citerefentry><refentrytitle>intro</refentrytitle>
624
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
625
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
626
 
      <manvolnum>5</manvolnum></citerefentry>,
627
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
628
 
      <manvolnum>5</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
630
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
631
 
      <citerefentry><refentrytitle>sh</refentrytitle>
632
 
      <manvolnum>1</manvolnum></citerefentry>
 
543
      <citerefentry>
 
544
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>mandos.conf</refentrytitle>
 
547
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>mandos-client</refentrytitle>
 
549
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
550
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
551
      </citerefentry>
633
552
    </para>
634
553
    <variablelist>
635
554
      <varlistentry>