/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-07-27 19:28:14 UTC
  • Revision ID: teddy@recompile.se-20190727192814-wzkmawaw88pn47s1
Add debconf translation support

* debian/mandos-client.templates: Reformatted by
                                  debconf-gettextize(1).
* debian/mandos.templates: - '' -
* debian/po/POTFILES.in: New.
* debian/po/templates.pot: - '' -

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-06-29">
 
5
<!ENTITY TIMESTAMP "2019-07-24">
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>
312
364
        <listitem>
313
365
          <para>
314
366
            Sets the number of bits to use for the prime number in the
315
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
367
            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.
 
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.
316
389
          </para>
317
390
        </listitem>
318
391
      </varlistentry>
452
525
          <para>
453
526
            This environment variable will be assumed to contain the
454
527
            directory containing any helper executables.  The use and
455
 
            nature of these helper executables, if any, is
456
 
            purposefully not documented.
 
528
            nature of these helper executables, if any, is purposely
 
529
            not documented.
457
530
        </para>
458
531
        </listitem>
459
532
      </varlistentry>
653
726
        </listitem>
654
727
      </varlistentry>
655
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>
656
743
        <term><filename
657
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
658
745
        <listitem>
666
753
    </variablelist>
667
754
  </refsect1>
668
755
  
669
 
<!--   <refsect1 id="bugs"> -->
670
 
<!--     <title>BUGS</title> -->
671
 
<!--     <para> -->
672
 
<!--     </para> -->
673
 
<!--   </refsect1> -->
 
756
  <refsect1 id="bugs">
 
757
    <title>BUGS</title>
 
758
    <xi:include href="../bugs.xml"/>
 
759
  </refsect1>
674
760
  
675
761
  <refsect1 id="example">
676
762
    <title>EXAMPLE</title>
701
787
    </informalexample>
702
788
    <informalexample>
703
789
      <para>
704
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
705
791
      </para>
706
792
      <para>
707
793
 
708
794
<!-- do not wrap this line -->
709
 
<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>
710
796
 
711
797
      </para>
712
798
    </informalexample>
713
799
    <informalexample>
714
800
      <para>
715
 
        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
716
802
        to locate a server; connect directly to the IPv6 link-local
717
803
        address <quote><systemitem class="ipaddress"
718
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
721
807
      <para>
722
808
 
723
809
<!-- do not wrap this line -->
724
 
<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>
725
811
 
726
812
      </para>
727
813
    </informalexample>
730
816
  <refsect1 id="security">
731
817
    <title>SECURITY</title>
732
818
    <para>
733
 
      This program is set-uid to root, but will switch back to the
734
 
      original (and presumably non-privileged) user and group after
735
 
      bringing up the network interface.
 
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.
736
822
    </para>
737
823
    <para>
738
824
      To use this program for its intended purpose (see <xref
751
837
    <para>
752
838
      The only remaining weak point is that someone with physical
753
839
      access to the client hard drive might turn off the client
754
 
      computer, read the OpenPGP keys directly from the hard drive,
755
 
      and communicate with the server.  To safeguard against this, the
756
 
      server is supposed to notice the client disappearing and stop
757
 
      giving out the encrypted data.  Therefore, it is important to
758
 
      set the timeout and checker interval values tightly on the
759
 
      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
760
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
761
847
    </para>
762
848
    <para>
805
891
      </varlistentry>
806
892
      <varlistentry>
807
893
        <term>
808
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
894
          <ulink url="https://www.avahi.org/">Avahi</ulink>
809
895
        </term>
810
896
      <listitem>
811
897
        <para>
816
902
      </varlistentry>
817
903
      <varlistentry>
818
904
        <term>
819
 
          <ulink url="http://www.gnu.org/software/gnutls/"
820
 
          >GnuTLS</ulink>
 
905
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
821
906
        </term>
822
907
      <listitem>
823
908
        <para>
824
909
          GnuTLS is the library this client uses to implement TLS for
825
910
          communicating securely with the server, and at the same time
826
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
827
912
        </para>
828
913
      </listitem>
829
914
      </varlistentry>
830
915
      <varlistentry>
831
916
        <term>
832
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
917
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
833
918
                 >GPGME</ulink>
834
919
        </term>
835
920
        <listitem>
873
958
      </varlistentry>
874
959
      <varlistentry>
875
960
        <term>
876
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
877
 
          Protocol Version 1.1</citetitle>
 
961
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
962
          Protocol Version 1.2</citetitle>
878
963
        </term>
879
964
      <listitem>
880
965
        <para>
881
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
966
          TLS 1.2 is the protocol implemented by GnuTLS.
882
967
        </para>
883
968
      </listitem>
884
969
      </varlistentry>
895
980
      </varlistentry>
896
981
      <varlistentry>
897
982
        <term>
898
 
          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
899
998
          Security</citetitle>
900
999
        </term>
901
1000
      <listitem>
902
1001
        <para>
903
 
          This is implemented by GnuTLS and used by this program so
904
 
          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.
905
1005
        </para>
906
1006
      </listitem>
907
1007
      </varlistentry>