/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-15 20:21:49 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20240915202149-447ayubypn08tpki
Fix lintian warning "build-depends-on-obsolete-package"

Apparently, pkg-config is deprecated in favor of pkgconf:
<https://bugs.debian.org/1020799>,
<http://pkgconf-migration.debian.net/>

Therefore, prefer pkgconf in the build dependencies.

* debian/control (Source: mandos/Build-Depends): Change "pkg-config"
  to "pkgconf | pkg-config".

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-06-29">
 
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>
312
358
        <listitem>
313
359
          <para>
314
360
            Sets the number of bits to use for the prime number in the
315
 
            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.
316
383
          </para>
317
384
        </listitem>
318
385
      </varlistentry>
409
476
    <title>OVERVIEW</title>
410
477
    <xi:include href="../overview.xml"/>
411
478
    <para>
412
 
      This program is the client part.  It is a plugin started by
413
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
414
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
415
 
      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.
416
504
    </para>
417
505
    <para>
418
506
      This program could, theoretically, be used as a keyscript in
419
507
      <filename>/etc/crypttab</filename>, but it would then be
420
508
      impossible to enter a password for the encrypted root disk at
421
509
      the console, since this program does not read from the console
422
 
      at all.  This is why a separate plugin runner (<citerefentry>
423
 
      <refentrytitle>plugin-runner</refentrytitle>
424
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
425
 
      both this program and others in in parallel,
426
 
      <emphasis>one</emphasis> of which (<citerefentry>
427
 
      <refentrytitle>password-prompt</refentrytitle>
428
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
429
 
      passwords on the system console.
 
510
      at all.
430
511
    </para>
431
512
  </refsect1>
432
513
  
452
533
          <para>
453
534
            This environment variable will be assumed to contain the
454
535
            directory containing any helper executables.  The use and
455
 
            nature of these helper executables, if any, is
456
 
            purposefully not documented.
 
536
            nature of these helper executables, if any, is purposely
 
537
            not documented.
457
538
        </para>
458
539
        </listitem>
459
540
      </varlistentry>
653
734
        </listitem>
654
735
      </varlistentry>
655
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>
656
751
        <term><filename
657
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
658
753
        <listitem>
666
761
    </variablelist>
667
762
  </refsect1>
668
763
  
669
 
<!--   <refsect1 id="bugs"> -->
670
 
<!--     <title>BUGS</title> -->
671
 
<!--     <para> -->
672
 
<!--     </para> -->
673
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
674
768
  
675
769
  <refsect1 id="example">
676
770
    <title>EXAMPLE</title>
677
771
    <para>
678
772
      Note that normally, command line options will not be given
679
 
      directly, but via options for the Mandos <citerefentry
680
 
      ><refentrytitle>plugin-runner</refentrytitle>
681
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
682
775
    </para>
683
776
    <informalexample>
684
777
      <para>
701
794
    </informalexample>
702
795
    <informalexample>
703
796
      <para>
704
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
705
798
      </para>
706
799
      <para>
707
800
 
708
801
<!-- do not wrap this line -->
709
 
<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>
710
803
 
711
804
      </para>
712
805
    </informalexample>
713
806
    <informalexample>
714
807
      <para>
715
 
        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
716
809
        to locate a server; connect directly to the IPv6 link-local
717
810
        address <quote><systemitem class="ipaddress"
718
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
721
814
      <para>
722
815
 
723
816
<!-- do not wrap this line -->
724
 
<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>
725
818
 
726
819
      </para>
727
820
    </informalexample>
730
823
  <refsect1 id="security">
731
824
    <title>SECURITY</title>
732
825
    <para>
733
 
      This program is set-uid to root, but will switch back to the
734
 
      original (and presumably non-privileged) user and group after
735
 
      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.
736
829
    </para>
737
830
    <para>
738
831
      To use this program for its intended purpose (see <xref
751
844
    <para>
752
845
      The only remaining weak point is that someone with physical
753
846
      access to the client hard drive might turn off the client
754
 
      computer, read the OpenPGP keys directly from the hard drive,
755
 
      and communicate with the server.  To safeguard against this, the
756
 
      server is supposed to notice the client disappearing and stop
757
 
      giving out the encrypted data.  Therefore, it is important to
758
 
      set the timeout and checker interval values tightly on the
759
 
      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
760
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
761
854
    </para>
762
855
    <para>
786
879
      <manvolnum>5</manvolnum></citerefentry>,
787
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
788
881
      <manvolnum>8</manvolnum></citerefentry>,
789
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
790
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
791
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
792
885
      <manvolnum>8mandos</manvolnum></citerefentry>
805
898
      </varlistentry>
806
899
      <varlistentry>
807
900
        <term>
808
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
809
902
        </term>
810
903
      <listitem>
811
904
        <para>
816
909
      </varlistentry>
817
910
      <varlistentry>
818
911
        <term>
819
 
          <ulink url="http://www.gnu.org/software/gnutls/"
820
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
821
913
        </term>
822
914
      <listitem>
823
915
        <para>
824
916
          GnuTLS is the library this client uses to implement TLS for
825
917
          communicating securely with the server, and at the same time
826
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
827
919
        </para>
828
920
      </listitem>
829
921
      </varlistentry>
830
922
      <varlistentry>
831
923
        <term>
832
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
833
925
                 >GPGME</ulink>
834
926
        </term>
835
927
        <listitem>
873
965
      </varlistentry>
874
966
      <varlistentry>
875
967
        <term>
876
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
877
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
878
970
        </term>
879
971
      <listitem>
880
972
        <para>
881
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
882
974
        </para>
883
975
      </listitem>
884
976
      </varlistentry>
895
987
      </varlistentry>
896
988
      <varlistentry>
897
989
        <term>
898
 
          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
899
1005
          Security</citetitle>
900
1006
        </term>
901
1007
      <listitem>
902
1008
        <para>
903
 
          This is implemented by GnuTLS and used by this program so
904
 
          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.
905
1012
        </para>
906
1013
      </listitem>
907
1014
      </varlistentry>