/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: 2014-01-21 21:04:25 UTC
  • mto: This revision was merged to the branch mainline in revision 653.
  • Revision ID: teddy@recompile.se-20140121210425-j1bgxxghrb751jej
Tags: version-1.6.3-1
* Makefile (version): Changed to "1.3.2".
* NEWS (Version 1.6.3): New entry.
* debian/changelog (1.6.3-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY TIMESTAMP "2013-10-26">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
34
40
      <holder>Teddy Hogeborn</holder>
35
41
      <holder>Björn Påhlsson</holder>
36
42
    </copyright>
83
89
      <replaceable>DIRECTORY</replaceable></option></arg>
84
90
      <sbr/>
85
91
      <arg><option>--debug</option></arg>
 
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
 
98
      <arg><option>--no-ipv6</option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-restore</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--statedir
 
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
86
109
    </cmdsynopsis>
87
110
    <cmdsynopsis>
88
111
      <command>&COMMANDNAME;</command>
106
129
    <para>
107
130
      <command>&COMMANDNAME;</command> is a server daemon which
108
131
      handles incoming request for passwords for a pre-defined list of
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.
 
132
      client host computers. For an introduction, see
 
133
      <citerefentry><refentrytitle>intro</refentrytitle>
 
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
135
      uses Zeroconf to announce itself on the local network, and uses
 
136
      TLS to communicate securely with and to authenticate the
 
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
138
      use IPv6 link-local addresses, since the clients will probably
 
139
      not have any other addresses configured (see <xref
 
140
      linkend="overview"/>).  Any authenticated client is then given
 
141
      the stored pre-encrypted password for that specific client.
117
142
    </para>
118
143
  </refsect1>
119
144
  
188
213
      </varlistentry>
189
214
      
190
215
      <varlistentry>
 
216
        <term><option>--debuglevel
 
217
        <replaceable>LEVEL</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Set the debugging log level.
 
221
            <replaceable>LEVEL</replaceable> is a string, one of
 
222
            <quote><literal>CRITICAL</literal></quote>,
 
223
            <quote><literal>ERROR</literal></quote>,
 
224
            <quote><literal>WARNING</literal></quote>,
 
225
            <quote><literal>INFO</literal></quote>, or
 
226
            <quote><literal>DEBUG</literal></quote>, in order of
 
227
            increasing verbosity.  The default level is
 
228
            <quote><literal>WARNING</literal></quote>.
 
229
          </para>
 
230
        </listitem>
 
231
      </varlistentry>
 
232
      
 
233
      <varlistentry>
191
234
        <term><option>--priority <replaceable>
192
235
        PRIORITY</replaceable></option></term>
193
236
        <listitem>
194
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="mandos-options.xml"
 
238
                      xpointer="priority_compat"/>
195
239
        </listitem>
196
240
      </varlistentry>
197
241
      
227
271
          </para>
228
272
        </listitem>
229
273
      </varlistentry>
 
274
      
 
275
      <varlistentry>
 
276
        <term><option>--no-dbus</option></term>
 
277
        <listitem>
 
278
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
279
          <para>
 
280
            See also <xref linkend="dbus_interface"/>.
 
281
          </para>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-ipv6</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
289
        </listitem>
 
290
      </varlistentry>
 
291
      
 
292
      <varlistentry>
 
293
        <term><option>--no-restore</option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
296
          <para>
 
297
            See also <xref linkend="persistent_state"/>.
 
298
          </para>
 
299
        </listitem>
 
300
      </varlistentry>
 
301
      
 
302
      <varlistentry>
 
303
        <term><option>--statedir
 
304
        <replaceable>DIRECTORY</replaceable></option></term>
 
305
        <listitem>
 
306
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
307
        </listitem>
 
308
      </varlistentry>
 
309
      
 
310
      <varlistentry>
 
311
        <term><option>--socket
 
312
        <replaceable>FD</replaceable></option></term>
 
313
        <listitem>
 
314
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
315
        </listitem>
 
316
      </varlistentry>
 
317
      
 
318
      <varlistentry>
 
319
        <term><option>--foreground</option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml"
 
322
                      xpointer="foreground"/>
 
323
        </listitem>
 
324
      </varlistentry>
 
325
      
230
326
    </variablelist>
231
327
  </refsect1>
232
328
  
304
400
      The server will, by default, continually check that the clients
305
401
      are still up.  If a client has not been confirmed as being up
306
402
      for some time, the client is assumed to be compromised and is no
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>
 
403
      longer eligible to receive the encrypted password.  (Manual
 
404
      intervention is required to re-enable a client.)  The timeout,
 
405
      extended timeout, checker program, and interval between checks
 
406
      can be configured both globally and per client; see
 
407
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
408
      <manvolnum>5</manvolnum></citerefentry>.
 
409
    </para>
 
410
  </refsect1>
 
411
  
 
412
  <refsect1 id="approval">
 
413
    <title>APPROVAL</title>
 
414
    <para>
 
415
      The server can be configured to require manual approval for a
 
416
      client before it is sent its secret.  The delay to wait for such
 
417
      approval and the default action (approve or deny) can be
 
418
      configured both globally and per client; see <citerefentry>
310
419
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
420
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
421
      will be approved immediately without delay.
 
422
    </para>
 
423
    <para>
 
424
      This can be used to deny a client its secret if not manually
 
425
      approved within a specified time.  It can also be used to make
 
426
      the server delay before giving a client its secret, allowing
 
427
      optional manual denying of this specific client.
 
428
    </para>
 
429
    
313
430
  </refsect1>
314
431
  
315
432
  <refsect1 id="logging">
316
433
    <title>LOGGING</title>
317
434
    <para>
318
435
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
436
      <filename class="devicefile">/dev/log</filename>.  With the
320
437
      <option>--debug</option> option, it will log even more messages,
321
438
      and also show them on the console.
322
439
    </para>
323
440
  </refsect1>
324
441
  
 
442
  <refsect1 id="persistent_state">
 
443
    <title>PERSISTENT STATE</title>
 
444
    <para>
 
445
      Client settings, initially read from
 
446
      <filename>clients.conf</filename>, are persistent across
 
447
      restarts, and run-time changes will override settings in
 
448
      <filename>clients.conf</filename>.  However, if a setting is
 
449
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
450
      <filename>clients.conf</filename>, this will take precedence.
 
451
    </para>
 
452
  </refsect1>
 
453
  
 
454
  <refsect1 id="dbus_interface">
 
455
    <title>D-BUS INTERFACE</title>
 
456
    <para>
 
457
      The server will by default provide a D-Bus system bus interface.
 
458
      This interface will only be accessible by the root user or a
 
459
      Mandos-specific user, if such a user exists.  For documentation
 
460
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
461
    </para>
 
462
  </refsect1>
 
463
  
325
464
  <refsect1 id="exit_status">
326
465
    <title>EXIT STATUS</title>
327
466
    <para>
350
489
    </variablelist>
351
490
  </refsect1>
352
491
  
353
 
  <refsect1 id="file">
 
492
  <refsect1 id="files">
354
493
    <title>FILES</title>
355
494
    <para>
356
495
      Use the <option>--configdir</option> option to change where
379
518
        </listitem>
380
519
      </varlistentry>
381
520
      <varlistentry>
382
 
        <term><filename>/var/run/mandos.pid</filename></term>
383
 
        <listitem>
384
 
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
521
        <term><filename>/run/mandos.pid</filename></term>
 
522
        <listitem>
 
523
          <para>
 
524
            The file containing the process id of the
 
525
            <command>&COMMANDNAME;</command> process started last.
 
526
            <emphasis >Note:</emphasis> If the <filename
 
527
            class="directory">/run</filename> directory does not
 
528
            exist, <filename>/var/run/mandos.pid</filename> will be
 
529
            used instead.
 
530
          </para>
 
531
        </listitem>
 
532
      </varlistentry>
 
533
      <varlistentry>
 
534
        <term><filename class="devicefile">/dev/log</filename></term>
 
535
      </varlistentry>
 
536
      <varlistentry>
 
537
        <term><filename
 
538
        class="directory">/var/lib/mandos</filename></term>
 
539
        <listitem>
 
540
          <para>
 
541
            Directory where persistent state will be saved.  Change
 
542
            this with the <option>--statedir</option> option.  See
 
543
            also the <option>--no-restore</option> option.
387
544
          </para>
388
545
        </listitem>
389
546
      </varlistentry>
417
574
      backtrace.  This could be considered a feature.
418
575
    </para>
419
576
    <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>
431
577
      There is no fine-grained control over logging and debug output.
432
578
    </para>
433
579
    <para>
434
 
      Debug mode is conflated with running in the foreground.
435
 
    </para>
436
 
    <para>
437
 
      The console log messages does not show a time stamp.
438
 
    </para>
439
 
    <para>
440
580
      This server does not check the expire time of clients’ OpenPGP
441
581
      keys.
442
582
    </para>
455
595
    <informalexample>
456
596
      <para>
457
597
        Run the server in debug mode, read configuration files from
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:
 
598
        the <filename class="directory">~/mandos</filename> directory,
 
599
        and use the Zeroconf service name <quote>Test</quote> to not
 
600
        collide with any other official Mandos server on this host:
461
601
      </para>
462
602
      <para>
463
603
 
482
622
  
483
623
  <refsect1 id="security">
484
624
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
625
    <refsect2 id="server">
486
626
      <title>SERVER</title>
487
627
      <para>
488
628
        Running this <command>&COMMANDNAME;</command> server program
491
631
        soon after startup.
492
632
      </para>
493
633
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
634
    <refsect2 id="clients">
495
635
      <title>CLIENTS</title>
496
636
      <para>
497
637
        The server only gives out its stored data to clients which
504
644
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
645
        <manvolnum>5</manvolnum></citerefentry>)
506
646
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
647
        except the user starting the server (usually root).
508
648
      </para>
509
649
      <para>
510
650
        As detailed in <xref linkend="checking"/>, the status of all
512
652
        compromised if they are gone for too long.
513
653
      </para>
514
654
      <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>
531
655
        For more details on client-side security, see
532
656
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
657
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
662
  <refsect1 id="see_also">
539
663
    <title>SEE ALSO</title>
540
664
    <para>
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>
 
665
      <citerefentry><refentrytitle>intro</refentrytitle>
 
666
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
667
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
668
      <manvolnum>5</manvolnum></citerefentry>,
 
669
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
670
      <manvolnum>5</manvolnum></citerefentry>,
 
671
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
672
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
673
      <citerefentry><refentrytitle>sh</refentrytitle>
 
674
      <manvolnum>1</manvolnum></citerefentry>
550
675
    </para>
551
676
    <variablelist>
552
677
      <varlistentry>