/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-10-27 20:41:11 UTC
  • Revision ID: teddy@recompile.se-20251027204111-kj8ighpkb6e2ei4f
http://bugs.debian.org/1118977
From: Carles Pina i Estany <carles@pina.cat>

Add Catalan debconf translation

* debian/po/ca.po: New.

Closes: #1118977
Acked-by: Teddy Hogeborn <teddy@recompile.se>

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 "2025-06-27">
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>
 
46
      <year>2020</year>
 
47
      <year>2021</year>
 
48
      <year>2022</year>
 
49
      <year>2023</year>
 
50
      <year>2024</year>
43
51
      <holder>Teddy Hogeborn</holder>
44
52
      <holder>Björn Påhlsson</holder>
45
53
    </copyright>
93
101
        <replaceable>FILE</replaceable></option></arg>
94
102
      </group>
95
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/>
96
118
      <arg>
97
119
        <option>--priority <replaceable>STRING</replaceable></option>
98
120
      </arg>
152
174
      brings up network interfaces, uses the interfaces’ IPv6
153
175
      link-local addresses to get network connectivity, uses Zeroconf
154
176
      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
 
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
159
181
      servers are periodically retried.  If no servers are found it
160
182
      will wait indefinitely for new servers to appear.
161
183
    </para>
179
201
    </para>
180
202
    <para>
181
203
      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.
 
204
      to be run by other programs in the initial
 
205
      <acronym>RAM</acronym> disk environment; see <xref
 
206
      linkend="overview"/>.
189
207
    </para>
190
208
  </refsect1>
191
209
  
203
221
    <title>OPTIONS</title>
204
222
    <para>
205
223
      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.
 
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.
212
228
    </para>
213
229
    
214
230
    <variablelist>
305
321
      </varlistentry>
306
322
      
307
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>
308
352
        <term><option>--priority=<replaceable
309
353
        >STRING</replaceable></option></term>
310
354
        <listitem>
320
364
          <para>
321
365
            Sets the number of bits to use for the prime number in the
322
366
            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.
 
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.
326
371
          </para>
327
372
        </listitem>
328
373
      </varlistentry>
436
481
    <title>OVERVIEW</title>
437
482
    <xi:include href="../overview.xml"/>
438
483
    <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.
 
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.
443
509
    </para>
444
510
    <para>
445
511
      This program could, theoretically, be used as a keyscript in
446
512
      <filename>/etc/crypttab</filename>, but it would then be
447
513
      impossible to enter a password for the encrypted root disk at
448
514
      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.
 
515
      at all.
457
516
    </para>
458
517
  </refsect1>
459
518
  
479
538
          <para>
480
539
            This environment variable will be assumed to contain the
481
540
            directory containing any helper executables.  The use and
482
 
            nature of these helper executables, if any, is
483
 
            purposefully not documented.
 
541
            nature of these helper executables, if any, is purposely
 
542
            not documented.
484
543
        </para>
485
544
        </listitem>
486
545
      </varlistentry>
680
739
        </listitem>
681
740
      </varlistentry>
682
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>
683
756
        <term><filename
684
757
        class="directory">/lib/mandos/network-hooks.d</filename></term>
685
758
        <listitem>
702
775
    <title>EXAMPLE</title>
703
776
    <para>
704
777
      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>.
 
778
      directly, but passed on via the program responsible for starting
 
779
      this program; see <xref linkend="overview"/>.
708
780
    </para>
709
781
    <informalexample>
710
782
      <para>
727
799
    </informalexample>
728
800
    <informalexample>
729
801
      <para>
730
 
        Run in debug mode, and use a custom key:
 
802
        Run in debug mode, and use custom keys:
731
803
      </para>
732
804
      <para>
733
805
 
734
806
<!-- do not wrap this line -->
735
 
<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>
736
808
 
737
809
      </para>
738
810
    </informalexample>
739
811
    <informalexample>
740
812
      <para>
741
 
        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
742
814
        to locate a server; connect directly to the IPv6 link-local
743
815
        address <quote><systemitem class="ipaddress"
744
816
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
747
819
      <para>
748
820
 
749
821
<!-- 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>
 
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>
751
823
 
752
824
      </para>
753
825
    </informalexample>
756
828
  <refsect1 id="security">
757
829
    <title>SECURITY</title>
758
830
    <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.
 
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.
762
834
    </para>
763
835
    <para>
764
836
      To use this program for its intended purpose (see <xref
777
849
    <para>
778
850
      The only remaining weak point is that someone with physical
779
851
      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
 
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
786
858
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
787
859
    </para>
788
860
    <para>
812
884
      <manvolnum>5</manvolnum></citerefentry>,
813
885
      <citerefentry><refentrytitle>mandos</refentrytitle>
814
886
      <manvolnum>8</manvolnum></citerefentry>,
815
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
887
      <citerefentry><refentrytitle>password-agent</refentrytitle>
816
888
      <manvolnum>8mandos</manvolnum></citerefentry>,
817
889
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
818
890
      <manvolnum>8mandos</manvolnum></citerefentry>
831
903
      </varlistentry>
832
904
      <varlistentry>
833
905
        <term>
834
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
906
          <ulink url="https://www.avahi.org/">Avahi</ulink>
835
907
        </term>
836
908
      <listitem>
837
909
        <para>
842
914
      </varlistentry>
843
915
      <varlistentry>
844
916
        <term>
845
 
          <ulink url="http://www.gnu.org/software/gnutls/"
846
 
          >GnuTLS</ulink>
 
917
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
847
918
        </term>
848
919
      <listitem>
849
920
        <para>
850
921
          GnuTLS is the library this client uses to implement TLS for
851
922
          communicating securely with the server, and at the same time
852
 
          send the public OpenPGP key to the server.
 
923
          send the public key to the server.
853
924
        </para>
854
925
      </listitem>
855
926
      </varlistentry>
856
927
      <varlistentry>
857
928
        <term>
858
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
929
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
859
930
                 >GPGME</ulink>
860
931
        </term>
861
932
        <listitem>
899
970
      </varlistentry>
900
971
      <varlistentry>
901
972
        <term>
902
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
903
 
          Protocol Version 1.1</citetitle>
 
973
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
974
          Protocol Version 1.2</citetitle>
904
975
        </term>
905
976
      <listitem>
906
977
        <para>
907
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
978
          TLS 1.2 is the protocol implemented by GnuTLS.
908
979
        </para>
909
980
      </listitem>
910
981
      </varlistentry>
921
992
      </varlistentry>
922
993
      <varlistentry>
923
994
        <term>
924
 
          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
925
1010
          Security</citetitle>
926
1011
        </term>
927
1012
      <listitem>
928
1013
        <para>
929
 
          This is implemented by GnuTLS and used by this program so
930
 
          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.
931
1017
        </para>
932
1018
      </listitem>
933
1019
      </varlistentry>