/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 plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2019-02-13 08:45:09 UTC
  • Revision ID: teddy@recompile.se-20190213084509-bb2uu006vip11v7l
http://bugs.debian.org/922202
Remove modification of debian/control file

* debian/rules (override_dh_shlibdeps-arch): Commented out.

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-06">
 
5
<!ENTITY TIMESTAMP "2019-02-10">
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>
 
45
      <year>2019</year>
40
46
      <holder>Teddy Hogeborn</holder>
41
47
      <holder>Björn Påhlsson</holder>
42
48
    </copyright>
90
96
        <replaceable>FILE</replaceable></option></arg>
91
97
      </group>
92
98
      <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/>
93
113
      <arg>
94
114
        <option>--priority <replaceable>STRING</replaceable></option>
95
115
      </arg>
99
119
      </arg>
100
120
      <sbr/>
101
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
102
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
103
127
      </arg>
104
128
      <sbr/>
145
169
      brings up network interfaces, uses the interfaces’ IPv6
146
170
      link-local addresses to get network connectivity, uses Zeroconf
147
171
      to find servers on the local network, and communicates with
148
 
      servers using TLS with an OpenPGP key to ensure authenticity and
149
 
      confidentiality.  This client program keeps running, trying all
150
 
      servers on the network, until it receives a satisfactory reply
151
 
      or a TERM signal.  After all servers have been tried, all
 
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
152
176
      servers are periodically retried.  If no servers are found it
153
177
      will wait indefinitely for new servers to appear.
154
178
    </para>
298
322
      </varlistentry>
299
323
      
300
324
      <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>
301
353
        <term><option>--priority=<replaceable
302
354
        >STRING</replaceable></option></term>
303
355
        <listitem>
313
365
          <para>
314
366
            Sets the number of bits to use for the prime number in the
315
367
            TLS Diffie-Hellman key exchange.  The default value is
316
 
            selected automatically based on the OpenPGP key.
 
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.
 
372
          </para>
 
373
        </listitem>
 
374
      </varlistentry>
 
375
      
 
376
      <varlistentry>
 
377
        <term><option>--dh-params=<replaceable
 
378
        >FILE</replaceable></option></term>
 
379
        <listitem>
 
380
          <para>
 
381
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
382
            needed by the TLS Diffie-Hellman key exchange from.  If
 
383
            this option is not given, or if the file for some reason
 
384
            could not be used, the parameters will be generated on
 
385
            startup, which will take some time and processing power.
 
386
            Those using servers running under time, power or processor
 
387
            constraints may want to generate such a file in advance
 
388
            and use this option.
317
389
          </para>
318
390
        </listitem>
319
391
      </varlistentry>
654
726
        </listitem>
655
727
      </varlistentry>
656
728
      <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>
657
743
        <term><filename
658
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
659
745
        <listitem>
667
753
    </variablelist>
668
754
  </refsect1>
669
755
  
670
 
<!--   <refsect1 id="bugs"> -->
671
 
<!--     <title>BUGS</title> -->
672
 
<!--     <para> -->
673
 
<!--     </para> -->
674
 
<!--   </refsect1> -->
 
756
  <refsect1 id="bugs">
 
757
    <title>BUGS</title>
 
758
    <xi:include href="../bugs.xml"/>
 
759
  </refsect1>
675
760
  
676
761
  <refsect1 id="example">
677
762
    <title>EXAMPLE</title>
702
787
    </informalexample>
703
788
    <informalexample>
704
789
      <para>
705
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
706
791
      </para>
707
792
      <para>
708
793
 
709
794
<!-- do not wrap this line -->
710
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
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>
711
796
 
712
797
      </para>
713
798
    </informalexample>
714
799
    <informalexample>
715
800
      <para>
716
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
801
        Run in debug mode, with custom keys, and do not use Zeroconf
717
802
        to locate a server; connect directly to the IPv6 link-local
718
803
        address <quote><systemitem class="ipaddress"
719
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
722
807
      <para>
723
808
 
724
809
<!-- do not wrap this line -->
725
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
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>
726
811
 
727
812
      </para>
728
813
    </informalexample>
752
837
    <para>
753
838
      The only remaining weak point is that someone with physical
754
839
      access to the client hard drive might turn off the client
755
 
      computer, read the OpenPGP keys directly from the hard drive,
756
 
      and communicate with the server.  To safeguard against this, the
757
 
      server is supposed to notice the client disappearing and stop
758
 
      giving out the encrypted data.  Therefore, it is important to
759
 
      set the timeout and checker interval values tightly on the
760
 
      server.  See <citerefentry><refentrytitle
 
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
761
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
762
847
    </para>
763
848
    <para>
817
902
      </varlistentry>
818
903
      <varlistentry>
819
904
        <term>
820
 
          <ulink url="http://www.gnu.org/software/gnutls/"
821
 
          >GnuTLS</ulink>
 
905
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
822
906
        </term>
823
907
      <listitem>
824
908
        <para>
825
909
          GnuTLS is the library this client uses to implement TLS for
826
910
          communicating securely with the server, and at the same time
827
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
828
912
        </para>
829
913
      </listitem>
830
914
      </varlistentry>
831
915
      <varlistentry>
832
916
        <term>
833
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
917
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
834
918
                 >GPGME</ulink>
835
919
        </term>
836
920
        <listitem>
874
958
      </varlistentry>
875
959
      <varlistentry>
876
960
        <term>
877
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
878
 
          Protocol Version 1.1</citetitle>
 
961
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
962
          Protocol Version 1.2</citetitle>
879
963
        </term>
880
964
      <listitem>
881
965
        <para>
882
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
966
          TLS 1.2 is the protocol implemented by GnuTLS.
883
967
        </para>
884
968
      </listitem>
885
969
      </varlistentry>
896
980
      </varlistentry>
897
981
      <varlistentry>
898
982
        <term>
899
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
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
900
998
          Security</citetitle>
901
999
        </term>
902
1000
      <listitem>
903
1001
        <para>
904
 
          This is implemented by GnuTLS and used by this program so
905
 
          that OpenPGP keys can be used.
 
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.
906
1005
        </para>
907
1006
      </listitem>
908
1007
      </varlistentry>