/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-10 03:54:09 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • Revision ID: teddy@recompile.se-20190210035409-l2mqp2ftzkggwybz
Do minor fix to make mandos-monitor work with new python-urwid

* mandos-monitor (UserInterface.log): Initialize to an
                                      urwid.SimpleListWalker([]), not
                                      an empty list.
  (UserInterface.log_message_raw): Fix off-by-one error.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.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-client">
5
 
<!ENTITY TIMESTAMP "2015-07-08">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
36
38
      <year>2012</year>
37
39
      <year>2013</year>
38
40
      <year>2014</year>
39
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
40
45
      <holder>Teddy Hogeborn</holder>
41
46
      <holder>Björn Påhlsson</holder>
42
47
    </copyright>
90
95
        <replaceable>FILE</replaceable></option></arg>
91
96
      </group>
92
97
      <sbr/>
 
98
      <group>
 
99
        <arg choice="plain"><option>--tls-privkey
 
100
        <replaceable>FILE</replaceable></option></arg>
 
101
        <arg choice="plain"><option>-t
 
102
        <replaceable>FILE</replaceable></option></arg>
 
103
      </group>
 
104
      <sbr/>
 
105
      <group>
 
106
        <arg choice="plain"><option>--tls-pubkey
 
107
        <replaceable>FILE</replaceable></option></arg>
 
108
        <arg choice="plain"><option>-T
 
109
        <replaceable>FILE</replaceable></option></arg>
 
110
      </group>
 
111
      <sbr/>
93
112
      <arg>
94
113
        <option>--priority <replaceable>STRING</replaceable></option>
95
114
      </arg>
149
168
      brings up network interfaces, uses the interfaces’ IPv6
150
169
      link-local addresses to get network connectivity, uses Zeroconf
151
170
      to find servers on the local network, and communicates with
152
 
      servers using TLS with an OpenPGP key to ensure authenticity and
153
 
      confidentiality.  This client program keeps running, trying all
154
 
      servers on the network, until it receives a satisfactory reply
155
 
      or a TERM signal.  After all servers have been tried, all
 
171
      servers using TLS with a raw public key to ensure authenticity
 
172
      and confidentiality.  This client program keeps running, trying
 
173
      all servers on the network, until it receives a satisfactory
 
174
      reply or a TERM signal.  After all servers have been tried, all
156
175
      servers are periodically retried.  If no servers are found it
157
176
      will wait indefinitely for new servers to appear.
158
177
    </para>
302
321
      </varlistentry>
303
322
      
304
323
      <varlistentry>
 
324
        <term><option>--tls-pubkey=<replaceable
 
325
        >FILE</replaceable></option></term>
 
326
        <term><option>-T
 
327
        <replaceable>FILE</replaceable></option></term>
 
328
        <listitem>
 
329
          <para>
 
330
            TLS raw public key file name.  The default name is
 
331
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
332
            ></quote>.
 
333
          </para>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
 
 
337
      <varlistentry>
 
338
        <term><option>--tls-privkey=<replaceable
 
339
        >FILE</replaceable></option></term>
 
340
        <term><option>-t
 
341
        <replaceable>FILE</replaceable></option></term>
 
342
        <listitem>
 
343
          <para>
 
344
            TLS secret key file name.  The default name is
 
345
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
346
            ></quote>.
 
347
          </para>
 
348
        </listitem>
 
349
      </varlistentry>
 
350
 
 
351
      <varlistentry>
305
352
        <term><option>--priority=<replaceable
306
353
        >STRING</replaceable></option></term>
307
354
        <listitem>
317
364
          <para>
318
365
            Sets the number of bits to use for the prime number in the
319
366
            TLS Diffie-Hellman key exchange.  The default value is
320
 
            selected automatically based on the OpenPGP key.  Note
321
 
            that if the <option>--dh-params</option> option is used,
322
 
            the values from that file will be used instead.
 
367
            selected automatically based on the GnuTLS security
 
368
            profile set in its priority string.  Note that if the
 
369
            <option>--dh-params</option> option is used, the values
 
370
            from that file will be used instead.
323
371
          </para>
324
372
        </listitem>
325
373
      </varlistentry>
677
725
        </listitem>
678
726
      </varlistentry>
679
727
      <varlistentry>
 
728
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
729
        ></term>
 
730
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
731
        ></term>
 
732
        <listitem>
 
733
          <para>
 
734
            Public and private raw key files, in <quote>PEM</quote>
 
735
            format.  These are the default file names, they can be
 
736
            changed with the <option>--tls-pubkey</option> and
 
737
            <option>--tls-privkey</option> options.
 
738
          </para>
 
739
        </listitem>
 
740
      </varlistentry>
 
741
      <varlistentry>
680
742
        <term><filename
681
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
682
744
        <listitem>
690
752
    </variablelist>
691
753
  </refsect1>
692
754
  
693
 
<!--   <refsect1 id="bugs"> -->
694
 
<!--     <title>BUGS</title> -->
695
 
<!--     <para> -->
696
 
<!--     </para> -->
697
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
698
759
  
699
760
  <refsect1 id="example">
700
761
    <title>EXAMPLE</title>
725
786
    </informalexample>
726
787
    <informalexample>
727
788
      <para>
728
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
729
790
      </para>
730
791
      <para>
731
792
 
732
793
<!-- do not wrap this line -->
733
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
794
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
734
795
 
735
796
      </para>
736
797
    </informalexample>
737
798
    <informalexample>
738
799
      <para>
739
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
800
        Run in debug mode, with custom keys, and do not use Zeroconf
740
801
        to locate a server; connect directly to the IPv6 link-local
741
802
        address <quote><systemitem class="ipaddress"
742
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
745
806
      <para>
746
807
 
747
808
<!-- do not wrap this line -->
748
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
809
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
749
810
 
750
811
      </para>
751
812
    </informalexample>
775
836
    <para>
776
837
      The only remaining weak point is that someone with physical
777
838
      access to the client hard drive might turn off the client
778
 
      computer, read the OpenPGP keys directly from the hard drive,
779
 
      and communicate with the server.  To safeguard against this, the
780
 
      server is supposed to notice the client disappearing and stop
781
 
      giving out the encrypted data.  Therefore, it is important to
782
 
      set the timeout and checker interval values tightly on the
783
 
      server.  See <citerefentry><refentrytitle
 
839
      computer, read the OpenPGP and TLS keys directly from the hard
 
840
      drive, and communicate with the server.  To safeguard against
 
841
      this, the server is supposed to notice the client disappearing
 
842
      and stop giving out the encrypted data.  Therefore, it is
 
843
      important to set the timeout and checker interval values tightly
 
844
      on the server.  See <citerefentry><refentrytitle
784
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
785
846
    </para>
786
847
    <para>
840
901
      </varlistentry>
841
902
      <varlistentry>
842
903
        <term>
843
 
          <ulink url="http://www.gnu.org/software/gnutls/"
844
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
845
905
        </term>
846
906
      <listitem>
847
907
        <para>
848
908
          GnuTLS is the library this client uses to implement TLS for
849
909
          communicating securely with the server, and at the same time
850
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
851
911
        </para>
852
912
      </listitem>
853
913
      </varlistentry>
854
914
      <varlistentry>
855
915
        <term>
856
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
857
917
                 >GPGME</ulink>
858
918
        </term>
859
919
        <listitem>
897
957
      </varlistentry>
898
958
      <varlistentry>
899
959
        <term>
900
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
901
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
902
962
        </term>
903
963
      <listitem>
904
964
        <para>
905
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
906
966
        </para>
907
967
      </listitem>
908
968
      </varlistentry>
919
979
      </varlistentry>
920
980
      <varlistentry>
921
981
        <term>
922
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
982
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
983
          Layer Security (TLS) and Datagram Transport Layer Security
 
984
          (DTLS)</citetitle>
 
985
        </term>
 
986
      <listitem>
 
987
        <para>
 
988
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
989
          present, used by this program so that raw public keys can be
 
990
          used.
 
991
        </para>
 
992
      </listitem>
 
993
      </varlistentry>
 
994
      <varlistentry>
 
995
        <term>
 
996
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
923
997
          Security</citetitle>
924
998
        </term>
925
999
      <listitem>
926
1000
        <para>
927
 
          This is implemented by GnuTLS and used by this program so
928
 
          that OpenPGP keys can be used.
 
1001
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1002
          if present, used by this program so that OpenPGP keys can be
 
1003
          used.
929
1004
        </para>
930
1005
      </listitem>
931
1006
      </varlistentry>