/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-07-17 02:45:02 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 319.
  • Revision ID: teddy@recompile.se-20140717024502-yg5ysk05lx8275k9
Update non-package install instructions.

* INSTALL: Update package names, URLs and versions.  Remove discussion
           of adjusting network device name.  Adjust minimum reboot
           time to reflect new default timeout value.

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