/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 "2015-07-06">
 
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>
39
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
 
45
      <year>2019</year>
40
46
      <holder>Teddy Hogeborn</holder>
41
47
      <holder>Björn Påhlsson</holder>
42
48
    </copyright>
90
96
        <replaceable>FILE</replaceable></option></arg>
91
97
      </group>
92
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/>
93
113
      <arg>
94
114
        <option>--priority <replaceable>STRING</replaceable></option>
95
115
      </arg>
99
119
      </arg>
100
120
      <sbr/>
101
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
102
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
103
127
      </arg>
104
128
      <sbr/>
145
169
      brings up network interfaces, uses the interfaces’ IPv6
146
170
      link-local addresses to get network connectivity, uses Zeroconf
147
171
      to find servers on the local network, and communicates with
148
 
      servers using TLS with an OpenPGP key to ensure authenticity and
149
 
      confidentiality.  This client program keeps running, trying all
150
 
      servers on the network, until it receives a satisfactory reply
151
 
      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
152
176
      servers are periodically retried.  If no servers are found it
153
177
      will wait indefinitely for new servers to appear.
154
178
    </para>
172
196
    </para>
173
197
    <para>
174
198
      This program is not meant to be run directly; it is really meant
175
 
      to run as a plugin of the <application>Mandos</application>
176
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
177
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
178
 
      initial <acronym>RAM</acronym> disk environment because it is
179
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
180
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
181
 
      </citerefentry> file.
 
199
      to be run by other programs in the initial
 
200
      <acronym>RAM</acronym> disk environment; see <xref
 
201
      linkend="overview"/>.
182
202
    </para>
183
203
  </refsect1>
184
204
  
196
216
    <title>OPTIONS</title>
197
217
    <para>
198
218
      This program is commonly not invoked from the command line; it
199
 
      is normally started by the <application>Mandos</application>
200
 
      plugin runner, see <citerefentry><refentrytitle
201
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
202
 
      </citerefentry>.  Any command line options this program accepts
203
 
      are therefore normally provided by the plugin runner, and not
204
 
      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.
205
223
    </para>
206
224
    
207
225
    <variablelist>
298
316
      </varlistentry>
299
317
      
300
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>
301
347
        <term><option>--priority=<replaceable
302
348
        >STRING</replaceable></option></term>
303
349
        <listitem>
313
359
          <para>
314
360
            Sets the number of bits to use for the prime number in the
315
361
            TLS Diffie-Hellman key exchange.  The default value is
316
 
            selected automatically based on the OpenPGP key.
 
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.
317
383
          </para>
318
384
        </listitem>
319
385
      </varlistentry>
410
476
    <title>OVERVIEW</title>
411
477
    <xi:include href="../overview.xml"/>
412
478
    <para>
413
 
      This program is the client part.  It is a plugin started by
414
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
415
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
416
 
      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.
417
504
    </para>
418
505
    <para>
419
506
      This program could, theoretically, be used as a keyscript in
420
507
      <filename>/etc/crypttab</filename>, but it would then be
421
508
      impossible to enter a password for the encrypted root disk at
422
509
      the console, since this program does not read from the console
423
 
      at all.  This is why a separate plugin runner (<citerefentry>
424
 
      <refentrytitle>plugin-runner</refentrytitle>
425
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
426
 
      both this program and others in in parallel,
427
 
      <emphasis>one</emphasis> of which (<citerefentry>
428
 
      <refentrytitle>password-prompt</refentrytitle>
429
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
430
 
      passwords on the system console.
 
510
      at all.
431
511
    </para>
432
512
  </refsect1>
433
513
  
453
533
          <para>
454
534
            This environment variable will be assumed to contain the
455
535
            directory containing any helper executables.  The use and
456
 
            nature of these helper executables, if any, is
457
 
            purposefully not documented.
 
536
            nature of these helper executables, if any, is purposely
 
537
            not documented.
458
538
        </para>
459
539
        </listitem>
460
540
      </varlistentry>
654
734
        </listitem>
655
735
      </varlistentry>
656
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>
657
751
        <term><filename
658
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
659
753
        <listitem>
667
761
    </variablelist>
668
762
  </refsect1>
669
763
  
670
 
<!--   <refsect1 id="bugs"> -->
671
 
<!--     <title>BUGS</title> -->
672
 
<!--     <para> -->
673
 
<!--     </para> -->
674
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
675
768
  
676
769
  <refsect1 id="example">
677
770
    <title>EXAMPLE</title>
678
771
    <para>
679
772
      Note that normally, command line options will not be given
680
 
      directly, but via options for the Mandos <citerefentry
681
 
      ><refentrytitle>plugin-runner</refentrytitle>
682
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
683
775
    </para>
684
776
    <informalexample>
685
777
      <para>
702
794
    </informalexample>
703
795
    <informalexample>
704
796
      <para>
705
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
706
798
      </para>
707
799
      <para>
708
800
 
709
801
<!-- do not wrap this line -->
710
 
<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>
711
803
 
712
804
      </para>
713
805
    </informalexample>
714
806
    <informalexample>
715
807
      <para>
716
 
        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
717
809
        to locate a server; connect directly to the IPv6 link-local
718
810
        address <quote><systemitem class="ipaddress"
719
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
722
814
      <para>
723
815
 
724
816
<!-- do not wrap this line -->
725
 
<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>
726
818
 
727
819
      </para>
728
820
    </informalexample>
731
823
  <refsect1 id="security">
732
824
    <title>SECURITY</title>
733
825
    <para>
734
 
      This program is set-uid to root, but will switch back to the
735
 
      original (and presumably non-privileged) user and group after
736
 
      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.
737
829
    </para>
738
830
    <para>
739
831
      To use this program for its intended purpose (see <xref
752
844
    <para>
753
845
      The only remaining weak point is that someone with physical
754
846
      access to the client hard drive might turn off the client
755
 
      computer, read the OpenPGP keys directly from the hard drive,
756
 
      and communicate with the server.  To safeguard against this, the
757
 
      server is supposed to notice the client disappearing and stop
758
 
      giving out the encrypted data.  Therefore, it is important to
759
 
      set the timeout and checker interval values tightly on the
760
 
      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
761
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
762
854
    </para>
763
855
    <para>
787
879
      <manvolnum>5</manvolnum></citerefentry>,
788
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
789
881
      <manvolnum>8</manvolnum></citerefentry>,
790
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
791
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
792
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
793
885
      <manvolnum>8mandos</manvolnum></citerefentry>
806
898
      </varlistentry>
807
899
      <varlistentry>
808
900
        <term>
809
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
810
902
        </term>
811
903
      <listitem>
812
904
        <para>
817
909
      </varlistentry>
818
910
      <varlistentry>
819
911
        <term>
820
 
          <ulink url="http://www.gnu.org/software/gnutls/"
821
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
822
913
        </term>
823
914
      <listitem>
824
915
        <para>
825
916
          GnuTLS is the library this client uses to implement TLS for
826
917
          communicating securely with the server, and at the same time
827
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
828
919
        </para>
829
920
      </listitem>
830
921
      </varlistentry>
831
922
      <varlistentry>
832
923
        <term>
833
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
834
925
                 >GPGME</ulink>
835
926
        </term>
836
927
        <listitem>
874
965
      </varlistentry>
875
966
      <varlistentry>
876
967
        <term>
877
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
878
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
879
970
        </term>
880
971
      <listitem>
881
972
        <para>
882
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
883
974
        </para>
884
975
      </listitem>
885
976
      </varlistentry>
896
987
      </varlistentry>
897
988
      <varlistentry>
898
989
        <term>
899
 
          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
900
1005
          Security</citetitle>
901
1006
        </term>
902
1007
      <listitem>
903
1008
        <para>
904
 
          This is implemented by GnuTLS and used by this program so
905
 
          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.
906
1012
        </para>
907
1013
      </listitem>
908
1014
      </varlistentry>