/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: Björn Påhlsson
  • Date: 2012-07-03 20:55:09 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: belorn@recompile.se-20120703205509-fkeb6uqy4i6gt4b6
added note messages when mandos-monitor starts without running server,
or a server with no clients.

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-06-17">
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>
112
105
      <replaceable>FD</replaceable></option></arg>
113
106
      <sbr/>
114
107
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <arg><option>--no-zeroconf</option></arg>
117
108
    </cmdsynopsis>
118
109
    <cmdsynopsis>
119
110
      <command>&COMMANDNAME;</command>
136
127
    <title>DESCRIPTION</title>
137
128
    <para>
138
129
      <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
 
130
      handles incoming request for passwords for a pre-defined list of
 
131
      client host computers. For an introduction, see
141
132
      <citerefentry><refentrytitle>intro</refentrytitle>
142
133
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
134
      uses Zeroconf to announce itself on the local network, and uses
330
321
        </listitem>
331
322
      </varlistentry>
332
323
      
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
324
    </variablelist>
341
325
  </refsect1>
342
326
  
362
346
      start a TLS protocol handshake with a slight quirk: the Mandos
363
347
      server program acts as a TLS <quote>client</quote> while the
364
348
      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.
 
349
      The Mandos client must supply an OpenPGP certificate, and the
 
350
      fingerprint of this certificate is used by the Mandos server to
 
351
      look up (in a list read from <filename>clients.conf</filename>
 
352
      at start time) which binary blob to give the client.  No other
 
353
      authentication or authorization is done by the server.
370
354
    </para>
371
355
    <table>
372
356
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
376
        </emphasis></entry>
393
377
      </row>
394
378
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
379
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
380
        <entry>-><!-- &rarr; --></entry>
397
381
      </row>
398
382
      <row>
532
516
        </listitem>
533
517
      </varlistentry>
534
518
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
519
        <term><filename>/var/run/mandos.pid</filename></term>
536
520
        <listitem>
537
521
          <para>
538
522
            The file containing the process id of the
539
523
            <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
524
          </para>
545
525
        </listitem>
546
526
      </varlistentry>
547
527
      <varlistentry>
 
528
        <term><filename class="devicefile">/dev/log</filename></term>
 
529
      </varlistentry>
 
530
      <varlistentry>
548
531
        <term><filename
549
532
        class="directory">/var/lib/mandos</filename></term>
550
533
        <listitem>
556
539
        </listitem>
557
540
      </varlistentry>
558
541
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
542
        <term><filename>/dev/log</filename></term>
560
543
        <listitem>
561
544
          <para>
562
545
            The Unix domain socket to where local syslog messages are
587
570
    <para>
588
571
      There is no fine-grained control over logging and debug output.
589
572
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
573
    <para>
 
574
      This server does not check the expire time of clients’ OpenPGP
 
575
      keys.
 
576
    </para>
591
577
  </refsect1>
592
578
  
593
579
  <refsect1 id="example">
643
629
      <title>CLIENTS</title>
644
630
      <para>
645
631
        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
 
632
        does have the OpenPGP key of the stored fingerprint.  This is
 
633
        guaranteed by the fact that the client sends its OpenPGP
 
634
        public key in the TLS handshake; this ensures it to be
 
635
        genuine.  The server computes the fingerprint of the key
 
636
        itself and looks up the fingerprint in its list of
 
637
        clients. The <filename>clients.conf</filename> file (see
652
638
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
639
        <manvolnum>5</manvolnum></citerefentry>)
654
640
        <emphasis>must</emphasis> be made non-readable by anyone
695
681
      </varlistentry>
696
682
      <varlistentry>
697
683
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
684
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
685
        </term>
700
686
      <listitem>
701
687
        <para>
706
692
      </varlistentry>
707
693
      <varlistentry>
708
694
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
695
          <ulink url="http://www.gnu.org/software/gnutls/"
 
696
          >GnuTLS</ulink>
710
697
        </term>
711
698
      <listitem>
712
699
        <para>
713
700
          GnuTLS is the library this server uses to implement TLS for
714
701
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
702
          confidently get the client’s public OpenPGP key.
716
703
        </para>
717
704
      </listitem>
718
705
      </varlistentry>
739
726
            <listitem>
740
727
              <para>
741
728
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
729
                immediately usable since a link-local addresses is
743
730
                automatically assigned to a network interfaces when it
744
731
                is brought up.
745
732
              </para>
750
737
      </varlistentry>
751
738
      <varlistentry>
752
739
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
740
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
741
          Protocol Version 1.1</citetitle>
755
742
        </term>
756
743
      <listitem>
757
744
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
745
          TLS 1.1 is the protocol implemented by GnuTLS.
759
746
        </para>
760
747
      </listitem>
761
748
      </varlistentry>
771
758
      </varlistentry>
772
759
      <varlistentry>
773
760
        <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.
 
761
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
762
          Security</citetitle>
 
763
        </term>
 
764
      <listitem>
 
765
        <para>
 
766
          This is implemented by GnuTLS and used by this server so
 
767
          that OpenPGP keys can be used.
796
768
        </para>
797
769
      </listitem>
798
770
      </varlistentry>