/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: 2025-06-27 19:57:27 UTC
  • mfrom: (1320 trunk)
  • mto: This revision was merged to the branch mainline in revision 1321.
  • Revision ID: teddy@recompile.se-20250627195727-wmn5jvu20sor29ts
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-03-05">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
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>
 
46
      <year>2020</year>
 
47
      <year>2021</year>
 
48
      <year>2022</year>
 
49
      <year>2023</year>
 
50
      <year>2024</year>
39
51
      <holder>Teddy Hogeborn</holder>
40
52
      <holder>Björn Påhlsson</holder>
41
53
    </copyright>
89
101
        <replaceable>FILE</replaceable></option></arg>
90
102
      </group>
91
103
      <sbr/>
 
104
      <group>
 
105
        <arg choice="plain"><option>--tls-privkey
 
106
        <replaceable>FILE</replaceable></option></arg>
 
107
        <arg choice="plain"><option>-t
 
108
        <replaceable>FILE</replaceable></option></arg>
 
109
      </group>
 
110
      <sbr/>
 
111
      <group>
 
112
        <arg choice="plain"><option>--tls-pubkey
 
113
        <replaceable>FILE</replaceable></option></arg>
 
114
        <arg choice="plain"><option>-T
 
115
        <replaceable>FILE</replaceable></option></arg>
 
116
      </group>
 
117
      <sbr/>
92
118
      <arg>
93
119
        <option>--priority <replaceable>STRING</replaceable></option>
94
120
      </arg>
98
124
      </arg>
99
125
      <sbr/>
100
126
      <arg>
 
127
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
128
      </arg>
 
129
      <sbr/>
 
130
      <arg>
101
131
        <option>--delay <replaceable>SECONDS</replaceable></option>
102
132
      </arg>
103
133
      <sbr/>
144
174
      brings up network interfaces, uses the interfaces’ IPv6
145
175
      link-local addresses to get network connectivity, uses Zeroconf
146
176
      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
 
177
      servers using TLS with a raw public key to ensure authenticity
 
178
      and confidentiality.  This client program keeps running, trying
 
179
      all servers on the network, until it receives a satisfactory
 
180
      reply or a TERM signal.  After all servers have been tried, all
151
181
      servers are periodically retried.  If no servers are found it
152
182
      will wait indefinitely for new servers to appear.
153
183
    </para>
171
201
    </para>
172
202
    <para>
173
203
      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.
 
204
      to be run by other programs in the initial
 
205
      <acronym>RAM</acronym> disk environment; see <xref
 
206
      linkend="overview"/>.
181
207
    </para>
182
208
  </refsect1>
183
209
  
195
221
    <title>OPTIONS</title>
196
222
    <para>
197
223
      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.
 
224
      is normally started by another program as described in <xref
 
225
      linkend="description"/>.  Any command line options this program
 
226
      accepts are therefore normally provided by the invoking program,
 
227
      and not directly.
204
228
    </para>
205
229
    
206
230
    <variablelist>
297
321
      </varlistentry>
298
322
      
299
323
      <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>
300
352
        <term><option>--priority=<replaceable
301
353
        >STRING</replaceable></option></term>
302
354
        <listitem>
311
363
        <listitem>
312
364
          <para>
313
365
            Sets the number of bits to use for the prime number in the
314
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
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.
315
388
          </para>
316
389
        </listitem>
317
390
      </varlistentry>
408
481
    <title>OVERVIEW</title>
409
482
    <xi:include href="../overview.xml"/>
410
483
    <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.
 
484
      This program is the client part.  It is run automatically in an
 
485
      initial <acronym>RAM</acronym> disk environment.
 
486
    </para>
 
487
    <para>
 
488
      In an initial <acronym>RAM</acronym> disk environment using
 
489
      <citerefentry><refentrytitle>systemd</refentrytitle>
 
490
      <manvolnum>1</manvolnum></citerefentry>, this program is started
 
491
      by the <application>Mandos</application> <citerefentry>
 
492
      <refentrytitle>password-agent</refentrytitle>
 
493
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
 
494
      started automatically by the <citerefentry>
 
495
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
496
      </citerefentry> <quote>Password Agent</quote> system.
 
497
    </para>
 
498
    <para>
 
499
      In the case of a non-<citerefentry>
 
500
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
 
501
      </citerefentry> environment, this program is started as a plugin
 
502
      of the <application>Mandos</application> <citerefentry>
 
503
      <refentrytitle>plugin-runner</refentrytitle>
 
504
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
505
      initial <acronym>RAM</acronym> disk environment because it is
 
506
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
507
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
508
      </citerefentry> file.
415
509
    </para>
416
510
    <para>
417
511
      This program could, theoretically, be used as a keyscript in
418
512
      <filename>/etc/crypttab</filename>, but it would then be
419
513
      impossible to enter a password for the encrypted root disk at
420
514
      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.
 
515
      at all.
429
516
    </para>
430
517
  </refsect1>
431
518
  
444
531
  
445
532
  <refsect1 id="environment">
446
533
    <title>ENVIRONMENT</title>
 
534
    <variablelist>
 
535
      <varlistentry>
 
536
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
537
        <listitem>
 
538
          <para>
 
539
            This environment variable will be assumed to contain the
 
540
            directory containing any helper executables.  The use and
 
541
            nature of these helper executables, if any, is purposely
 
542
            not documented.
 
543
        </para>
 
544
        </listitem>
 
545
      </varlistentry>
 
546
    </variablelist>
447
547
    <para>
448
 
      This program does not use any environment variables, not even
449
 
      the ones provided by <citerefentry><refentrytitle
 
548
      This program does not use any other environment variables, not
 
549
      even the ones provided by <citerefentry><refentrytitle
450
550
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
451
551
    </citerefentry>.
452
552
    </para>
639
739
        </listitem>
640
740
      </varlistentry>
641
741
      <varlistentry>
 
742
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
 
743
        ></term>
 
744
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
 
745
        ></term>
 
746
        <listitem>
 
747
          <para>
 
748
            Public and private raw key files, in <quote>PEM</quote>
 
749
            format.  These are the default file names, they can be
 
750
            changed with the <option>--tls-pubkey</option> and
 
751
            <option>--tls-privkey</option> options.
 
752
          </para>
 
753
        </listitem>
 
754
      </varlistentry>
 
755
      <varlistentry>
642
756
        <term><filename
643
757
        class="directory">/lib/mandos/network-hooks.d</filename></term>
644
758
        <listitem>
652
766
    </variablelist>
653
767
  </refsect1>
654
768
  
655
 
<!--   <refsect1 id="bugs"> -->
656
 
<!--     <title>BUGS</title> -->
657
 
<!--     <para> -->
658
 
<!--     </para> -->
659
 
<!--   </refsect1> -->
 
769
  <refsect1 id="bugs">
 
770
    <title>BUGS</title>
 
771
    <xi:include href="../bugs.xml"/>
 
772
  </refsect1>
660
773
  
661
774
  <refsect1 id="example">
662
775
    <title>EXAMPLE</title>
663
776
    <para>
664
777
      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>.
 
778
      directly, but passed on via the program responsible for starting
 
779
      this program; see <xref linkend="overview"/>.
668
780
    </para>
669
781
    <informalexample>
670
782
      <para>
687
799
    </informalexample>
688
800
    <informalexample>
689
801
      <para>
690
 
        Run in debug mode, and use a custom key:
 
802
        Run in debug mode, and use custom keys:
691
803
      </para>
692
804
      <para>
693
805
 
694
806
<!-- do not wrap this line -->
695
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
807
<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
808
 
697
809
      </para>
698
810
    </informalexample>
699
811
    <informalexample>
700
812
      <para>
701
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
813
        Run in debug mode, with custom keys, and do not use Zeroconf
702
814
        to locate a server; connect directly to the IPv6 link-local
703
815
        address <quote><systemitem class="ipaddress"
704
816
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
707
819
      <para>
708
820
 
709
821
<!-- 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>
 
822
<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
823
 
712
824
      </para>
713
825
    </informalexample>
716
828
  <refsect1 id="security">
717
829
    <title>SECURITY</title>
718
830
    <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.
 
831
      This program assumes that it is set-uid to root, and will switch
 
832
      back to the original (and presumably non-privileged) user and
 
833
      group after bringing up the network interface.
722
834
    </para>
723
835
    <para>
724
836
      To use this program for its intended purpose (see <xref
737
849
    <para>
738
850
      The only remaining weak point is that someone with physical
739
851
      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
 
852
      computer, read the OpenPGP and TLS keys directly from the hard
 
853
      drive, and communicate with the server.  To safeguard against
 
854
      this, the server is supposed to notice the client disappearing
 
855
      and stop giving out the encrypted data.  Therefore, it is
 
856
      important to set the timeout and checker interval values tightly
 
857
      on the server.  See <citerefentry><refentrytitle
746
858
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
747
859
    </para>
748
860
    <para>
749
861
      It will also help if the checker program on the server is
750
862
      configured to request something from the client which can not be
751
 
      spoofed by someone else on the network, unlike unencrypted
752
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
863
      spoofed by someone else on the network, like SSH server key
 
864
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
865
      echo (<quote>ping</quote>) replies.
753
866
    </para>
754
867
    <para>
755
868
      <emphasis>Note</emphasis>: This makes it completely insecure to
771
884
      <manvolnum>5</manvolnum></citerefentry>,
772
885
      <citerefentry><refentrytitle>mandos</refentrytitle>
773
886
      <manvolnum>8</manvolnum></citerefentry>,
774
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
887
      <citerefentry><refentrytitle>password-agent</refentrytitle>
775
888
      <manvolnum>8mandos</manvolnum></citerefentry>,
776
889
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
777
890
      <manvolnum>8mandos</manvolnum></citerefentry>
790
903
      </varlistentry>
791
904
      <varlistentry>
792
905
        <term>
793
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
906
          <ulink url="https://www.avahi.org/">Avahi</ulink>
794
907
        </term>
795
908
      <listitem>
796
909
        <para>
801
914
      </varlistentry>
802
915
      <varlistentry>
803
916
        <term>
804
 
          <ulink url="http://www.gnu.org/software/gnutls/"
805
 
          >GnuTLS</ulink>
 
917
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
806
918
        </term>
807
919
      <listitem>
808
920
        <para>
809
921
          GnuTLS is the library this client uses to implement TLS for
810
922
          communicating securely with the server, and at the same time
811
 
          send the public OpenPGP key to the server.
 
923
          send the public key to the server.
812
924
        </para>
813
925
      </listitem>
814
926
      </varlistentry>
815
927
      <varlistentry>
816
928
        <term>
817
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
929
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
818
930
                 >GPGME</ulink>
819
931
        </term>
820
932
        <listitem>
858
970
      </varlistentry>
859
971
      <varlistentry>
860
972
        <term>
861
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
862
 
          Protocol Version 1.1</citetitle>
 
973
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
974
          Protocol Version 1.2</citetitle>
863
975
        </term>
864
976
      <listitem>
865
977
        <para>
866
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
978
          TLS 1.2 is the protocol implemented by GnuTLS.
867
979
        </para>
868
980
      </listitem>
869
981
      </varlistentry>
880
992
      </varlistentry>
881
993
      <varlistentry>
882
994
        <term>
883
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
995
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
 
996
          Layer Security (TLS) and Datagram Transport Layer Security
 
997
          (DTLS)</citetitle>
 
998
        </term>
 
999
      <listitem>
 
1000
        <para>
 
1001
          This is implemented by GnuTLS in version 3.6.6 and is, if
 
1002
          present, used by this program so that raw public keys can be
 
1003
          used.
 
1004
        </para>
 
1005
      </listitem>
 
1006
      </varlistentry>
 
1007
      <varlistentry>
 
1008
        <term>
 
1009
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
884
1010
          Security</citetitle>
885
1011
        </term>
886
1012
      <listitem>
887
1013
        <para>
888
 
          This is implemented by GnuTLS and used by this program so
889
 
          that OpenPGP keys can be used.
 
1014
          This is implemented by GnuTLS before version 3.6.0 and is,
 
1015
          if present, used by this program so that OpenPGP keys can be
 
1016
          used.
890
1017
        </para>
891
1018
      </listitem>
892
1019
      </varlistentry>