/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-11-22 20:28:54 UTC
  • mto: This revision was merged to the branch mainline in revision 412.
  • Revision ID: teddy@recompile.se-20241122202854-dycuf117byxhxl32
mandos-monitor: Avoid debug messages from urwid

Avoid debug messages from urwid.  Any logging output before the screen
has been set up will mangle the screen.

* mandos-monitor: When setting up logging, set urwid to only show log
  messages of level INFO or above.

(Thanks to an anonymous contributor for reporting this.)

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-06-21">
 
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>
 
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>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
87
96
        <replaceable>FILE</replaceable></option></arg>
88
97
      </group>
89
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/>
90
113
      <arg>
91
114
        <option>--priority <replaceable>STRING</replaceable></option>
92
115
      </arg>
96
119
      </arg>
97
120
      <sbr/>
98
121
      <arg>
 
122
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
123
      </arg>
 
124
      <sbr/>
 
125
      <arg>
99
126
        <option>--delay <replaceable>SECONDS</replaceable></option>
100
127
      </arg>
101
128
      <sbr/>
142
169
      brings up network interfaces, uses the interfaces’ IPv6
143
170
      link-local addresses to get network connectivity, uses Zeroconf
144
171
      to find servers on the local network, and communicates with
145
 
      servers using TLS with an OpenPGP key to ensure authenticity and
146
 
      confidentiality.  This client program keeps running, trying all
147
 
      servers on the network, until it receives a satisfactory reply
148
 
      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
149
176
      servers are periodically retried.  If no servers are found it
150
177
      will wait indefinitely for new servers to appear.
151
178
    </para>
169
196
    </para>
170
197
    <para>
171
198
      This program is not meant to be run directly; it is really meant
172
 
      to run as a plugin of the <application>Mandos</application>
173
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
174
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
175
 
      initial <acronym>RAM</acronym> disk environment because it is
176
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
177
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
178
 
      </citerefentry> file.
 
199
      to be run by other programs in the initial
 
200
      <acronym>RAM</acronym> disk environment; see <xref
 
201
      linkend="overview"/>.
179
202
    </para>
180
203
  </refsect1>
181
204
  
193
216
    <title>OPTIONS</title>
194
217
    <para>
195
218
      This program is commonly not invoked from the command line; it
196
 
      is normally started by the <application>Mandos</application>
197
 
      plugin runner, see <citerefentry><refentrytitle
198
 
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
199
 
      </citerefentry>.  Any command line options this program accepts
200
 
      are therefore normally provided by the plugin runner, and not
201
 
      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.
202
223
    </para>
203
224
    
204
225
    <variablelist>
218
239
            assumed to separate the address from the port number.
219
240
          </para>
220
241
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
242
            Normally, Zeroconf would be used to locate Mandos servers,
 
243
            in which case this option would only be used when testing
 
244
            and debugging.
223
245
          </para>
224
246
        </listitem>
225
247
      </varlistentry>
258
280
          <para>
259
281
            <replaceable>NAME</replaceable> can be the string
260
282
            <quote><literal>none</literal></quote>; this will make
261
 
            <command>&COMMANDNAME;</command> not bring up
262
 
            <emphasis>any</emphasis> interfaces specified
263
 
            <emphasis>after</emphasis> this string.  This is not
264
 
            recommended, and only meant for advanced users.
 
283
            <command>&COMMANDNAME;</command> only bring up interfaces
 
284
            specified <emphasis>before</emphasis> this string.  This
 
285
            is not recommended, and only meant for advanced users.
265
286
          </para>
266
287
        </listitem>
267
288
      </varlistentry>
295
316
      </varlistentry>
296
317
      
297
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>
298
347
        <term><option>--priority=<replaceable
299
348
        >STRING</replaceable></option></term>
300
349
        <listitem>
309
358
        <listitem>
310
359
          <para>
311
360
            Sets the number of bits to use for the prime number in the
312
 
            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.
313
383
          </para>
314
384
        </listitem>
315
385
      </varlistentry>
406
476
    <title>OVERVIEW</title>
407
477
    <xi:include href="../overview.xml"/>
408
478
    <para>
409
 
      This program is the client part.  It is a plugin started by
410
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
411
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
412
 
      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.
413
504
    </para>
414
505
    <para>
415
506
      This program could, theoretically, be used as a keyscript in
416
507
      <filename>/etc/crypttab</filename>, but it would then be
417
508
      impossible to enter a password for the encrypted root disk at
418
509
      the console, since this program does not read from the console
419
 
      at all.  This is why a separate plugin runner (<citerefentry>
420
 
      <refentrytitle>plugin-runner</refentrytitle>
421
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
422
 
      both this program and others in in parallel,
423
 
      <emphasis>one</emphasis> of which (<citerefentry>
424
 
      <refentrytitle>password-prompt</refentrytitle>
425
 
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
426
 
      passwords on the system console.
 
510
      at all.
427
511
    </para>
428
512
  </refsect1>
429
513
  
442
526
  
443
527
  <refsect1 id="environment">
444
528
    <title>ENVIRONMENT</title>
 
529
    <variablelist>
 
530
      <varlistentry>
 
531
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
 
532
        <listitem>
 
533
          <para>
 
534
            This environment variable will be assumed to contain the
 
535
            directory containing any helper executables.  The use and
 
536
            nature of these helper executables, if any, is purposely
 
537
            not documented.
 
538
        </para>
 
539
        </listitem>
 
540
      </varlistentry>
 
541
    </variablelist>
445
542
    <para>
446
 
      This program does not use any environment variables, not even
447
 
      the ones provided by <citerefentry><refentrytitle
 
543
      This program does not use any other environment variables, not
 
544
      even the ones provided by <citerefentry><refentrytitle
448
545
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
449
546
    </citerefentry>.
450
547
    </para>
637
734
        </listitem>
638
735
      </varlistentry>
639
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>
640
751
        <term><filename
641
752
        class="directory">/lib/mandos/network-hooks.d</filename></term>
642
753
        <listitem>
650
761
    </variablelist>
651
762
  </refsect1>
652
763
  
653
 
<!--   <refsect1 id="bugs"> -->
654
 
<!--     <title>BUGS</title> -->
655
 
<!--     <para> -->
656
 
<!--     </para> -->
657
 
<!--   </refsect1> -->
 
764
  <refsect1 id="bugs">
 
765
    <title>BUGS</title>
 
766
    <xi:include href="../bugs.xml"/>
 
767
  </refsect1>
658
768
  
659
769
  <refsect1 id="example">
660
770
    <title>EXAMPLE</title>
661
771
    <para>
662
772
      Note that normally, command line options will not be given
663
 
      directly, but via options for the Mandos <citerefentry
664
 
      ><refentrytitle>plugin-runner</refentrytitle>
665
 
      <manvolnum>8mandos</manvolnum></citerefentry>.
 
773
      directly, but passed on via the program responsible for starting
 
774
      this program; see <xref linkend="overview"/>.
666
775
    </para>
667
776
    <informalexample>
668
777
      <para>
685
794
    </informalexample>
686
795
    <informalexample>
687
796
      <para>
688
 
        Run in debug mode, and use a custom key:
 
797
        Run in debug mode, and use custom keys:
689
798
      </para>
690
799
      <para>
691
800
 
692
801
<!-- do not wrap this line -->
693
 
<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>
694
803
 
695
804
      </para>
696
805
    </informalexample>
697
806
    <informalexample>
698
807
      <para>
699
 
        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
700
809
        to locate a server; connect directly to the IPv6 link-local
701
810
        address <quote><systemitem class="ipaddress"
702
811
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
705
814
      <para>
706
815
 
707
816
<!-- do not wrap this line -->
708
 
<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>
709
818
 
710
819
      </para>
711
820
    </informalexample>
714
823
  <refsect1 id="security">
715
824
    <title>SECURITY</title>
716
825
    <para>
717
 
      This program is set-uid to root, but will switch back to the
718
 
      original (and presumably non-privileged) user and group after
719
 
      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.
720
829
    </para>
721
830
    <para>
722
831
      To use this program for its intended purpose (see <xref
735
844
    <para>
736
845
      The only remaining weak point is that someone with physical
737
846
      access to the client hard drive might turn off the client
738
 
      computer, read the OpenPGP keys directly from the hard drive,
739
 
      and communicate with the server.  To safeguard against this, the
740
 
      server is supposed to notice the client disappearing and stop
741
 
      giving out the encrypted data.  Therefore, it is important to
742
 
      set the timeout and checker interval values tightly on the
743
 
      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
744
853
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
745
854
    </para>
746
855
    <para>
747
856
      It will also help if the checker program on the server is
748
857
      configured to request something from the client which can not be
749
 
      spoofed by someone else on the network, unlike unencrypted
750
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
858
      spoofed by someone else on the network, like SSH server key
 
859
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
 
860
      echo (<quote>ping</quote>) replies.
751
861
    </para>
752
862
    <para>
753
863
      <emphasis>Note</emphasis>: This makes it completely insecure to
769
879
      <manvolnum>5</manvolnum></citerefentry>,
770
880
      <citerefentry><refentrytitle>mandos</refentrytitle>
771
881
      <manvolnum>8</manvolnum></citerefentry>,
772
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
882
      <citerefentry><refentrytitle>password-agent</refentrytitle>
773
883
      <manvolnum>8mandos</manvolnum></citerefentry>,
774
884
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
775
885
      <manvolnum>8mandos</manvolnum></citerefentry>
788
898
      </varlistentry>
789
899
      <varlistentry>
790
900
        <term>
791
 
          <ulink url="http://www.avahi.org/">Avahi</ulink>
 
901
          <ulink url="https://www.avahi.org/">Avahi</ulink>
792
902
        </term>
793
903
      <listitem>
794
904
        <para>
799
909
      </varlistentry>
800
910
      <varlistentry>
801
911
        <term>
802
 
          <ulink url="http://www.gnu.org/software/gnutls/"
803
 
          >GnuTLS</ulink>
 
912
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
804
913
        </term>
805
914
      <listitem>
806
915
        <para>
807
916
          GnuTLS is the library this client uses to implement TLS for
808
917
          communicating securely with the server, and at the same time
809
 
          send the public OpenPGP key to the server.
 
918
          send the public key to the server.
810
919
        </para>
811
920
      </listitem>
812
921
      </varlistentry>
813
922
      <varlistentry>
814
923
        <term>
815
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
924
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
816
925
                 >GPGME</ulink>
817
926
        </term>
818
927
        <listitem>
856
965
      </varlistentry>
857
966
      <varlistentry>
858
967
        <term>
859
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
860
 
          Protocol Version 1.1</citetitle>
 
968
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
969
          Protocol Version 1.2</citetitle>
861
970
        </term>
862
971
      <listitem>
863
972
        <para>
864
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
973
          TLS 1.2 is the protocol implemented by GnuTLS.
865
974
        </para>
866
975
      </listitem>
867
976
      </varlistentry>
878
987
      </varlistentry>
879
988
      <varlistentry>
880
989
        <term>
881
 
          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
882
1005
          Security</citetitle>
883
1006
        </term>
884
1007
      <listitem>
885
1008
        <para>
886
 
          This is implemented by GnuTLS and used by this program so
887
 
          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.
888
1012
        </para>
889
1013
      </listitem>
890
1014
      </varlistentry>