/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: 2025-06-27 19:56:23 UTC
  • mto: This revision was merged to the branch mainline in revision 414.
  • Revision ID: teddy@recompile.se-20250627195623-02t2vap0gixox3mo
Update Debian Policy version to 4.7.2; no other changes necessary.

* debian/control (Standards-Version): Change to "4.7.2".

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 "2008-10-03">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
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
      <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
      <year>2020</year>
 
47
      <year>2021</year>
 
48
      <year>2022</year>
35
49
      <holder>Teddy Hogeborn</holder>
36
50
      <holder>Björn Påhlsson</holder>
37
51
    </copyright>
84
98
      <replaceable>DIRECTORY</replaceable></option></arg>
85
99
      <sbr/>
86
100
      <arg><option>--debug</option></arg>
 
101
      <sbr/>
 
102
      <arg><option>--debuglevel
 
103
      <replaceable>LEVEL</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--no-dbus</option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--no-ipv6</option></arg>
 
108
      <sbr/>
 
109
      <arg><option>--no-restore</option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--statedir
 
112
      <replaceable>DIRECTORY</replaceable></option></arg>
 
113
      <sbr/>
 
114
      <arg><option>--socket
 
115
      <replaceable>FD</replaceable></option></arg>
 
116
      <sbr/>
 
117
      <arg><option>--foreground</option></arg>
 
118
      <sbr/>
 
119
      <arg><option>--no-zeroconf</option></arg>
87
120
    </cmdsynopsis>
88
121
    <cmdsynopsis>
89
122
      <command>&COMMANDNAME;</command>
106
139
    <title>DESCRIPTION</title>
107
140
    <para>
108
141
      <command>&COMMANDNAME;</command> is a server daemon which
109
 
      handles incoming request for passwords for a pre-defined list of
110
 
      client host computers.  The Mandos server uses Zeroconf to
111
 
      announce itself on the local network, and uses TLS to
112
 
      communicate securely with and to authenticate the clients.  The
113
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
114
 
      link-local addresses, since the clients will probably not have
115
 
      any other addresses configured (see <xref linkend="overview"/>).
116
 
      Any authenticated client is then given the stored pre-encrypted
117
 
      password for that specific client.
 
142
      handles incoming requests for passwords for a pre-defined list
 
143
      of client host computers. For an introduction, see
 
144
      <citerefentry><refentrytitle>intro</refentrytitle>
 
145
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
146
      uses Zeroconf to announce itself on the local network, and uses
 
147
      TLS to communicate securely with and to authenticate the
 
148
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
149
      use IPv6 link-local addresses, since the clients will probably
 
150
      not have any other addresses configured (see <xref
 
151
      linkend="overview"/>).  Any authenticated client is then given
 
152
      the stored pre-encrypted password for that specific client.
118
153
    </para>
119
154
  </refsect1>
120
155
  
189
224
      </varlistentry>
190
225
      
191
226
      <varlistentry>
 
227
        <term><option>--debuglevel
 
228
        <replaceable>LEVEL</replaceable></option></term>
 
229
        <listitem>
 
230
          <para>
 
231
            Set the debugging log level.
 
232
            <replaceable>LEVEL</replaceable> is a string, one of
 
233
            <quote><literal>CRITICAL</literal></quote>,
 
234
            <quote><literal>ERROR</literal></quote>,
 
235
            <quote><literal>WARNING</literal></quote>,
 
236
            <quote><literal>INFO</literal></quote>, or
 
237
            <quote><literal>DEBUG</literal></quote>, in order of
 
238
            increasing verbosity.  The default level is
 
239
            <quote><literal>WARNING</literal></quote>.
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
 
243
      
 
244
      <varlistentry>
192
245
        <term><option>--priority <replaceable>
193
246
        PRIORITY</replaceable></option></term>
194
247
        <listitem>
228
281
          </para>
229
282
        </listitem>
230
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-dbus</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
289
          <para>
 
290
            See also <xref linkend="dbus_interface"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--no-ipv6</option></term>
 
297
        <listitem>
 
298
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
299
        </listitem>
 
300
      </varlistentry>
 
301
      
 
302
      <varlistentry>
 
303
        <term><option>--no-restore</option></term>
 
304
        <listitem>
 
305
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
306
          <para>
 
307
            See also <xref linkend="persistent_state"/>.
 
308
          </para>
 
309
        </listitem>
 
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--statedir
 
314
        <replaceable>DIRECTORY</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--socket
 
322
        <replaceable>FD</replaceable></option></term>
 
323
        <listitem>
 
324
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--foreground</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml"
 
332
                      xpointer="foreground"/>
 
333
        </listitem>
 
334
      </varlistentry>
 
335
      
 
336
      <varlistentry>
 
337
        <term><option>--no-zeroconf</option></term>
 
338
        <listitem>
 
339
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
340
        </listitem>
 
341
      </varlistentry>
 
342
      
231
343
    </variablelist>
232
344
  </refsect1>
233
345
  
253
365
      start a TLS protocol handshake with a slight quirk: the Mandos
254
366
      server program acts as a TLS <quote>client</quote> while the
255
367
      connecting Mandos client acts as a TLS <quote>server</quote>.
256
 
      The Mandos client must supply an OpenPGP certificate, and the
257
 
      fingerprint of this certificate is used by the Mandos server to
258
 
      look up (in a list read from <filename>clients.conf</filename>
259
 
      at start time) which binary blob to give the client.  No other
260
 
      authentication or authorization is done by the server.
 
368
      The Mandos client must supply a TLS public key, and the key ID
 
369
      of this public key is used by the Mandos server to look up (in a
 
370
      list read from <filename>clients.conf</filename> at start time)
 
371
      which binary blob to give the client.  No other authentication
 
372
      or authorization is done by the server.
261
373
    </para>
262
374
    <table>
263
375
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
283
395
        </emphasis></entry>
284
396
      </row>
285
397
      <row>
286
 
        <entry>OpenPGP public key (part of TLS handshake)</entry>
 
398
        <entry>Public key (part of TLS handshake)</entry>
287
399
        <entry>-><!-- &rarr; --></entry>
288
400
      </row>
289
401
      <row>
305
417
      The server will, by default, continually check that the clients
306
418
      are still up.  If a client has not been confirmed as being up
307
419
      for some time, the client is assumed to be compromised and is no
308
 
      longer eligible to receive the encrypted password.  The timeout,
309
 
      checker program, and interval between checks can be configured
310
 
      both globally and per client; see <citerefentry>
 
420
      longer eligible to receive the encrypted password.  (Manual
 
421
      intervention is required to re-enable a client.)  The timeout,
 
422
      extended timeout, checker program, and interval between checks
 
423
      can be configured both globally and per client; see
 
424
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
425
      <manvolnum>5</manvolnum></citerefentry>.
 
426
    </para>
 
427
  </refsect1>
 
428
  
 
429
  <refsect1 id="approval">
 
430
    <title>APPROVAL</title>
 
431
    <para>
 
432
      The server can be configured to require manual approval for a
 
433
      client before it is sent its secret.  The delay to wait for such
 
434
      approval and the default action (approve or deny) can be
 
435
      configured both globally and per client; see <citerefentry>
311
436
      <refentrytitle>mandos-clients.conf</refentrytitle>
312
 
      <manvolnum>5</manvolnum></citerefentry>.
313
 
    </para>
 
437
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
438
      will be approved immediately without delay.
 
439
    </para>
 
440
    <para>
 
441
      This can be used to deny a client its secret if not manually
 
442
      approved within a specified time.  It can also be used to make
 
443
      the server delay before giving a client its secret, allowing
 
444
      optional manual denying of this specific client.
 
445
    </para>
 
446
    
314
447
  </refsect1>
315
448
  
316
449
  <refsect1 id="logging">
317
450
    <title>LOGGING</title>
318
451
    <para>
319
452
      The server will send log message with various severity levels to
320
 
      <filename>/dev/log</filename>.  With the
 
453
      <filename class="devicefile">/dev/log</filename>.  With the
321
454
      <option>--debug</option> option, it will log even more messages,
322
455
      and also show them on the console.
323
456
    </para>
324
457
  </refsect1>
325
458
  
 
459
  <refsect1 id="persistent_state">
 
460
    <title>PERSISTENT STATE</title>
 
461
    <para>
 
462
      Client settings, initially read from
 
463
      <filename>clients.conf</filename>, are persistent across
 
464
      restarts, and run-time changes will override settings in
 
465
      <filename>clients.conf</filename>.  However, if a setting is
 
466
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
467
      <filename>clients.conf</filename>, this will take precedence.
 
468
    </para>
 
469
  </refsect1>
 
470
  
 
471
  <refsect1 id="dbus_interface">
 
472
    <title>D-BUS INTERFACE</title>
 
473
    <para>
 
474
      The server will by default provide a D-Bus system bus interface.
 
475
      This interface will only be accessible by the root user or a
 
476
      Mandos-specific user, if such a user exists.  For documentation
 
477
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
478
    </para>
 
479
  </refsect1>
 
480
  
326
481
  <refsect1 id="exit_status">
327
482
    <title>EXIT STATUS</title>
328
483
    <para>
380
535
        </listitem>
381
536
      </varlistentry>
382
537
      <varlistentry>
383
 
        <term><filename>/var/run/mandos.pid</filename></term>
384
 
        <listitem>
385
 
          <para>
386
 
            The file containing the process id of
387
 
            <command>&COMMANDNAME;</command>.
388
 
          </para>
389
 
        </listitem>
390
 
      </varlistentry>
391
 
      <varlistentry>
392
 
        <term><filename>/dev/log</filename></term>
 
538
        <term><filename>/run/mandos.pid</filename></term>
 
539
        <listitem>
 
540
          <para>
 
541
            The file containing the process id of the
 
542
            <command>&COMMANDNAME;</command> process started last.
 
543
            <emphasis >Note:</emphasis> If the <filename
 
544
            class="directory">/run</filename> directory does not
 
545
            exist, <filename>/var/run/mandos.pid</filename> will be
 
546
            used instead.
 
547
          </para>
 
548
        </listitem>
 
549
      </varlistentry>
 
550
      <varlistentry>
 
551
        <term><filename
 
552
        class="directory">/var/lib/mandos</filename></term>
 
553
        <listitem>
 
554
          <para>
 
555
            Directory where persistent state will be saved.  Change
 
556
            this with the <option>--statedir</option> option.  See
 
557
            also the <option>--no-restore</option> option.
 
558
          </para>
 
559
        </listitem>
 
560
      </varlistentry>
 
561
      <varlistentry>
 
562
        <term><filename class="devicefile">/dev/log</filename></term>
393
563
        <listitem>
394
564
          <para>
395
565
            The Unix domain socket to where local syslog messages are
418
588
      backtrace.  This could be considered a feature.
419
589
    </para>
420
590
    <para>
421
 
      Currently, if a client is declared <quote>invalid</quote> due to
422
 
      having timed out, the server does not record this fact onto
423
 
      permanent storage.  This has some security implications, see
424
 
      <xref linkend="clients"/>.
425
 
    </para>
426
 
    <para>
427
 
      There is currently no way of querying the server of the current
428
 
      status of clients, other than analyzing its <systemitem
429
 
      class="service">syslog</systemitem> output.
430
 
    </para>
431
 
    <para>
432
591
      There is no fine-grained control over logging and debug output.
433
592
    </para>
434
 
    <para>
435
 
      Debug mode is conflated with running in the foreground.
436
 
    </para>
437
 
    <para>
438
 
      The console log messages does not show a time stamp.
439
 
    </para>
440
 
    <para>
441
 
      This server does not check the expire time of clients’ OpenPGP
442
 
      keys.
443
 
    </para>
 
593
    <xi:include href="bugs.xml"/>
444
594
  </refsect1>
445
595
  
446
596
  <refsect1 id="example">
456
606
    <informalexample>
457
607
      <para>
458
608
        Run the server in debug mode, read configuration files from
459
 
        the <filename>~/mandos</filename> directory, and use the
460
 
        Zeroconf service name <quote>Test</quote> to not collide with
461
 
        any other official Mandos server on this host:
 
609
        the <filename class="directory">~/mandos</filename> directory,
 
610
        and use the Zeroconf service name <quote>Test</quote> to not
 
611
        collide with any other official Mandos server on this host:
462
612
      </para>
463
613
      <para>
464
614
 
496
646
      <title>CLIENTS</title>
497
647
      <para>
498
648
        The server only gives out its stored data to clients which
499
 
        does have the OpenPGP key of the stored fingerprint.  This is
500
 
        guaranteed by the fact that the client sends its OpenPGP
501
 
        public key in the TLS handshake; this ensures it to be
502
 
        genuine.  The server computes the fingerprint of the key
503
 
        itself and looks up the fingerprint in its list of
504
 
        clients. The <filename>clients.conf</filename> file (see
 
649
        does have the correct key ID of the stored key ID.  This is
 
650
        guaranteed by the fact that the client sends its public key in
 
651
        the TLS handshake; this ensures it to be genuine.  The server
 
652
        computes the key ID of the key itself and looks up the key ID
 
653
        in its list of clients. The <filename>clients.conf</filename>
 
654
        file (see
505
655
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
656
        <manvolnum>5</manvolnum></citerefentry>)
507
657
        <emphasis>must</emphasis> be made non-readable by anyone
513
663
        compromised if they are gone for too long.
514
664
      </para>
515
665
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial <acronym>RAM</acronym> image of the client host.  What
526
 
        should be done in that case (if restarting the server program
527
 
        really is necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
666
        For more details on client-side security, see
533
667
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
534
668
        <manvolnum>8mandos</manvolnum></citerefentry>.
539
673
  <refsect1 id="see_also">
540
674
    <title>SEE ALSO</title>
541
675
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos.conf</refentrytitle>
546
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>mandos-client</refentrytitle>
548
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
 
      </citerefentry>
 
676
      <citerefentry><refentrytitle>intro</refentrytitle>
 
677
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
678
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
679
      <manvolnum>5</manvolnum></citerefentry>,
 
680
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
681
      <manvolnum>5</manvolnum></citerefentry>,
 
682
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
683
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
684
      <citerefentry><refentrytitle>sh</refentrytitle>
 
685
      <manvolnum>1</manvolnum></citerefentry>
551
686
    </para>
552
687
    <variablelist>
553
688
      <varlistentry>
563
698
      </varlistentry>
564
699
      <varlistentry>
565
700
        <term>
566
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
701
          <ulink url="https://www.avahi.org/">Avahi</ulink>
567
702
        </term>
568
703
      <listitem>
569
704
        <para>
574
709
      </varlistentry>
575
710
      <varlistentry>
576
711
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
712
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
579
713
        </term>
580
714
      <listitem>
581
715
        <para>
582
716
          GnuTLS is the library this server uses to implement TLS for
583
717
          communicating securely with the client, and at the same time
584
 
          confidently get the client’s public OpenPGP key.
 
718
          confidently get the client’s public key.
585
719
        </para>
586
720
      </listitem>
587
721
      </varlistentry>
608
742
            <listitem>
609
743
              <para>
610
744
                The clients use IPv6 link-local addresses, which are
611
 
                immediately usable since a link-local addresses is
 
745
                immediately usable since a link-local address is
612
746
                automatically assigned to a network interfaces when it
613
747
                is brought up.
614
748
              </para>
619
753
      </varlistentry>
620
754
      <varlistentry>
621
755
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
756
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
757
          Protocol Version 1.2</citetitle>
624
758
        </term>
625
759
      <listitem>
626
760
        <para>
627
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
761
          TLS 1.2 is the protocol implemented by GnuTLS.
628
762
        </para>
629
763
      </listitem>
630
764
      </varlistentry>
640
774
      </varlistentry>
641
775
      <varlistentry>
642
776
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
645
 
        </term>
646
 
      <listitem>
647
 
        <para>
648
 
          This is implemented by GnuTLS and used by this server so
649
 
          that OpenPGP keys can be used.
 
777
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
778
          Layer Security (TLS) and Datagram Transport Layer Security
 
779
          (DTLS)</citetitle>
 
780
        </term>
 
781
      <listitem>
 
782
        <para>
 
783
          This is implemented by GnuTLS version 3.6.6 and is, if
 
784
          present, used by this server so that raw public keys can be
 
785
          used.
 
786
        </para>
 
787
      </listitem>
 
788
      </varlistentry>
 
789
      <varlistentry>
 
790
        <term>
 
791
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
792
          Security (TLS) Authentication</citetitle>
 
793
        </term>
 
794
      <listitem>
 
795
        <para>
 
796
          This is implemented by GnuTLS before version 3.6.0 and is,
 
797
          if present, used by this server so that OpenPGP keys can be
 
798
          used.
650
799
        </para>
651
800
      </listitem>
652
801
      </varlistentry>