/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-02-09 02:01:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090209020113-726hq380zvp8zt97
Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

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 "2011-02-27">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
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
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
90
    </cmdsynopsis>
98
91
    <cmdsynopsis>
99
92
      <command>&COMMANDNAME;</command>
199
192
      </varlistentry>
200
193
      
201
194
      <varlistentry>
202
 
        <term><option>--debuglevel
203
 
        <replaceable>LEVEL</replaceable></option></term>
204
 
        <listitem>
205
 
          <para>
206
 
            Set the debugging log level.
207
 
            <replaceable>LEVEL</replaceable> is a string, one of
208
 
            <quote><literal>CRITICAL</literal></quote>,
209
 
            <quote><literal>ERROR</literal></quote>,
210
 
            <quote><literal>WARNING</literal></quote>,
211
 
            <quote><literal>INFO</literal></quote>, or
212
 
            <quote><literal>DEBUG</literal></quote>, in order of
213
 
            increasing verbosity.  The default level is
214
 
            <quote><literal>WARNING</literal></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
195
        <term><option>--priority <replaceable>
221
196
        PRIORITY</replaceable></option></term>
222
197
        <listitem>
266
241
          </para>
267
242
        </listitem>
268
243
      </varlistentry>
269
 
      
270
 
      <varlistentry>
271
 
        <term><option>--no-ipv6</option></term>
272
 
        <listitem>
273
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
 
        </listitem>
275
 
      </varlistentry>
276
244
    </variablelist>
277
245
  </refsect1>
278
246
  
350
318
      The server will, by default, continually check that the clients
351
319
      are still up.  If a client has not been confirmed as being up
352
320
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  (Manual
354
 
      intervention is required to re-enable a client.)  The timeout,
 
321
      longer eligible to receive the encrypted password.  The timeout,
355
322
      checker program, and interval between checks can be configured
356
323
      both globally and per client; see <citerefentry>
357
324
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="approval">
365
 
    <title>APPROVAL</title>
366
 
    <para>
367
 
      The server can be configured to require manual approval for a
368
 
      client before it is sent its secret.  The delay to wait for such
369
 
      approval and the default action (approve or deny) can be
370
 
      configured both globally and per client; see <citerefentry>
371
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
372
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
373
 
      will be approved immediately without delay.
374
 
    </para>
375
 
    <para>
376
 
      This can be used to deny a client its secret if not manually
377
 
      approved within a specified time.  It can also be used to make
378
 
      the server delay before giving a client its secret, allowing
379
 
      optional manual denying of this specific client.
380
 
    </para>
381
 
    
 
325
      <manvolnum>5</manvolnum></citerefentry>.
 
326
    </para>
382
327
  </refsect1>
383
328
  
384
329
  <refsect1 id="logging">
396
341
    <para>
397
342
      The server will by default provide a D-Bus system bus interface.
398
343
      This interface will only be accessible by the root user or a
399
 
      Mandos-specific user, if such a user exists.  For documentation
400
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
401
346
    </para>
402
347
  </refsect1>
403
 
  
 
348
 
404
349
  <refsect1 id="exit_status">
405
350
    <title>EXIT STATUS</title>
406
351
    <para>
461
406
        <term><filename>/var/run/mandos.pid</filename></term>
462
407
        <listitem>
463
408
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
409
            The file containing the process id of
 
410
            <command>&COMMANDNAME;</command>.
466
411
          </para>
467
412
        </listitem>
468
413
      </varlistentry>
496
441
      backtrace.  This could be considered a feature.
497
442
    </para>
498
443
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      has some security implications, see <xref linkend="clients"/>.
 
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.
502
453
    </para>
503
454
    <para>
504
455
      There is no fine-grained control over logging and debug output.
507
458
      Debug mode is conflated with running in the foreground.
508
459
    </para>
509
460
    <para>
510
 
      The console log messages do not show a time stamp.
 
461
      The console log messages does not show a time stamp.
511
462
    </para>
512
463
    <para>
513
464
      This server does not check the expire time of clients’ OpenPGP
586
537
      </para>
587
538
      <para>
588
539
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        any suspect clients, and restart the server program.
 
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.
601
553
      </para>
602
554
      <para>
603
555
        For more details on client-side security, see