/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-18 11:17:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081018111722-jtbz35c031lxuuc9
* debian/mandos-client.docs (NEWS): Added.
* debian/mandos.docs (NEWS): - '' -

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 "2014-06-15">
 
5
<!ENTITY TIMESTAMP "2008-10-03">
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
 
      <year>2013</year>
40
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
89
84
      <replaceable>DIRECTORY</replaceable></option></arg>
90
85
      <sbr/>
91
86
      <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>
109
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
111
87
    </cmdsynopsis>
112
88
    <cmdsynopsis>
113
89
      <command>&COMMANDNAME;</command>
131
107
    <para>
132
108
      <command>&COMMANDNAME;</command> is a server daemon which
133
109
      handles incoming request for passwords for a pre-defined list of
134
 
      client host computers. For an introduction, see
135
 
      <citerefentry><refentrytitle>intro</refentrytitle>
136
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
 
      uses Zeroconf to announce itself on the local network, and uses
138
 
      TLS to communicate securely with and to authenticate the
139
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
140
 
      use IPv6 link-local addresses, since the clients will probably
141
 
      not have any other addresses configured (see <xref
142
 
      linkend="overview"/>).  Any authenticated client is then given
143
 
      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.
144
118
    </para>
145
119
  </refsect1>
146
120
  
215
189
      </varlistentry>
216
190
      
217
191
      <varlistentry>
218
 
        <term><option>--debuglevel
219
 
        <replaceable>LEVEL</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            Set the debugging log level.
223
 
            <replaceable>LEVEL</replaceable> is a string, one of
224
 
            <quote><literal>CRITICAL</literal></quote>,
225
 
            <quote><literal>ERROR</literal></quote>,
226
 
            <quote><literal>WARNING</literal></quote>,
227
 
            <quote><literal>INFO</literal></quote>, or
228
 
            <quote><literal>DEBUG</literal></quote>, in order of
229
 
            increasing verbosity.  The default level is
230
 
            <quote><literal>WARNING</literal></quote>.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
      
235
 
      <varlistentry>
236
192
        <term><option>--priority <replaceable>
237
193
        PRIORITY</replaceable></option></term>
238
194
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
195
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
196
        </listitem>
242
197
      </varlistentry>
243
198
      
273
228
          </para>
274
229
        </listitem>
275
230
      </varlistentry>
276
 
      
277
 
      <varlistentry>
278
 
        <term><option>--no-dbus</option></term>
279
 
        <listitem>
280
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
281
 
          <para>
282
 
            See also <xref linkend="dbus_interface"/>.
283
 
          </para>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      
287
 
      <varlistentry>
288
 
        <term><option>--no-ipv6</option></term>
289
 
        <listitem>
290
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
 
        </listitem>
292
 
      </varlistentry>
293
 
      
294
 
      <varlistentry>
295
 
        <term><option>--no-restore</option></term>
296
 
        <listitem>
297
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
298
 
          <para>
299
 
            See also <xref linkend="persistent_state"/>.
300
 
          </para>
301
 
        </listitem>
302
 
      </varlistentry>
303
 
      
304
 
      <varlistentry>
305
 
        <term><option>--statedir
306
 
        <replaceable>DIRECTORY</replaceable></option></term>
307
 
        <listitem>
308
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
 
        </listitem>
310
 
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--socket
314
 
        <replaceable>FD</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--foreground</option></term>
322
 
        <listitem>
323
 
          <xi:include href="mandos-options.xml"
324
 
                      xpointer="foreground"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--no-zeroconf</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
      
335
231
    </variablelist>
336
232
  </refsect1>
337
233
  
409
305
      The server will, by default, continually check that the clients
410
306
      are still up.  If a client has not been confirmed as being up
411
307
      for some time, the client is assumed to be compromised and is no
412
 
      longer eligible to receive the encrypted password.  (Manual
413
 
      intervention is required to re-enable a client.)  The timeout,
414
 
      extended timeout, checker program, and interval between checks
415
 
      can be configured both globally and per client; see
416
 
      <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>
417
312
      <manvolnum>5</manvolnum></citerefentry>.
418
313
    </para>
419
314
  </refsect1>
420
315
  
421
 
  <refsect1 id="approval">
422
 
    <title>APPROVAL</title>
423
 
    <para>
424
 
      The server can be configured to require manual approval for a
425
 
      client before it is sent its secret.  The delay to wait for such
426
 
      approval and the default action (approve or deny) can be
427
 
      configured both globally and per client; see <citerefentry>
428
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
429
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
430
 
      will be approved immediately without delay.
431
 
    </para>
432
 
    <para>
433
 
      This can be used to deny a client its secret if not manually
434
 
      approved within a specified time.  It can also be used to make
435
 
      the server delay before giving a client its secret, allowing
436
 
      optional manual denying of this specific client.
437
 
    </para>
438
 
    
439
 
  </refsect1>
440
 
  
441
316
  <refsect1 id="logging">
442
317
    <title>LOGGING</title>
443
318
    <para>
444
319
      The server will send log message with various severity levels to
445
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
320
      <filename>/dev/log</filename>.  With the
446
321
      <option>--debug</option> option, it will log even more messages,
447
322
      and also show them on the console.
448
323
    </para>
449
324
  </refsect1>
450
325
  
451
 
  <refsect1 id="persistent_state">
452
 
    <title>PERSISTENT STATE</title>
453
 
    <para>
454
 
      Client settings, initially read from
455
 
      <filename>clients.conf</filename>, are persistent across
456
 
      restarts, and run-time changes will override settings in
457
 
      <filename>clients.conf</filename>.  However, if a setting is
458
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
459
 
      <filename>clients.conf</filename>, this will take precedence.
460
 
    </para>
461
 
  </refsect1>
462
 
  
463
 
  <refsect1 id="dbus_interface">
464
 
    <title>D-BUS INTERFACE</title>
465
 
    <para>
466
 
      The server will by default provide a D-Bus system bus interface.
467
 
      This interface will only be accessible by the root user or a
468
 
      Mandos-specific user, if such a user exists.  For documentation
469
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
470
 
    </para>
471
 
  </refsect1>
472
 
  
473
326
  <refsect1 id="exit_status">
474
327
    <title>EXIT STATUS</title>
475
328
    <para>
527
380
        </listitem>
528
381
      </varlistentry>
529
382
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
531
 
        <listitem>
532
 
          <para>
533
 
            The file containing the process id of the
534
 
            <command>&COMMANDNAME;</command> process started last.
535
 
            <emphasis >Note:</emphasis> If the <filename
536
 
            class="directory">/run</filename> directory does not
537
 
            exist, <filename>/var/run/mandos.pid</filename> will be
538
 
            used instead.
539
 
          </para>
540
 
        </listitem>
541
 
      </varlistentry>
542
 
      <varlistentry>
543
 
        <term><filename class="devicefile">/dev/log</filename></term>
544
 
      </varlistentry>
545
 
      <varlistentry>
546
 
        <term><filename
547
 
        class="directory">/var/lib/mandos</filename></term>
548
 
        <listitem>
549
 
          <para>
550
 
            Directory where persistent state will be saved.  Change
551
 
            this with the <option>--statedir</option> option.  See
552
 
            also the <option>--no-restore</option> option.
 
383
        <term><filename>/var/run/mandos.pid</filename></term>
 
384
        <listitem>
 
385
          <para>
 
386
            The file containing the process id of
 
387
            <command>&COMMANDNAME;</command>.
553
388
          </para>
554
389
        </listitem>
555
390
      </varlistentry>
583
418
      backtrace.  This could be considered a feature.
584
419
    </para>
585
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>
586
432
      There is no fine-grained control over logging and debug output.
587
433
    </para>
588
434
    <para>
 
435
      Debug mode is conflated with running in the foreground.
 
436
    </para>
 
437
    <para>
 
438
      The console log messages does not show a time stamp.
 
439
    </para>
 
440
    <para>
589
441
      This server does not check the expire time of clients’ OpenPGP
590
442
      keys.
591
443
    </para>
604
456
    <informalexample>
605
457
      <para>
606
458
        Run the server in debug mode, read configuration files from
607
 
        the <filename class="directory">~/mandos</filename> directory,
608
 
        and use the Zeroconf service name <quote>Test</quote> to not
609
 
        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:
610
462
      </para>
611
463
      <para>
612
464
 
661
513
        compromised if they are gone for too long.
662
514
      </para>
663
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>
664
532
        For more details on client-side security, see
665
533
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
666
534
        <manvolnum>8mandos</manvolnum></citerefentry>.
671
539
  <refsect1 id="see_also">
672
540
    <title>SEE ALSO</title>
673
541
    <para>
674
 
      <citerefentry><refentrytitle>intro</refentrytitle>
675
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
676
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
 
      <manvolnum>5</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
681
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>sh</refentrytitle>
683
 
      <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>
684
551
    </para>
685
552
    <variablelist>
686
553
      <varlistentry>