/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: 2008-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2011-11-26">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-21">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
87
83
      <replaceable>DIRECTORY</replaceable></option></arg>
88
84
      <sbr/>
89
85
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <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
86
    </cmdsynopsis>
103
87
    <cmdsynopsis>
104
88
      <command>&COMMANDNAME;</command>
122
106
    <para>
123
107
      <command>&COMMANDNAME;</command> is a server daemon which
124
108
      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.
 
109
      client host computers.  The Mandos server uses Zeroconf to
 
110
      announce itself on the local network, and uses TLS to
 
111
      communicate securely with and to authenticate the clients.  The
 
112
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
113
      link-local addresses, since the clients will probably not have
 
114
      any other addresses configured (see <xref linkend="overview"/>).
 
115
      Any authenticated client is then given the stored pre-encrypted
 
116
      password for that specific client.
135
117
    </para>
136
118
  </refsect1>
137
119
  
206
188
      </varlistentry>
207
189
      
208
190
      <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
191
        <term><option>--priority <replaceable>
228
192
        PRIORITY</replaceable></option></term>
229
193
        <listitem>
263
227
          </para>
264
228
        </listitem>
265
229
      </varlistentry>
266
 
      
267
 
      <varlistentry>
268
 
        <term><option>--no-dbus</option></term>
269
 
        <listitem>
270
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
271
 
          <para>
272
 
            See also <xref linkend="dbus_interface"/>.
273
 
          </para>
274
 
        </listitem>
275
 
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-ipv6</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
 
        </listitem>
282
 
      </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
230
    </variablelist>
299
231
  </refsect1>
300
232
  
372
304
      The server will, by default, continually check that the clients
373
305
      are still up.  If a client has not been confirmed as being up
374
306
      for some time, the client is assumed to be compromised and is no
375
 
      longer eligible to receive the encrypted password.  (Manual
376
 
      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>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
383
 
    </para>
384
 
  </refsect1>
385
 
  
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>
 
307
      longer eligible to receive the encrypted password.  The timeout,
 
308
      checker program, and interval between checks can be configured
 
309
      both globally and per client; see <citerefentry>
393
310
      <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
 
    
 
311
      <manvolnum>5</manvolnum></citerefentry>.
 
312
    </para>
404
313
  </refsect1>
405
314
  
406
315
  <refsect1 id="logging">
407
316
    <title>LOGGING</title>
408
317
    <para>
409
318
      The server will send log message with various severity levels to
410
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
319
      <filename>/dev/log</filename>.  With the
411
320
      <option>--debug</option> option, it will log even more messages,
412
321
      and also show them on the console.
413
322
    </para>
414
323
  </refsect1>
415
324
  
416
 
  <refsect1 id="dbus_interface">
417
 
    <title>D-BUS INTERFACE</title>
418
 
    <para>
419
 
      The server will by default provide a D-Bus system bus interface.
420
 
      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>.
423
 
    </para>
424
 
  </refsect1>
425
 
  
426
325
  <refsect1 id="exit_status">
427
326
    <title>EXIT STATUS</title>
428
327
    <para>
451
350
    </variablelist>
452
351
  </refsect1>
453
352
  
454
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
455
354
    <title>FILES</title>
456
355
    <para>
457
356
      Use the <option>--configdir</option> option to change where
483
382
        <term><filename>/var/run/mandos.pid</filename></term>
484
383
        <listitem>
485
384
          <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 class="devicefile">/dev/log</filename></term>
493
 
      </varlistentry>
494
 
      <varlistentry>
495
 
        <term><filename
496
 
        class="directory">/var/lib/mandos</filename></term>
497
 
        <listitem>
498
 
          <para>
499
 
            Directory where persistent state will be saved.  Change
500
 
            this with the <option>--statedir</option> option.  See
501
 
            also the <option>--no-restore</option> option.
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
502
387
          </para>
503
388
        </listitem>
504
389
      </varlistentry>
532
417
      backtrace.  This could be considered a feature.
533
418
    </para>
534
419
    <para>
 
420
      Currently, if a client is declared <quote>invalid</quote> due to
 
421
      having timed out, the server does not record this fact onto
 
422
      permanent storage.  This has some security implications, see
 
423
      <xref linkend="CLIENTS"/>.
 
424
    </para>
 
425
    <para>
 
426
      There is currently no way of querying the server of the current
 
427
      status of clients, other than analyzing its <systemitem
 
428
      class="service">syslog</systemitem> output.
 
429
    </para>
 
430
    <para>
535
431
      There is no fine-grained control over logging and debug output.
536
432
    </para>
537
433
    <para>
538
434
      Debug mode is conflated with running in the foreground.
539
435
    </para>
540
436
    <para>
 
437
      The console log messages does not show a time stamp.
 
438
    </para>
 
439
    <para>
541
440
      This server does not check the expire time of clients’ OpenPGP
542
441
      keys.
543
442
    </para>
556
455
    <informalexample>
557
456
      <para>
558
457
        Run the server in debug mode, read configuration files from
559
 
        the <filename class="directory">~/mandos</filename> directory,
560
 
        and use the Zeroconf service name <quote>Test</quote> to not
561
 
        collide with any other official Mandos server on this host:
 
458
        the <filename>~/mandos</filename> directory, and use the
 
459
        Zeroconf service name <quote>Test</quote> to not collide with
 
460
        any other official Mandos server on this host:
562
461
      </para>
563
462
      <para>
564
463
 
583
482
  
584
483
  <refsect1 id="security">
585
484
    <title>SECURITY</title>
586
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
587
486
      <title>SERVER</title>
588
487
      <para>
589
488
        Running this <command>&COMMANDNAME;</command> server program
592
491
        soon after startup.
593
492
      </para>
594
493
    </refsect2>
595
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
596
495
      <title>CLIENTS</title>
597
496
      <para>
598
497
        The server only gives out its stored data to clients which
613
512
        compromised if they are gone for too long.
614
513
      </para>
615
514
      <para>
 
515
        If a client is compromised, its downtime should be duly noted
 
516
        by the server which would therefore declare the client
 
517
        invalid.  But if the server was ever restarted, it would
 
518
        re-read its client list from its configuration file and again
 
519
        regard all clients therein as valid, and hence eligible to
 
520
        receive their passwords.  Therefore, be careful when
 
521
        restarting servers if it is suspected that a client has, in
 
522
        fact, been compromised by parties who may now be running a
 
523
        fake Mandos client with the keys from the non-encrypted
 
524
        initial <acronym>RAM</acronym> image of the client host.  What
 
525
        should be done in that case (if restarting the server program
 
526
        really is necessary) is to stop the server program, edit the
 
527
        configuration file to omit any suspect clients, and restart
 
528
        the server program.
 
529
      </para>
 
530
      <para>
616
531
        For more details on client-side security, see
617
532
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
618
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
623
538
  <refsect1 id="see_also">
624
539
    <title>SEE ALSO</title>
625
540
    <para>
626
 
      <citerefentry><refentrytitle>intro</refentrytitle>
627
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
628
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
 
      <manvolnum>5</manvolnum></citerefentry>,
630
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
 
      <manvolnum>5</manvolnum></citerefentry>,
632
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
633
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
634
 
      <citerefentry><refentrytitle>sh</refentrytitle>
635
 
      <manvolnum>1</manvolnum></citerefentry>
 
541
      <citerefentry>
 
542
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
544
        <refentrytitle>mandos.conf</refentrytitle>
 
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
546
        <refentrytitle>mandos-client</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
636
550
    </para>
637
551
    <variablelist>
638
552
      <varlistentry>