/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: 2024-09-12 18:31:12 UTC
  • mfrom: (237.4.142 release)
  • Revision ID: teddy@recompile.se-20240912183112-xxy0akg67c0ky0t8
Merge from release branch

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 "2016-02-28">
 
5
<!ENTITY TIMESTAMP "2023-10-21">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
40
40
      <year>2014</year>
41
41
      <year>2015</year>
42
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
43
46
      <holder>Teddy Hogeborn</holder>
44
47
      <holder>Björn Påhlsson</holder>
45
48
    </copyright>
93
96
        <replaceable>FILE</replaceable></option></arg>
94
97
      </group>
95
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/>
96
113
      <arg>
97
114
        <option>--priority <replaceable>STRING</replaceable></option>
98
115
      </arg>
152
169
      brings up network interfaces, uses the interfaces’ IPv6
153
170
      link-local addresses to get network connectivity, uses Zeroconf
154
171
      to find servers on the local network, and communicates with
155
 
      servers using TLS with an OpenPGP key to ensure authenticity and
156
 
      confidentiality.  This client program keeps running, trying all
157
 
      servers on the network, until it receives a satisfactory reply
158
 
      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
159
176
      servers are periodically retried.  If no servers are found it
160
177
      will wait indefinitely for new servers to appear.
161
178
    </para>
179
196
    </para>
180
197
    <para>
181
198
      This program is not meant to be run directly; it is really meant
182
 
      to run as a plugin of the <application>Mandos</application>
183
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
184
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
185
 
      initial <acronym>RAM</acronym> disk environment because it is
186
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
187
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
188
 
      </citerefentry> file.
 
199
      to be run by other programs in the initial
 
200
      <acronym>RAM</acronym> disk environment; see <xref
 
201
      linkend="overview"/>.
189
202
    </para>
190
203
  </refsect1>
191
204
  
203
216
    <title>OPTIONS</title>
204
217
    <para>
205
218
      This program is commonly not invoked from the command line; it
206
 
      is normally started by the <application>Mandos</application>
207
 
      plugin runner, see <citerefentry><refentrytitle
208
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
209
 
      </citerefentry>.  Any command line options this program accepts
210
 
      are therefore normally provided by the plugin runner, and not
211
 
      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.
212
223
    </para>
213
224
    
214
225
    <variablelist>
305
316
      </varlistentry>
306
317
      
307
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>
308
347
        <term><option>--priority=<replaceable
309
348
        >STRING</replaceable></option></term>
310
349
        <listitem>
320
359
          <para>
321
360
            Sets the number of bits to use for the prime number in the
322
361
            TLS Diffie-Hellman key exchange.  The default value is
323
 
            selected automatically based on the OpenPGP key.  Note
324
 
            that if the <option>--dh-params</option> option is used,
325
 
            the values from that file will be used instead.
 
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.
326
366
          </para>
327
367
        </listitem>
328
368
      </varlistentry>
436
476
    <title>OVERVIEW</title>
437
477
    <xi:include href="../overview.xml"/>
438
478
    <para>
439
 
      This program is the client part.  It is a plugin started by
440
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
441
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
442
 
      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.
443
504
    </para>
444
505
    <para>
445
506
      This program could, theoretically, be used as a keyscript in
446
507
      <filename>/etc/crypttab</filename>, but it would then be
447
508
      impossible to enter a password for the encrypted root disk at
448
509
      the console, since this program does not read from the console
449
 
      at all.  This is why a separate plugin runner (<citerefentry>
450
 
      <refentrytitle>plugin-runner</refentrytitle>
451
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
452
 
      both this program and others in in parallel,
453
 
      <emphasis>one</emphasis> of which (<citerefentry>
454
 
      <refentrytitle>password-prompt</refentrytitle>
455
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
456
 
      passwords on the system console.
 
510
      at all.
457
511
    </para>
458
512
  </refsect1>
459
513
  
479
533
          <para>
480
534
            This environment variable will be assumed to contain the
481
535
            directory containing any helper executables.  The use and
482
 
            nature of these helper executables, if any, is
483
 
            purposefully not documented.
 
536
            nature of these helper executables, if any, is purposely
 
537
            not documented.
484
538
        </para>
485
539
        </listitem>
486
540
      </varlistentry>
680
734
        </listitem>
681
735
      </varlistentry>
682
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>
683
751
        <term><filename
684
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
685
753
        <listitem>
693
761
    </variablelist>
694
762
  </refsect1>
695
763
  
696
 
<!--   <refsect1 id="bugs"> -->
697
 
<!--     <title>BUGS</title> -->
698
 
<!--     <para> -->
699
 
<!--     </para> -->
700
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
701
768
  
702
769
  <refsect1 id="example">
703
770
    <title>EXAMPLE</title>
704
771
    <para>
705
772
      Note that normally, command line options will not be given
706
 
      directly, but via options for the Mandos <citerefentry
707
 
      ><refentrytitle>plugin-runner</refentrytitle>
708
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
709
775
    </para>
710
776
    <informalexample>
711
777
      <para>
728
794
    </informalexample>
729
795
    <informalexample>
730
796
      <para>
731
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
732
798
      </para>
733
799
      <para>
734
800
 
735
801
<!-- do not wrap this line -->
736
 
<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>
737
803
 
738
804
      </para>
739
805
    </informalexample>
740
806
    <informalexample>
741
807
      <para>
742
 
        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
743
809
        to locate a server; connect directly to the IPv6 link-local
744
810
        address <quote><systemitem class="ipaddress"
745
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
748
814
      <para>
749
815
 
750
816
<!-- do not wrap this line -->
751
 
<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>
752
818
 
753
819
      </para>
754
820
    </informalexample>
757
823
  <refsect1 id="security">
758
824
    <title>SECURITY</title>
759
825
    <para>
760
 
      This program is set-uid to root, but will switch back to the
761
 
      original (and presumably non-privileged) user and group after
762
 
      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.
763
829
    </para>
764
830
    <para>
765
831
      To use this program for its intended purpose (see <xref
778
844
    <para>
779
845
      The only remaining weak point is that someone with physical
780
846
      access to the client hard drive might turn off the client
781
 
      computer, read the OpenPGP keys directly from the hard drive,
782
 
      and communicate with the server.  To safeguard against this, the
783
 
      server is supposed to notice the client disappearing and stop
784
 
      giving out the encrypted data.  Therefore, it is important to
785
 
      set the timeout and checker interval values tightly on the
786
 
      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
787
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
788
854
    </para>
789
855
    <para>
813
879
      <manvolnum>5</manvolnum></citerefentry>,
814
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
815
881
      <manvolnum>8</manvolnum></citerefentry>,
816
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
817
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
818
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
819
885
      <manvolnum>8mandos</manvolnum></citerefentry>
832
898
      </varlistentry>
833
899
      <varlistentry>
834
900
        <term>
835
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
836
902
        </term>
837
903
      <listitem>
838
904
        <para>
843
909
      </varlistentry>
844
910
      <varlistentry>
845
911
        <term>
846
 
          <ulink url="http://www.gnu.org/software/gnutls/"
847
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
848
913
        </term>
849
914
      <listitem>
850
915
        <para>
851
916
          GnuTLS is the library this client uses to implement TLS for
852
917
          communicating securely with the server, and at the same time
853
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
854
919
        </para>
855
920
      </listitem>
856
921
      </varlistentry>
857
922
      <varlistentry>
858
923
        <term>
859
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
860
925
                 >GPGME</ulink>
861
926
        </term>
862
927
        <listitem>
900
965
      </varlistentry>
901
966
      <varlistentry>
902
967
        <term>
903
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
904
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
905
970
        </term>
906
971
      <listitem>
907
972
        <para>
908
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
909
974
        </para>
910
975
      </listitem>
911
976
      </varlistentry>
922
987
      </varlistentry>
923
988
      <varlistentry>
924
989
        <term>
925
 
          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
926
1005
          Security</citetitle>
927
1006
        </term>
928
1007
      <listitem>
929
1008
        <para>
930
 
          This is implemented by GnuTLS and used by this program so
931
 
          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.
932
1012
        </para>
933
1013
      </listitem>
934
1014
      </varlistentry>