/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: 2013-10-22 19:24:01 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 305.
  • Revision ID: teddy@recompile.se-20131022192401-op6mwsb7f7gygjyh
http://bugs.debian.org/702120
* mandos (priority): Bug fix: Add even more magic to make the old
                     DSA/ELG 2048-bit keys work with GnuTLS.
* mandos-keygen (KEYCOMMENT): Changed default to "".
* mandos-keygen (OPTIONS): Document new default value of "--comment".
* mandos-options.xml (priority): Document new default value.
* mandos.conf (priority): - '' -

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-17">
 
5
<!ENTITY TIMESTAMP "2013-10-20">
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>
 
39
      <year>2013</year>
36
40
      <holder>Teddy Hogeborn</holder>
37
41
      <holder>Björn Påhlsson</holder>
38
42
    </copyright>
86
90
      <sbr/>
87
91
      <arg><option>--debug</option></arg>
88
92
      <sbr/>
 
93
      <arg><option>--debuglevel
 
94
      <replaceable>LEVEL</replaceable></option></arg>
 
95
      <sbr/>
 
96
      <arg><option>--no-dbus</option></arg>
 
97
      <sbr/>
89
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>
90
109
    </cmdsynopsis>
91
110
    <cmdsynopsis>
92
111
      <command>&COMMANDNAME;</command>
110
129
    <para>
111
130
      <command>&COMMANDNAME;</command> is a server daemon which
112
131
      handles incoming request for passwords for a pre-defined list of
113
 
      client host computers.  The Mandos server uses Zeroconf to
114
 
      announce itself on the local network, and uses TLS to
115
 
      communicate securely with and to authenticate the clients.  The
116
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
 
      link-local addresses, since the clients will probably not have
118
 
      any other addresses configured (see <xref linkend="overview"/>).
119
 
      Any authenticated client is then given the stored pre-encrypted
120
 
      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.
121
142
    </para>
122
143
  </refsect1>
123
144
  
192
213
      </varlistentry>
193
214
      
194
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>
195
234
        <term><option>--priority <replaceable>
196
235
        PRIORITY</replaceable></option></term>
197
236
        <listitem>
233
272
      </varlistentry>
234
273
      
235
274
      <varlistentry>
 
275
        <term><option>--no-dbus</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
278
          <para>
 
279
            See also <xref linkend="dbus_interface"/>.
 
280
          </para>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
236
285
        <term><option>--no-ipv6</option></term>
237
286
        <listitem>
238
287
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
288
        </listitem>
240
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--no-restore</option></term>
 
293
        <listitem>
 
294
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
295
          <para>
 
296
            See also <xref linkend="persistent_state"/>.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
      
 
301
      <varlistentry>
 
302
        <term><option>--statedir
 
303
        <replaceable>DIRECTORY</replaceable></option></term>
 
304
        <listitem>
 
305
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
306
        </listitem>
 
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--socket
 
311
        <replaceable>FD</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--foreground</option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml"
 
321
                      xpointer="foreground"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
241
325
    </variablelist>
242
326
  </refsect1>
243
327
  
317
401
      for some time, the client is assumed to be compromised and is no
318
402
      longer eligible to receive the encrypted password.  (Manual
319
403
      intervention is required to re-enable a client.)  The timeout,
320
 
      checker program, and interval between checks can be configured
321
 
      both globally and per client; see <citerefentry>
 
404
      extended timeout, checker program, and interval between checks
 
405
      can be configured both globally and per client; see
 
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
407
      <manvolnum>5</manvolnum></citerefentry>.
 
408
    </para>
 
409
  </refsect1>
 
410
  
 
411
  <refsect1 id="approval">
 
412
    <title>APPROVAL</title>
 
413
    <para>
 
414
      The server can be configured to require manual approval for a
 
415
      client before it is sent its secret.  The delay to wait for such
 
416
      approval and the default action (approve or deny) can be
 
417
      configured both globally and per client; see <citerefentry>
322
418
      <refentrytitle>mandos-clients.conf</refentrytitle>
323
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
324
 
      receiving its password will also be treated as a successful
325
 
      checker run.
326
 
    </para>
 
419
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
420
      will be approved immediately without delay.
 
421
    </para>
 
422
    <para>
 
423
      This can be used to deny a client its secret if not manually
 
424
      approved within a specified time.  It can also be used to make
 
425
      the server delay before giving a client its secret, allowing
 
426
      optional manual denying of this specific client.
 
427
    </para>
 
428
    
327
429
  </refsect1>
328
430
  
329
431
  <refsect1 id="logging">
330
432
    <title>LOGGING</title>
331
433
    <para>
332
434
      The server will send log message with various severity levels to
333
 
      <filename>/dev/log</filename>.  With the
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
334
436
      <option>--debug</option> option, it will log even more messages,
335
437
      and also show them on the console.
336
438
    </para>
337
439
  </refsect1>
338
440
  
 
441
  <refsect1 id="persistent_state">
 
442
    <title>PERSISTENT STATE</title>
 
443
    <para>
 
444
      Client settings, initially read from
 
445
      <filename>clients.conf</filename>, are persistent across
 
446
      restarts, and run-time changes will override settings in
 
447
      <filename>clients.conf</filename>.  However, if a setting is
 
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
449
      <filename>clients.conf</filename>, this will take precedence.
 
450
    </para>
 
451
  </refsect1>
 
452
  
 
453
  <refsect1 id="dbus_interface">
 
454
    <title>D-BUS INTERFACE</title>
 
455
    <para>
 
456
      The server will by default provide a D-Bus system bus interface.
 
457
      This interface will only be accessible by the root user or a
 
458
      Mandos-specific user, if such a user exists.  For documentation
 
459
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
460
    </para>
 
461
  </refsect1>
 
462
  
339
463
  <refsect1 id="exit_status">
340
464
    <title>EXIT STATUS</title>
341
465
    <para>
393
517
        </listitem>
394
518
      </varlistentry>
395
519
      <varlistentry>
396
 
        <term><filename>/var/run/mandos.pid</filename></term>
397
 
        <listitem>
398
 
          <para>
399
 
            The file containing the process id of
400
 
            <command>&COMMANDNAME;</command>.
 
520
        <term><filename>/run/mandos.pid</filename></term>
 
521
        <listitem>
 
522
          <para>
 
523
            The file containing the process id of the
 
524
            <command>&COMMANDNAME;</command> process started last.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
 
532
        <term><filename
 
533
        class="directory">/var/lib/mandos</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            Directory where persistent state will be saved.  Change
 
537
            this with the <option>--statedir</option> option.  See
 
538
            also the <option>--no-restore</option> option.
401
539
          </para>
402
540
        </listitem>
403
541
      </varlistentry>
431
569
      backtrace.  This could be considered a feature.
432
570
    </para>
433
571
    <para>
434
 
      Currently, if a client is declared <quote>invalid</quote> due to
435
 
      having timed out, the server does not record this fact onto
436
 
      permanent storage.  This has some security implications, see
437
 
      <xref linkend="clients"/>.
438
 
    </para>
439
 
    <para>
440
 
      There is currently no way of querying the server of the current
441
 
      status of clients, other than analyzing its <systemitem
442
 
      class="service">syslog</systemitem> output.
443
 
    </para>
444
 
    <para>
445
572
      There is no fine-grained control over logging and debug output.
446
573
    </para>
447
574
    <para>
448
 
      Debug mode is conflated with running in the foreground.
449
 
    </para>
450
 
    <para>
451
 
      The console log messages do not show a time stamp.
452
 
    </para>
453
 
    <para>
454
575
      This server does not check the expire time of clients’ OpenPGP
455
576
      keys.
456
577
    </para>
469
590
    <informalexample>
470
591
      <para>
471
592
        Run the server in debug mode, read configuration files from
472
 
        the <filename>~/mandos</filename> directory, and use the
473
 
        Zeroconf service name <quote>Test</quote> to not collide with
474
 
        any other official Mandos server on this host:
 
593
        the <filename class="directory">~/mandos</filename> directory,
 
594
        and use the Zeroconf service name <quote>Test</quote> to not
 
595
        collide with any other official Mandos server on this host:
475
596
      </para>
476
597
      <para>
477
598
 
526
647
        compromised if they are gone for too long.
527
648
      </para>
528
649
      <para>
529
 
        If a client is compromised, its downtime should be duly noted
530
 
        by the server which would therefore declare the client
531
 
        invalid.  But if the server was ever restarted, it would
532
 
        re-read its client list from its configuration file and again
533
 
        regard all clients therein as valid, and hence eligible to
534
 
        receive their passwords.  Therefore, be careful when
535
 
        restarting servers if it is suspected that a client has, in
536
 
        fact, been compromised by parties who may now be running a
537
 
        fake Mandos client with the keys from the non-encrypted
538
 
        initial <acronym>RAM</acronym> image of the client host.  What
539
 
        should be done in that case (if restarting the server program
540
 
        really is necessary) is to stop the server program, edit the
541
 
        configuration file to omit any suspect clients, and restart
542
 
        the server program.
543
 
      </para>
544
 
      <para>
545
650
        For more details on client-side security, see
546
651
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
547
652
        <manvolnum>8mandos</manvolnum></citerefentry>.
552
657
  <refsect1 id="see_also">
553
658
    <title>SEE ALSO</title>
554
659
    <para>
555
 
      <citerefentry>
556
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
557
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
558
 
        <refentrytitle>mandos.conf</refentrytitle>
559
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
560
 
        <refentrytitle>mandos-client</refentrytitle>
561
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
562
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
563
 
      </citerefentry>
 
660
      <citerefentry><refentrytitle>intro</refentrytitle>
 
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
663
      <manvolnum>5</manvolnum></citerefentry>,
 
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
665
      <manvolnum>5</manvolnum></citerefentry>,
 
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
668
      <citerefentry><refentrytitle>sh</refentrytitle>
 
669
      <manvolnum>1</manvolnum></citerefentry>
564
670
    </para>
565
671
    <variablelist>
566
672
      <varlistentry>