/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: 2012-02-26 11:49:48 UTC
  • mfrom: (560.1.2 deprecate-dbus)
  • Revision ID: teddy@recompile.se-20120226114948-eho4a6wn5ock5h7g
Merge D-Bus interface annotations and D-Bus interface deprecations.

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 "2019-07-24">
 
5
<!ENTITY TIMESTAMP "2012-01-15">
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>
313
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
314
300
        </listitem>
315
301
      </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
302
    </variablelist>
341
303
  </refsect1>
342
304
  
362
324
      start a TLS protocol handshake with a slight quirk: the Mandos
363
325
      server program acts as a TLS <quote>client</quote> while the
364
326
      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.
 
327
      The Mandos client must supply an OpenPGP certificate, and the
 
328
      fingerprint of this certificate is used by the Mandos server to
 
329
      look up (in a list read from <filename>clients.conf</filename>
 
330
      at start time) which binary blob to give the client.  No other
 
331
      authentication or authorization is done by the server.
370
332
    </para>
371
333
    <table>
372
334
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
392
354
        </emphasis></entry>
393
355
      </row>
394
356
      <row>
395
 
        <entry>Public key (part of TLS handshake)</entry>
 
357
        <entry>OpenPGP public key (part of TLS handshake)</entry>
396
358
        <entry>-><!-- &rarr; --></entry>
397
359
      </row>
398
360
      <row>
532
494
        </listitem>
533
495
      </varlistentry>
534
496
      <varlistentry>
535
 
        <term><filename>/run/mandos.pid</filename></term>
 
497
        <term><filename>/var/run/mandos.pid</filename></term>
536
498
        <listitem>
537
499
          <para>
538
500
            The file containing the process id of the
539
501
            <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
502
          </para>
545
503
        </listitem>
546
504
      </varlistentry>
547
505
      <varlistentry>
 
506
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
      </varlistentry>
 
508
      <varlistentry>
548
509
        <term><filename
549
510
        class="directory">/var/lib/mandos</filename></term>
550
511
        <listitem>
556
517
        </listitem>
557
518
      </varlistentry>
558
519
      <varlistentry>
559
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
520
        <term><filename>/dev/log</filename></term>
560
521
        <listitem>
561
522
          <para>
562
523
            The Unix domain socket to where local syslog messages are
587
548
    <para>
588
549
      There is no fine-grained control over logging and debug output.
589
550
    </para>
590
 
    <xi:include href="bugs.xml"/>
 
551
    <para>
 
552
      Debug mode is conflated with running in the foreground.
 
553
    </para>
 
554
    <para>
 
555
      This server does not check the expire time of clients’ OpenPGP
 
556
      keys.
 
557
    </para>
591
558
  </refsect1>
592
559
  
593
560
  <refsect1 id="example">
643
610
      <title>CLIENTS</title>
644
611
      <para>
645
612
        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
 
613
        does have the OpenPGP key of the stored fingerprint.  This is
 
614
        guaranteed by the fact that the client sends its OpenPGP
 
615
        public key in the TLS handshake; this ensures it to be
 
616
        genuine.  The server computes the fingerprint of the key
 
617
        itself and looks up the fingerprint in its list of
 
618
        clients. The <filename>clients.conf</filename> file (see
652
619
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
653
620
        <manvolnum>5</manvolnum></citerefentry>)
654
621
        <emphasis>must</emphasis> be made non-readable by anyone
695
662
      </varlistentry>
696
663
      <varlistentry>
697
664
        <term>
698
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
665
          <ulink url="http://www.avahi.org/">Avahi</ulink>
699
666
        </term>
700
667
      <listitem>
701
668
        <para>
706
673
      </varlistentry>
707
674
      <varlistentry>
708
675
        <term>
709
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
676
          <ulink url="http://www.gnu.org/software/gnutls/"
 
677
          >GnuTLS</ulink>
710
678
        </term>
711
679
      <listitem>
712
680
        <para>
713
681
          GnuTLS is the library this server uses to implement TLS for
714
682
          communicating securely with the client, and at the same time
715
 
          confidently get the client’s public key.
 
683
          confidently get the client’s public OpenPGP key.
716
684
        </para>
717
685
      </listitem>
718
686
      </varlistentry>
750
718
      </varlistentry>
751
719
      <varlistentry>
752
720
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
721
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
722
          Protocol Version 1.1</citetitle>
755
723
        </term>
756
724
      <listitem>
757
725
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
726
          TLS 1.1 is the protocol implemented by GnuTLS.
759
727
        </para>
760
728
      </listitem>
761
729
      </varlistentry>
771
739
      </varlistentry>
772
740
      <varlistentry>
773
741
        <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.
 
742
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
743
          Security</citetitle>
 
744
        </term>
 
745
      <listitem>
 
746
        <para>
 
747
          This is implemented by GnuTLS and used by this server so
 
748
          that OpenPGP keys can be used.
796
749
        </para>
797
750
      </listitem>
798
751
      </varlistentry>