/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: 2015-08-10 08:25:01 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150810082501-rb7w2dre1flqiqe2
Refactor D-Bus annotation class out from D-Bus properties class.

* mandos (DBusObjectWithAnnotations): New; factored out D-Bus
                                      annotations code from
                                      DBusObjectWithProperties class.
  (DBusObjectWithProperties): Inherit from DBusObjectWithAnnotations.
  (main/MandosDBusService): - '' -
  (main/MandosDBusService._foo): Removed interface annotation for
                                 "o.f.D.Property.EmitsChangedSignal";
                                 this object has no properties.

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