/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: 2015-07-05 21:38:01 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150705213801-pi8vk0ovlumuj826
plugin-helpers/mandos-client-iprouteadddel.c: Fix #include lines.
(main): Fix minor typo in error message.

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-02-10">
 
5
<!ENTITY TIMESTAMP "2015-06-29">
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>
38
36
      <year>2012</year>
39
37
      <year>2013</year>
40
38
      <year>2014</year>
41
39
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
96
90
        <replaceable>FILE</replaceable></option></arg>
97
91
      </group>
98
92
      <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
93
      <arg>
114
94
        <option>--priority <replaceable>STRING</replaceable></option>
115
95
      </arg>
119
99
      </arg>
120
100
      <sbr/>
121
101
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
102
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
103
      </arg>
128
104
      <sbr/>
169
145
      brings up network interfaces, uses the interfaces’ IPv6
170
146
      link-local addresses to get network connectivity, uses Zeroconf
171
147
      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
 
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
176
152
      servers are periodically retried.  If no servers are found it
177
153
      will wait indefinitely for new servers to appear.
178
154
    </para>
322
298
      </varlistentry>
323
299
      
324
300
      <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
301
        <term><option>--priority=<replaceable
354
302
        >STRING</replaceable></option></term>
355
303
        <listitem>
364
312
        <listitem>
365
313
          <para>
366
314
            Sets the number of bits to use for the prime number in the
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.
 
315
            TLS Diffie-Hellman key exchange.  Default is 1024.
389
316
          </para>
390
317
        </listitem>
391
318
      </varlistentry>
525
452
          <para>
526
453
            This environment variable will be assumed to contain the
527
454
            directory containing any helper executables.  The use and
528
 
            nature of these helper executables, if any, is purposely
529
 
            not documented.
 
455
            nature of these helper executables, if any, is
 
456
            purposefully not documented.
530
457
        </para>
531
458
        </listitem>
532
459
      </varlistentry>
726
653
        </listitem>
727
654
      </varlistentry>
728
655
      <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
656
        <term><filename
744
657
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
658
        <listitem>
753
666
    </variablelist>
754
667
  </refsect1>
755
668
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
669
<!--   <refsect1 id="bugs"> -->
 
670
<!--     <title>BUGS</title> -->
 
671
<!--     <para> -->
 
672
<!--     </para> -->
 
673
<!--   </refsect1> -->
760
674
  
761
675
  <refsect1 id="example">
762
676
    <title>EXAMPLE</title>
787
701
    </informalexample>
788
702
    <informalexample>
789
703
      <para>
790
 
        Run in debug mode, and use custom keys:
 
704
        Run in debug mode, and use a custom key:
791
705
      </para>
792
706
      <para>
793
707
 
794
708
<!-- 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>
 
709
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
710
 
797
711
      </para>
798
712
    </informalexample>
799
713
    <informalexample>
800
714
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
715
        Run in debug mode, with a custom key, and do not use Zeroconf
802
716
        to locate a server; connect directly to the IPv6 link-local
803
717
        address <quote><systemitem class="ipaddress"
804
718
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
721
      <para>
808
722
 
809
723
<!-- 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>
 
724
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
725
 
812
726
      </para>
813
727
    </informalexample>
837
751
    <para>
838
752
      The only remaining weak point is that someone with physical
839
753
      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
 
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
846
760
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
761
    </para>
848
762
    <para>
902
816
      </varlistentry>
903
817
      <varlistentry>
904
818
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
819
          <ulink url="http://www.gnu.org/software/gnutls/"
 
820
          >GnuTLS</ulink>
906
821
        </term>
907
822
      <listitem>
908
823
        <para>
909
824
          GnuTLS is the library this client uses to implement TLS for
910
825
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
826
          send the public OpenPGP key to the server.
912
827
        </para>
913
828
      </listitem>
914
829
      </varlistentry>
915
830
      <varlistentry>
916
831
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
832
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
833
                 >GPGME</ulink>
919
834
        </term>
920
835
        <listitem>
958
873
      </varlistentry>
959
874
      <varlistentry>
960
875
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
876
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
877
          Protocol Version 1.1</citetitle>
963
878
        </term>
964
879
      <listitem>
965
880
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
881
          TLS 1.1 is the protocol implemented by GnuTLS.
967
882
        </para>
968
883
      </listitem>
969
884
      </varlistentry>
980
895
      </varlistentry>
981
896
      <varlistentry>
982
897
        <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
 
898
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
899
          Security</citetitle>
999
900
        </term>
1000
901
      <listitem>
1001
902
        <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.
 
903
          This is implemented by GnuTLS and used by this program so
 
904
          that OpenPGP keys can be used.
1005
905
        </para>
1006
906
      </listitem>
1007
907
      </varlistentry>