/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-03-17 18:17:02 UTC
  • Revision ID: teddy@recompile.se-20190317181702-tf6uvnb0gnyw9z8v
mandos-ctl: Refactor tests

* mandos-ctl (Test_check_option_syntax.redirect_stderr_to_devnull):
  Override file objects instead of raw file descriptors.

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-03-08">
 
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>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
89
96
        <replaceable>FILE</replaceable></option></arg>
90
97
      </group>
91
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/>
92
113
      <arg>
93
114
        <option>--priority <replaceable>STRING</replaceable></option>
94
115
      </arg>
98
119
      </arg>
99
120
      <sbr/>
100
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
101
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
127
      </arg>
103
128
      <sbr/>
144
169
      brings up network interfaces, uses the interfaces’ IPv6
145
170
      link-local addresses to get network connectivity, uses Zeroconf
146
171
      to find servers on the local network, and communicates with
147
 
      servers using TLS with an OpenPGP key to ensure authenticity and
148
 
      confidentiality.  This client program keeps running, trying all
149
 
      servers on the network, until it receives a satisfactory reply
150
 
      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
151
176
      servers are periodically retried.  If no servers are found it
152
177
      will wait indefinitely for new servers to appear.
153
178
    </para>
297
322
      </varlistentry>
298
323
      
299
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>
300
353
        <term><option>--priority=<replaceable
301
354
        >STRING</replaceable></option></term>
302
355
        <listitem>
312
365
          <para>
313
366
            Sets the number of bits to use for the prime number in the
314
367
            TLS Diffie-Hellman key exchange.  The default value is
315
 
            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.
316
389
          </para>
317
390
        </listitem>
318
391
      </varlistentry>
445
518
  
446
519
  <refsect1 id="environment">
447
520
    <title>ENVIRONMENT</title>
 
521
    <variablelist>
 
522
      <varlistentry>
 
523
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
524
        <listitem>
 
525
          <para>
 
526
            This environment variable will be assumed to contain the
 
527
            directory containing any helper executables.  The use and
 
528
            nature of these helper executables, if any, is
 
529
            purposefully not documented.
 
530
        </para>
 
531
        </listitem>
 
532
      </varlistentry>
 
533
    </variablelist>
448
534
    <para>
449
 
      This program does not use any environment variables, not even
450
 
      the ones provided by <citerefentry><refentrytitle
 
535
      This program does not use any other environment variables, not
 
536
      even the ones provided by <citerefentry><refentrytitle
451
537
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
452
538
    </citerefentry>.
453
539
    </para>
640
726
        </listitem>
641
727
      </varlistentry>
642
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>
643
743
        <term><filename
644
744
        class="directory">/lib/mandos/network-hooks.d</filename></term>
645
745
        <listitem>
653
753
    </variablelist>
654
754
  </refsect1>
655
755
  
656
 
<!--   <refsect1 id="bugs"> -->
657
 
<!--     <title>BUGS</title> -->
658
 
<!--     <para> -->
659
 
<!--     </para> -->
660
 
<!--   </refsect1> -->
 
756
  <refsect1 id="bugs">
 
757
    <title>BUGS</title>
 
758
    <xi:include href="../bugs.xml"/>
 
759
  </refsect1>
661
760
  
662
761
  <refsect1 id="example">
663
762
    <title>EXAMPLE</title>
688
787
    </informalexample>
689
788
    <informalexample>
690
789
      <para>
691
 
        Run in debug mode, and use a custom key:
 
790
        Run in debug mode, and use custom keys:
692
791
      </para>
693
792
      <para>
694
793
 
695
794
<!-- do not wrap this line -->
696
 
<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>
697
796
 
698
797
      </para>
699
798
    </informalexample>
700
799
    <informalexample>
701
800
      <para>
702
 
        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
703
802
        to locate a server; connect directly to the IPv6 link-local
704
803
        address <quote><systemitem class="ipaddress"
705
804
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
708
807
      <para>
709
808
 
710
809
<!-- do not wrap this line -->
711
 
<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>
712
811
 
713
812
      </para>
714
813
    </informalexample>
738
837
    <para>
739
838
      The only remaining weak point is that someone with physical
740
839
      access to the client hard drive might turn off the client
741
 
      computer, read the OpenPGP keys directly from the hard drive,
742
 
      and communicate with the server.  To safeguard against this, the
743
 
      server is supposed to notice the client disappearing and stop
744
 
      giving out the encrypted data.  Therefore, it is important to
745
 
      set the timeout and checker interval values tightly on the
746
 
      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
747
846
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
748
847
    </para>
749
848
    <para>
803
902
      </varlistentry>
804
903
      <varlistentry>
805
904
        <term>
806
 
          <ulink url="http://www.gnu.org/software/gnutls/"
807
 
          >GnuTLS</ulink>
 
905
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
808
906
        </term>
809
907
      <listitem>
810
908
        <para>
811
909
          GnuTLS is the library this client uses to implement TLS for
812
910
          communicating securely with the server, and at the same time
813
 
          send the public OpenPGP key to the server.
 
911
          send the public key to the server.
814
912
        </para>
815
913
      </listitem>
816
914
      </varlistentry>
817
915
      <varlistentry>
818
916
        <term>
819
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
917
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
820
918
                 >GPGME</ulink>
821
919
        </term>
822
920
        <listitem>
860
958
      </varlistentry>
861
959
      <varlistentry>
862
960
        <term>
863
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
864
 
          Protocol Version 1.1</citetitle>
 
961
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
962
          Protocol Version 1.2</citetitle>
865
963
        </term>
866
964
      <listitem>
867
965
        <para>
868
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
966
          TLS 1.2 is the protocol implemented by GnuTLS.
869
967
        </para>
870
968
      </listitem>
871
969
      </varlistentry>
882
980
      </varlistentry>
883
981
      <varlistentry>
884
982
        <term>
885
 
          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
886
998
          Security</citetitle>
887
999
        </term>
888
1000
      <listitem>
889
1001
        <para>
890
 
          This is implemented by GnuTLS and used by this program so
891
 
          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.
892
1005
        </para>
893
1006
      </listitem>
894
1007
      </varlistentry>