/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: Björn Påhlsson
  • Date: 2012-07-03 20:55:09 UTC
  • Revision ID: belorn@recompile.se-20120703205509-fkeb6uqy4i6gt4b6
added note messages when mandos-monitor starts without running server,
or a server with no clients.

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-09">
 
5
<!ENTITY TIMESTAMP "2012-06-17">
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
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
37
      <holder>Teddy Hogeborn</holder>
46
38
      <holder>Björn Påhlsson</holder>
47
39
    </copyright>
95
87
        <replaceable>FILE</replaceable></option></arg>
96
88
      </group>
97
89
      <sbr/>
98
 
      <group>
99
 
        <arg choice="plain"><option>--tls-privkey
100
 
        <replaceable>FILE</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-t
102
 
        <replaceable>FILE</replaceable></option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group>
106
 
        <arg choice="plain"><option>--tls-pubkey
107
 
        <replaceable>FILE</replaceable></option></arg>
108
 
        <arg choice="plain"><option>-T
109
 
        <replaceable>FILE</replaceable></option></arg>
110
 
      </group>
111
 
      <sbr/>
112
90
      <arg>
113
91
        <option>--priority <replaceable>STRING</replaceable></option>
114
92
      </arg>
118
96
      </arg>
119
97
      <sbr/>
120
98
      <arg>
121
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
122
 
      </arg>
123
 
      <sbr/>
124
 
      <arg>
125
99
        <option>--delay <replaceable>SECONDS</replaceable></option>
126
100
      </arg>
127
101
      <sbr/>
168
142
      brings up network interfaces, uses the interfaces’ IPv6
169
143
      link-local addresses to get network connectivity, uses Zeroconf
170
144
      to find servers on the local network, and communicates with
171
 
      servers using TLS with a raw public key to ensure authenticity
172
 
      and confidentiality.  This client program keeps running, trying
173
 
      all servers on the network, until it receives a satisfactory
174
 
      reply or a TERM signal.  After all servers have been tried, all
 
145
      servers using TLS with an OpenPGP key to ensure authenticity and
 
146
      confidentiality.  This client program keeps running, trying all
 
147
      servers on the network, until it receives a satisfactory reply
 
148
      or a TERM signal.  After all servers have been tried, all
175
149
      servers are periodically retried.  If no servers are found it
176
150
      will wait indefinitely for new servers to appear.
177
151
    </para>
244
218
            assumed to separate the address from the port number.
245
219
          </para>
246
220
          <para>
247
 
            Normally, Zeroconf would be used to locate Mandos servers,
248
 
            in which case this option would only be used when testing
249
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
250
223
          </para>
251
224
        </listitem>
252
225
      </varlistentry>
285
258
          <para>
286
259
            <replaceable>NAME</replaceable> can be the string
287
260
            <quote><literal>none</literal></quote>; this will make
288
 
            <command>&COMMANDNAME;</command> only bring up interfaces
289
 
            specified <emphasis>before</emphasis> this string.  This
290
 
            is not recommended, and only meant for advanced users.
 
261
            <command>&COMMANDNAME;</command> not bring up
 
262
            <emphasis>any</emphasis> interfaces specified
 
263
            <emphasis>after</emphasis> this string.  This is not
 
264
            recommended, and only meant for advanced users.
291
265
          </para>
292
266
        </listitem>
293
267
      </varlistentry>
321
295
      </varlistentry>
322
296
      
323
297
      <varlistentry>
324
 
        <term><option>--tls-pubkey=<replaceable
325
 
        >FILE</replaceable></option></term>
326
 
        <term><option>-T
327
 
        <replaceable>FILE</replaceable></option></term>
328
 
        <listitem>
329
 
          <para>
330
 
            TLS raw public key file name.  The default name is
331
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
332
 
            ></quote>.
333
 
          </para>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
 
337
 
      <varlistentry>
338
 
        <term><option>--tls-privkey=<replaceable
339
 
        >FILE</replaceable></option></term>
340
 
        <term><option>-t
341
 
        <replaceable>FILE</replaceable></option></term>
342
 
        <listitem>
343
 
          <para>
344
 
            TLS secret key file name.  The default name is
345
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
346
 
            ></quote>.
347
 
          </para>
348
 
        </listitem>
349
 
      </varlistentry>
350
 
 
351
 
      <varlistentry>
352
298
        <term><option>--priority=<replaceable
353
299
        >STRING</replaceable></option></term>
354
300
        <listitem>
363
309
        <listitem>
364
310
          <para>
365
311
            Sets the number of bits to use for the prime number in the
366
 
            TLS Diffie-Hellman key exchange.  The default value is
367
 
            selected automatically based on the GnuTLS security
368
 
            profile set in its priority string.  Note that if the
369
 
            <option>--dh-params</option> option is used, the values
370
 
            from that file will be used instead.
371
 
          </para>
372
 
        </listitem>
373
 
      </varlistentry>
374
 
      
375
 
      <varlistentry>
376
 
        <term><option>--dh-params=<replaceable
377
 
        >FILE</replaceable></option></term>
378
 
        <listitem>
379
 
          <para>
380
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
381
 
            needed by the TLS Diffie-Hellman key exchange from.  If
382
 
            this option is not given, or if the file for some reason
383
 
            could not be used, the parameters will be generated on
384
 
            startup, which will take some time and processing power.
385
 
            Those using servers running under time, power or processor
386
 
            constraints may want to generate such a file in advance
387
 
            and use this option.
 
312
            TLS Diffie-Hellman key exchange.  Default is 1024.
388
313
          </para>
389
314
        </listitem>
390
315
      </varlistentry>
517
442
  
518
443
  <refsect1 id="environment">
519
444
    <title>ENVIRONMENT</title>
520
 
    <variablelist>
521
 
      <varlistentry>
522
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
523
 
        <listitem>
524
 
          <para>
525
 
            This environment variable will be assumed to contain the
526
 
            directory containing any helper executables.  The use and
527
 
            nature of these helper executables, if any, is
528
 
            purposefully not documented.
529
 
        </para>
530
 
        </listitem>
531
 
      </varlistentry>
532
 
    </variablelist>
533
445
    <para>
534
 
      This program does not use any other environment variables, not
535
 
      even the ones provided by <citerefentry><refentrytitle
 
446
      This program does not use any environment variables, not even
 
447
      the ones provided by <citerefentry><refentrytitle
536
448
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
537
449
    </citerefentry>.
538
450
    </para>
600
512
              It is not necessary to print any non-executable files
601
513
              already in the network hook directory, these will be
602
514
              copied implicitly if they otherwise satisfy the name
603
 
              requirements.
 
515
              requirement.
604
516
            </para>
605
517
          </listitem>
606
518
        </varlistentry>
725
637
        </listitem>
726
638
      </varlistentry>
727
639
      <varlistentry>
728
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
729
 
        ></term>
730
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
731
 
        ></term>
732
 
        <listitem>
733
 
          <para>
734
 
            Public and private raw key files, in <quote>PEM</quote>
735
 
            format.  These are the default file names, they can be
736
 
            changed with the <option>--tls-pubkey</option> and
737
 
            <option>--tls-privkey</option> options.
738
 
          </para>
739
 
        </listitem>
740
 
      </varlistentry>
741
 
      <varlistentry>
742
640
        <term><filename
743
641
        class="directory">/lib/mandos/network-hooks.d</filename></term>
744
642
        <listitem>
752
650
    </variablelist>
753
651
  </refsect1>
754
652
  
755
 
  <refsect1 id="bugs">
756
 
    <title>BUGS</title>
757
 
    <xi:include href="../bugs.xml"/>
758
 
  </refsect1>
 
653
<!--   <refsect1 id="bugs"> -->
 
654
<!--     <title>BUGS</title> -->
 
655
<!--     <para> -->
 
656
<!--     </para> -->
 
657
<!--   </refsect1> -->
759
658
  
760
659
  <refsect1 id="example">
761
660
    <title>EXAMPLE</title>
767
666
    </para>
768
667
    <informalexample>
769
668
      <para>
770
 
        Normal invocation needs no options, if the network interfaces
 
669
        Normal invocation needs no options, if the network interface
771
670
        can be automatically determined:
772
671
      </para>
773
672
      <para>
776
675
    </informalexample>
777
676
    <informalexample>
778
677
      <para>
779
 
        Search for Mandos servers (and connect to them) using one
780
 
        specific interface:
 
678
        Search for Mandos servers (and connect to them) using another
 
679
        interface:
781
680
      </para>
782
681
      <para>
783
682
        <!-- do not wrap this line -->
786
685
    </informalexample>
787
686
    <informalexample>
788
687
      <para>
789
 
        Run in debug mode, and use custom keys:
 
688
        Run in debug mode, and use a custom key:
790
689
      </para>
791
690
      <para>
792
691
 
793
692
<!-- do not wrap this line -->
794
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
693
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
694
 
796
695
      </para>
797
696
    </informalexample>
798
697
    <informalexample>
799
698
      <para>
800
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
699
        Run in debug mode, with a custom key, and do not use Zeroconf
801
700
        to locate a server; connect directly to the IPv6 link-local
802
701
        address <quote><systemitem class="ipaddress"
803
702
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
806
705
      <para>
807
706
 
808
707
<!-- do not wrap this line -->
809
 
<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>
 
708
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
810
709
 
811
710
      </para>
812
711
    </informalexample>
836
735
    <para>
837
736
      The only remaining weak point is that someone with physical
838
737
      access to the client hard drive might turn off the client
839
 
      computer, read the OpenPGP and TLS keys directly from the hard
840
 
      drive, and communicate with the server.  To safeguard against
841
 
      this, the server is supposed to notice the client disappearing
842
 
      and stop giving out the encrypted data.  Therefore, it is
843
 
      important to set the timeout and checker interval values tightly
844
 
      on the server.  See <citerefentry><refentrytitle
 
738
      computer, read the OpenPGP keys directly from the hard drive,
 
739
      and communicate with the server.  To safeguard against this, the
 
740
      server is supposed to notice the client disappearing and stop
 
741
      giving out the encrypted data.  Therefore, it is important to
 
742
      set the timeout and checker interval values tightly on the
 
743
      server.  See <citerefentry><refentrytitle
845
744
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
745
    </para>
847
746
    <para>
848
747
      It will also help if the checker program on the server is
849
748
      configured to request something from the client which can not be
850
 
      spoofed by someone else on the network, like SSH server key
851
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
852
 
      echo (<quote>ping</quote>) replies.
 
749
      spoofed by someone else on the network, unlike unencrypted
 
750
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
853
751
    </para>
854
752
    <para>
855
753
      <emphasis>Note</emphasis>: This makes it completely insecure to
901
799
      </varlistentry>
902
800
      <varlistentry>
903
801
        <term>
904
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
802
          <ulink url="http://www.gnu.org/software/gnutls/"
 
803
          >GnuTLS</ulink>
905
804
        </term>
906
805
      <listitem>
907
806
        <para>
908
807
          GnuTLS is the library this client uses to implement TLS for
909
808
          communicating securely with the server, and at the same time
910
 
          send the public key to the server.
 
809
          send the public OpenPGP key to the server.
911
810
        </para>
912
811
      </listitem>
913
812
      </varlistentry>
914
813
      <varlistentry>
915
814
        <term>
916
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
815
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
917
816
                 >GPGME</ulink>
918
817
        </term>
919
818
        <listitem>
947
846
              <para>
948
847
                This client uses IPv6 link-local addresses, which are
949
848
                immediately usable since a link-local addresses is
950
 
                automatically assigned to a network interface when it
 
849
                automatically assigned to a network interfaces when it
951
850
                is brought up.
952
851
              </para>
953
852
            </listitem>
957
856
      </varlistentry>
958
857
      <varlistentry>
959
858
        <term>
960
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
 
          Protocol Version 1.2</citetitle>
 
859
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
860
          Protocol Version 1.1</citetitle>
962
861
        </term>
963
862
      <listitem>
964
863
        <para>
965
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
864
          TLS 1.1 is the protocol implemented by GnuTLS.
966
865
        </para>
967
866
      </listitem>
968
867
      </varlistentry>
979
878
      </varlistentry>
980
879
      <varlistentry>
981
880
        <term>
982
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
983
 
          Layer Security (TLS) and Datagram Transport Layer Security
984
 
          (DTLS)</citetitle>
985
 
        </term>
986
 
      <listitem>
987
 
        <para>
988
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
989
 
          present, used by this program so that raw public keys can be
990
 
          used.
991
 
        </para>
992
 
      </listitem>
993
 
      </varlistentry>
994
 
      <varlistentry>
995
 
        <term>
996
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
881
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
997
882
          Security</citetitle>
998
883
        </term>
999
884
      <listitem>
1000
885
        <para>
1001
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1002
 
          if present, used by this program so that OpenPGP keys can be
1003
 
          used.
 
886
          This is implemented by GnuTLS and used by this program so
 
887
          that OpenPGP keys can be used.
1004
888
        </para>
1005
889
      </listitem>
1006
890
      </varlistentry>