/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-ctl (main): Bug fix: Make --secret actually work.

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 "2022-04-24">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
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
39
      <holder>Teddy Hogeborn</holder>
47
40
      <holder>Björn Påhlsson</holder>
48
41
    </copyright>
107
100
      <sbr/>
108
101
      <arg><option>--statedir
109
102
      <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
103
    </cmdsynopsis>
118
104
    <cmdsynopsis>
119
105
      <command>&COMMANDNAME;</command>
136
122
    <title>DESCRIPTION</title>
137
123
    <para>
138
124
      <command>&COMMANDNAME;</command> is a server daemon which
139
 
      handles incoming requests for passwords for a pre-defined list
140
 
      of client host computers. For an introduction, see
 
125
      handles incoming request for passwords for a pre-defined list of
 
126
      client host computers. For an introduction, see
141
127
      <citerefentry><refentrytitle>intro</refentrytitle>
142
128
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
129
      uses Zeroconf to announce itself on the local network, and uses
300
286
        <term><option>--no-restore</option></term>
301
287
        <listitem>
302
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
303
 
          <para>
304
 
            See also <xref linkend="persistent_state"/>.
305
 
          </para>
306
289
        </listitem>
307
290
      </varlistentry>
308
291
      
313
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
297
        </listitem>
315
298
      </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
299
    </variablelist>
341
300
  </refsect1>
342
301
  
362
321
      start a TLS protocol handshake with a slight quirk: the Mandos
363
322
      server program acts as a TLS <quote>client</quote> while the
364
323
      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.
 
324
      The Mandos client must supply an OpenPGP certificate, and the
 
325
      fingerprint of this certificate is used by the Mandos server to
 
326
      look up (in a list read from <filename>clients.conf</filename>
 
327
      at start time) which binary blob to give the client.  No other
 
328
      authentication or authorization is done by the server.
370
329
    </para>
371
330
    <table>
372
331
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
351
        </emphasis></entry>
393
352
      </row>
394
353
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
354
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
355
        <entry>-><!-- &rarr; --></entry>
397
356
      </row>
398
357
      <row>
419
378
      extended timeout, checker program, and interval between checks
420
379
      can be configured both globally and per client; see
421
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
 
      <manvolnum>5</manvolnum></citerefentry>.
 
381
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
382
      receiving its password will also be treated as a successful
 
383
      checker run.
423
384
    </para>
424
385
  </refsect1>
425
386
  
453
414
    </para>
454
415
  </refsect1>
455
416
  
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
417
  <refsect1 id="dbus_interface">
469
418
    <title>D-BUS INTERFACE</title>
470
419
    <para>
532
481
        </listitem>
533
482
      </varlistentry>
534
483
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
536
485
        <listitem>
537
486
          <para>
538
487
            The file containing the process id of the
539
488
            <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
489
          </para>
545
490
        </listitem>
546
491
      </varlistentry>
547
492
      <varlistentry>
 
493
        <term><filename class="devicefile">/dev/log</filename></term>
 
494
      </varlistentry>
 
495
      <varlistentry>
548
496
        <term><filename
549
497
        class="directory">/var/lib/mandos</filename></term>
550
498
        <listitem>
556
504
        </listitem>
557
505
      </varlistentry>
558
506
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
        <term><filename>/dev/log</filename></term>
560
508
        <listitem>
561
509
          <para>
562
510
            The Unix domain socket to where local syslog messages are
587
535
    <para>
588
536
      There is no fine-grained control over logging and debug output.
589
537
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
538
    <para>
 
539
      Debug mode is conflated with running in the foreground.
 
540
    </para>
 
541
    <para>
 
542
      This server does not check the expire time of clients’ OpenPGP
 
543
      keys.
 
544
    </para>
591
545
  </refsect1>
592
546
  
593
547
  <refsect1 id="example">
643
597
      <title>CLIENTS</title>
644
598
      <para>
645
599
        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
 
600
        does have the OpenPGP key of the stored fingerprint.  This is
 
601
        guaranteed by the fact that the client sends its OpenPGP
 
602
        public key in the TLS handshake; this ensures it to be
 
603
        genuine.  The server computes the fingerprint of the key
 
604
        itself and looks up the fingerprint in its list of
 
605
        clients. The <filename>clients.conf</filename> file (see
652
606
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
607
        <manvolnum>5</manvolnum></citerefentry>)
654
608
        <emphasis>must</emphasis> be made non-readable by anyone
695
649
      </varlistentry>
696
650
      <varlistentry>
697
651
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
652
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
653
        </term>
700
654
      <listitem>
701
655
        <para>
706
660
      </varlistentry>
707
661
      <varlistentry>
708
662
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
663
          <ulink url="http://www.gnu.org/software/gnutls/"
 
664
          >GnuTLS</ulink>
710
665
        </term>
711
666
      <listitem>
712
667
        <para>
713
668
          GnuTLS is the library this server uses to implement TLS for
714
669
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
670
          confidently get the client’s public OpenPGP key.
716
671
        </para>
717
672
      </listitem>
718
673
      </varlistentry>
739
694
            <listitem>
740
695
              <para>
741
696
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
697
                immediately usable since a link-local addresses is
743
698
                automatically assigned to a network interfaces when it
744
699
                is brought up.
745
700
              </para>
750
705
      </varlistentry>
751
706
      <varlistentry>
752
707
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
708
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
709
          Protocol Version 1.1</citetitle>
755
710
        </term>
756
711
      <listitem>
757
712
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
713
          TLS 1.1 is the protocol implemented by GnuTLS.
759
714
        </para>
760
715
      </listitem>
761
716
      </varlistentry>
771
726
      </varlistentry>
772
727
      <varlistentry>
773
728
        <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.
 
729
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
730
          Security</citetitle>
 
731
        </term>
 
732
      <listitem>
 
733
        <para>
 
734
          This is implemented by GnuTLS and used by this server so
 
735
          that OpenPGP keys can be used.
796
736
        </para>
797
737
      </listitem>
798
738
      </varlistentry>