/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: 2014-01-06 17:22:30 UTC
  • Revision ID: teddy@recompile.se-20140106172230-irt9aykv36s55xlt
Fix Debian package bug with avahi-daemon 0.6.31-2 or older.

* debian/mandos.postinst: If avahi-daemon is version 0.6.31-2 or
                          older, edit /etc/init.d script headers
                          Required-Start and Required-Stop to have
                          "avahi" instead of "avahi-daemon", before
                          insserv(8) sees it.

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 "2023-10-21">
 
5
<!ENTITY TIMESTAMP "2013-10-20">
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>
38
36
      <year>2012</year>
39
37
      <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
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
96
88
        <replaceable>FILE</replaceable></option></arg>
97
89
      </group>
98
90
      <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/>
113
91
      <arg>
114
92
        <option>--priority <replaceable>STRING</replaceable></option>
115
93
      </arg>
119
97
      </arg>
120
98
      <sbr/>
121
99
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
100
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
101
      </arg>
128
102
      <sbr/>
169
143
      brings up network interfaces, uses the interfaces’ IPv6
170
144
      link-local addresses to get network connectivity, uses Zeroconf
171
145
      to find servers on the local network, and communicates with
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
 
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
176
150
      servers are periodically retried.  If no servers are found it
177
151
      will wait indefinitely for new servers to appear.
178
152
    </para>
196
170
    </para>
197
171
    <para>
198
172
      This program is not meant to be run directly; it is really meant
199
 
      to be run by other programs in the initial
200
 
      <acronym>RAM</acronym> disk environment; see <xref
201
 
      linkend="overview"/>.
 
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.
202
180
    </para>
203
181
  </refsect1>
204
182
  
216
194
    <title>OPTIONS</title>
217
195
    <para>
218
196
      This program is commonly not invoked from the command line; it
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.
 
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.
223
203
    </para>
224
204
    
225
205
    <variablelist>
239
219
            assumed to separate the address from the port number.
240
220
          </para>
241
221
          <para>
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.
 
222
            This option is normally only useful for testing and
 
223
            debugging.
245
224
          </para>
246
225
        </listitem>
247
226
      </varlistentry>
280
259
          <para>
281
260
            <replaceable>NAME</replaceable> can be the string
282
261
            <quote><literal>none</literal></quote>; this will make
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.
 
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.
286
266
          </para>
287
267
        </listitem>
288
268
      </varlistentry>
316
296
      </varlistentry>
317
297
      
318
298
      <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>
347
299
        <term><option>--priority=<replaceable
348
300
        >STRING</replaceable></option></term>
349
301
        <listitem>
358
310
        <listitem>
359
311
          <para>
360
312
            Sets the number of bits to use for the prime number in the
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
            TLS Diffie-Hellman key exchange.  Default is 1024.
383
314
          </para>
384
315
        </listitem>
385
316
      </varlistentry>
476
407
    <title>OVERVIEW</title>
477
408
    <xi:include href="../overview.xml"/>
478
409
    <para>
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.
 
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.
504
414
    </para>
505
415
    <para>
506
416
      This program could, theoretically, be used as a keyscript in
507
417
      <filename>/etc/crypttab</filename>, but it would then be
508
418
      impossible to enter a password for the encrypted root disk at
509
419
      the console, since this program does not read from the console
510
 
      at all.
 
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.
511
428
    </para>
512
429
  </refsect1>
513
430
  
526
443
  
527
444
  <refsect1 id="environment">
528
445
    <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>
542
446
    <para>
543
 
      This program does not use any other environment variables, not
544
 
      even the ones provided by <citerefentry><refentrytitle
 
447
      This program does not use any environment variables, not even
 
448
      the ones provided by <citerefentry><refentrytitle
545
449
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
546
450
    </citerefentry>.
547
451
    </para>
734
638
        </listitem>
735
639
      </varlistentry>
736
640
      <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>
751
641
        <term><filename
752
642
        class="directory">/lib/mandos/network-hooks.d</filename></term>
753
643
        <listitem>
761
651
    </variablelist>
762
652
  </refsect1>
763
653
  
764
 
  <refsect1 id="bugs">
765
 
    <title>BUGS</title>
766
 
    <xi:include href="../bugs.xml"/>
767
 
  </refsect1>
 
654
<!--   <refsect1 id="bugs"> -->
 
655
<!--     <title>BUGS</title> -->
 
656
<!--     <para> -->
 
657
<!--     </para> -->
 
658
<!--   </refsect1> -->
768
659
  
769
660
  <refsect1 id="example">
770
661
    <title>EXAMPLE</title>
771
662
    <para>
772
663
      Note that normally, command line options will not be given
773
 
      directly, but passed on via the program responsible for starting
774
 
      this program; see <xref linkend="overview"/>.
 
664
      directly, but via options for the Mandos <citerefentry
 
665
      ><refentrytitle>plugin-runner</refentrytitle>
 
666
      <manvolnum>8mandos</manvolnum></citerefentry>.
775
667
    </para>
776
668
    <informalexample>
777
669
      <para>
794
686
    </informalexample>
795
687
    <informalexample>
796
688
      <para>
797
 
        Run in debug mode, and use custom keys:
 
689
        Run in debug mode, and use a custom key:
798
690
      </para>
799
691
      <para>
800
692
 
801
693
<!-- do not wrap this line -->
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
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
803
695
 
804
696
      </para>
805
697
    </informalexample>
806
698
    <informalexample>
807
699
      <para>
808
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
700
        Run in debug mode, with a custom key, and do not use Zeroconf
809
701
        to locate a server; connect directly to the IPv6 link-local
810
702
        address <quote><systemitem class="ipaddress"
811
703
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
706
      <para>
815
707
 
816
708
<!-- do not wrap this line -->
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
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
818
710
 
819
711
      </para>
820
712
    </informalexample>
823
715
  <refsect1 id="security">
824
716
    <title>SECURITY</title>
825
717
    <para>
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.
 
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.
829
721
    </para>
830
722
    <para>
831
723
      To use this program for its intended purpose (see <xref
844
736
    <para>
845
737
      The only remaining weak point is that someone with physical
846
738
      access to the client hard drive might turn off the client
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
 
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
853
745
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
746
    </para>
855
747
    <para>
856
748
      It will also help if the checker program on the server is
857
749
      configured to request something from the client which can not be
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.
 
750
      spoofed by someone else on the network, unlike unencrypted
 
751
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
861
752
    </para>
862
753
    <para>
863
754
      <emphasis>Note</emphasis>: This makes it completely insecure to
879
770
      <manvolnum>5</manvolnum></citerefentry>,
880
771
      <citerefentry><refentrytitle>mandos</refentrytitle>
881
772
      <manvolnum>8</manvolnum></citerefentry>,
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
773
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
883
774
      <manvolnum>8mandos</manvolnum></citerefentry>,
884
775
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
776
      <manvolnum>8mandos</manvolnum></citerefentry>
898
789
      </varlistentry>
899
790
      <varlistentry>
900
791
        <term>
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
792
          <ulink url="http://www.avahi.org/">Avahi</ulink>
902
793
        </term>
903
794
      <listitem>
904
795
        <para>
909
800
      </varlistentry>
910
801
      <varlistentry>
911
802
        <term>
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
803
          <ulink url="http://www.gnu.org/software/gnutls/"
 
804
          >GnuTLS</ulink>
913
805
        </term>
914
806
      <listitem>
915
807
        <para>
916
808
          GnuTLS is the library this client uses to implement TLS for
917
809
          communicating securely with the server, and at the same time
918
 
          send the public key to the server.
 
810
          send the public OpenPGP key to the server.
919
811
        </para>
920
812
      </listitem>
921
813
      </varlistentry>
922
814
      <varlistentry>
923
815
        <term>
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
816
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
925
817
                 >GPGME</ulink>
926
818
        </term>
927
819
        <listitem>
965
857
      </varlistentry>
966
858
      <varlistentry>
967
859
        <term>
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
 
          Protocol Version 1.2</citetitle>
 
860
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
861
          Protocol Version 1.1</citetitle>
970
862
        </term>
971
863
      <listitem>
972
864
        <para>
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
865
          TLS 1.1 is the protocol implemented by GnuTLS.
974
866
        </para>
975
867
      </listitem>
976
868
      </varlistentry>
987
879
      </varlistentry>
988
880
      <varlistentry>
989
881
        <term>
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
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
883
          Security</citetitle>
1006
884
        </term>
1007
885
      <listitem>
1008
886
        <para>
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.
 
887
          This is implemented by GnuTLS and used by this program so
 
888
          that OpenPGP keys can be used.
1012
889
        </para>
1013
890
      </listitem>
1014
891
      </varlistentry>