/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 "2013-10-20">
 
5
<!ENTITY TIMESTAMP "2025-06-27">
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>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
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>
38
51
      <holder>Teddy Hogeborn</holder>
39
52
      <holder>Björn Påhlsson</holder>
40
53
    </copyright>
88
101
        <replaceable>FILE</replaceable></option></arg>
89
102
      </group>
90
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/>
91
118
      <arg>
92
119
        <option>--priority <replaceable>STRING</replaceable></option>
93
120
      </arg>
97
124
      </arg>
98
125
      <sbr/>
99
126
      <arg>
 
127
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
128
      </arg>
 
129
      <sbr/>
 
130
      <arg>
100
131
        <option>--delay <replaceable>SECONDS</replaceable></option>
101
132
      </arg>
102
133
      <sbr/>
143
174
      brings up network interfaces, uses the interfaces’ IPv6
144
175
      link-local addresses to get network connectivity, uses Zeroconf
145
176
      to find servers on the local network, and communicates with
146
 
      servers using TLS with an OpenPGP key to ensure authenticity and
147
 
      confidentiality.  This client program keeps running, trying all
148
 
      servers on the network, until it receives a satisfactory reply
149
 
      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
150
181
      servers are periodically retried.  If no servers are found it
151
182
      will wait indefinitely for new servers to appear.
152
183
    </para>
170
201
    </para>
171
202
    <para>
172
203
      This program is not meant to be run directly; it is really meant
173
 
      to run as a plugin of the <application>Mandos</application>
174
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
175
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
176
 
      initial <acronym>RAM</acronym> disk environment because it is
177
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
178
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
179
 
      </citerefentry> file.
 
204
      to be run by other programs in the initial
 
205
      <acronym>RAM</acronym> disk environment; see <xref
 
206
      linkend="overview"/>.
180
207
    </para>
181
208
  </refsect1>
182
209
  
194
221
    <title>OPTIONS</title>
195
222
    <para>
196
223
      This program is commonly not invoked from the command line; it
197
 
      is normally started by the <application>Mandos</application>
198
 
      plugin runner, see <citerefentry><refentrytitle
199
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
200
 
      </citerefentry>.  Any command line options this program accepts
201
 
      are therefore normally provided by the plugin runner, and not
202
 
      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.
203
228
    </para>
204
229
    
205
230
    <variablelist>
219
244
            assumed to separate the address from the port number.
220
245
          </para>
221
246
          <para>
222
 
            This option is normally only useful for testing and
223
 
            debugging.
 
247
            Normally, Zeroconf would be used to locate Mandos servers,
 
248
            in which case this option would only be used when testing
 
249
            and debugging.
224
250
          </para>
225
251
        </listitem>
226
252
      </varlistentry>
259
285
          <para>
260
286
            <replaceable>NAME</replaceable> can be the string
261
287
            <quote><literal>none</literal></quote>; this will make
262
 
            <command>&COMMANDNAME;</command> not bring up
263
 
            <emphasis>any</emphasis> interfaces specified
264
 
            <emphasis>after</emphasis> this string.  This is not
265
 
            recommended, and only meant for advanced users.
 
288
            <command>&COMMANDNAME;</command> only bring up interfaces
 
289
            specified <emphasis>before</emphasis> this string.  This
 
290
            is not recommended, and only meant for advanced users.
266
291
          </para>
267
292
        </listitem>
268
293
      </varlistentry>
296
321
      </varlistentry>
297
322
      
298
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>
299
352
        <term><option>--priority=<replaceable
300
353
        >STRING</replaceable></option></term>
301
354
        <listitem>
310
363
        <listitem>
311
364
          <para>
312
365
            Sets the number of bits to use for the prime number in the
313
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
366
            TLS Diffie-Hellman key exchange.  The default value is
 
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.
 
371
          </para>
 
372
        </listitem>
 
373
      </varlistentry>
 
374
      
 
375
      <varlistentry>
 
376
        <term><option>--dh-params=<replaceable
 
377
        >FILE</replaceable></option></term>
 
378
        <listitem>
 
379
          <para>
 
380
            Specifies a PEM-encoded PKCS#3 file to read the parameters
 
381
            needed by the TLS Diffie-Hellman key exchange from.  If
 
382
            this option is not given, or if the file for some reason
 
383
            could not be used, the parameters will be generated on
 
384
            startup, which will take some time and processing power.
 
385
            Those using servers running under time, power or processor
 
386
            constraints may want to generate such a file in advance
 
387
            and use this option.
314
388
          </para>
315
389
        </listitem>
316
390
      </varlistentry>
407
481
    <title>OVERVIEW</title>
408
482
    <xi:include href="../overview.xml"/>
409
483
    <para>
410
 
      This program is the client part.  It is a plugin started by
411
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
412
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
413
 
      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.
414
509
    </para>
415
510
    <para>
416
511
      This program could, theoretically, be used as a keyscript in
417
512
      <filename>/etc/crypttab</filename>, but it would then be
418
513
      impossible to enter a password for the encrypted root disk at
419
514
      the console, since this program does not read from the console
420
 
      at all.  This is why a separate plugin runner (<citerefentry>
421
 
      <refentrytitle>plugin-runner</refentrytitle>
422
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
423
 
      both this program and others in in parallel,
424
 
      <emphasis>one</emphasis> of which (<citerefentry>
425
 
      <refentrytitle>password-prompt</refentrytitle>
426
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
427
 
      passwords on the system console.
 
515
      at all.
428
516
    </para>
429
517
  </refsect1>
430
518
  
443
531
  
444
532
  <refsect1 id="environment">
445
533
    <title>ENVIRONMENT</title>
 
534
    <variablelist>
 
535
      <varlistentry>
 
536
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
537
        <listitem>
 
538
          <para>
 
539
            This environment variable will be assumed to contain the
 
540
            directory containing any helper executables.  The use and
 
541
            nature of these helper executables, if any, is purposely
 
542
            not documented.
 
543
        </para>
 
544
        </listitem>
 
545
      </varlistentry>
 
546
    </variablelist>
446
547
    <para>
447
 
      This program does not use any environment variables, not even
448
 
      the ones provided by <citerefentry><refentrytitle
 
548
      This program does not use any other environment variables, not
 
549
      even the ones provided by <citerefentry><refentrytitle
449
550
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
450
551
    </citerefentry>.
451
552
    </para>
638
739
        </listitem>
639
740
      </varlistentry>
640
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>
641
756
        <term><filename
642
757
        class="directory">/lib/mandos/network-hooks.d</filename></term>
643
758
        <listitem>
651
766
    </variablelist>
652
767
  </refsect1>
653
768
  
654
 
<!--   <refsect1 id="bugs"> -->
655
 
<!--     <title>BUGS</title> -->
656
 
<!--     <para> -->
657
 
<!--     </para> -->
658
 
<!--   </refsect1> -->
 
769
  <refsect1 id="bugs">
 
770
    <title>BUGS</title>
 
771
    <xi:include href="../bugs.xml"/>
 
772
  </refsect1>
659
773
  
660
774
  <refsect1 id="example">
661
775
    <title>EXAMPLE</title>
662
776
    <para>
663
777
      Note that normally, command line options will not be given
664
 
      directly, but via options for the Mandos <citerefentry
665
 
      ><refentrytitle>plugin-runner</refentrytitle>
666
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
778
      directly, but passed on via the program responsible for starting
 
779
      this program; see <xref linkend="overview"/>.
667
780
    </para>
668
781
    <informalexample>
669
782
      <para>
686
799
    </informalexample>
687
800
    <informalexample>
688
801
      <para>
689
 
        Run in debug mode, and use a custom key:
 
802
        Run in debug mode, and use custom keys:
690
803
      </para>
691
804
      <para>
692
805
 
693
806
<!-- do not wrap this line -->
694
 
<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>
695
808
 
696
809
      </para>
697
810
    </informalexample>
698
811
    <informalexample>
699
812
      <para>
700
 
        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
701
814
        to locate a server; connect directly to the IPv6 link-local
702
815
        address <quote><systemitem class="ipaddress"
703
816
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
706
819
      <para>
707
820
 
708
821
<!-- do not wrap this line -->
709
 
<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>
710
823
 
711
824
      </para>
712
825
    </informalexample>
715
828
  <refsect1 id="security">
716
829
    <title>SECURITY</title>
717
830
    <para>
718
 
      This program is set-uid to root, but will switch back to the
719
 
      original (and presumably non-privileged) user and group after
720
 
      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.
721
834
    </para>
722
835
    <para>
723
836
      To use this program for its intended purpose (see <xref
736
849
    <para>
737
850
      The only remaining weak point is that someone with physical
738
851
      access to the client hard drive might turn off the client
739
 
      computer, read the OpenPGP keys directly from the hard drive,
740
 
      and communicate with the server.  To safeguard against this, the
741
 
      server is supposed to notice the client disappearing and stop
742
 
      giving out the encrypted data.  Therefore, it is important to
743
 
      set the timeout and checker interval values tightly on the
744
 
      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
745
858
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
746
859
    </para>
747
860
    <para>
748
861
      It will also help if the checker program on the server is
749
862
      configured to request something from the client which can not be
750
 
      spoofed by someone else on the network, unlike unencrypted
751
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
863
      spoofed by someone else on the network, like SSH server key
 
864
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
865
      echo (<quote>ping</quote>) replies.
752
866
    </para>
753
867
    <para>
754
868
      <emphasis>Note</emphasis>: This makes it completely insecure to
770
884
      <manvolnum>5</manvolnum></citerefentry>,
771
885
      <citerefentry><refentrytitle>mandos</refentrytitle>
772
886
      <manvolnum>8</manvolnum></citerefentry>,
773
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
887
      <citerefentry><refentrytitle>password-agent</refentrytitle>
774
888
      <manvolnum>8mandos</manvolnum></citerefentry>,
775
889
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
776
890
      <manvolnum>8mandos</manvolnum></citerefentry>
789
903
      </varlistentry>
790
904
      <varlistentry>
791
905
        <term>
792
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
906
          <ulink url="https://www.avahi.org/">Avahi</ulink>
793
907
        </term>
794
908
      <listitem>
795
909
        <para>
800
914
      </varlistentry>
801
915
      <varlistentry>
802
916
        <term>
803
 
          <ulink url="http://www.gnu.org/software/gnutls/"
804
 
          >GnuTLS</ulink>
 
917
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
805
918
        </term>
806
919
      <listitem>
807
920
        <para>
808
921
          GnuTLS is the library this client uses to implement TLS for
809
922
          communicating securely with the server, and at the same time
810
 
          send the public OpenPGP key to the server.
 
923
          send the public key to the server.
811
924
        </para>
812
925
      </listitem>
813
926
      </varlistentry>
814
927
      <varlistentry>
815
928
        <term>
816
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
929
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
817
930
                 >GPGME</ulink>
818
931
        </term>
819
932
        <listitem>
857
970
      </varlistentry>
858
971
      <varlistentry>
859
972
        <term>
860
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
861
 
          Protocol Version 1.1</citetitle>
 
973
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
974
          Protocol Version 1.2</citetitle>
862
975
        </term>
863
976
      <listitem>
864
977
        <para>
865
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
978
          TLS 1.2 is the protocol implemented by GnuTLS.
866
979
        </para>
867
980
      </listitem>
868
981
      </varlistentry>
879
992
      </varlistentry>
880
993
      <varlistentry>
881
994
        <term>
882
 
          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
883
1010
          Security</citetitle>
884
1011
        </term>
885
1012
      <listitem>
886
1013
        <para>
887
 
          This is implemented by GnuTLS and used by this program so
888
 
          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.
889
1017
        </para>
890
1018
      </listitem>
891
1019
      </varlistentry>