/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-01-06 22:21:53 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090106222153-3b43cfdjyvz1032y
Tags: version-1.0.3-2
* debian/changelog (1.0.3-2): 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 "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>
88
85
      <replaceable>DIRECTORY</replaceable></option></arg>
89
86
      <sbr/>
90
87
      <arg><option>--debug</option></arg>
91
 
      <sbr/>
92
 
      <arg><option>--debuglevel
93
 
      <replaceable>LEVEL</replaceable></option></arg>
94
 
      <sbr/>
95
 
      <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
88
    </cmdsynopsis>
104
89
    <cmdsynopsis>
105
90
      <command>&COMMANDNAME;</command>
123
108
    <para>
124
109
      <command>&COMMANDNAME;</command> is a server daemon which
125
110
      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.
 
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.
136
119
    </para>
137
120
  </refsect1>
138
121
  
207
190
      </varlistentry>
208
191
      
209
192
      <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
193
        <term><option>--priority <replaceable>
229
194
        PRIORITY</replaceable></option></term>
230
195
        <listitem>
264
229
          </para>
265
230
        </listitem>
266
231
      </varlistentry>
267
 
      
268
 
      <varlistentry>
269
 
        <term><option>--no-dbus</option></term>
270
 
        <listitem>
271
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
272
 
          <para>
273
 
            See also <xref linkend="dbus_interface"/>.
274
 
          </para>
275
 
        </listitem>
276
 
      </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
232
    </variablelist>
300
233
  </refsect1>
301
234
  
373
306
      The server will, by default, continually check that the clients
374
307
      are still up.  If a client has not been confirmed as being up
375
308
      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>
 
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>
394
312
      <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
 
    
 
313
      <manvolnum>5</manvolnum></citerefentry>.
 
314
    </para>
405
315
  </refsect1>
406
316
  
407
317
  <refsect1 id="logging">
408
318
    <title>LOGGING</title>
409
319
    <para>
410
320
      The server will send log message with various severity levels to
411
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
321
      <filename>/dev/log</filename>.  With the
412
322
      <option>--debug</option> option, it will log even more messages,
413
323
      and also show them on the console.
414
324
    </para>
415
325
  </refsect1>
416
326
  
417
 
  <refsect1 id="dbus_interface">
418
 
    <title>D-BUS INTERFACE</title>
419
 
    <para>
420
 
      The server will by default provide a D-Bus system bus interface.
421
 
      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>.
424
 
    </para>
425
 
  </refsect1>
426
 
  
427
327
  <refsect1 id="exit_status">
428
328
    <title>EXIT STATUS</title>
429
329
    <para>
484
384
        <term><filename>/var/run/mandos.pid</filename></term>
485
385
        <listitem>
486
386
          <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.
 
387
            The file containing the process id of
 
388
            <command>&COMMANDNAME;</command>.
503
389
          </para>
504
390
        </listitem>
505
391
      </varlistentry>
533
419
      backtrace.  This could be considered a feature.
534
420
    </para>
535
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>
536
433
      There is no fine-grained control over logging and debug output.
537
434
    </para>
538
435
    <para>
539
436
      Debug mode is conflated with running in the foreground.
540
437
    </para>
541
438
    <para>
 
439
      The console log messages does not show a time stamp.
 
440
    </para>
 
441
    <para>
542
442
      This server does not check the expire time of clients’ OpenPGP
543
443
      keys.
544
444
    </para>
557
457
    <informalexample>
558
458
      <para>
559
459
        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:
 
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:
563
463
      </para>
564
464
      <para>
565
465
 
614
514
        compromised if they are gone for too long.
615
515
      </para>
616
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>
617
533
        For more details on client-side security, see
618
534
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
619
535
        <manvolnum>8mandos</manvolnum></citerefentry>.
624
540
  <refsect1 id="see_also">
625
541
    <title>SEE ALSO</title>
626
542
    <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>
 
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>
637
552
    </para>
638
553
    <variablelist>
639
554
      <varlistentry>