/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: 2017-06-24 10:08:21 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170624100821-3ojepr4r6sifqzj5
Fix memory leak in password-prompt

* plugins.d/password-prompt.c (conflict_detection): Free any
  individual direntries, not just the direntry list.

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-02-24">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
36
44
      <holder>Teddy Hogeborn</holder>
37
45
      <holder>Björn Påhlsson</holder>
38
46
    </copyright>
86
94
      <sbr/>
87
95
      <arg><option>--debug</option></arg>
88
96
      <sbr/>
 
97
      <arg><option>--debuglevel
 
98
      <replaceable>LEVEL</replaceable></option></arg>
 
99
      <sbr/>
 
100
      <arg><option>--no-dbus</option></arg>
 
101
      <sbr/>
89
102
      <arg><option>--no-ipv6</option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--no-restore</option></arg>
 
105
      <sbr/>
 
106
      <arg><option>--statedir
 
107
      <replaceable>DIRECTORY</replaceable></option></arg>
 
108
      <sbr/>
 
109
      <arg><option>--socket
 
110
      <replaceable>FD</replaceable></option></arg>
 
111
      <sbr/>
 
112
      <arg><option>--foreground</option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--no-zeroconf</option></arg>
90
115
    </cmdsynopsis>
91
116
    <cmdsynopsis>
92
117
      <command>&COMMANDNAME;</command>
110
135
    <para>
111
136
      <command>&COMMANDNAME;</command> is a server daemon which
112
137
      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.
 
138
      client host computers. For an introduction, see
 
139
      <citerefentry><refentrytitle>intro</refentrytitle>
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
141
      uses Zeroconf to announce itself on the local network, and uses
 
142
      TLS to communicate securely with and to authenticate the
 
143
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
144
      use IPv6 link-local addresses, since the clients will probably
 
145
      not have any other addresses configured (see <xref
 
146
      linkend="overview"/>).  Any authenticated client is then given
 
147
      the stored pre-encrypted password for that specific client.
121
148
    </para>
122
149
  </refsect1>
123
150
  
192
219
      </varlistentry>
193
220
      
194
221
      <varlistentry>
 
222
        <term><option>--debuglevel
 
223
        <replaceable>LEVEL</replaceable></option></term>
 
224
        <listitem>
 
225
          <para>
 
226
            Set the debugging log level.
 
227
            <replaceable>LEVEL</replaceable> is a string, one of
 
228
            <quote><literal>CRITICAL</literal></quote>,
 
229
            <quote><literal>ERROR</literal></quote>,
 
230
            <quote><literal>WARNING</literal></quote>,
 
231
            <quote><literal>INFO</literal></quote>, or
 
232
            <quote><literal>DEBUG</literal></quote>, in order of
 
233
            increasing verbosity.  The default level is
 
234
            <quote><literal>WARNING</literal></quote>.
 
235
          </para>
 
236
        </listitem>
 
237
      </varlistentry>
 
238
      
 
239
      <varlistentry>
195
240
        <term><option>--priority <replaceable>
196
241
        PRIORITY</replaceable></option></term>
197
242
        <listitem>
233
278
      </varlistentry>
234
279
      
235
280
      <varlistentry>
 
281
        <term><option>--no-dbus</option></term>
 
282
        <listitem>
 
283
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
284
          <para>
 
285
            See also <xref linkend="dbus_interface"/>.
 
286
          </para>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      
 
290
      <varlistentry>
236
291
        <term><option>--no-ipv6</option></term>
237
292
        <listitem>
238
293
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
294
        </listitem>
240
295
      </varlistentry>
 
296
      
 
297
      <varlistentry>
 
298
        <term><option>--no-restore</option></term>
 
299
        <listitem>
 
300
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
301
          <para>
 
302
            See also <xref linkend="persistent_state"/>.
 
303
          </para>
 
304
        </listitem>
 
305
      </varlistentry>
 
306
      
 
307
      <varlistentry>
 
308
        <term><option>--statedir
 
309
        <replaceable>DIRECTORY</replaceable></option></term>
 
310
        <listitem>
 
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
312
        </listitem>
 
313
      </varlistentry>
 
314
      
 
315
      <varlistentry>
 
316
        <term><option>--socket
 
317
        <replaceable>FD</replaceable></option></term>
 
318
        <listitem>
 
319
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>--foreground</option></term>
 
325
        <listitem>
 
326
          <xi:include href="mandos-options.xml"
 
327
                      xpointer="foreground"/>
 
328
        </listitem>
 
329
      </varlistentry>
 
330
      
 
331
      <varlistentry>
 
332
        <term><option>--no-zeroconf</option></term>
 
333
        <listitem>
 
334
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
335
        </listitem>
 
336
      </varlistentry>
 
337
      
241
338
    </variablelist>
242
339
  </refsect1>
243
340
  
315
412
      The server will, by default, continually check that the clients
316
413
      are still up.  If a client has not been confirmed as being up
317
414
      for some time, the client is assumed to be compromised and is no
318
 
      longer eligible to receive the encrypted password.  The timeout,
319
 
      checker program, and interval between checks can be configured
320
 
      both globally and per client; see <citerefentry>
 
415
      longer eligible to receive the encrypted password.  (Manual
 
416
      intervention is required to re-enable a client.)  The timeout,
 
417
      extended timeout, checker program, and interval between checks
 
418
      can be configured both globally and per client; see
 
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
420
      <manvolnum>5</manvolnum></citerefentry>.
 
421
    </para>
 
422
  </refsect1>
 
423
  
 
424
  <refsect1 id="approval">
 
425
    <title>APPROVAL</title>
 
426
    <para>
 
427
      The server can be configured to require manual approval for a
 
428
      client before it is sent its secret.  The delay to wait for such
 
429
      approval and the default action (approve or deny) can be
 
430
      configured both globally and per client; see <citerefentry>
321
431
      <refentrytitle>mandos-clients.conf</refentrytitle>
322
 
      <manvolnum>5</manvolnum></citerefentry>.
323
 
    </para>
 
432
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
433
      will be approved immediately without delay.
 
434
    </para>
 
435
    <para>
 
436
      This can be used to deny a client its secret if not manually
 
437
      approved within a specified time.  It can also be used to make
 
438
      the server delay before giving a client its secret, allowing
 
439
      optional manual denying of this specific client.
 
440
    </para>
 
441
    
324
442
  </refsect1>
325
443
  
326
444
  <refsect1 id="logging">
327
445
    <title>LOGGING</title>
328
446
    <para>
329
447
      The server will send log message with various severity levels to
330
 
      <filename>/dev/log</filename>.  With the
 
448
      <filename class="devicefile">/dev/log</filename>.  With the
331
449
      <option>--debug</option> option, it will log even more messages,
332
450
      and also show them on the console.
333
451
    </para>
334
452
  </refsect1>
335
453
  
 
454
  <refsect1 id="persistent_state">
 
455
    <title>PERSISTENT STATE</title>
 
456
    <para>
 
457
      Client settings, initially read from
 
458
      <filename>clients.conf</filename>, are persistent across
 
459
      restarts, and run-time changes will override settings in
 
460
      <filename>clients.conf</filename>.  However, if a setting is
 
461
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
462
      <filename>clients.conf</filename>, this will take precedence.
 
463
    </para>
 
464
  </refsect1>
 
465
  
 
466
  <refsect1 id="dbus_interface">
 
467
    <title>D-BUS INTERFACE</title>
 
468
    <para>
 
469
      The server will by default provide a D-Bus system bus interface.
 
470
      This interface will only be accessible by the root user or a
 
471
      Mandos-specific user, if such a user exists.  For documentation
 
472
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
473
    </para>
 
474
  </refsect1>
 
475
  
336
476
  <refsect1 id="exit_status">
337
477
    <title>EXIT STATUS</title>
338
478
    <para>
390
530
        </listitem>
391
531
      </varlistentry>
392
532
      <varlistentry>
393
 
        <term><filename>/var/run/mandos.pid</filename></term>
394
 
        <listitem>
395
 
          <para>
396
 
            The file containing the process id of
397
 
            <command>&COMMANDNAME;</command>.
398
 
          </para>
399
 
        </listitem>
400
 
      </varlistentry>
401
 
      <varlistentry>
402
 
        <term><filename>/dev/log</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
 
534
        <listitem>
 
535
          <para>
 
536
            The file containing the process id of the
 
537
            <command>&COMMANDNAME;</command> process started last.
 
538
            <emphasis >Note:</emphasis> If the <filename
 
539
            class="directory">/run</filename> directory does not
 
540
            exist, <filename>/var/run/mandos.pid</filename> will be
 
541
            used instead.
 
542
          </para>
 
543
        </listitem>
 
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.
 
553
          </para>
 
554
        </listitem>
 
555
      </varlistentry>
 
556
      <varlistentry>
 
557
        <term><filename class="devicefile">/dev/log</filename></term>
403
558
        <listitem>
404
559
          <para>
405
560
            The Unix domain socket to where local syslog messages are
428
583
      backtrace.  This could be considered a feature.
429
584
    </para>
430
585
    <para>
431
 
      Currently, if a client is declared <quote>invalid</quote> due to
432
 
      having timed out, the server does not record this fact onto
433
 
      permanent storage.  This has some security implications, see
434
 
      <xref linkend="clients"/>.
435
 
    </para>
436
 
    <para>
437
 
      There is currently no way of querying the server of the current
438
 
      status of clients, other than analyzing its <systemitem
439
 
      class="service">syslog</systemitem> output.
440
 
    </para>
441
 
    <para>
442
586
      There is no fine-grained control over logging and debug output.
443
587
    </para>
444
588
    <para>
445
 
      Debug mode is conflated with running in the foreground.
446
 
    </para>
447
 
    <para>
448
 
      The console log messages do not show a time stamp.
449
 
    </para>
450
 
    <para>
451
589
      This server does not check the expire time of clients’ OpenPGP
452
590
      keys.
453
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
454
593
  </refsect1>
455
594
  
456
595
  <refsect1 id="example">
466
605
    <informalexample>
467
606
      <para>
468
607
        Run the server in debug mode, read configuration files from
469
 
        the <filename>~/mandos</filename> directory, and use the
470
 
        Zeroconf service name <quote>Test</quote> to not collide with
471
 
        any other official Mandos server on this host:
 
608
        the <filename class="directory">~/mandos</filename> directory,
 
609
        and use the Zeroconf service name <quote>Test</quote> to not
 
610
        collide with any other official Mandos server on this host:
472
611
      </para>
473
612
      <para>
474
613
 
523
662
        compromised if they are gone for too long.
524
663
      </para>
525
664
      <para>
526
 
        If a client is compromised, its downtime should be duly noted
527
 
        by the server which would therefore declare the client
528
 
        invalid.  But if the server was ever restarted, it would
529
 
        re-read its client list from its configuration file and again
530
 
        regard all clients therein as valid, and hence eligible to
531
 
        receive their passwords.  Therefore, be careful when
532
 
        restarting servers if it is suspected that a client has, in
533
 
        fact, been compromised by parties who may now be running a
534
 
        fake Mandos client with the keys from the non-encrypted
535
 
        initial <acronym>RAM</acronym> image of the client host.  What
536
 
        should be done in that case (if restarting the server program
537
 
        really is necessary) is to stop the server program, edit the
538
 
        configuration file to omit any suspect clients, and restart
539
 
        the server program.
540
 
      </para>
541
 
      <para>
542
665
        For more details on client-side security, see
543
666
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
544
667
        <manvolnum>8mandos</manvolnum></citerefentry>.
549
672
  <refsect1 id="see_also">
550
673
    <title>SEE ALSO</title>
551
674
    <para>
552
 
      <citerefentry>
553
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
554
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
 
        <refentrytitle>mandos.conf</refentrytitle>
556
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
 
        <refentrytitle>mandos-client</refentrytitle>
558
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
560
 
      </citerefentry>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
677
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
678
      <manvolnum>5</manvolnum></citerefentry>,
 
679
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
680
      <manvolnum>5</manvolnum></citerefentry>,
 
681
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
683
      <citerefentry><refentrytitle>sh</refentrytitle>
 
684
      <manvolnum>1</manvolnum></citerefentry>
561
685
    </para>
562
686
    <variablelist>
563
687
      <varlistentry>
584
708
      </varlistentry>
585
709
      <varlistentry>
586
710
        <term>
587
 
          <ulink url="http://www.gnu.org/software/gnutls/"
588
 
          >GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
589
712
        </term>
590
713
      <listitem>
591
714
        <para>
629
752
      </varlistentry>
630
753
      <varlistentry>
631
754
        <term>
632
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
633
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
634
757
        </term>
635
758
      <listitem>
636
759
        <para>
637
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
638
761
        </para>
639
762
      </listitem>
640
763
      </varlistentry>
650
773
      </varlistentry>
651
774
      <varlistentry>
652
775
        <term>
653
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
654
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
655
778
        </term>
656
779
      <listitem>
657
780
        <para>