/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: 2016-06-27 20:21:50 UTC
  • Revision ID: teddy@recompile.se-20160627202150-ml201ilxwjf1g29w
mandos-ctl: Implement --dump-json option

* mandos-ctl (main): Implement --dump-json option
* mandos-ctl.xml (NAME, DESCRIPTION): Change description to the more
                                      accurate "control or query".
  (SYNOPSIS): Add required group around action options and add new
              "--dump-json" option.
  (OPTIONS): Document new "--dump-json" option.

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-02-09">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
43
      <holder>Teddy Hogeborn</holder>
46
44
      <holder>Björn Påhlsson</holder>
47
45
    </copyright>
361
359
      start a TLS protocol handshake with a slight quirk: the Mandos
362
360
      server program acts as a TLS <quote>client</quote> while the
363
361
      connecting Mandos client acts as a TLS <quote>server</quote>.
364
 
      The Mandos client must supply a TLS public key, and the key ID
365
 
      of this public key is used by the Mandos server to look up (in a
366
 
      list read from <filename>clients.conf</filename> at start time)
367
 
      which binary blob to give the client.  No other authentication
368
 
      or authorization is done by the server.
 
362
      The Mandos client must supply an OpenPGP certificate, and the
 
363
      fingerprint of this certificate is used by the Mandos server to
 
364
      look up (in a list read from <filename>clients.conf</filename>
 
365
      at start time) which binary blob to give the client.  No other
 
366
      authentication or authorization is done by the server.
369
367
    </para>
370
368
    <table>
371
369
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
389
        </emphasis></entry>
392
390
      </row>
393
391
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
392
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
393
        <entry>-><!-- &rarr; --></entry>
396
394
      </row>
397
395
      <row>
586
584
    <para>
587
585
      There is no fine-grained control over logging and debug output.
588
586
    </para>
 
587
    <para>
 
588
      This server does not check the expire time of clients’ OpenPGP
 
589
      keys.
 
590
    </para>
589
591
    <xi:include href="bugs.xml"/>
590
592
  </refsect1>
591
593
  
642
644
      <title>CLIENTS</title>
643
645
      <para>
644
646
        The server only gives out its stored data to clients which
645
 
        does have the correct key ID of the stored key ID.  This is
646
 
        guaranteed by the fact that the client sends its public key in
647
 
        the TLS handshake; this ensures it to be genuine.  The server
648
 
        computes the key ID of the key itself and looks up the key ID
649
 
        in its list of clients. The <filename>clients.conf</filename>
650
 
        file (see
 
647
        does have the OpenPGP key of the stored fingerprint.  This is
 
648
        guaranteed by the fact that the client sends its OpenPGP
 
649
        public key in the TLS handshake; this ensures it to be
 
650
        genuine.  The server computes the fingerprint of the key
 
651
        itself and looks up the fingerprint in its list of
 
652
        clients. The <filename>clients.conf</filename> file (see
651
653
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
654
        <manvolnum>5</manvolnum></citerefentry>)
653
655
        <emphasis>must</emphasis> be made non-readable by anyone
705
707
      </varlistentry>
706
708
      <varlistentry>
707
709
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
709
711
        </term>
710
712
      <listitem>
711
713
        <para>
712
714
          GnuTLS is the library this server uses to implement TLS for
713
715
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
716
          confidently get the client’s public OpenPGP key.
715
717
        </para>
716
718
      </listitem>
717
719
      </varlistentry>
770
772
      </varlistentry>
771
773
      <varlistentry>
772
774
        <term>
773
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
774
 
          Layer Security (TLS) and Datagram Transport Layer Security
775
 
          (DTLS)</citetitle>
776
 
        </term>
777
 
      <listitem>
778
 
        <para>
779
 
          This is implemented by GnuTLS version 3.6.6 and is, if
780
 
          present, used by this server so that raw public keys can be
781
 
          used.
782
 
        </para>
783
 
      </listitem>
784
 
      </varlistentry>
785
 
      <varlistentry>
786
 
        <term>
787
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
776
          Security (TLS) Authentication</citetitle>
789
777
        </term>
790
778
      <listitem>
791
779
        <para>
792
 
          This is implemented by GnuTLS before version 3.6.0 and is,
793
 
          if present, used by this server so that OpenPGP keys can be
794
 
          used.
 
780
          This is implemented by GnuTLS and used by this server so
 
781
          that OpenPGP keys can be used.
795
782
        </para>
796
783
      </listitem>
797
784
      </varlistentry>