/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

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-12-09">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
 
44
      <year>2018</year>
36
45
      <holder>Teddy Hogeborn</holder>
37
46
      <holder>Björn Påhlsson</holder>
38
47
    </copyright>
86
95
      <sbr/>
87
96
      <arg><option>--debug</option></arg>
88
97
      <sbr/>
 
98
      <arg><option>--debuglevel
 
99
      <replaceable>LEVEL</replaceable></option></arg>
 
100
      <sbr/>
89
101
      <arg><option>--no-dbus</option></arg>
90
102
      <sbr/>
91
103
      <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>
92
116
    </cmdsynopsis>
93
117
    <cmdsynopsis>
94
118
      <command>&COMMANDNAME;</command>
112
136
    <para>
113
137
      <command>&COMMANDNAME;</command> is a server daemon which
114
138
      handles incoming request for passwords for a pre-defined list of
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.
 
139
      client host computers. For an introduction, see
 
140
      <citerefentry><refentrytitle>intro</refentrytitle>
 
141
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
142
      uses Zeroconf to announce itself on the local network, and uses
 
143
      TLS to communicate securely with and to authenticate the
 
144
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
145
      use IPv6 link-local addresses, since the clients will probably
 
146
      not have any other addresses configured (see <xref
 
147
      linkend="overview"/>).  Any authenticated client is then given
 
148
      the stored pre-encrypted password for that specific client.
123
149
    </para>
124
150
  </refsect1>
125
151
  
194
220
      </varlistentry>
195
221
      
196
222
      <varlistentry>
 
223
        <term><option>--debuglevel
 
224
        <replaceable>LEVEL</replaceable></option></term>
 
225
        <listitem>
 
226
          <para>
 
227
            Set the debugging log level.
 
228
            <replaceable>LEVEL</replaceable> is a string, one of
 
229
            <quote><literal>CRITICAL</literal></quote>,
 
230
            <quote><literal>ERROR</literal></quote>,
 
231
            <quote><literal>WARNING</literal></quote>,
 
232
            <quote><literal>INFO</literal></quote>, or
 
233
            <quote><literal>DEBUG</literal></quote>, in order of
 
234
            increasing verbosity.  The default level is
 
235
            <quote><literal>WARNING</literal></quote>.
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
197
241
        <term><option>--priority <replaceable>
198
242
        PRIORITY</replaceable></option></term>
199
243
        <listitem>
250
294
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
295
        </listitem>
252
296
      </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
      
253
339
    </variablelist>
254
340
  </refsect1>
255
341
  
275
361
      start a TLS protocol handshake with a slight quirk: the Mandos
276
362
      server program acts as a TLS <quote>client</quote> while the
277
363
      connecting Mandos client acts as a TLS <quote>server</quote>.
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.
 
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.
283
369
    </para>
284
370
    <table>
285
371
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
305
391
        </emphasis></entry>
306
392
      </row>
307
393
      <row>
308
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
394
        <entry>Public key (part of TLS handshake)</entry>
309
395
        <entry>-><!-- &rarr; --></entry>
310
396
      </row>
311
397
      <row>
329
415
      for some time, the client is assumed to be compromised and is no
330
416
      longer eligible to receive the encrypted password.  (Manual
331
417
      intervention is required to re-enable a client.)  The timeout,
332
 
      checker program, and interval between checks can be configured
333
 
      both globally and per client; see <citerefentry>
 
418
      extended timeout, checker program, and interval between checks
 
419
      can be configured both globally and per client; see
 
420
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
421
      <manvolnum>5</manvolnum></citerefentry>.
 
422
    </para>
 
423
  </refsect1>
 
424
  
 
425
  <refsect1 id="approval">
 
426
    <title>APPROVAL</title>
 
427
    <para>
 
428
      The server can be configured to require manual approval for a
 
429
      client before it is sent its secret.  The delay to wait for such
 
430
      approval and the default action (approve or deny) can be
 
431
      configured both globally and per client; see <citerefentry>
334
432
      <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.
338
 
    </para>
 
433
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
434
      will be approved immediately without delay.
 
435
    </para>
 
436
    <para>
 
437
      This can be used to deny a client its secret if not manually
 
438
      approved within a specified time.  It can also be used to make
 
439
      the server delay before giving a client its secret, allowing
 
440
      optional manual denying of this specific client.
 
441
    </para>
 
442
    
339
443
  </refsect1>
340
444
  
341
445
  <refsect1 id="logging">
342
446
    <title>LOGGING</title>
343
447
    <para>
344
448
      The server will send log message with various severity levels to
345
 
      <filename>/dev/log</filename>.  With the
 
449
      <filename class="devicefile">/dev/log</filename>.  With the
346
450
      <option>--debug</option> option, it will log even more messages,
347
451
      and also show them on the console.
348
452
    </para>
349
453
  </refsect1>
350
454
  
 
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
  
351
467
  <refsect1 id="dbus_interface">
352
468
    <title>D-BUS INTERFACE</title>
353
469
    <para>
354
470
      The server will by default provide a D-Bus system bus interface.
355
471
      This interface will only be accessible by the root user or a
356
 
      Mandos-specific user, if such a user exists.
357
 
      <!-- XXX -->
 
472
      Mandos-specific user, if such a user exists.  For documentation
 
473
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
474
    </para>
359
475
  </refsect1>
360
476
  
415
531
        </listitem>
416
532
      </varlistentry>
417
533
      <varlistentry>
418
 
        <term><filename>/var/run/mandos.pid</filename></term>
419
 
        <listitem>
420
 
          <para>
421
 
            The file containing the process id of
422
 
            <command>&COMMANDNAME;</command>.
423
 
          </para>
424
 
        </listitem>
425
 
      </varlistentry>
426
 
      <varlistentry>
427
 
        <term><filename>/dev/log</filename></term>
 
534
        <term><filename>/run/mandos.pid</filename></term>
 
535
        <listitem>
 
536
          <para>
 
537
            The file containing the process id of the
 
538
            <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>
428
559
        <listitem>
429
560
          <para>
430
561
            The Unix domain socket to where local syslog messages are
453
584
      backtrace.  This could be considered a feature.
454
585
    </para>
455
586
    <para>
456
 
      Currently, if a client is disabled due to having timed out, the
457
 
      server does not record this fact onto permanent storage.  This
458
 
      has some security implications, see <xref linkend="clients"/>.
459
 
    </para>
460
 
    <para>
461
 
      There is currently no way of querying the server of the current
462
 
      status of clients, other than analyzing its <systemitem
463
 
      class="service">syslog</systemitem> output.
464
 
    </para>
465
 
    <para>
466
587
      There is no fine-grained control over logging and debug output.
467
588
    </para>
468
 
    <para>
469
 
      Debug mode is conflated with running in the foreground.
470
 
    </para>
471
 
    <para>
472
 
      The console log messages do not show a time stamp.
473
 
    </para>
474
 
    <para>
475
 
      This server does not check the expire time of clients’ OpenPGP
476
 
      keys.
477
 
    </para>
 
589
    <xi:include href="bugs.xml"/>
478
590
  </refsect1>
479
591
  
480
592
  <refsect1 id="example">
490
602
    <informalexample>
491
603
      <para>
492
604
        Run the server in debug mode, read configuration files from
493
 
        the <filename>~/mandos</filename> directory, and use the
494
 
        Zeroconf service name <quote>Test</quote> to not collide with
495
 
        any other official Mandos server on this host:
 
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:
496
608
      </para>
497
609
      <para>
498
610
 
530
642
      <title>CLIENTS</title>
531
643
      <para>
532
644
        The server only gives out its stored data to clients which
533
 
        does have the OpenPGP key of the stored fingerprint.  This is
534
 
        guaranteed by the fact that the client sends its OpenPGP
535
 
        public key in the TLS handshake; this ensures it to be
536
 
        genuine.  The server computes the fingerprint of the key
537
 
        itself and looks up the fingerprint in its list of
538
 
        clients. The <filename>clients.conf</filename> file (see
 
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
539
651
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
540
652
        <manvolnum>5</manvolnum></citerefentry>)
541
653
        <emphasis>must</emphasis> be made non-readable by anyone
547
659
        compromised if they are gone for too long.
548
660
      </para>
549
661
      <para>
550
 
        If a client is compromised, its downtime should be duly noted
551
 
        by the server which would therefore disable the client.  But
552
 
        if the server was ever restarted, it would re-read its client
553
 
        list from its configuration file and again regard all clients
554
 
        therein as enabled, and hence eligible to receive their
555
 
        passwords.  Therefore, be careful when restarting servers if
556
 
        it is suspected that a client has, in fact, been compromised
557
 
        by parties who may now be running a fake Mandos client with
558
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
559
 
        image of the client host.  What should be done in that case
560
 
        (if restarting the server program really is necessary) is to
561
 
        stop the server program, edit the configuration file to omit
562
 
        any suspect clients, and restart the server program.
563
 
      </para>
564
 
      <para>
565
662
        For more details on client-side security, see
566
663
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
567
664
        <manvolnum>8mandos</manvolnum></citerefentry>.
572
669
  <refsect1 id="see_also">
573
670
    <title>SEE ALSO</title>
574
671
    <para>
575
 
      <citerefentry>
576
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
577
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
 
        <refentrytitle>mandos.conf</refentrytitle>
579
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
 
        <refentrytitle>mandos-client</refentrytitle>
581
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
 
      </citerefentry>
 
672
      <citerefentry><refentrytitle>intro</refentrytitle>
 
673
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
674
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
675
      <manvolnum>5</manvolnum></citerefentry>,
 
676
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
677
      <manvolnum>5</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
679
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>sh</refentrytitle>
 
681
      <manvolnum>1</manvolnum></citerefentry>
584
682
    </para>
585
683
    <variablelist>
586
684
      <varlistentry>
607
705
      </varlistentry>
608
706
      <varlistentry>
609
707
        <term>
610
 
          <ulink url="http://www.gnu.org/software/gnutls/"
611
 
          >GnuTLS</ulink>
 
708
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
612
709
        </term>
613
710
      <listitem>
614
711
        <para>
615
712
          GnuTLS is the library this server uses to implement TLS for
616
713
          communicating securely with the client, and at the same time
617
 
          confidently get the client’s public OpenPGP key.
 
714
          confidently get the client’s public key.
618
715
        </para>
619
716
      </listitem>
620
717
      </varlistentry>
652
749
      </varlistentry>
653
750
      <varlistentry>
654
751
        <term>
655
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
656
 
          Protocol Version 1.1</citetitle>
 
752
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
753
          Protocol Version 1.2</citetitle>
657
754
        </term>
658
755
      <listitem>
659
756
        <para>
660
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
757
          TLS 1.2 is the protocol implemented by GnuTLS.
661
758
        </para>
662
759
      </listitem>
663
760
      </varlistentry>
673
770
      </varlistentry>
674
771
      <varlistentry>
675
772
        <term>
676
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
677
 
          Security</citetitle>
678
 
        </term>
679
 
      <listitem>
680
 
        <para>
681
 
          This is implemented by GnuTLS and used by this server so
682
 
          that OpenPGP keys can be used.
 
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.
683
795
        </para>
684
796
      </listitem>
685
797
      </varlistentry>