/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: 2014-01-06 16:01:46 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20140106160146-v5gnpwf0vidfz7h7
Minor code fix; raise only exception instances, not classes.

* mandos (DBusObjectWithProperties.Set): Add error message if raising
                                         ValueError (should never
                                         happen anyway).

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 "2013-10-20">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
96
88
        <replaceable>FILE</replaceable></option></arg>
97
89
      </group>
98
90
      <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
91
      <arg>
114
92
        <option>--priority <replaceable>STRING</replaceable></option>
115
93
      </arg>
119
97
      </arg>
120
98
      <sbr/>
121
99
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
100
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
101
      </arg>
128
102
      <sbr/>
169
143
      brings up network interfaces, uses the interfaces’ IPv6
170
144
      link-local addresses to get network connectivity, uses Zeroconf
171
145
      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
 
146
      servers using TLS with an OpenPGP key to ensure authenticity and
 
147
      confidentiality.  This client program keeps running, trying all
 
148
      servers on the network, until it receives a satisfactory reply
 
149
      or a TERM signal.  After all servers have been tried, all
176
150
      servers are periodically retried.  If no servers are found it
177
151
      will wait indefinitely for new servers to appear.
178
152
    </para>
245
219
            assumed to separate the address from the port number.
246
220
          </para>
247
221
          <para>
248
 
            Normally, Zeroconf would be used to locate Mandos servers,
249
 
            in which case this option would only be used when testing
250
 
            and debugging.
 
222
            This option is normally only useful for testing and
 
223
            debugging.
251
224
          </para>
252
225
        </listitem>
253
226
      </varlistentry>
286
259
          <para>
287
260
            <replaceable>NAME</replaceable> can be the string
288
261
            <quote><literal>none</literal></quote>; this will make
289
 
            <command>&COMMANDNAME;</command> only bring up interfaces
290
 
            specified <emphasis>before</emphasis> this string.  This
291
 
            is not recommended, and only meant for advanced users.
 
262
            <command>&COMMANDNAME;</command> not bring up
 
263
            <emphasis>any</emphasis> interfaces specified
 
264
            <emphasis>after</emphasis> this string.  This is not
 
265
            recommended, and only meant for advanced users.
292
266
          </para>
293
267
        </listitem>
294
268
      </varlistentry>
322
296
      </varlistentry>
323
297
      
324
298
      <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
299
        <term><option>--priority=<replaceable
354
300
        >STRING</replaceable></option></term>
355
301
        <listitem>
364
310
        <listitem>
365
311
          <para>
366
312
            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.
 
313
            TLS Diffie-Hellman key exchange.  Default is 1024.
389
314
          </para>
390
315
        </listitem>
391
316
      </varlistentry>
518
443
  
519
444
  <refsect1 id="environment">
520
445
    <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>
534
446
    <para>
535
 
      This program does not use any other environment variables, not
536
 
      even the ones provided by <citerefentry><refentrytitle
 
447
      This program does not use any environment variables, not even
 
448
      the ones provided by <citerefentry><refentrytitle
537
449
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
538
450
    </citerefentry>.
539
451
    </para>
726
638
        </listitem>
727
639
      </varlistentry>
728
640
      <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
641
        <term><filename
744
642
        class="directory">/lib/mandos/network-hooks.d</filename></term>
745
643
        <listitem>
753
651
    </variablelist>
754
652
  </refsect1>
755
653
  
756
 
  <refsect1 id="bugs">
757
 
    <title>BUGS</title>
758
 
    <xi:include href="../bugs.xml"/>
759
 
  </refsect1>
 
654
<!--   <refsect1 id="bugs"> -->
 
655
<!--     <title>BUGS</title> -->
 
656
<!--     <para> -->
 
657
<!--     </para> -->
 
658
<!--   </refsect1> -->
760
659
  
761
660
  <refsect1 id="example">
762
661
    <title>EXAMPLE</title>
787
686
    </informalexample>
788
687
    <informalexample>
789
688
      <para>
790
 
        Run in debug mode, and use custom keys:
 
689
        Run in debug mode, and use a custom key:
791
690
      </para>
792
691
      <para>
793
692
 
794
693
<!-- 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>
 
694
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
796
695
 
797
696
      </para>
798
697
    </informalexample>
799
698
    <informalexample>
800
699
      <para>
801
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
700
        Run in debug mode, with a custom key, and do not use Zeroconf
802
701
        to locate a server; connect directly to the IPv6 link-local
803
702
        address <quote><systemitem class="ipaddress"
804
703
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
807
706
      <para>
808
707
 
809
708
<!-- 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>
 
709
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
811
710
 
812
711
      </para>
813
712
    </informalexample>
837
736
    <para>
838
737
      The only remaining weak point is that someone with physical
839
738
      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
 
739
      computer, read the OpenPGP keys directly from the hard drive,
 
740
      and communicate with the server.  To safeguard against this, the
 
741
      server is supposed to notice the client disappearing and stop
 
742
      giving out the encrypted data.  Therefore, it is important to
 
743
      set the timeout and checker interval values tightly on the
 
744
      server.  See <citerefentry><refentrytitle
846
745
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
847
746
    </para>
848
747
    <para>
849
748
      It will also help if the checker program on the server is
850
749
      configured to request something from the client which can not be
851
 
      spoofed by someone else on the network, like SSH server key
852
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
853
 
      echo (<quote>ping</quote>) replies.
 
750
      spoofed by someone else on the network, unlike unencrypted
 
751
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
854
752
    </para>
855
753
    <para>
856
754
      <emphasis>Note</emphasis>: This makes it completely insecure to
902
800
      </varlistentry>
903
801
      <varlistentry>
904
802
        <term>
905
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
803
          <ulink url="http://www.gnu.org/software/gnutls/"
 
804
          >GnuTLS</ulink>
906
805
        </term>
907
806
      <listitem>
908
807
        <para>
909
808
          GnuTLS is the library this client uses to implement TLS for
910
809
          communicating securely with the server, and at the same time
911
 
          send the public key to the server.
 
810
          send the public OpenPGP key to the server.
912
811
        </para>
913
812
      </listitem>
914
813
      </varlistentry>
915
814
      <varlistentry>
916
815
        <term>
917
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
816
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
918
817
                 >GPGME</ulink>
919
818
        </term>
920
819
        <listitem>
958
857
      </varlistentry>
959
858
      <varlistentry>
960
859
        <term>
961
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
962
 
          Protocol Version 1.2</citetitle>
 
860
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
861
          Protocol Version 1.1</citetitle>
963
862
        </term>
964
863
      <listitem>
965
864
        <para>
966
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
865
          TLS 1.1 is the protocol implemented by GnuTLS.
967
866
        </para>
968
867
      </listitem>
969
868
      </varlistentry>
980
879
      </varlistentry>
981
880
      <varlistentry>
982
881
        <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
 
882
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
998
883
          Security</citetitle>
999
884
        </term>
1000
885
      <listitem>
1001
886
        <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.
 
887
          This is implemented by GnuTLS and used by this program so
 
888
          that OpenPGP keys can be used.
1005
889
        </para>
1006
890
      </listitem>
1007
891
      </varlistentry>