/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: 2014-02-16 14:22:03 UTC
  • Revision ID: teddy@recompile.se-20140216142203-48mkrnoin5bly7l2
* mandos.lsm: Fix formatting to be acceptable by the LSM Robot.

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 "2013-10-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
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
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
112
106
      <replaceable>FD</replaceable></option></arg>
113
107
      <sbr/>
114
108
      <arg><option>--foreground</option></arg>
115
 
      <sbr/>
116
 
      <arg><option>--no-zeroconf</option></arg>
117
109
    </cmdsynopsis>
118
110
    <cmdsynopsis>
119
111
      <command>&COMMANDNAME;</command>
136
128
    <title>DESCRIPTION</title>
137
129
    <para>
138
130
      <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
 
131
      handles incoming request for passwords for a pre-defined list of
 
132
      client host computers. For an introduction, see
141
133
      <citerefentry><refentrytitle>intro</refentrytitle>
142
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
135
      uses Zeroconf to announce itself on the local network, and uses
242
234
        <term><option>--priority <replaceable>
243
235
        PRIORITY</replaceable></option></term>
244
236
        <listitem>
245
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="mandos-options.xml"
 
238
                      xpointer="priority_compat"/>
246
239
        </listitem>
247
240
      </varlistentry>
248
241
      
330
323
        </listitem>
331
324
      </varlistentry>
332
325
      
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
326
    </variablelist>
341
327
  </refsect1>
342
328
  
362
348
      start a TLS protocol handshake with a slight quirk: the Mandos
363
349
      server program acts as a TLS <quote>client</quote> while the
364
350
      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.
 
351
      The Mandos client must supply an OpenPGP certificate, and the
 
352
      fingerprint of this certificate is used by the Mandos server to
 
353
      look up (in a list read from <filename>clients.conf</filename>
 
354
      at start time) which binary blob to give the client.  No other
 
355
      authentication or authorization is done by the server.
370
356
    </para>
371
357
    <table>
372
358
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
378
        </emphasis></entry>
393
379
      </row>
394
380
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
381
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
382
        <entry>-><!-- &rarr; --></entry>
397
383
      </row>
398
384
      <row>
545
531
        </listitem>
546
532
      </varlistentry>
547
533
      <varlistentry>
 
534
        <term><filename class="devicefile">/dev/log</filename></term>
 
535
      </varlistentry>
 
536
      <varlistentry>
548
537
        <term><filename
549
538
        class="directory">/var/lib/mandos</filename></term>
550
539
        <listitem>
556
545
        </listitem>
557
546
      </varlistentry>
558
547
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
548
        <term><filename>/dev/log</filename></term>
560
549
        <listitem>
561
550
          <para>
562
551
            The Unix domain socket to where local syslog messages are
587
576
    <para>
588
577
      There is no fine-grained control over logging and debug output.
589
578
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
579
    <para>
 
580
      This server does not check the expire time of clients’ OpenPGP
 
581
      keys.
 
582
    </para>
591
583
  </refsect1>
592
584
  
593
585
  <refsect1 id="example">
643
635
      <title>CLIENTS</title>
644
636
      <para>
645
637
        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
 
638
        does have the OpenPGP key of the stored fingerprint.  This is
 
639
        guaranteed by the fact that the client sends its OpenPGP
 
640
        public key in the TLS handshake; this ensures it to be
 
641
        genuine.  The server computes the fingerprint of the key
 
642
        itself and looks up the fingerprint in its list of
 
643
        clients. The <filename>clients.conf</filename> file (see
652
644
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
645
        <manvolnum>5</manvolnum></citerefentry>)
654
646
        <emphasis>must</emphasis> be made non-readable by anyone
695
687
      </varlistentry>
696
688
      <varlistentry>
697
689
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
690
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
691
        </term>
700
692
      <listitem>
701
693
        <para>
706
698
      </varlistentry>
707
699
      <varlistentry>
708
700
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
701
          <ulink url="http://www.gnu.org/software/gnutls/"
 
702
          >GnuTLS</ulink>
710
703
        </term>
711
704
      <listitem>
712
705
        <para>
713
706
          GnuTLS is the library this server uses to implement TLS for
714
707
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
708
          confidently get the client’s public OpenPGP key.
716
709
        </para>
717
710
      </listitem>
718
711
      </varlistentry>
739
732
            <listitem>
740
733
              <para>
741
734
                The clients use IPv6 link-local addresses, which are
742
 
                immediately usable since a link-local address is
 
735
                immediately usable since a link-local addresses is
743
736
                automatically assigned to a network interfaces when it
744
737
                is brought up.
745
738
              </para>
750
743
      </varlistentry>
751
744
      <varlistentry>
752
745
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
746
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
747
          Protocol Version 1.1</citetitle>
755
748
        </term>
756
749
      <listitem>
757
750
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
751
          TLS 1.1 is the protocol implemented by GnuTLS.
759
752
        </para>
760
753
      </listitem>
761
754
      </varlistentry>
771
764
      </varlistentry>
772
765
      <varlistentry>
773
766
        <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.
 
767
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
768
          Security</citetitle>
 
769
        </term>
 
770
      <listitem>
 
771
        <para>
 
772
          This is implemented by GnuTLS and used by this server so
 
773
          that OpenPGP keys can be used.
796
774
        </para>
797
775
      </listitem>
798
776
      </varlistentry>