/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 at bsnet
  • Date: 2010-09-15 17:17:46 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100915171746-bg5cppurdd0pcvcy
* debian/watch: Also watch for "*.tar.xz" files.

* plugins.d/plymouth.c (getargv): Use argz_count() and argz_extract().
* plugins.d/usplash.c (main): - '' -

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 "2010-09-11">
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
90
      <sbr/>
97
91
      <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
92
    </cmdsynopsis>
104
93
    <cmdsynopsis>
105
94
      <command>&COMMANDNAME;</command>
123
112
    <para>
124
113
      <command>&COMMANDNAME;</command> is a server daemon which
125
114
      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.
 
115
      client host computers.  The Mandos server uses Zeroconf to
 
116
      announce itself on the local network, and uses TLS to
 
117
      communicate securely with and to authenticate the clients.  The
 
118
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
119
      link-local addresses, since the clients will probably not have
 
120
      any other addresses configured (see <xref linkend="overview"/>).
 
121
      Any authenticated client is then given the stored pre-encrypted
 
122
      password for that specific client.
136
123
    </para>
137
124
  </refsect1>
138
125
  
207
194
      </varlistentry>
208
195
      
209
196
      <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
197
        <term><option>--priority <replaceable>
229
198
        PRIORITY</replaceable></option></term>
230
199
        <listitem>
281
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
251
        </listitem>
283
252
      </varlistentry>
284
 
      
285
 
      <varlistentry>
286
 
        <term><option>--no-restore</option></term>
287
 
        <listitem>
288
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
289
 
          <para>
290
 
            See also <xref linkend="persistent_state"/>.
291
 
          </para>
292
 
        </listitem>
293
 
      </varlistentry>
294
 
      
295
 
      <varlistentry>
296
 
        <term><option>--statedir
297
 
        <replaceable>DIRECTORY</replaceable></option></term>
298
 
        <listitem>
299
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
 
        </listitem>
301
 
      </varlistentry>
302
253
    </variablelist>
303
254
  </refsect1>
304
255
  
378
329
      for some time, the client is assumed to be compromised and is no
379
330
      longer eligible to receive the encrypted password.  (Manual
380
331
      intervention is required to re-enable a client.)  The timeout,
381
 
      extended timeout, checker program, and interval between checks
382
 
      can be configured both globally and per client; see
383
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
384
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
385
336
      receiving its password will also be treated as a successful
386
337
      checker run.
387
338
    </para>
388
339
  </refsect1>
389
340
  
390
 
  <refsect1 id="approval">
391
 
    <title>APPROVAL</title>
392
 
    <para>
393
 
      The server can be configured to require manual approval for a
394
 
      client before it is sent its secret.  The delay to wait for such
395
 
      approval and the default action (approve or deny) can be
396
 
      configured both globally and per client; see <citerefentry>
397
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
398
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
399
 
      will be approved immediately without delay.
400
 
    </para>
401
 
    <para>
402
 
      This can be used to deny a client its secret if not manually
403
 
      approved within a specified time.  It can also be used to make
404
 
      the server delay before giving a client its secret, allowing
405
 
      optional manual denying of this specific client.
406
 
    </para>
407
 
    
408
 
  </refsect1>
409
 
  
410
341
  <refsect1 id="logging">
411
342
    <title>LOGGING</title>
412
343
    <para>
413
344
      The server will send log message with various severity levels to
414
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
345
      <filename>/dev/log</filename>.  With the
415
346
      <option>--debug</option> option, it will log even more messages,
416
347
      and also show them on the console.
417
348
    </para>
418
349
  </refsect1>
419
350
  
420
 
  <refsect1 id="persistent_state">
421
 
    <title>PERSISTENT STATE</title>
422
 
    <para>
423
 
      Client settings, initially read from
424
 
      <filename>clients.conf</filename>, are persistent across
425
 
      restarts, and run-time changes will override settings in
426
 
      <filename>clients.conf</filename>.  However, if a setting is
427
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
428
 
      <filename>clients.conf</filename>, this will take precedence.
429
 
    </para>
430
 
  </refsect1>
431
 
  
432
351
  <refsect1 id="dbus_interface">
433
352
    <title>D-BUS INTERFACE</title>
434
353
    <para>
499
418
        <term><filename>/var/run/mandos.pid</filename></term>
500
419
        <listitem>
501
420
          <para>
502
 
            The file containing the process id of the
503
 
            <command>&COMMANDNAME;</command> process started last.
504
 
          </para>
505
 
        </listitem>
506
 
      </varlistentry>
507
 
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
 
        <term><filename
512
 
        class="directory">/var/lib/mandos</filename></term>
513
 
        <listitem>
514
 
          <para>
515
 
            Directory where persistent state will be saved.  Change
516
 
            this with the <option>--statedir</option> option.  See
517
 
            also the <option>--no-restore</option> option.
 
421
            The file containing the process id of
 
422
            <command>&COMMANDNAME;</command>.
518
423
          </para>
519
424
        </listitem>
520
425
      </varlistentry>
548
453
      backtrace.  This could be considered a feature.
549
454
    </para>
550
455
    <para>
 
456
      Currently, if a client is disabled due to having timed out, the
 
457
      server does not record this fact onto permanent storage.  This
 
458
      has some security implications, see <xref linkend="clients"/>.
 
459
    </para>
 
460
    <para>
551
461
      There is no fine-grained control over logging and debug output.
552
462
    </para>
553
463
    <para>
554
464
      Debug mode is conflated with running in the foreground.
555
465
    </para>
556
466
    <para>
 
467
      The console log messages do not show a time stamp.
 
468
    </para>
 
469
    <para>
557
470
      This server does not check the expire time of clients’ OpenPGP
558
471
      keys.
559
472
    </para>
572
485
    <informalexample>
573
486
      <para>
574
487
        Run the server in debug mode, read configuration files from
575
 
        the <filename class="directory">~/mandos</filename> directory,
576
 
        and use the Zeroconf service name <quote>Test</quote> to not
577
 
        collide with any other official Mandos server on this host:
 
488
        the <filename>~/mandos</filename> directory, and use the
 
489
        Zeroconf service name <quote>Test</quote> to not collide with
 
490
        any other official Mandos server on this host:
578
491
      </para>
579
492
      <para>
580
493
 
629
542
        compromised if they are gone for too long.
630
543
      </para>
631
544
      <para>
 
545
        If a client is compromised, its downtime should be duly noted
 
546
        by the server which would therefore disable the client.  But
 
547
        if the server was ever restarted, it would re-read its client
 
548
        list from its configuration file and again regard all clients
 
549
        therein as enabled, and hence eligible to receive their
 
550
        passwords.  Therefore, be careful when restarting servers if
 
551
        it is suspected that a client has, in fact, been compromised
 
552
        by parties who may now be running a fake Mandos client with
 
553
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
554
        image of the client host.  What should be done in that case
 
555
        (if restarting the server program really is necessary) is to
 
556
        stop the server program, edit the configuration file to omit
 
557
        any suspect clients, and restart the server program.
 
558
      </para>
 
559
      <para>
632
560
        For more details on client-side security, see
633
561
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
634
562
        <manvolnum>8mandos</manvolnum></citerefentry>.
639
567
  <refsect1 id="see_also">
640
568
    <title>SEE ALSO</title>
641
569
    <para>
642
 
      <citerefentry><refentrytitle>intro</refentrytitle>
643
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
644
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
 
      <manvolnum>5</manvolnum></citerefentry>,
646
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
647
 
      <manvolnum>5</manvolnum></citerefentry>,
648
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
649
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
650
 
      <citerefentry><refentrytitle>sh</refentrytitle>
651
 
      <manvolnum>1</manvolnum></citerefentry>
 
570
      <citerefentry>
 
571
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
572
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
573
        <refentrytitle>mandos.conf</refentrytitle>
 
574
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
575
        <refentrytitle>mandos-client</refentrytitle>
 
576
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
577
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
578
      </citerefentry>
652
579
    </para>
653
580
    <variablelist>
654
581
      <varlistentry>