/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-08 00:11:24 UTC
  • Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements 

* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.

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-03-05">
 
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>
702
770
    <title>EXAMPLE</title>
703
771
    <para>
704
772
      Note that normally, command line options will not be given
705
 
      directly, but via options for the Mandos <citerefentry
706
 
      ><refentrytitle>plugin-runner</refentrytitle>
707
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
708
775
    </para>
709
776
    <informalexample>
710
777
      <para>
727
794
    </informalexample>
728
795
    <informalexample>
729
796
      <para>
730
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
731
798
      </para>
732
799
      <para>
733
800
 
734
801
<!-- do not wrap this line -->
735
 
<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>
736
803
 
737
804
      </para>
738
805
    </informalexample>
739
806
    <informalexample>
740
807
      <para>
741
 
        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
742
809
        to locate a server; connect directly to the IPv6 link-local
743
810
        address <quote><systemitem class="ipaddress"
744
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
747
814
      <para>
748
815
 
749
816
<!-- do not wrap this line -->
750
 
<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>
751
818
 
752
819
      </para>
753
820
    </informalexample>
756
823
  <refsect1 id="security">
757
824
    <title>SECURITY</title>
758
825
    <para>
759
 
      This program is set-uid to root, but will switch back to the
760
 
      original (and presumably non-privileged) user and group after
761
 
      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.
762
829
    </para>
763
830
    <para>
764
831
      To use this program for its intended purpose (see <xref
777
844
    <para>
778
845
      The only remaining weak point is that someone with physical
779
846
      access to the client hard drive might turn off the client
780
 
      computer, read the OpenPGP keys directly from the hard drive,
781
 
      and communicate with the server.  To safeguard against this, the
782
 
      server is supposed to notice the client disappearing and stop
783
 
      giving out the encrypted data.  Therefore, it is important to
784
 
      set the timeout and checker interval values tightly on the
785
 
      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
786
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
854
    </para>
788
855
    <para>
812
879
      <manvolnum>5</manvolnum></citerefentry>,
813
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
814
881
      <manvolnum>8</manvolnum></citerefentry>,
815
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
816
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
817
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
818
885
      <manvolnum>8mandos</manvolnum></citerefentry>
831
898
      </varlistentry>
832
899
      <varlistentry>
833
900
        <term>
834
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
835
902
        </term>
836
903
      <listitem>
837
904
        <para>
842
909
      </varlistentry>
843
910
      <varlistentry>
844
911
        <term>
845
 
          <ulink url="http://www.gnu.org/software/gnutls/"
846
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
847
913
        </term>
848
914
      <listitem>
849
915
        <para>
850
916
          GnuTLS is the library this client uses to implement TLS for
851
917
          communicating securely with the server, and at the same time
852
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
853
919
        </para>
854
920
      </listitem>
855
921
      </varlistentry>
856
922
      <varlistentry>
857
923
        <term>
858
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
859
925
                 >GPGME</ulink>
860
926
        </term>
861
927
        <listitem>
899
965
      </varlistentry>
900
966
      <varlistentry>
901
967
        <term>
902
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
904
970
        </term>
905
971
      <listitem>
906
972
        <para>
907
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
908
974
        </para>
909
975
      </listitem>
910
976
      </varlistentry>
921
987
      </varlistentry>
922
988
      <varlistentry>
923
989
        <term>
924
 
          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
925
1005
          Security</citetitle>
926
1006
        </term>
927
1007
      <listitem>
928
1008
        <para>
929
 
          This is implemented by GnuTLS and used by this program so
930
 
          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.
931
1012
        </para>
932
1013
      </listitem>
933
1014
      </varlistentry>