/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

* Makefile (install-server): Add intro(8mandos) man page.
* network-hooks.d/bridge: Add copyright info and year.
* network-hooks.d/openvpn: - '' -
* network-hooks.d/wireless: - '' -

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 "2009-09-10">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.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
      <year>2012</year>
36
39
      <holder>Teddy Hogeborn</holder>
37
40
      <holder>Björn Påhlsson</holder>
38
41
    </copyright>
86
89
      <sbr/>
87
90
      <arg><option>--debug</option></arg>
88
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
89
95
      <arg><option>--no-dbus</option></arg>
90
96
      <sbr/>
91
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>
92
103
    </cmdsynopsis>
93
104
    <cmdsynopsis>
94
105
      <command>&COMMANDNAME;</command>
112
123
    <para>
113
124
      <command>&COMMANDNAME;</command> is a server daemon which
114
125
      handles incoming request for passwords for a pre-defined list of
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.
 
126
      client host computers. For an introduction, see
 
127
      <citerefentry><refentrytitle>intro</refentrytitle>
 
128
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
129
      uses Zeroconf to announce itself on the local network, and uses
 
130
      TLS to communicate securely with and to authenticate the
 
131
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
132
      use IPv6 link-local addresses, since the clients will probably
 
133
      not have any other addresses configured (see <xref
 
134
      linkend="overview"/>).  Any authenticated client is then given
 
135
      the stored pre-encrypted password for that specific client.
123
136
    </para>
124
137
  </refsect1>
125
138
  
194
207
      </varlistentry>
195
208
      
196
209
      <varlistentry>
 
210
        <term><option>--debuglevel
 
211
        <replaceable>LEVEL</replaceable></option></term>
 
212
        <listitem>
 
213
          <para>
 
214
            Set the debugging log level.
 
215
            <replaceable>LEVEL</replaceable> is a string, one of
 
216
            <quote><literal>CRITICAL</literal></quote>,
 
217
            <quote><literal>ERROR</literal></quote>,
 
218
            <quote><literal>WARNING</literal></quote>,
 
219
            <quote><literal>INFO</literal></quote>, or
 
220
            <quote><literal>DEBUG</literal></quote>, in order of
 
221
            increasing verbosity.  The default level is
 
222
            <quote><literal>WARNING</literal></quote>.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
 
227
      <varlistentry>
197
228
        <term><option>--priority <replaceable>
198
229
        PRIORITY</replaceable></option></term>
199
230
        <listitem>
250
281
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
282
        </listitem>
252
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-restore</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
253
302
    </variablelist>
254
303
  </refsect1>
255
304
  
329
378
      for some time, the client is assumed to be compromised and is no
330
379
      longer eligible to receive the encrypted password.  (Manual
331
380
      intervention is required to re-enable a client.)  The timeout,
332
 
      checker program, and interval between checks can be configured
333
 
      both globally and per client; see <citerefentry>
 
381
      extended timeout, checker program, and interval between checks
 
382
      can be configured both globally and per client; see
 
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
384
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
385
      receiving its password will also be treated as a successful
 
386
      checker run.
 
387
    </para>
 
388
  </refsect1>
 
389
  
 
390
  <refsect1 id="approval">
 
391
    <title>APPROVAL</title>
 
392
    <para>
 
393
      The server can be configured to require manual approval for a
 
394
      client before it is sent its secret.  The delay to wait for such
 
395
      approval and the default action (approve or deny) can be
 
396
      configured both globally and per client; see <citerefentry>
334
397
      <refentrytitle>mandos-clients.conf</refentrytitle>
335
 
      <manvolnum>5</manvolnum></citerefentry>.
336
 
    </para>
 
398
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
399
      will be approved immediately without delay.
 
400
    </para>
 
401
    <para>
 
402
      This can be used to deny a client its secret if not manually
 
403
      approved within a specified time.  It can also be used to make
 
404
      the server delay before giving a client its secret, allowing
 
405
      optional manual denying of this specific client.
 
406
    </para>
 
407
    
337
408
  </refsect1>
338
409
  
339
410
  <refsect1 id="logging">
340
411
    <title>LOGGING</title>
341
412
    <para>
342
413
      The server will send log message with various severity levels to
343
 
      <filename>/dev/log</filename>.  With the
 
414
      <filename class="devicefile">/dev/log</filename>.  With the
344
415
      <option>--debug</option> option, it will log even more messages,
345
416
      and also show them on the console.
346
417
    </para>
347
418
  </refsect1>
348
419
  
 
420
  <refsect1 id="persistent_state">
 
421
    <title>PERSISTENT STATE</title>
 
422
    <para>
 
423
      Client settings, initially read from
 
424
      <filename>clients.conf</filename>, are persistent across
 
425
      restarts, and run-time changes will override settings in
 
426
      <filename>clients.conf</filename>.  However, if a setting is
 
427
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
428
      <filename>clients.conf</filename>, this will take precedence.
 
429
    </para>
 
430
  </refsect1>
 
431
  
349
432
  <refsect1 id="dbus_interface">
350
433
    <title>D-BUS INTERFACE</title>
351
434
    <para>
352
435
      The server will by default provide a D-Bus system bus interface.
353
436
      This interface will only be accessible by the root user or a
354
 
      Mandos-specific user, if such a user exists.
355
 
      <!-- XXX -->
 
437
      Mandos-specific user, if such a user exists.  For documentation
 
438
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
356
439
    </para>
357
440
  </refsect1>
358
441
  
416
499
        <term><filename>/var/run/mandos.pid</filename></term>
417
500
        <listitem>
418
501
          <para>
419
 
            The file containing the process id of
420
 
            <command>&COMMANDNAME;</command>.
 
502
            The file containing the process id of the
 
503
            <command>&COMMANDNAME;</command> process started last.
 
504
          </para>
 
505
        </listitem>
 
506
      </varlistentry>
 
507
      <varlistentry>
 
508
        <term><filename class="devicefile">/dev/log</filename></term>
 
509
      </varlistentry>
 
510
      <varlistentry>
 
511
        <term><filename
 
512
        class="directory">/var/lib/mandos</filename></term>
 
513
        <listitem>
 
514
          <para>
 
515
            Directory where persistent state will be saved.  Change
 
516
            this with the <option>--statedir</option> option.  See
 
517
            also the <option>--no-restore</option> option.
421
518
          </para>
422
519
        </listitem>
423
520
      </varlistentry>
451
548
      backtrace.  This could be considered a feature.
452
549
    </para>
453
550
    <para>
454
 
      Currently, if a client is declared <quote>invalid</quote> due to
455
 
      having timed out, the server does not record this fact onto
456
 
      permanent storage.  This has some security implications, see
457
 
      <xref linkend="clients"/>.
458
 
    </para>
459
 
    <para>
460
 
      There is currently no way of querying the server of the current
461
 
      status of clients, other than analyzing its <systemitem
462
 
      class="service">syslog</systemitem> output.
463
 
    </para>
464
 
    <para>
465
551
      There is no fine-grained control over logging and debug output.
466
552
    </para>
467
553
    <para>
468
554
      Debug mode is conflated with running in the foreground.
469
555
    </para>
470
556
    <para>
471
 
      The console log messages do not show a time stamp.
472
 
    </para>
473
 
    <para>
474
557
      This server does not check the expire time of clients’ OpenPGP
475
558
      keys.
476
559
    </para>
489
572
    <informalexample>
490
573
      <para>
491
574
        Run the server in debug mode, read configuration files from
492
 
        the <filename>~/mandos</filename> directory, and use the
493
 
        Zeroconf service name <quote>Test</quote> to not collide with
494
 
        any other official Mandos server on this host:
 
575
        the <filename class="directory">~/mandos</filename> directory,
 
576
        and use the Zeroconf service name <quote>Test</quote> to not
 
577
        collide with any other official Mandos server on this host:
495
578
      </para>
496
579
      <para>
497
580
 
546
629
        compromised if they are gone for too long.
547
630
      </para>
548
631
      <para>
549
 
        If a client is compromised, its downtime should be duly noted
550
 
        by the server which would therefore declare the client
551
 
        invalid.  But if the server was ever restarted, it would
552
 
        re-read its client list from its configuration file and again
553
 
        regard all clients therein as valid, and hence eligible to
554
 
        receive their passwords.  Therefore, be careful when
555
 
        restarting servers if it is suspected that a client has, in
556
 
        fact, been compromised by parties who may now be running a
557
 
        fake Mandos client with the keys from the non-encrypted
558
 
        initial <acronym>RAM</acronym> image of the client host.  What
559
 
        should be done in that case (if restarting the server program
560
 
        really is necessary) is to stop the server program, edit the
561
 
        configuration file to omit any suspect clients, and restart
562
 
        the server program.
563
 
      </para>
564
 
      <para>
565
632
        For more details on client-side security, see
566
633
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
567
634
        <manvolnum>8mandos</manvolnum></citerefentry>.
572
639
  <refsect1 id="see_also">
573
640
    <title>SEE ALSO</title>
574
641
    <para>
575
 
      <citerefentry>
576
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
577
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
 
        <refentrytitle>mandos.conf</refentrytitle>
579
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
 
        <refentrytitle>mandos-client</refentrytitle>
581
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
 
      </citerefentry>
 
642
      <citerefentry><refentrytitle>intro</refentrytitle>
 
643
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
644
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
645
      <manvolnum>5</manvolnum></citerefentry>,
 
646
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
647
      <manvolnum>5</manvolnum></citerefentry>,
 
648
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
649
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
650
      <citerefentry><refentrytitle>sh</refentrytitle>
 
651
      <manvolnum>1</manvolnum></citerefentry>
584
652
    </para>
585
653
    <variablelist>
586
654
      <varlistentry>