/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: 2014-03-28 21:31:12 UTC
  • Revision ID: teddy@recompile.se-20140328213112-2gldx4x8nlyy7era
Post-processing of man pages is no longer necessary.

* Makefile (DOCBOOKTOMAN): Remove call to MANPOST.
  (MANPOST): Remove.

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 "2023-10-21">
 
5
<!ENTITY TIMESTAMP "2014-03-05">
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>
196
171
    </para>
197
172
    <para>
198
173
      This program is not meant to be run directly; it is really meant
199
 
      to be run by other programs in the initial
200
 
      <acronym>RAM</acronym> disk environment; see <xref
201
 
      linkend="overview"/>.
 
174
      to run as a plugin of the <application>Mandos</application>
 
175
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
176
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
177
      initial <acronym>RAM</acronym> disk environment because it is
 
178
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
179
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
180
      </citerefentry> file.
202
181
    </para>
203
182
  </refsect1>
204
183
  
216
195
    <title>OPTIONS</title>
217
196
    <para>
218
197
      This program is commonly not invoked from the command line; it
219
 
      is normally started by another program as described in <xref
220
 
      linkend="description"/>.  Any command line options this program
221
 
      accepts are therefore normally provided by the invoking program,
222
 
      and not directly.
 
198
      is normally started by the <application>Mandos</application>
 
199
      plugin runner, see <citerefentry><refentrytitle
 
200
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
201
      </citerefentry>.  Any command line options this program accepts
 
202
      are therefore normally provided by the plugin runner, and not
 
203
      directly.
223
204
    </para>
224
205
    
225
206
    <variablelist>
316
297
      </varlistentry>
317
298
      
318
299
      <varlistentry>
319
 
        <term><option>--tls-pubkey=<replaceable
320
 
        >FILE</replaceable></option></term>
321
 
        <term><option>-T
322
 
        <replaceable>FILE</replaceable></option></term>
323
 
        <listitem>
324
 
          <para>
325
 
            TLS raw public key file name.  The default name is
326
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
327
 
            ></quote>.
328
 
          </para>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
 
332
 
      <varlistentry>
333
 
        <term><option>--tls-privkey=<replaceable
334
 
        >FILE</replaceable></option></term>
335
 
        <term><option>-t
336
 
        <replaceable>FILE</replaceable></option></term>
337
 
        <listitem>
338
 
          <para>
339
 
            TLS secret key file name.  The default name is
340
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
341
 
            ></quote>.
342
 
          </para>
343
 
        </listitem>
344
 
      </varlistentry>
345
 
 
346
 
      <varlistentry>
347
300
        <term><option>--priority=<replaceable
348
301
        >STRING</replaceable></option></term>
349
302
        <listitem>
358
311
        <listitem>
359
312
          <para>
360
313
            Sets the number of bits to use for the prime number in the
361
 
            TLS Diffie-Hellman key exchange.  The default value is
362
 
            selected automatically based on the GnuTLS security
363
 
            profile set in its priority string.  Note that if the
364
 
            <option>--dh-params</option> option is used, the values
365
 
            from that file will be used instead.
366
 
          </para>
367
 
        </listitem>
368
 
      </varlistentry>
369
 
      
370
 
      <varlistentry>
371
 
        <term><option>--dh-params=<replaceable
372
 
        >FILE</replaceable></option></term>
373
 
        <listitem>
374
 
          <para>
375
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
376
 
            needed by the TLS Diffie-Hellman key exchange from.  If
377
 
            this option is not given, or if the file for some reason
378
 
            could not be used, the parameters will be generated on
379
 
            startup, which will take some time and processing power.
380
 
            Those using servers running under time, power or processor
381
 
            constraints may want to generate such a file in advance
382
 
            and use this option.
 
314
            TLS Diffie-Hellman key exchange.  Default is 1024.
383
315
          </para>
384
316
        </listitem>
385
317
      </varlistentry>
476
408
    <title>OVERVIEW</title>
477
409
    <xi:include href="../overview.xml"/>
478
410
    <para>
479
 
      This program is the client part.  It is run automatically in an
480
 
      initial <acronym>RAM</acronym> disk environment.
481
 
    </para>
482
 
    <para>
483
 
      In an initial <acronym>RAM</acronym> disk environment using
484
 
      <citerefentry><refentrytitle>systemd</refentrytitle>
485
 
      <manvolnum>1</manvolnum></citerefentry>, this program is started
486
 
      by the <application>Mandos</application> <citerefentry>
487
 
      <refentrytitle>password-agent</refentrytitle>
488
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
489
 
      started automatically by the <citerefentry>
490
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
491
 
      </citerefentry> <quote>Password Agent</quote> system.
492
 
    </para>
493
 
    <para>
494
 
      In the case of a non-<citerefentry>
495
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
 
      </citerefentry> environment, this program is started as a plugin
497
 
      of the <application>Mandos</application> <citerefentry>
498
 
      <refentrytitle>plugin-runner</refentrytitle>
499
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
500
 
      initial <acronym>RAM</acronym> disk environment because it is
501
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
502
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
503
 
      </citerefentry> file.
 
411
      This program is the client part.  It is a plugin started by
 
412
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
413
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
414
      an initial <acronym>RAM</acronym> disk environment.
504
415
    </para>
505
416
    <para>
506
417
      This program could, theoretically, be used as a keyscript in
507
418
      <filename>/etc/crypttab</filename>, but it would then be
508
419
      impossible to enter a password for the encrypted root disk at
509
420
      the console, since this program does not read from the console
510
 
      at all.
 
421
      at all.  This is why a separate plugin runner (<citerefentry>
 
422
      <refentrytitle>plugin-runner</refentrytitle>
 
423
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
424
      both this program and others in in parallel,
 
425
      <emphasis>one</emphasis> of which (<citerefentry>
 
426
      <refentrytitle>password-prompt</refentrytitle>
 
427
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
428
      passwords on the system console.
511
429
    </para>
512
430
  </refsect1>
513
431
  
526
444
  
527
445
  <refsect1 id="environment">
528
446
    <title>ENVIRONMENT</title>
529
 
    <variablelist>
530
 
      <varlistentry>
531
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
532
 
        <listitem>
533
 
          <para>
534
 
            This environment variable will be assumed to contain the
535
 
            directory containing any helper executables.  The use and
536
 
            nature of these helper executables, if any, is purposely
537
 
            not documented.
538
 
        </para>
539
 
        </listitem>
540
 
      </varlistentry>
541
 
    </variablelist>
542
447
    <para>
543
 
      This program does not use any other environment variables, not
544
 
      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
545
450
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
546
451
    </citerefentry>.
547
452
    </para>
734
639
        </listitem>
735
640
      </varlistentry>
736
641
      <varlistentry>
737
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
738
 
        ></term>
739
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
740
 
        ></term>
741
 
        <listitem>
742
 
          <para>
743
 
            Public and private raw key files, in <quote>PEM</quote>
744
 
            format.  These are the default file names, they can be
745
 
            changed with the <option>--tls-pubkey</option> and
746
 
            <option>--tls-privkey</option> options.
747
 
          </para>
748
 
        </listitem>
749
 
      </varlistentry>
750
 
      <varlistentry>
751
642
        <term><filename
752
643
        class="directory">/lib/mandos/network-hooks.d</filename></term>
753
644
        <listitem>
761
652
    </variablelist>
762
653
  </refsect1>
763
654
  
764
 
  <refsect1 id="bugs">
765
 
    <title>BUGS</title>
766
 
    <xi:include href="../bugs.xml"/>
767
 
  </refsect1>
 
655
<!--   <refsect1 id="bugs"> -->
 
656
<!--     <title>BUGS</title> -->
 
657
<!--     <para> -->
 
658
<!--     </para> -->
 
659
<!--   </refsect1> -->
768
660
  
769
661
  <refsect1 id="example">
770
662
    <title>EXAMPLE</title>
771
663
    <para>
772
664
      Note that normally, command line options will not be given
773
 
      directly, but passed on via the program responsible for starting
774
 
      this program; see <xref linkend="overview"/>.
 
665
      directly, but via options for the Mandos <citerefentry
 
666
      ><refentrytitle>plugin-runner</refentrytitle>
 
667
      <manvolnum>8mandos</manvolnum></citerefentry>.
775
668
    </para>
776
669
    <informalexample>
777
670
      <para>
794
687
    </informalexample>
795
688
    <informalexample>
796
689
      <para>
797
 
        Run in debug mode, and use custom keys:
 
690
        Run in debug mode, and use a custom key:
798
691
      </para>
799
692
      <para>
800
693
 
801
694
<!-- do not wrap this line -->
802
 
<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>
803
696
 
804
697
      </para>
805
698
    </informalexample>
806
699
    <informalexample>
807
700
      <para>
808
 
        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
809
702
        to locate a server; connect directly to the IPv6 link-local
810
703
        address <quote><systemitem class="ipaddress"
811
704
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
707
      <para>
815
708
 
816
709
<!-- do not wrap this line -->
817
 
<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>
818
711
 
819
712
      </para>
820
713
    </informalexample>
823
716
  <refsect1 id="security">
824
717
    <title>SECURITY</title>
825
718
    <para>
826
 
      This program assumes that it is set-uid to root, and will switch
827
 
      back to the original (and presumably non-privileged) user and
828
 
      group after bringing up the network interface.
 
719
      This program is set-uid to root, but will switch back to the
 
720
      original (and presumably non-privileged) user and group after
 
721
      bringing up the network interface.
829
722
    </para>
830
723
    <para>
831
724
      To use this program for its intended purpose (see <xref
844
737
    <para>
845
738
      The only remaining weak point is that someone with physical
846
739
      access to the client hard drive might turn off the client
847
 
      computer, read the OpenPGP and TLS keys directly from the hard
848
 
      drive, and communicate with the server.  To safeguard against
849
 
      this, the server is supposed to notice the client disappearing
850
 
      and stop giving out the encrypted data.  Therefore, it is
851
 
      important to set the timeout and checker interval values tightly
852
 
      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
853
746
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
747
    </para>
855
748
    <para>
856
749
      It will also help if the checker program on the server is
857
750
      configured to request something from the client which can not be
858
 
      spoofed by someone else on the network, like SSH server key
859
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
860
 
      echo (<quote>ping</quote>) replies.
 
751
      spoofed by someone else on the network, unlike unencrypted
 
752
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
861
753
    </para>
862
754
    <para>
863
755
      <emphasis>Note</emphasis>: This makes it completely insecure to
879
771
      <manvolnum>5</manvolnum></citerefentry>,
880
772
      <citerefentry><refentrytitle>mandos</refentrytitle>
881
773
      <manvolnum>8</manvolnum></citerefentry>,
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
774
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
883
775
      <manvolnum>8mandos</manvolnum></citerefentry>,
884
776
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
777
      <manvolnum>8mandos</manvolnum></citerefentry>
898
790
      </varlistentry>
899
791
      <varlistentry>
900
792
        <term>
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
793
          <ulink url="http://www.avahi.org/">Avahi</ulink>
902
794
        </term>
903
795
      <listitem>
904
796
        <para>
909
801
      </varlistentry>
910
802
      <varlistentry>
911
803
        <term>
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
804
          <ulink url="http://www.gnu.org/software/gnutls/"
 
805
          >GnuTLS</ulink>
913
806
        </term>
914
807
      <listitem>
915
808
        <para>
916
809
          GnuTLS is the library this client uses to implement TLS for
917
810
          communicating securely with the server, and at the same time
918
 
          send the public key to the server.
 
811
          send the public OpenPGP key to the server.
919
812
        </para>
920
813
      </listitem>
921
814
      </varlistentry>
922
815
      <varlistentry>
923
816
        <term>
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
817
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
925
818
                 >GPGME</ulink>
926
819
        </term>
927
820
        <listitem>
965
858
      </varlistentry>
966
859
      <varlistentry>
967
860
        <term>
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
 
          Protocol Version 1.2</citetitle>
 
861
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
862
          Protocol Version 1.1</citetitle>
970
863
        </term>
971
864
      <listitem>
972
865
        <para>
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
866
          TLS 1.1 is the protocol implemented by GnuTLS.
974
867
        </para>
975
868
      </listitem>
976
869
      </varlistentry>
987
880
      </varlistentry>
988
881
      <varlistentry>
989
882
        <term>
990
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
991
 
          Layer Security (TLS) and Datagram Transport Layer Security
992
 
          (DTLS)</citetitle>
993
 
        </term>
994
 
      <listitem>
995
 
        <para>
996
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
997
 
          present, used by this program so that raw public keys can be
998
 
          used.
999
 
        </para>
1000
 
      </listitem>
1001
 
      </varlistentry>
1002
 
      <varlistentry>
1003
 
        <term>
1004
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
883
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
884
          Security</citetitle>
1006
885
        </term>
1007
886
      <listitem>
1008
887
        <para>
1009
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1010
 
          if present, used by this program so that OpenPGP keys can be
1011
 
          used.
 
888
          This is implemented by GnuTLS and used by this program so
 
889
          that OpenPGP keys can be used.
1012
890
        </para>
1013
891
      </listitem>
1014
892
      </varlistentry>