/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: 2024-09-12 16:21:53 UTC
  • mfrom: (237.7.849 trunk)
  • Revision ID: teddy@recompile.se-20240912162153-grzvz1n3u1iruu93
Merge from trunk

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 "2014-06-22">
 
5
<!ENTITY TIMESTAMP "2023-10-21">
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>
36
38
      <year>2012</year>
37
39
      <year>2013</year>
38
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
89
96
        <replaceable>FILE</replaceable></option></arg>
90
97
      </group>
91
98
      <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/>
92
113
      <arg>
93
114
        <option>--priority <replaceable>STRING</replaceable></option>
94
115
      </arg>
98
119
      </arg>
99
120
      <sbr/>
100
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
101
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
127
      </arg>
103
128
      <sbr/>
144
169
      brings up network interfaces, uses the interfaces’ IPv6
145
170
      link-local addresses to get network connectivity, uses Zeroconf
146
171
      to find servers on the local network, and communicates with
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
 
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
151
176
      servers are periodically retried.  If no servers are found it
152
177
      will wait indefinitely for new servers to appear.
153
178
    </para>
171
196
    </para>
172
197
    <para>
173
198
      This program is not meant to be run directly; it is really meant
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.
 
199
      to be run by other programs in the initial
 
200
      <acronym>RAM</acronym> disk environment; see <xref
 
201
      linkend="overview"/>.
181
202
    </para>
182
203
  </refsect1>
183
204
  
195
216
    <title>OPTIONS</title>
196
217
    <para>
197
218
      This program is commonly not invoked from the command line; it
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.
 
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.
204
223
    </para>
205
224
    
206
225
    <variablelist>
297
316
      </varlistentry>
298
317
      
299
318
      <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>
300
347
        <term><option>--priority=<replaceable
301
348
        >STRING</replaceable></option></term>
302
349
        <listitem>
311
358
        <listitem>
312
359
          <para>
313
360
            Sets the number of bits to use for the prime number in the
314
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
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.
315
383
          </para>
316
384
        </listitem>
317
385
      </varlistentry>
408
476
    <title>OVERVIEW</title>
409
477
    <xi:include href="../overview.xml"/>
410
478
    <para>
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.
 
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.
415
504
    </para>
416
505
    <para>
417
506
      This program could, theoretically, be used as a keyscript in
418
507
      <filename>/etc/crypttab</filename>, but it would then be
419
508
      impossible to enter a password for the encrypted root disk at
420
509
      the console, since this program does not read from the console
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.
 
510
      at all.
429
511
    </para>
430
512
  </refsect1>
431
513
  
444
526
  
445
527
  <refsect1 id="environment">
446
528
    <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>
447
542
    <para>
448
 
      This program does not use any environment variables, not even
449
 
      the ones provided by <citerefentry><refentrytitle
 
543
      This program does not use any other environment variables, not
 
544
      even the ones provided by <citerefentry><refentrytitle
450
545
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
451
546
    </citerefentry>.
452
547
    </para>
639
734
        </listitem>
640
735
      </varlistentry>
641
736
      <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>
642
751
        <term><filename
643
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
644
753
        <listitem>
652
761
    </variablelist>
653
762
  </refsect1>
654
763
  
655
 
<!--   <refsect1 id="bugs"> -->
656
 
<!--     <title>BUGS</title> -->
657
 
<!--     <para> -->
658
 
<!--     </para> -->
659
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
660
768
  
661
769
  <refsect1 id="example">
662
770
    <title>EXAMPLE</title>
663
771
    <para>
664
772
      Note that normally, command line options will not be given
665
 
      directly, but via options for the Mandos <citerefentry
666
 
      ><refentrytitle>plugin-runner</refentrytitle>
667
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
668
775
    </para>
669
776
    <informalexample>
670
777
      <para>
687
794
    </informalexample>
688
795
    <informalexample>
689
796
      <para>
690
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
691
798
      </para>
692
799
      <para>
693
800
 
694
801
<!-- do not wrap this line -->
695
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
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>
696
803
 
697
804
      </para>
698
805
    </informalexample>
699
806
    <informalexample>
700
807
      <para>
701
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
808
        Run in debug mode, with custom keys, and do not use Zeroconf
702
809
        to locate a server; connect directly to the IPv6 link-local
703
810
        address <quote><systemitem class="ipaddress"
704
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
707
814
      <para>
708
815
 
709
816
<!-- do not wrap this line -->
710
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
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>
711
818
 
712
819
      </para>
713
820
    </informalexample>
716
823
  <refsect1 id="security">
717
824
    <title>SECURITY</title>
718
825
    <para>
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.
 
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.
722
829
    </para>
723
830
    <para>
724
831
      To use this program for its intended purpose (see <xref
737
844
    <para>
738
845
      The only remaining weak point is that someone with physical
739
846
      access to the client hard drive might turn off the client
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
 
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
746
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
747
854
    </para>
748
855
    <para>
772
879
      <manvolnum>5</manvolnum></citerefentry>,
773
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
774
881
      <manvolnum>8</manvolnum></citerefentry>,
775
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
776
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
777
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
778
885
      <manvolnum>8mandos</manvolnum></citerefentry>
791
898
      </varlistentry>
792
899
      <varlistentry>
793
900
        <term>
794
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
795
902
        </term>
796
903
      <listitem>
797
904
        <para>
802
909
      </varlistentry>
803
910
      <varlistentry>
804
911
        <term>
805
 
          <ulink url="http://www.gnu.org/software/gnutls/"
806
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
807
913
        </term>
808
914
      <listitem>
809
915
        <para>
810
916
          GnuTLS is the library this client uses to implement TLS for
811
917
          communicating securely with the server, and at the same time
812
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
813
919
        </para>
814
920
      </listitem>
815
921
      </varlistentry>
816
922
      <varlistentry>
817
923
        <term>
818
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
819
925
                 >GPGME</ulink>
820
926
        </term>
821
927
        <listitem>
859
965
      </varlistentry>
860
966
      <varlistentry>
861
967
        <term>
862
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
863
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
864
970
        </term>
865
971
      <listitem>
866
972
        <para>
867
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
868
974
        </para>
869
975
      </listitem>
870
976
      </varlistentry>
881
987
      </varlistentry>
882
988
      <varlistentry>
883
989
        <term>
884
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
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
885
1005
          Security</citetitle>
886
1006
        </term>
887
1007
      <listitem>
888
1008
        <para>
889
 
          This is implemented by GnuTLS and used by this program so
890
 
          that OpenPGP keys can be used.
 
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.
891
1012
        </para>
892
1013
      </listitem>
893
1014
      </varlistentry>