/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: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir 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 "2014-06-15">
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
40
      <holder>Teddy Hogeborn</holder>
46
41
      <holder>Björn Påhlsson</holder>
47
42
    </copyright>
241
236
        <term><option>--priority <replaceable>
242
237
        PRIORITY</replaceable></option></term>
243
238
        <listitem>
244
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
245
241
        </listitem>
246
242
      </varlistentry>
247
243
      
361
357
      start a TLS protocol handshake with a slight quirk: the Mandos
362
358
      server program acts as a TLS <quote>client</quote> while the
363
359
      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.
 
360
      The Mandos client must supply an OpenPGP certificate, and the
 
361
      fingerprint of this certificate is used by the Mandos server to
 
362
      look up (in a list read from <filename>clients.conf</filename>
 
363
      at start time) which binary blob to give the client.  No other
 
364
      authentication or authorization is done by the server.
369
365
    </para>
370
366
    <table>
371
367
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
387
        </emphasis></entry>
392
388
      </row>
393
389
      <row>
394
 
        <entry>Public key (part of TLS handshake)</entry>
 
390
        <entry>OpenPGP public key (part of TLS handshake)</entry>
395
391
        <entry>-><!-- &rarr; --></entry>
396
392
      </row>
397
393
      <row>
544
540
        </listitem>
545
541
      </varlistentry>
546
542
      <varlistentry>
 
543
        <term><filename class="devicefile">/dev/log</filename></term>
 
544
      </varlistentry>
 
545
      <varlistentry>
547
546
        <term><filename
548
547
        class="directory">/var/lib/mandos</filename></term>
549
548
        <listitem>
555
554
        </listitem>
556
555
      </varlistentry>
557
556
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
557
        <term><filename>/dev/log</filename></term>
559
558
        <listitem>
560
559
          <para>
561
560
            The Unix domain socket to where local syslog messages are
586
585
    <para>
587
586
      There is no fine-grained control over logging and debug output.
588
587
    </para>
589
 
    <xi:include href="bugs.xml"/>
 
588
    <para>
 
589
      This server does not check the expire time of clients’ OpenPGP
 
590
      keys.
 
591
    </para>
590
592
  </refsect1>
591
593
  
592
594
  <refsect1 id="example">
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://www.gnu.org/software/gnutls/"
 
711
          >GnuTLS</ulink>
709
712
        </term>
710
713
      <listitem>
711
714
        <para>
712
715
          GnuTLS is the library this server uses to implement TLS for
713
716
          communicating securely with the client, and at the same time
714
 
          confidently get the client’s public key.
 
717
          confidently get the client’s public OpenPGP key.
715
718
        </para>
716
719
      </listitem>
717
720
      </varlistentry>
749
752
      </varlistentry>
750
753
      <varlistentry>
751
754
        <term>
752
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
 
          Protocol Version 1.2</citetitle>
 
755
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.1</citetitle>
754
757
        </term>
755
758
      <listitem>
756
759
        <para>
757
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
760
          TLS 1.1 is the protocol implemented by GnuTLS.
758
761
        </para>
759
762
      </listitem>
760
763
      </varlistentry>
770
773
      </varlistentry>
771
774
      <varlistentry>
772
775
        <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.
 
776
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security</citetitle>
 
778
        </term>
 
779
      <listitem>
 
780
        <para>
 
781
          This is implemented by GnuTLS and used by this server so
 
782
          that OpenPGP keys can be used.
795
783
        </para>
796
784
      </listitem>
797
785
      </varlistentry>