/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

* mandos.xml (APPROVAL): New section.

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-10">
 
5
<!ENTITY TIMESTAMP "2010-09-25">
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
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>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
36
      <holder>Teddy Hogeborn</holder>
47
37
      <holder>Björn Påhlsson</holder>
48
38
    </copyright>
96
86
      <sbr/>
97
87
      <arg><option>--debug</option></arg>
98
88
      <sbr/>
99
 
      <arg><option>--debuglevel
100
 
      <replaceable>LEVEL</replaceable></option></arg>
101
 
      <sbr/>
102
89
      <arg><option>--no-dbus</option></arg>
103
90
      <sbr/>
104
91
      <arg><option>--no-ipv6</option></arg>
105
 
      <sbr/>
106
 
      <arg><option>--no-restore</option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--statedir
109
 
      <replaceable>DIRECTORY</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--socket
112
 
      <replaceable>FD</replaceable></option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <arg><option>--no-zeroconf</option></arg>
117
92
    </cmdsynopsis>
118
93
    <cmdsynopsis>
119
94
      <command>&COMMANDNAME;</command>
137
112
    <para>
138
113
      <command>&COMMANDNAME;</command> is a server daemon which
139
114
      handles incoming request for passwords for a pre-defined list of
140
 
      client host computers. For an introduction, see
141
 
      <citerefentry><refentrytitle>intro</refentrytitle>
142
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
 
      uses Zeroconf to announce itself on the local network, and uses
144
 
      TLS to communicate securely with and to authenticate the
145
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
146
 
      use IPv6 link-local addresses, since the clients will probably
147
 
      not have any other addresses configured (see <xref
148
 
      linkend="overview"/>).  Any authenticated client is then given
149
 
      the stored pre-encrypted password for that specific client.
 
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.
150
123
    </para>
151
124
  </refsect1>
152
125
  
221
194
      </varlistentry>
222
195
      
223
196
      <varlistentry>
224
 
        <term><option>--debuglevel
225
 
        <replaceable>LEVEL</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            Set the debugging log level.
229
 
            <replaceable>LEVEL</replaceable> is a string, one of
230
 
            <quote><literal>CRITICAL</literal></quote>,
231
 
            <quote><literal>ERROR</literal></quote>,
232
 
            <quote><literal>WARNING</literal></quote>,
233
 
            <quote><literal>INFO</literal></quote>, or
234
 
            <quote><literal>DEBUG</literal></quote>, in order of
235
 
            increasing verbosity.  The default level is
236
 
            <quote><literal>WARNING</literal></quote>.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
197
        <term><option>--priority <replaceable>
243
198
        PRIORITY</replaceable></option></term>
244
199
        <listitem>
295
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
251
        </listitem>
297
252
      </varlistentry>
298
 
      
299
 
      <varlistentry>
300
 
        <term><option>--no-restore</option></term>
301
 
        <listitem>
302
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
 
        </listitem>
307
 
      </varlistentry>
308
 
      
309
 
      <varlistentry>
310
 
        <term><option>--statedir
311
 
        <replaceable>DIRECTORY</replaceable></option></term>
312
 
        <listitem>
313
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
 
        </listitem>
315
 
      </varlistentry>
316
 
      
317
 
      <varlistentry>
318
 
        <term><option>--socket
319
 
        <replaceable>FD</replaceable></option></term>
320
 
        <listitem>
321
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
322
 
        </listitem>
323
 
      </varlistentry>
324
 
      
325
 
      <varlistentry>
326
 
        <term><option>--foreground</option></term>
327
 
        <listitem>
328
 
          <xi:include href="mandos-options.xml"
329
 
                      xpointer="foreground"/>
330
 
        </listitem>
331
 
      </varlistentry>
332
 
      
333
 
      <varlistentry>
334
 
        <term><option>--no-zeroconf</option></term>
335
 
        <listitem>
336
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
337
 
        </listitem>
338
 
      </varlistentry>
339
 
      
340
253
    </variablelist>
341
254
  </refsect1>
342
255
  
362
275
      start a TLS protocol handshake with a slight quirk: the Mandos
363
276
      server program acts as a TLS <quote>client</quote> while the
364
277
      connecting Mandos client acts as a TLS <quote>server</quote>.
365
 
      The Mandos client must supply a TLS public key, and the key ID
366
 
      of this public key is used by the Mandos server to look up (in a
367
 
      list read from <filename>clients.conf</filename> at start time)
368
 
      which binary blob to give the client.  No other authentication
369
 
      or authorization is done by the server.
 
278
      The Mandos client must supply an OpenPGP certificate, and the
 
279
      fingerprint of this certificate is used by the Mandos server to
 
280
      look up (in a list read from <filename>clients.conf</filename>
 
281
      at start time) which binary blob to give the client.  No other
 
282
      authentication or authorization is done by the server.
370
283
    </para>
371
284
    <table>
372
285
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
305
        </emphasis></entry>
393
306
      </row>
394
307
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
308
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
309
        <entry>-><!-- &rarr; --></entry>
397
310
      </row>
398
311
      <row>
416
329
      for some time, the client is assumed to be compromised and is no
417
330
      longer eligible to receive the encrypted password.  (Manual
418
331
      intervention is required to re-enable a client.)  The timeout,
419
 
      extended timeout, checker program, and interval between checks
420
 
      can be configured both globally and per client; see
421
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
332
      checker program, and interval between checks can be configured
 
333
      both globally and per client; see <citerefentry>
 
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
423
338
    </para>
424
339
  </refsect1>
425
340
  
447
362
    <title>LOGGING</title>
448
363
    <para>
449
364
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
365
      <filename>/dev/log</filename>.  With the
451
366
      <option>--debug</option> option, it will log even more messages,
452
367
      and also show them on the console.
453
368
    </para>
454
369
  </refsect1>
455
370
  
456
 
  <refsect1 id="persistent_state">
457
 
    <title>PERSISTENT STATE</title>
458
 
    <para>
459
 
      Client settings, initially read from
460
 
      <filename>clients.conf</filename>, are persistent across
461
 
      restarts, and run-time changes will override settings in
462
 
      <filename>clients.conf</filename>.  However, if a setting is
463
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
464
 
      <filename>clients.conf</filename>, this will take precedence.
465
 
    </para>
466
 
  </refsect1>
467
 
  
468
371
  <refsect1 id="dbus_interface">
469
372
    <title>D-BUS INTERFACE</title>
470
373
    <para>
532
435
        </listitem>
533
436
      </varlistentry>
534
437
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
438
        <term><filename>/var/run/mandos.pid</filename></term>
536
439
        <listitem>
537
440
          <para>
538
441
            The file containing the process id of the
539
442
            <command>&COMMANDNAME;</command> process started last.
540
 
            <emphasis >Note:</emphasis> If the <filename
541
 
            class="directory">/run</filename> directory does not
542
 
            exist, <filename>/var/run/mandos.pid</filename> will be
543
 
            used instead.
544
 
          </para>
545
 
        </listitem>
546
 
      </varlistentry>
547
 
      <varlistentry>
548
 
        <term><filename
549
 
        class="directory">/var/lib/mandos</filename></term>
550
 
        <listitem>
551
 
          <para>
552
 
            Directory where persistent state will be saved.  Change
553
 
            this with the <option>--statedir</option> option.  See
554
 
            also the <option>--no-restore</option> option.
555
 
          </para>
556
 
        </listitem>
557
 
      </varlistentry>
558
 
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
443
          </para>
 
444
        </listitem>
 
445
      </varlistentry>
 
446
      <varlistentry>
 
447
        <term><filename>/dev/log</filename></term>
560
448
        <listitem>
561
449
          <para>
562
450
            The Unix domain socket to where local syslog messages are
585
473
      backtrace.  This could be considered a feature.
586
474
    </para>
587
475
    <para>
 
476
      Currently, if a client is disabled due to having timed out, the
 
477
      server does not record this fact onto permanent storage.  This
 
478
      has some security implications, see <xref linkend="clients"/>.
 
479
    </para>
 
480
    <para>
588
481
      There is no fine-grained control over logging and debug output.
589
482
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
483
    <para>
 
484
      Debug mode is conflated with running in the foreground.
 
485
    </para>
 
486
    <para>
 
487
      The console log messages do not show a time stamp.
 
488
    </para>
 
489
    <para>
 
490
      This server does not check the expire time of clients’ OpenPGP
 
491
      keys.
 
492
    </para>
591
493
  </refsect1>
592
494
  
593
495
  <refsect1 id="example">
603
505
    <informalexample>
604
506
      <para>
605
507
        Run the server in debug mode, read configuration files from
606
 
        the <filename class="directory">~/mandos</filename> directory,
607
 
        and use the Zeroconf service name <quote>Test</quote> to not
608
 
        collide with any other official Mandos server on this host:
 
508
        the <filename>~/mandos</filename> directory, and use the
 
509
        Zeroconf service name <quote>Test</quote> to not collide with
 
510
        any other official Mandos server on this host:
609
511
      </para>
610
512
      <para>
611
513
 
643
545
      <title>CLIENTS</title>
644
546
      <para>
645
547
        The server only gives out its stored data to clients which
646
 
        does have the correct key ID of the stored key ID.  This is
647
 
        guaranteed by the fact that the client sends its public key in
648
 
        the TLS handshake; this ensures it to be genuine.  The server
649
 
        computes the key ID of the key itself and looks up the key ID
650
 
        in its list of clients. The <filename>clients.conf</filename>
651
 
        file (see
 
548
        does have the OpenPGP key of the stored fingerprint.  This is
 
549
        guaranteed by the fact that the client sends its OpenPGP
 
550
        public key in the TLS handshake; this ensures it to be
 
551
        genuine.  The server computes the fingerprint of the key
 
552
        itself and looks up the fingerprint in its list of
 
553
        clients. The <filename>clients.conf</filename> file (see
652
554
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
555
        <manvolnum>5</manvolnum></citerefentry>)
654
556
        <emphasis>must</emphasis> be made non-readable by anyone
660
562
        compromised if they are gone for too long.
661
563
      </para>
662
564
      <para>
 
565
        If a client is compromised, its downtime should be duly noted
 
566
        by the server which would therefore disable the client.  But
 
567
        if the server was ever restarted, it would re-read its client
 
568
        list from its configuration file and again regard all clients
 
569
        therein as enabled, and hence eligible to receive their
 
570
        passwords.  Therefore, be careful when restarting servers if
 
571
        it is suspected that a client has, in fact, been compromised
 
572
        by parties who may now be running a fake Mandos client with
 
573
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
574
        image of the client host.  What should be done in that case
 
575
        (if restarting the server program really is necessary) is to
 
576
        stop the server program, edit the configuration file to omit
 
577
        any suspect clients, and restart the server program.
 
578
      </para>
 
579
      <para>
663
580
        For more details on client-side security, see
664
581
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
582
        <manvolnum>8mandos</manvolnum></citerefentry>.
670
587
  <refsect1 id="see_also">
671
588
    <title>SEE ALSO</title>
672
589
    <para>
673
 
      <citerefentry><refentrytitle>intro</refentrytitle>
674
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
675
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
 
      <manvolnum>5</manvolnum></citerefentry>,
677
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
 
      <manvolnum>5</manvolnum></citerefentry>,
679
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
680
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
681
 
      <citerefentry><refentrytitle>sh</refentrytitle>
682
 
      <manvolnum>1</manvolnum></citerefentry>
 
590
      <citerefentry>
 
591
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
592
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
593
        <refentrytitle>mandos.conf</refentrytitle>
 
594
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
595
        <refentrytitle>mandos-client</refentrytitle>
 
596
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
597
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
598
      </citerefentry>
683
599
    </para>
684
600
    <variablelist>
685
601
      <varlistentry>
706
622
      </varlistentry>
707
623
      <varlistentry>
708
624
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
625
          <ulink url="http://www.gnu.org/software/gnutls/"
 
626
          >GnuTLS</ulink>
710
627
        </term>
711
628
      <listitem>
712
629
        <para>
713
630
          GnuTLS is the library this server uses to implement TLS for
714
631
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
632
          confidently get the client’s public OpenPGP key.
716
633
        </para>
717
634
      </listitem>
718
635
      </varlistentry>
750
667
      </varlistentry>
751
668
      <varlistentry>
752
669
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
670
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
671
          Protocol Version 1.1</citetitle>
755
672
        </term>
756
673
      <listitem>
757
674
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
675
          TLS 1.1 is the protocol implemented by GnuTLS.
759
676
        </para>
760
677
      </listitem>
761
678
      </varlistentry>
771
688
      </varlistentry>
772
689
      <varlistentry>
773
690
        <term>
774
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
775
 
          Layer Security (TLS) and Datagram Transport Layer Security
776
 
          (DTLS)</citetitle>
777
 
        </term>
778
 
      <listitem>
779
 
        <para>
780
 
          This is implemented by GnuTLS version 3.6.6 and is, if
781
 
          present, used by this server so that raw public keys can be
782
 
          used.
783
 
        </para>
784
 
      </listitem>
785
 
      </varlistentry>
786
 
      <varlistentry>
787
 
        <term>
788
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
 
          Security (TLS) Authentication</citetitle>
790
 
        </term>
791
 
      <listitem>
792
 
        <para>
793
 
          This is implemented by GnuTLS before version 3.6.0 and is,
794
 
          if present, used by this server so that OpenPGP keys can be
795
 
          used.
 
691
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
692
          Security</citetitle>
 
693
        </term>
 
694
      <listitem>
 
695
        <para>
 
696
          This is implemented by GnuTLS and used by this server so
 
697
          that OpenPGP keys can be used.
796
698
        </para>
797
699
      </listitem>
798
700
      </varlistentry>