/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-06-22 23:33:56 UTC
  • Revision ID: teddy@recompile.se-20120622233356-odoqqt2ki2gssn37
* Makefile (check): Also check mandos-ctl.
* mandos-ctl: All options taking a time interval argument can now take
              an RFC 3339 duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
  (main): New "--check" option.
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new "--check" 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 "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
39
      <holder>Teddy Hogeborn</holder>
46
40
      <holder>Björn Påhlsson</holder>
47
41
    </copyright>
111
105
      <replaceable>FD</replaceable></option></arg>
112
106
      <sbr/>
113
107
      <arg><option>--foreground</option></arg>
114
 
      <sbr/>
115
 
      <arg><option>--no-zeroconf</option></arg>
116
108
    </cmdsynopsis>
117
109
    <cmdsynopsis>
118
110
      <command>&COMMANDNAME;</command>
329
321
        </listitem>
330
322
      </varlistentry>
331
323
      
332
 
      <varlistentry>
333
 
        <term><option>--no-zeroconf</option></term>
334
 
        <listitem>
335
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
      
339
324
    </variablelist>
340
325
  </refsect1>
341
326
  
361
346
      start a TLS protocol handshake with a slight quirk: the Mandos
362
347
      server program acts as a TLS <quote>client</quote> while the
363
348
      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.
 
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.
369
354
    </para>
370
355
    <table>
371
356
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
376
        </emphasis></entry>
392
377
      </row>
393
378
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
379
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
380
        <entry>-><!-- &rarr; --></entry>
396
381
      </row>
397
382
      <row>
531
516
        </listitem>
532
517
      </varlistentry>
533
518
      <varlistentry>
534
 
        <term><filename>/run/mandos.pid</filename></term>
 
519
        <term><filename>/var/run/mandos.pid</filename></term>
535
520
        <listitem>
536
521
          <para>
537
522
            The file containing the process id of the
538
523
            <command>&COMMANDNAME;</command> process started last.
539
 
            <emphasis >Note:</emphasis> If the <filename
540
 
            class="directory">/run</filename> directory does not
541
 
            exist, <filename>/var/run/mandos.pid</filename> will be
542
 
            used instead.
543
524
          </para>
544
525
        </listitem>
545
526
      </varlistentry>
546
527
      <varlistentry>
 
528
        <term><filename class="devicefile">/dev/log</filename></term>
 
529
      </varlistentry>
 
530
      <varlistentry>
547
531
        <term><filename
548
532
        class="directory">/var/lib/mandos</filename></term>
549
533
        <listitem>
555
539
        </listitem>
556
540
      </varlistentry>
557
541
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
542
        <term><filename>/dev/log</filename></term>
559
543
        <listitem>
560
544
          <para>
561
545
            The Unix domain socket to where local syslog messages are
586
570
    <para>
587
571
      There is no fine-grained control over logging and debug output.
588
572
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
573
    <para>
 
574
      This server does not check the expire time of clients’ OpenPGP
 
575
      keys.
 
576
    </para>
590
577
  </refsect1>
591
578
  
592
579
  <refsect1 id="example">
642
629
      <title>CLIENTS</title>
643
630
      <para>
644
631
        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
 
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
651
638
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
639
        <manvolnum>5</manvolnum></citerefentry>)
653
640
        <emphasis>must</emphasis> be made non-readable by anyone
705
692
      </varlistentry>
706
693
      <varlistentry>
707
694
        <term>
708
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
695
          <ulink url="http://www.gnu.org/software/gnutls/"
 
696
          >GnuTLS</ulink>
709
697
        </term>
710
698
      <listitem>
711
699
        <para>
712
700
          GnuTLS is the library this server uses to implement TLS for
713
701
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
702
          confidently get the client’s public OpenPGP key.
715
703
        </para>
716
704
      </listitem>
717
705
      </varlistentry>
749
737
      </varlistentry>
750
738
      <varlistentry>
751
739
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
740
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
741
          Protocol Version 1.1</citetitle>
754
742
        </term>
755
743
      <listitem>
756
744
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
745
          TLS 1.1 is the protocol implemented by GnuTLS.
758
746
        </para>
759
747
      </listitem>
760
748
      </varlistentry>
770
758
      </varlistentry>
771
759
      <varlistentry>
772
760
        <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
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
 
          Security (TLS) Authentication</citetitle>
789
 
        </term>
790
 
      <listitem>
791
 
        <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.
 
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.
795
768
        </para>
796
769
      </listitem>
797
770
      </varlistentry>