/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-09-21 21:39:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090921213925-jbpt6tzu99otseng
Use D-Bus properties instead of our own methods.

* mandos (Client._datetime_to_milliseconds): Renamed to
                                             "_timedelta_to_milliseconds".
                                             All callers changed.
  (dbus_service_property): New decorator for D-Bus properties.
  (DBusPropertyException, DBusPropertyAccessException,
  DBusPropertyNotFound): New D-Bus exception classes.
  (DBusObjectWithProperties): New; extends "dbus.service.Object" with
                              support for properties.
  (ClientDBus): Inherit from, and call up to, "DBusObjectWithProperties".
  (ClientDBus.CheckedOK, ClientDBus.GetAllProperties,
  ClientDBus.SetChecker, ClientDBus.SetHost, ClientDBus.SetInterval,
  ClientDBus.SetSecret, ClientDBus.SetTimeout, ClientDBus.Enable,
  ClientDBus.StartChecker, ClientDBus.Disable,
  ClientDBus.StopChecker): Removed, replaced with properties.
  (ClientDBus.IsStillValid): Removed, superfluous.
  (ClientDBus.name_dbus_property,
  ClientDBus.fingerprint_dbus_property, ClientDBus.host_dbus_property,
  ClientDBus.created_dbus_property,
  ClientDBus.last_enabled_dbus_property,
  ClientDBus.enabled_dbus_property,
  ClientDBus.last_checked_ok_dbus_property,
  ClientDBus.timeout_dbus_property, ClientDBus.interval_dbus_property,
  ClientDBus.checker_dbus_property,
  ClientDBus.checker_running_dbus_property,
  ClientDBus.object_path_dbus_property,
  ClientDBus.secret_dbus_property): New D-Bus properties.

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-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
89
      <arg><option>--no-dbus</option></arg>
95
90
      <sbr/>
96
91
      <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
92
    </cmdsynopsis>
103
93
    <cmdsynopsis>
104
94
      <command>&COMMANDNAME;</command>
122
112
    <para>
123
113
      <command>&COMMANDNAME;</command> is a server daemon which
124
114
      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.
 
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.
135
123
    </para>
136
124
  </refsect1>
137
125
  
206
194
      </varlistentry>
207
195
      
208
196
      <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
197
        <term><option>--priority <replaceable>
228
198
        PRIORITY</replaceable></option></term>
229
199
        <listitem>
280
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
251
        </listitem>
282
252
      </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
253
    </variablelist>
299
254
  </refsect1>
300
255
  
374
329
      for some time, the client is assumed to be compromised and is no
375
330
      longer eligible to receive the encrypted password.  (Manual
376
331
      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>
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
380
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
336
      receiving its password will also be treated as a successful
382
337
      checker run.
383
338
    </para>
384
339
  </refsect1>
385
340
  
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>
393
 
      <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
 
    
404
 
  </refsect1>
405
 
  
406
341
  <refsect1 id="logging">
407
342
    <title>LOGGING</title>
408
343
    <para>
418
353
    <para>
419
354
      The server will by default provide a D-Bus system bus interface.
420
355
      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>.
 
356
      Mandos-specific user, if such a user exists.
 
357
      <!-- XXX -->
423
358
    </para>
424
359
  </refsect1>
425
360
  
483
418
        <term><filename>/var/run/mandos.pid</filename></term>
484
419
        <listitem>
485
420
          <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.
 
421
            The file containing the process id of
 
422
            <command>&COMMANDNAME;</command>.
499
423
          </para>
500
424
        </listitem>
501
425
      </varlistentry>
529
453
      backtrace.  This could be considered a feature.
530
454
    </para>
531
455
    <para>
 
456
      Currently, if a client is declared <quote>invalid</quote> due to
 
457
      having timed out, the server does not record this fact onto
 
458
      permanent storage.  This has some security implications, see
 
459
      <xref linkend="clients"/>.
 
460
    </para>
 
461
    <para>
 
462
      There is currently no way of querying the server of the current
 
463
      status of clients, other than analyzing its <systemitem
 
464
      class="service">syslog</systemitem> output.
 
465
    </para>
 
466
    <para>
532
467
      There is no fine-grained control over logging and debug output.
533
468
    </para>
534
469
    <para>
535
470
      Debug mode is conflated with running in the foreground.
536
471
    </para>
537
472
    <para>
 
473
      The console log messages do not show a time stamp.
 
474
    </para>
 
475
    <para>
538
476
      This server does not check the expire time of clients’ OpenPGP
539
477
      keys.
540
478
    </para>
553
491
    <informalexample>
554
492
      <para>
555
493
        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:
 
494
        the <filename>~/mandos</filename> directory, and use the
 
495
        Zeroconf service name <quote>Test</quote> to not collide with
 
496
        any other official Mandos server on this host:
559
497
      </para>
560
498
      <para>
561
499
 
610
548
        compromised if they are gone for too long.
611
549
      </para>
612
550
      <para>
 
551
        If a client is compromised, its downtime should be duly noted
 
552
        by the server which would therefore declare the client
 
553
        invalid.  But if the server was ever restarted, it would
 
554
        re-read its client list from its configuration file and again
 
555
        regard all clients therein as valid, and hence eligible to
 
556
        receive their passwords.  Therefore, be careful when
 
557
        restarting servers if it is suspected that a client has, in
 
558
        fact, been compromised by parties who may now be running a
 
559
        fake Mandos client with the keys from the non-encrypted
 
560
        initial <acronym>RAM</acronym> image of the client host.  What
 
561
        should be done in that case (if restarting the server program
 
562
        really is necessary) is to stop the server program, edit the
 
563
        configuration file to omit any suspect clients, and restart
 
564
        the server program.
 
565
      </para>
 
566
      <para>
613
567
        For more details on client-side security, see
614
568
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
615
569
        <manvolnum>8mandos</manvolnum></citerefentry>.
620
574
  <refsect1 id="see_also">
621
575
    <title>SEE ALSO</title>
622
576
    <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>
 
577
      <citerefentry>
 
578
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
579
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
580
        <refentrytitle>mandos.conf</refentrytitle>
 
581
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
582
        <refentrytitle>mandos-client</refentrytitle>
 
583
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
584
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
585
      </citerefentry>
633
586
    </para>
634
587
    <variablelist>
635
588
      <varlistentry>