/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:16:57 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090118001657-6mo3ae73ldy5tegf
* debian/mandos-client.postinst: Converted to Bourne shell.  Also
                                 minor message change.
* debian/mandos-client.postrm: Minor message change.
* debian/mandos.postinst: Converted to Bourne shell.  Also minor
                          message change.
* debian/mandos.prerm: Minor message change.

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 "2012-01-01">
 
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
 
      <year>2012</year>
39
36
      <holder>Teddy Hogeborn</holder>
40
37
      <holder>Björn Påhlsson</holder>
41
38
    </copyright>
89
86
      <sbr/>
90
87
      <arg><option>--debug</option></arg>
91
88
      <sbr/>
92
 
      <arg><option>--debuglevel
93
 
      <replaceable>LEVEL</replaceable></option></arg>
94
 
      <sbr/>
95
89
      <arg><option>--no-dbus</option></arg>
96
 
      <sbr/>
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
90
    </cmdsynopsis>
104
91
    <cmdsynopsis>
105
92
      <command>&COMMANDNAME;</command>
123
110
    <para>
124
111
      <command>&COMMANDNAME;</command> is a server daemon which
125
112
      handles incoming request for passwords for a pre-defined list of
126
 
      client host computers. For an introduction, see
127
 
      <citerefentry><refentrytitle>intro</refentrytitle>
128
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
 
      uses Zeroconf to announce itself on the local network, and uses
130
 
      TLS to communicate securely with and to authenticate the
131
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
132
 
      use IPv6 link-local addresses, since the clients will probably
133
 
      not have any other addresses configured (see <xref
134
 
      linkend="overview"/>).  Any authenticated client is then given
135
 
      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.
136
121
    </para>
137
122
  </refsect1>
138
123
  
207
192
      </varlistentry>
208
193
      
209
194
      <varlistentry>
210
 
        <term><option>--debuglevel
211
 
        <replaceable>LEVEL</replaceable></option></term>
212
 
        <listitem>
213
 
          <para>
214
 
            Set the debugging log level.
215
 
            <replaceable>LEVEL</replaceable> is a string, one of
216
 
            <quote><literal>CRITICAL</literal></quote>,
217
 
            <quote><literal>ERROR</literal></quote>,
218
 
            <quote><literal>WARNING</literal></quote>,
219
 
            <quote><literal>INFO</literal></quote>, or
220
 
            <quote><literal>DEBUG</literal></quote>, in order of
221
 
            increasing verbosity.  The default level is
222
 
            <quote><literal>WARNING</literal></quote>.
223
 
          </para>
224
 
        </listitem>
225
 
      </varlistentry>
226
 
      
227
 
      <varlistentry>
228
195
        <term><option>--priority <replaceable>
229
196
        PRIORITY</replaceable></option></term>
230
197
        <listitem>
274
241
          </para>
275
242
        </listitem>
276
243
      </varlistentry>
277
 
      
278
 
      <varlistentry>
279
 
        <term><option>--no-ipv6</option></term>
280
 
        <listitem>
281
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
 
        </listitem>
283
 
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-restore</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
289
 
        </listitem>
290
 
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--statedir
294
 
        <replaceable>DIRECTORY</replaceable></option></term>
295
 
        <listitem>
296
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
 
        </listitem>
298
 
      </varlistentry>
299
244
    </variablelist>
300
245
  </refsect1>
301
246
  
373
318
      The server will, by default, continually check that the clients
374
319
      are still up.  If a client has not been confirmed as being up
375
320
      for some time, the client is assumed to be compromised and is no
376
 
      longer eligible to receive the encrypted password.  (Manual
377
 
      intervention is required to re-enable a client.)  The timeout,
378
 
      extended timeout, checker program, and interval between checks
379
 
      can be configured both globally and per client; see
380
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
384
 
    </para>
385
 
  </refsect1>
386
 
  
387
 
  <refsect1 id="approval">
388
 
    <title>APPROVAL</title>
389
 
    <para>
390
 
      The server can be configured to require manual approval for a
391
 
      client before it is sent its secret.  The delay to wait for such
392
 
      approval and the default action (approve or deny) can be
393
 
      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>
394
324
      <refentrytitle>mandos-clients.conf</refentrytitle>
395
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
396
 
      will be approved immediately without delay.
397
 
    </para>
398
 
    <para>
399
 
      This can be used to deny a client its secret if not manually
400
 
      approved within a specified time.  It can also be used to make
401
 
      the server delay before giving a client its secret, allowing
402
 
      optional manual denying of this specific client.
403
 
    </para>
404
 
    
 
325
      <manvolnum>5</manvolnum></citerefentry>.
 
326
    </para>
405
327
  </refsect1>
406
328
  
407
329
  <refsect1 id="logging">
408
330
    <title>LOGGING</title>
409
331
    <para>
410
332
      The server will send log message with various severity levels to
411
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
333
      <filename>/dev/log</filename>.  With the
412
334
      <option>--debug</option> option, it will log even more messages,
413
335
      and also show them on the console.
414
336
    </para>
419
341
    <para>
420
342
      The server will by default provide a D-Bus system bus interface.
421
343
      This interface will only be accessible by the root user or a
422
 
      Mandos-specific user, if such a user exists.  For documentation
423
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
424
346
    </para>
425
347
  </refsect1>
426
 
  
 
348
 
427
349
  <refsect1 id="exit_status">
428
350
    <title>EXIT STATUS</title>
429
351
    <para>
484
406
        <term><filename>/var/run/mandos.pid</filename></term>
485
407
        <listitem>
486
408
          <para>
487
 
            The file containing the process id of the
488
 
            <command>&COMMANDNAME;</command> process started last.
489
 
          </para>
490
 
        </listitem>
491
 
      </varlistentry>
492
 
      <varlistentry>
493
 
        <term><filename class="devicefile">/dev/log</filename></term>
494
 
      </varlistentry>
495
 
      <varlistentry>
496
 
        <term><filename
497
 
        class="directory">/var/lib/mandos</filename></term>
498
 
        <listitem>
499
 
          <para>
500
 
            Directory where persistent state will be saved.  Change
501
 
            this with the <option>--statedir</option> option.  See
502
 
            also the <option>--no-restore</option> option.
 
409
            The file containing the process id of
 
410
            <command>&COMMANDNAME;</command>.
503
411
          </para>
504
412
        </listitem>
505
413
      </varlistentry>
533
441
      backtrace.  This could be considered a feature.
534
442
    </para>
535
443
    <para>
 
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.
 
453
    </para>
 
454
    <para>
536
455
      There is no fine-grained control over logging and debug output.
537
456
    </para>
538
457
    <para>
539
458
      Debug mode is conflated with running in the foreground.
540
459
    </para>
541
460
    <para>
 
461
      The console log messages does not show a time stamp.
 
462
    </para>
 
463
    <para>
542
464
      This server does not check the expire time of clients’ OpenPGP
543
465
      keys.
544
466
    </para>
557
479
    <informalexample>
558
480
      <para>
559
481
        Run the server in debug mode, read configuration files from
560
 
        the <filename class="directory">~/mandos</filename> directory,
561
 
        and use the Zeroconf service name <quote>Test</quote> to not
562
 
        collide with any other official Mandos server on this host:
 
482
        the <filename>~/mandos</filename> directory, and use the
 
483
        Zeroconf service name <quote>Test</quote> to not collide with
 
484
        any other official Mandos server on this host:
563
485
      </para>
564
486
      <para>
565
487
 
614
536
        compromised if they are gone for too long.
615
537
      </para>
616
538
      <para>
 
539
        If a client is compromised, its downtime should be duly noted
 
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.
 
553
      </para>
 
554
      <para>
617
555
        For more details on client-side security, see
618
556
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
619
557
        <manvolnum>8mandos</manvolnum></citerefentry>.
624
562
  <refsect1 id="see_also">
625
563
    <title>SEE ALSO</title>
626
564
    <para>
627
 
      <citerefentry><refentrytitle>intro</refentrytitle>
628
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
629
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
630
 
      <manvolnum>5</manvolnum></citerefentry>,
631
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
632
 
      <manvolnum>5</manvolnum></citerefentry>,
633
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
634
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
635
 
      <citerefentry><refentrytitle>sh</refentrytitle>
636
 
      <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>
637
574
    </para>
638
575
    <variablelist>
639
576
      <varlistentry>