/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: 2008-10-03 09:32:30 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081003093230-rshn19e0c19zz12i
* .bzrignore (plugins.d/askpass-fifo): Added.

* Makefile (FORTIFY): Added "-fstack-protector-all".
  (mandos, mandos-keygen): Use more strict regexps when updating the
                           version number.

* mandos (Client.__init__): Use os.path.expandvars() and
                            os.path.expanduser() on the "secfile"
                            config value.

* plugins.d/splashy.c: Update comments and order of #include's.
  (main): Check user and group when looking for running splashy
          process.  Do not ignore ENOENT from execl().  Use _exit()
          instead of "return" when an error happens in child
          processes.  Bug fix: Only wait for splashy_update
          completion if it was started.  Bug fix: detect failing
          waitpid().  Only kill splashy_update if it is running.  Do
          the killing of the old splashy process before the fork().
          Do setsid() and setuid(geteuid()) before starting the new
          splashy.  Report failing execl().

* plugins.d/usplash.c: Update comments and order of #include's.
  (main): Check user and group when looking for running usplash
          process.  Do not report execv() error if interrupted by a
          signal.

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-05-26">
 
5
<!ENTITY TIMESTAMP "2008-09-30">
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
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
35
      <holder>Teddy Hogeborn</holder>
40
36
      <holder>Björn Påhlsson</holder>
41
37
    </copyright>
88
84
      <replaceable>DIRECTORY</replaceable></option></arg>
89
85
      <sbr/>
90
86
      <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
 
      <sbr/>
104
 
      <arg><option>--socket
105
 
      <replaceable>FD</replaceable></option></arg>
106
87
    </cmdsynopsis>
107
88
    <cmdsynopsis>
108
89
      <command>&COMMANDNAME;</command>
126
107
    <para>
127
108
      <command>&COMMANDNAME;</command> is a server daemon which
128
109
      handles incoming request for passwords for a pre-defined list of
129
 
      client host computers. For an introduction, see
130
 
      <citerefentry><refentrytitle>intro</refentrytitle>
131
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
 
      uses Zeroconf to announce itself on the local network, and uses
133
 
      TLS to communicate securely with and to authenticate the
134
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
135
 
      use IPv6 link-local addresses, since the clients will probably
136
 
      not have any other addresses configured (see <xref
137
 
      linkend="overview"/>).  Any authenticated client is then given
138
 
      the stored pre-encrypted password for that specific client.
 
110
      client host computers.  The Mandos server uses Zeroconf to
 
111
      announce itself on the local network, and uses TLS to
 
112
      communicate securely with and to authenticate the clients.  The
 
113
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
114
      link-local addresses, since the clients will probably not have
 
115
      any other addresses configured (see <xref linkend="overview"/>).
 
116
      Any authenticated client is then given the stored pre-encrypted
 
117
      password for that specific client.
139
118
    </para>
140
119
  </refsect1>
141
120
  
210
189
      </varlistentry>
211
190
      
212
191
      <varlistentry>
213
 
        <term><option>--debuglevel
214
 
        <replaceable>LEVEL</replaceable></option></term>
215
 
        <listitem>
216
 
          <para>
217
 
            Set the debugging log level.
218
 
            <replaceable>LEVEL</replaceable> is a string, one of
219
 
            <quote><literal>CRITICAL</literal></quote>,
220
 
            <quote><literal>ERROR</literal></quote>,
221
 
            <quote><literal>WARNING</literal></quote>,
222
 
            <quote><literal>INFO</literal></quote>, or
223
 
            <quote><literal>DEBUG</literal></quote>, in order of
224
 
            increasing verbosity.  The default level is
225
 
            <quote><literal>WARNING</literal></quote>.
226
 
          </para>
227
 
        </listitem>
228
 
      </varlistentry>
229
 
      
230
 
      <varlistentry>
231
192
        <term><option>--priority <replaceable>
232
193
        PRIORITY</replaceable></option></term>
233
194
        <listitem>
267
228
          </para>
268
229
        </listitem>
269
230
      </varlistentry>
270
 
      
271
 
      <varlistentry>
272
 
        <term><option>--no-dbus</option></term>
273
 
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
275
 
          <para>
276
 
            See also <xref linkend="dbus_interface"/>.
277
 
          </para>
278
 
        </listitem>
279
 
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-ipv6</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
 
        <term><option>--no-restore</option></term>
290
 
        <listitem>
291
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
292
 
          <para>
293
 
            See also <xref linkend="persistent_state"/>.
294
 
          </para>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
      
298
 
      <varlistentry>
299
 
        <term><option>--statedir
300
 
        <replaceable>DIRECTORY</replaceable></option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
303
 
        </listitem>
304
 
      </varlistentry>
305
 
      
306
 
      <varlistentry>
307
 
        <term><option>--socket
308
 
        <replaceable>FD</replaceable></option></term>
309
 
        <listitem>
310
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
311
 
        </listitem>
312
 
      </varlistentry>
313
 
      
314
231
    </variablelist>
315
232
  </refsect1>
316
233
  
388
305
      The server will, by default, continually check that the clients
389
306
      are still up.  If a client has not been confirmed as being up
390
307
      for some time, the client is assumed to be compromised and is no
391
 
      longer eligible to receive the encrypted password.  (Manual
392
 
      intervention is required to re-enable a client.)  The timeout,
393
 
      extended timeout, checker program, and interval between checks
394
 
      can be configured both globally and per client; see
395
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
308
      longer eligible to receive the encrypted password.  The timeout,
 
309
      checker program, and interval between checks can be configured
 
310
      both globally and per client; see <citerefentry>
 
311
      <refentrytitle>mandos-clients.conf</refentrytitle>
396
312
      <manvolnum>5</manvolnum></citerefentry>.
397
313
    </para>
398
314
  </refsect1>
399
315
  
400
 
  <refsect1 id="approval">
401
 
    <title>APPROVAL</title>
402
 
    <para>
403
 
      The server can be configured to require manual approval for a
404
 
      client before it is sent its secret.  The delay to wait for such
405
 
      approval and the default action (approve or deny) can be
406
 
      configured both globally and per client; see <citerefentry>
407
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
408
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
409
 
      will be approved immediately without delay.
410
 
    </para>
411
 
    <para>
412
 
      This can be used to deny a client its secret if not manually
413
 
      approved within a specified time.  It can also be used to make
414
 
      the server delay before giving a client its secret, allowing
415
 
      optional manual denying of this specific client.
416
 
    </para>
417
 
    
418
 
  </refsect1>
419
 
  
420
316
  <refsect1 id="logging">
421
317
    <title>LOGGING</title>
422
318
    <para>
423
319
      The server will send log message with various severity levels to
424
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
320
      <filename>/dev/log</filename>.  With the
425
321
      <option>--debug</option> option, it will log even more messages,
426
322
      and also show them on the console.
427
323
    </para>
428
324
  </refsect1>
429
325
  
430
 
  <refsect1 id="persistent_state">
431
 
    <title>PERSISTENT STATE</title>
432
 
    <para>
433
 
      Client settings, initially read from
434
 
      <filename>clients.conf</filename>, are persistent across
435
 
      restarts, and run-time changes will override settings in
436
 
      <filename>clients.conf</filename>.  However, if a setting is
437
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
438
 
      <filename>clients.conf</filename>, this will take precedence.
439
 
    </para>
440
 
  </refsect1>
441
 
  
442
 
  <refsect1 id="dbus_interface">
443
 
    <title>D-BUS INTERFACE</title>
444
 
    <para>
445
 
      The server will by default provide a D-Bus system bus interface.
446
 
      This interface will only be accessible by the root user or a
447
 
      Mandos-specific user, if such a user exists.  For documentation
448
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
449
 
    </para>
450
 
  </refsect1>
451
 
  
452
326
  <refsect1 id="exit_status">
453
327
    <title>EXIT STATUS</title>
454
328
    <para>
477
351
    </variablelist>
478
352
  </refsect1>
479
353
  
480
 
  <refsect1 id="files">
 
354
  <refsect1 id="file">
481
355
    <title>FILES</title>
482
356
    <para>
483
357
      Use the <option>--configdir</option> option to change where
509
383
        <term><filename>/var/run/mandos.pid</filename></term>
510
384
        <listitem>
511
385
          <para>
512
 
            The file containing the process id of the
513
 
            <command>&COMMANDNAME;</command> process started last.
514
 
          </para>
515
 
        </listitem>
516
 
      </varlistentry>
517
 
      <varlistentry>
518
 
        <term><filename class="devicefile">/dev/log</filename></term>
519
 
      </varlistentry>
520
 
      <varlistentry>
521
 
        <term><filename
522
 
        class="directory">/var/lib/mandos</filename></term>
523
 
        <listitem>
524
 
          <para>
525
 
            Directory where persistent state will be saved.  Change
526
 
            this with the <option>--statedir</option> option.  See
527
 
            also the <option>--no-restore</option> option.
 
386
            The file containing the process id of
 
387
            <command>&COMMANDNAME;</command>.
528
388
          </para>
529
389
        </listitem>
530
390
      </varlistentry>
558
418
      backtrace.  This could be considered a feature.
559
419
    </para>
560
420
    <para>
 
421
      Currently, if a client is declared <quote>invalid</quote> due to
 
422
      having timed out, the server does not record this fact onto
 
423
      permanent storage.  This has some security implications, see
 
424
      <xref linkend="CLIENTS"/>.
 
425
    </para>
 
426
    <para>
 
427
      There is currently no way of querying the server of the current
 
428
      status of clients, other than analyzing its <systemitem
 
429
      class="service">syslog</systemitem> output.
 
430
    </para>
 
431
    <para>
561
432
      There is no fine-grained control over logging and debug output.
562
433
    </para>
563
434
    <para>
564
435
      Debug mode is conflated with running in the foreground.
565
436
    </para>
566
437
    <para>
 
438
      The console log messages does not show a time stamp.
 
439
    </para>
 
440
    <para>
567
441
      This server does not check the expire time of clients’ OpenPGP
568
442
      keys.
569
443
    </para>
582
456
    <informalexample>
583
457
      <para>
584
458
        Run the server in debug mode, read configuration files from
585
 
        the <filename class="directory">~/mandos</filename> directory,
586
 
        and use the Zeroconf service name <quote>Test</quote> to not
587
 
        collide with any other official Mandos server on this host:
 
459
        the <filename>~/mandos</filename> directory, and use the
 
460
        Zeroconf service name <quote>Test</quote> to not collide with
 
461
        any other official Mandos server on this host:
588
462
      </para>
589
463
      <para>
590
464
 
609
483
  
610
484
  <refsect1 id="security">
611
485
    <title>SECURITY</title>
612
 
    <refsect2 id="server">
 
486
    <refsect2 id="SERVER">
613
487
      <title>SERVER</title>
614
488
      <para>
615
489
        Running this <command>&COMMANDNAME;</command> server program
618
492
        soon after startup.
619
493
      </para>
620
494
    </refsect2>
621
 
    <refsect2 id="clients">
 
495
    <refsect2 id="CLIENTS">
622
496
      <title>CLIENTS</title>
623
497
      <para>
624
498
        The server only gives out its stored data to clients which
639
513
        compromised if they are gone for too long.
640
514
      </para>
641
515
      <para>
 
516
        If a client is compromised, its downtime should be duly noted
 
517
        by the server which would therefore declare the client
 
518
        invalid.  But if the server was ever restarted, it would
 
519
        re-read its client list from its configuration file and again
 
520
        regard all clients therein as valid, and hence eligible to
 
521
        receive their passwords.  Therefore, be careful when
 
522
        restarting servers if it is suspected that a client has, in
 
523
        fact, been compromised by parties who may now be running a
 
524
        fake Mandos client with the keys from the non-encrypted
 
525
        initial <acronym>RAM</acronym> image of the client host.  What
 
526
        should be done in that case (if restarting the server program
 
527
        really is necessary) is to stop the server program, edit the
 
528
        configuration file to omit any suspect clients, and restart
 
529
        the server program.
 
530
      </para>
 
531
      <para>
642
532
        For more details on client-side security, see
643
533
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
644
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
649
539
  <refsect1 id="see_also">
650
540
    <title>SEE ALSO</title>
651
541
    <para>
652
 
      <citerefentry><refentrytitle>intro</refentrytitle>
653
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
654
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
 
      <manvolnum>5</manvolnum></citerefentry>,
656
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
 
      <manvolnum>5</manvolnum></citerefentry>,
658
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
659
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
660
 
      <citerefentry><refentrytitle>sh</refentrytitle>
661
 
      <manvolnum>1</manvolnum></citerefentry>
 
542
      <citerefentry>
 
543
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
544
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
545
        <refentrytitle>mandos.conf</refentrytitle>
 
546
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
547
        <refentrytitle>mandos-client</refentrytitle>
 
548
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
549
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
550
      </citerefentry>
662
551
    </para>
663
552
    <variablelist>
664
553
      <varlistentry>