/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 (MandosServer.Quit): New.

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-07-24">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
35
      <holder>Teddy Hogeborn</holder>
47
36
      <holder>Björn Påhlsson</holder>
48
37
    </copyright>
96
85
      <sbr/>
97
86
      <arg><option>--debug</option></arg>
98
87
      <sbr/>
99
 
      <arg><option>--debuglevel
100
 
      <replaceable>LEVEL</replaceable></option></arg>
101
 
      <sbr/>
102
88
      <arg><option>--no-dbus</option></arg>
103
 
      <sbr/>
104
 
      <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
89
    </cmdsynopsis>
118
90
    <cmdsynopsis>
119
91
      <command>&COMMANDNAME;</command>
137
109
    <para>
138
110
      <command>&COMMANDNAME;</command> is a server daemon which
139
111
      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.
 
112
      client host computers.  The Mandos server uses Zeroconf to
 
113
      announce itself on the local network, and uses TLS to
 
114
      communicate securely with and to authenticate the clients.  The
 
115
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
 
116
      link-local addresses, since the clients will probably not have
 
117
      any other addresses configured (see <xref linkend="overview"/>).
 
118
      Any authenticated client is then given the stored pre-encrypted
 
119
      password for that specific client.
150
120
    </para>
151
121
  </refsect1>
152
122
  
221
191
      </varlistentry>
222
192
      
223
193
      <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
194
        <term><option>--priority <replaceable>
243
195
        PRIORITY</replaceable></option></term>
244
196
        <listitem>
288
240
          </para>
289
241
        </listitem>
290
242
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>--no-ipv6</option></term>
294
 
        <listitem>
295
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
 
        </listitem>
297
 
      </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
243
    </variablelist>
341
244
  </refsect1>
342
245
  
362
265
      start a TLS protocol handshake with a slight quirk: the Mandos
363
266
      server program acts as a TLS <quote>client</quote> while the
364
267
      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.
 
268
      The Mandos client must supply an OpenPGP certificate, and the
 
269
      fingerprint of this certificate is used by the Mandos server to
 
270
      look up (in a list read from <filename>clients.conf</filename>
 
271
      at start time) which binary blob to give the client.  No other
 
272
      authentication or authorization is done by the server.
370
273
    </para>
371
274
    <table>
372
275
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
295
        </emphasis></entry>
393
296
      </row>
394
297
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
298
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
299
        <entry>-><!-- &rarr; --></entry>
397
300
      </row>
398
301
      <row>
414
317
      The server will, by default, continually check that the clients
415
318
      are still up.  If a client has not been confirmed as being up
416
319
      for some time, the client is assumed to be compromised and is no
417
 
      longer eligible to receive the encrypted password.  (Manual
418
 
      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>
 
320
      longer eligible to receive the encrypted password.  The timeout,
 
321
      checker program, and interval between checks can be configured
 
322
      both globally and per client; see <citerefentry>
 
323
      <refentrytitle>mandos-clients.conf</refentrytitle>
422
324
      <manvolnum>5</manvolnum></citerefentry>.
423
325
    </para>
424
326
  </refsect1>
425
327
  
426
 
  <refsect1 id="approval">
427
 
    <title>APPROVAL</title>
428
 
    <para>
429
 
      The server can be configured to require manual approval for a
430
 
      client before it is sent its secret.  The delay to wait for such
431
 
      approval and the default action (approve or deny) can be
432
 
      configured both globally and per client; see <citerefentry>
433
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
434
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
435
 
      will be approved immediately without delay.
436
 
    </para>
437
 
    <para>
438
 
      This can be used to deny a client its secret if not manually
439
 
      approved within a specified time.  It can also be used to make
440
 
      the server delay before giving a client its secret, allowing
441
 
      optional manual denying of this specific client.
442
 
    </para>
443
 
    
444
 
  </refsect1>
445
 
  
446
328
  <refsect1 id="logging">
447
329
    <title>LOGGING</title>
448
330
    <para>
449
331
      The server will send log message with various severity levels to
450
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
332
      <filename>/dev/log</filename>.  With the
451
333
      <option>--debug</option> option, it will log even more messages,
452
334
      and also show them on the console.
453
335
    </para>
454
336
  </refsect1>
455
337
  
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
338
  <refsect1 id="dbus_interface">
469
339
    <title>D-BUS INTERFACE</title>
470
340
    <para>
471
341
      The server will by default provide a D-Bus system bus interface.
472
342
      This interface will only be accessible by the root user or a
473
 
      Mandos-specific user, if such a user exists.  For documentation
474
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
343
      Mandos-specific user, if such a user exists.
 
344
      <!-- XXX -->
475
345
    </para>
476
346
  </refsect1>
477
 
  
 
347
 
478
348
  <refsect1 id="exit_status">
479
349
    <title>EXIT STATUS</title>
480
350
    <para>
532
402
        </listitem>
533
403
      </varlistentry>
534
404
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
536
 
        <listitem>
537
 
          <para>
538
 
            The file containing the process id of the
539
 
            <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>
 
405
        <term><filename>/var/run/mandos.pid</filename></term>
 
406
        <listitem>
 
407
          <para>
 
408
            The file containing the process id of
 
409
            <command>&COMMANDNAME;</command>.
 
410
          </para>
 
411
        </listitem>
 
412
      </varlistentry>
 
413
      <varlistentry>
 
414
        <term><filename>/dev/log</filename></term>
560
415
        <listitem>
561
416
          <para>
562
417
            The Unix domain socket to where local syslog messages are
585
440
      backtrace.  This could be considered a feature.
586
441
    </para>
587
442
    <para>
 
443
      Currently, if a client is declared <quote>invalid</quote> due to
 
444
      having timed out, the server does not record this fact onto
 
445
      permanent storage.  This has some security implications, see
 
446
      <xref linkend="clients"/>.
 
447
    </para>
 
448
    <para>
 
449
      There is currently no way of querying the server of the current
 
450
      status of clients, other than analyzing its <systemitem
 
451
      class="service">syslog</systemitem> output.
 
452
    </para>
 
453
    <para>
588
454
      There is no fine-grained control over logging and debug output.
589
455
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
456
    <para>
 
457
      Debug mode is conflated with running in the foreground.
 
458
    </para>
 
459
    <para>
 
460
      The console log messages does not show a time stamp.
 
461
    </para>
 
462
    <para>
 
463
      This server does not check the expire time of clients’ OpenPGP
 
464
      keys.
 
465
    </para>
591
466
  </refsect1>
592
467
  
593
468
  <refsect1 id="example">
603
478
    <informalexample>
604
479
      <para>
605
480
        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:
 
481
        the <filename>~/mandos</filename> directory, and use the
 
482
        Zeroconf service name <quote>Test</quote> to not collide with
 
483
        any other official Mandos server on this host:
609
484
      </para>
610
485
      <para>
611
486
 
643
518
      <title>CLIENTS</title>
644
519
      <para>
645
520
        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
 
521
        does have the OpenPGP key of the stored fingerprint.  This is
 
522
        guaranteed by the fact that the client sends its OpenPGP
 
523
        public key in the TLS handshake; this ensures it to be
 
524
        genuine.  The server computes the fingerprint of the key
 
525
        itself and looks up the fingerprint in its list of
 
526
        clients. The <filename>clients.conf</filename> file (see
652
527
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
528
        <manvolnum>5</manvolnum></citerefentry>)
654
529
        <emphasis>must</emphasis> be made non-readable by anyone
660
535
        compromised if they are gone for too long.
661
536
      </para>
662
537
      <para>
 
538
        If a client is compromised, its downtime should be duly noted
 
539
        by the server which would therefore declare the client
 
540
        invalid.  But if the server was ever restarted, it would
 
541
        re-read its client list from its configuration file and again
 
542
        regard all clients therein as valid, and hence eligible to
 
543
        receive their passwords.  Therefore, be careful when
 
544
        restarting servers if it is suspected that a client has, in
 
545
        fact, been compromised by parties who may now be running a
 
546
        fake Mandos client with the keys from the non-encrypted
 
547
        initial <acronym>RAM</acronym> image of the client host.  What
 
548
        should be done in that case (if restarting the server program
 
549
        really is necessary) is to stop the server program, edit the
 
550
        configuration file to omit any suspect clients, and restart
 
551
        the server program.
 
552
      </para>
 
553
      <para>
663
554
        For more details on client-side security, see
664
555
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
665
556
        <manvolnum>8mandos</manvolnum></citerefentry>.
670
561
  <refsect1 id="see_also">
671
562
    <title>SEE ALSO</title>
672
563
    <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>
 
564
      <citerefentry>
 
565
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
566
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
567
        <refentrytitle>mandos.conf</refentrytitle>
 
568
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
 
569
        <refentrytitle>mandos-client</refentrytitle>
 
570
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
571
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
572
      </citerefentry>
683
573
    </para>
684
574
    <variablelist>
685
575
      <varlistentry>
695
585
      </varlistentry>
696
586
      <varlistentry>
697
587
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
588
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
589
        </term>
700
590
      <listitem>
701
591
        <para>
706
596
      </varlistentry>
707
597
      <varlistentry>
708
598
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
599
          <ulink url="http://www.gnu.org/software/gnutls/"
 
600
          >GnuTLS</ulink>
710
601
        </term>
711
602
      <listitem>
712
603
        <para>
713
604
          GnuTLS is the library this server uses to implement TLS for
714
605
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
606
          confidently get the client’s public OpenPGP key.
716
607
        </para>
717
608
      </listitem>
718
609
      </varlistentry>
750
641
      </varlistentry>
751
642
      <varlistentry>
752
643
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
644
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
645
          Protocol Version 1.1</citetitle>
755
646
        </term>
756
647
      <listitem>
757
648
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
649
          TLS 1.1 is the protocol implemented by GnuTLS.
759
650
        </para>
760
651
      </listitem>
761
652
      </varlistentry>
771
662
      </varlistentry>
772
663
      <varlistentry>
773
664
        <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.
 
665
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
666
          Security</citetitle>
 
667
        </term>
 
668
      <listitem>
 
669
        <para>
 
670
          This is implemented by GnuTLS and used by this server so
 
671
          that OpenPGP keys can be used.
796
672
        </para>
797
673
      </listitem>
798
674
      </varlistentry>