/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

Added sample OpenVPN network hook.

* network-hooks.d/openvpn: New.
* network-hooks.d/openvpn.conf: - '' -

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 "2019-02-09">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
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>
44
 
      <year>2018</year>
45
38
      <holder>Teddy Hogeborn</holder>
46
39
      <holder>Björn Påhlsson</holder>
47
40
    </copyright>
101
94
      <arg><option>--no-dbus</option></arg>
102
95
      <sbr/>
103
96
      <arg><option>--no-ipv6</option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--no-restore</option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--statedir
108
 
      <replaceable>DIRECTORY</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--socket
111
 
      <replaceable>FD</replaceable></option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--foreground</option></arg>
114
 
      <sbr/>
115
 
      <arg><option>--no-zeroconf</option></arg>
116
97
    </cmdsynopsis>
117
98
    <cmdsynopsis>
118
99
      <command>&COMMANDNAME;</command>
294
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
276
        </listitem>
296
277
      </varlistentry>
297
 
      
298
 
      <varlistentry>
299
 
        <term><option>--no-restore</option></term>
300
 
        <listitem>
301
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
302
 
          <para>
303
 
            See also <xref linkend="persistent_state"/>.
304
 
          </para>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
      
308
 
      <varlistentry>
309
 
        <term><option>--statedir
310
 
        <replaceable>DIRECTORY</replaceable></option></term>
311
 
        <listitem>
312
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--socket
318
 
        <replaceable>FD</replaceable></option></term>
319
 
        <listitem>
320
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
321
 
        </listitem>
322
 
      </varlistentry>
323
 
      
324
 
      <varlistentry>
325
 
        <term><option>--foreground</option></term>
326
 
        <listitem>
327
 
          <xi:include href="mandos-options.xml"
328
 
                      xpointer="foreground"/>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
      
332
 
      <varlistentry>
333
 
        <term><option>--no-zeroconf</option></term>
334
 
        <listitem>
335
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
      
339
278
    </variablelist>
340
279
  </refsect1>
341
280
  
361
300
      start a TLS protocol handshake with a slight quirk: the Mandos
362
301
      server program acts as a TLS <quote>client</quote> while the
363
302
      connecting Mandos client acts as a TLS <quote>server</quote>.
364
 
      The Mandos client must supply a TLS public key, and the key ID
365
 
      of this public key is used by the Mandos server to look up (in a
366
 
      list read from <filename>clients.conf</filename> at start time)
367
 
      which binary blob to give the client.  No other authentication
368
 
      or authorization is done by the server.
 
303
      The Mandos client must supply an OpenPGP certificate, and the
 
304
      fingerprint of this certificate is used by the Mandos server to
 
305
      look up (in a list read from <filename>clients.conf</filename>
 
306
      at start time) which binary blob to give the client.  No other
 
307
      authentication or authorization is done by the server.
369
308
    </para>
370
309
    <table>
371
310
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
330
        </emphasis></entry>
392
331
      </row>
393
332
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
333
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
334
        <entry>-><!-- &rarr; --></entry>
396
335
      </row>
397
336
      <row>
418
357
      extended timeout, checker program, and interval between checks
419
358
      can be configured both globally and per client; see
420
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
 
      <manvolnum>5</manvolnum></citerefentry>.
 
360
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
361
      receiving its password will also be treated as a successful
 
362
      checker run.
422
363
    </para>
423
364
  </refsect1>
424
365
  
446
387
    <title>LOGGING</title>
447
388
    <para>
448
389
      The server will send log message with various severity levels to
449
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
390
      <filename>/dev/log</filename>.  With the
450
391
      <option>--debug</option> option, it will log even more messages,
451
392
      and also show them on the console.
452
393
    </para>
453
394
  </refsect1>
454
395
  
455
 
  <refsect1 id="persistent_state">
456
 
    <title>PERSISTENT STATE</title>
457
 
    <para>
458
 
      Client settings, initially read from
459
 
      <filename>clients.conf</filename>, are persistent across
460
 
      restarts, and run-time changes will override settings in
461
 
      <filename>clients.conf</filename>.  However, if a setting is
462
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
463
 
      <filename>clients.conf</filename>, this will take precedence.
464
 
    </para>
465
 
  </refsect1>
466
 
  
467
396
  <refsect1 id="dbus_interface">
468
397
    <title>D-BUS INTERFACE</title>
469
398
    <para>
531
460
        </listitem>
532
461
      </varlistentry>
533
462
      <varlistentry>
534
 
        <term><filename>/run/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
535
464
        <listitem>
536
465
          <para>
537
466
            The file containing the process id of the
538
467
            <command>&COMMANDNAME;</command> process started last.
539
 
            <emphasis >Note:</emphasis> If the <filename
540
 
            class="directory">/run</filename> directory does not
541
 
            exist, <filename>/var/run/mandos.pid</filename> will be
542
 
            used instead.
543
 
          </para>
544
 
        </listitem>
545
 
      </varlistentry>
546
 
      <varlistentry>
547
 
        <term><filename
548
 
        class="directory">/var/lib/mandos</filename></term>
549
 
        <listitem>
550
 
          <para>
551
 
            Directory where persistent state will be saved.  Change
552
 
            this with the <option>--statedir</option> option.  See
553
 
            also the <option>--no-restore</option> option.
554
 
          </para>
555
 
        </listitem>
556
 
      </varlistentry>
557
 
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
468
          </para>
 
469
        </listitem>
 
470
      </varlistentry>
 
471
      <varlistentry>
 
472
        <term><filename>/dev/log</filename></term>
559
473
        <listitem>
560
474
          <para>
561
475
            The Unix domain socket to where local syslog messages are
584
498
      backtrace.  This could be considered a feature.
585
499
    </para>
586
500
    <para>
 
501
      Currently, if a client is disabled due to having timed out, the
 
502
      server does not record this fact onto permanent storage.  This
 
503
      has some security implications, see <xref linkend="clients"/>.
 
504
    </para>
 
505
    <para>
587
506
      There is no fine-grained control over logging and debug output.
588
507
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
508
    <para>
 
509
      Debug mode is conflated with running in the foreground.
 
510
    </para>
 
511
    <para>
 
512
      The console log messages do not show a time stamp.
 
513
    </para>
 
514
    <para>
 
515
      This server does not check the expire time of clients’ OpenPGP
 
516
      keys.
 
517
    </para>
590
518
  </refsect1>
591
519
  
592
520
  <refsect1 id="example">
602
530
    <informalexample>
603
531
      <para>
604
532
        Run the server in debug mode, read configuration files from
605
 
        the <filename class="directory">~/mandos</filename> directory,
606
 
        and use the Zeroconf service name <quote>Test</quote> to not
607
 
        collide with any other official Mandos server on this host:
 
533
        the <filename>~/mandos</filename> directory, and use the
 
534
        Zeroconf service name <quote>Test</quote> to not collide with
 
535
        any other official Mandos server on this host:
608
536
      </para>
609
537
      <para>
610
538
 
642
570
      <title>CLIENTS</title>
643
571
      <para>
644
572
        The server only gives out its stored data to clients which
645
 
        does have the correct key ID of the stored key ID.  This is
646
 
        guaranteed by the fact that the client sends its public key in
647
 
        the TLS handshake; this ensures it to be genuine.  The server
648
 
        computes the key ID of the key itself and looks up the key ID
649
 
        in its list of clients. The <filename>clients.conf</filename>
650
 
        file (see
 
573
        does have the OpenPGP key of the stored fingerprint.  This is
 
574
        guaranteed by the fact that the client sends its OpenPGP
 
575
        public key in the TLS handshake; this ensures it to be
 
576
        genuine.  The server computes the fingerprint of the key
 
577
        itself and looks up the fingerprint in its list of
 
578
        clients. The <filename>clients.conf</filename> file (see
651
579
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
580
        <manvolnum>5</manvolnum></citerefentry>)
653
581
        <emphasis>must</emphasis> be made non-readable by anyone
659
587
        compromised if they are gone for too long.
660
588
      </para>
661
589
      <para>
 
590
        If a client is compromised, its downtime should be duly noted
 
591
        by the server which would therefore disable the client.  But
 
592
        if the server was ever restarted, it would re-read its client
 
593
        list from its configuration file and again regard all clients
 
594
        therein as enabled, and hence eligible to receive their
 
595
        passwords.  Therefore, be careful when restarting servers if
 
596
        it is suspected that a client has, in fact, been compromised
 
597
        by parties who may now be running a fake Mandos client with
 
598
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
599
        image of the client host.  What should be done in that case
 
600
        (if restarting the server program really is necessary) is to
 
601
        stop the server program, edit the configuration file to omit
 
602
        any suspect clients, and restart the server program.
 
603
      </para>
 
604
      <para>
662
605
        For more details on client-side security, see
663
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
664
607
        <manvolnum>8mandos</manvolnum></citerefentry>.
705
648
      </varlistentry>
706
649
      <varlistentry>
707
650
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
651
          <ulink url="http://www.gnu.org/software/gnutls/"
 
652
          >GnuTLS</ulink>
709
653
        </term>
710
654
      <listitem>
711
655
        <para>
712
656
          GnuTLS is the library this server uses to implement TLS for
713
657
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
658
          confidently get the client’s public OpenPGP key.
715
659
        </para>
716
660
      </listitem>
717
661
      </varlistentry>
749
693
      </varlistentry>
750
694
      <varlistentry>
751
695
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
696
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
697
          Protocol Version 1.1</citetitle>
754
698
        </term>
755
699
      <listitem>
756
700
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
701
          TLS 1.1 is the protocol implemented by GnuTLS.
758
702
        </para>
759
703
      </listitem>
760
704
      </varlistentry>
770
714
      </varlistentry>
771
715
      <varlistentry>
772
716
        <term>
773
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
774
 
          Layer Security (TLS) and Datagram Transport Layer Security
775
 
          (DTLS)</citetitle>
776
 
        </term>
777
 
      <listitem>
778
 
        <para>
779
 
          This is implemented by GnuTLS version 3.6.6 and is, if
780
 
          present, used by this server so that raw public keys can be
781
 
          used.
782
 
        </para>
783
 
      </listitem>
784
 
      </varlistentry>
785
 
      <varlistentry>
786
 
        <term>
787
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
 
          Security (TLS) Authentication</citetitle>
789
 
        </term>
790
 
      <listitem>
791
 
        <para>
792
 
          This is implemented by GnuTLS before version 3.6.0 and is,
793
 
          if present, used by this server so that OpenPGP keys can be
794
 
          used.
 
717
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
718
          Security</citetitle>
 
719
        </term>
 
720
      <listitem>
 
721
        <para>
 
722
          This is implemented by GnuTLS and used by this server so
 
723
          that OpenPGP keys can be used.
795
724
        </para>
796
725
      </listitem>
797
726
      </varlistentry>