/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: 2015-07-09 08:57:02 UTC
  • Revision ID: teddy@recompile.se-20150709085702-7bsl6191yo2eusik
initramfs-tools-hook: Use Diffie-Hellman parameters file if available.

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 "2015-07-08">
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
38
      <year>2014</year>
41
39
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
 
      <year>2019</year>
46
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
96
90
        <replaceable>FILE</replaceable></option></arg>
97
91
      </group>
98
92
      <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
93
      <arg>
114
94
        <option>--priority <replaceable>STRING</replaceable></option>
115
95
      </arg>
169
149
      brings up network interfaces, uses the interfaces’ IPv6
170
150
      link-local addresses to get network connectivity, uses Zeroconf
171
151
      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
 
152
      servers using TLS with an OpenPGP key to ensure authenticity and
 
153
      confidentiality.  This client program keeps running, trying all
 
154
      servers on the network, until it receives a satisfactory reply
 
155
      or a TERM signal.  After all servers have been tried, all
176
156
      servers are periodically retried.  If no servers are found it
177
157
      will wait indefinitely for new servers to appear.
178
158
    </para>
196
176
    </para>
197
177
    <para>
198
178
      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"/>.
 
179
      to run as a plugin of the <application>Mandos</application>
 
180
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
181
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
182
      initial <acronym>RAM</acronym> disk environment because it is
 
183
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
184
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
185
      </citerefentry> file.
202
186
    </para>
203
187
  </refsect1>
204
188
  
216
200
    <title>OPTIONS</title>
217
201
    <para>
218
202
      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.
 
203
      is normally started by the <application>Mandos</application>
 
204
      plugin runner, see <citerefentry><refentrytitle
 
205
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
206
      </citerefentry>.  Any command line options this program accepts
 
207
      are therefore normally provided by the plugin runner, and not
 
208
      directly.
223
209
    </para>
224
210
    
225
211
    <variablelist>
316
302
      </varlistentry>
317
303
      
318
304
      <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
305
        <term><option>--priority=<replaceable
348
306
        >STRING</replaceable></option></term>
349
307
        <listitem>
359
317
          <para>
360
318
            Sets the number of bits to use for the prime number in the
361
319
            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.
 
320
            selected automatically based on the OpenPGP key.  Note
 
321
            that if the <option>--dh-params</option> option is used,
 
322
            the values from that file will be used instead.
366
323
          </para>
367
324
        </listitem>
368
325
      </varlistentry>
476
433
    <title>OVERVIEW</title>
477
434
    <xi:include href="../overview.xml"/>
478
435
    <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.
 
436
      This program is the client part.  It is a plugin started by
 
437
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
438
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
439
      an initial <acronym>RAM</acronym> disk environment.
504
440
    </para>
505
441
    <para>
506
442
      This program could, theoretically, be used as a keyscript in
507
443
      <filename>/etc/crypttab</filename>, but it would then be
508
444
      impossible to enter a password for the encrypted root disk at
509
445
      the console, since this program does not read from the console
510
 
      at all.
 
446
      at all.  This is why a separate plugin runner (<citerefentry>
 
447
      <refentrytitle>plugin-runner</refentrytitle>
 
448
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
449
      both this program and others in in parallel,
 
450
      <emphasis>one</emphasis> of which (<citerefentry>
 
451
      <refentrytitle>password-prompt</refentrytitle>
 
452
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
453
      passwords on the system console.
511
454
    </para>
512
455
  </refsect1>
513
456
  
533
476
          <para>
534
477
            This environment variable will be assumed to contain the
535
478
            directory containing any helper executables.  The use and
536
 
            nature of these helper executables, if any, is purposely
537
 
            not documented.
 
479
            nature of these helper executables, if any, is
 
480
            purposefully not documented.
538
481
        </para>
539
482
        </listitem>
540
483
      </varlistentry>
734
677
        </listitem>
735
678
      </varlistentry>
736
679
      <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
680
        <term><filename
752
681
        class="directory">/lib/mandos/network-hooks.d</filename></term>
753
682
        <listitem>
761
690
    </variablelist>
762
691
  </refsect1>
763
692
  
764
 
  <refsect1 id="bugs">
765
 
    <title>BUGS</title>
766
 
    <xi:include href="../bugs.xml"/>
767
 
  </refsect1>
 
693
<!--   <refsect1 id="bugs"> -->
 
694
<!--     <title>BUGS</title> -->
 
695
<!--     <para> -->
 
696
<!--     </para> -->
 
697
<!--   </refsect1> -->
768
698
  
769
699
  <refsect1 id="example">
770
700
    <title>EXAMPLE</title>
771
701
    <para>
772
702
      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"/>.
 
703
      directly, but via options for the Mandos <citerefentry
 
704
      ><refentrytitle>plugin-runner</refentrytitle>
 
705
      <manvolnum>8mandos</manvolnum></citerefentry>.
775
706
    </para>
776
707
    <informalexample>
777
708
      <para>
794
725
    </informalexample>
795
726
    <informalexample>
796
727
      <para>
797
 
        Run in debug mode, and use custom keys:
 
728
        Run in debug mode, and use a custom key:
798
729
      </para>
799
730
      <para>
800
731
 
801
732
<!-- 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>
 
733
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
803
734
 
804
735
      </para>
805
736
    </informalexample>
806
737
    <informalexample>
807
738
      <para>
808
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
739
        Run in debug mode, with a custom key, and do not use Zeroconf
809
740
        to locate a server; connect directly to the IPv6 link-local
810
741
        address <quote><systemitem class="ipaddress"
811
742
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
745
      <para>
815
746
 
816
747
<!-- 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>
 
748
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
818
749
 
819
750
      </para>
820
751
    </informalexample>
823
754
  <refsect1 id="security">
824
755
    <title>SECURITY</title>
825
756
    <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.
 
757
      This program is set-uid to root, but will switch back to the
 
758
      original (and presumably non-privileged) user and group after
 
759
      bringing up the network interface.
829
760
    </para>
830
761
    <para>
831
762
      To use this program for its intended purpose (see <xref
844
775
    <para>
845
776
      The only remaining weak point is that someone with physical
846
777
      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
 
778
      computer, read the OpenPGP keys directly from the hard drive,
 
779
      and communicate with the server.  To safeguard against this, the
 
780
      server is supposed to notice the client disappearing and stop
 
781
      giving out the encrypted data.  Therefore, it is important to
 
782
      set the timeout and checker interval values tightly on the
 
783
      server.  See <citerefentry><refentrytitle
853
784
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
785
    </para>
855
786
    <para>
879
810
      <manvolnum>5</manvolnum></citerefentry>,
880
811
      <citerefentry><refentrytitle>mandos</refentrytitle>
881
812
      <manvolnum>8</manvolnum></citerefentry>,
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
813
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
883
814
      <manvolnum>8mandos</manvolnum></citerefentry>,
884
815
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
816
      <manvolnum>8mandos</manvolnum></citerefentry>
898
829
      </varlistentry>
899
830
      <varlistentry>
900
831
        <term>
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
832
          <ulink url="http://www.avahi.org/">Avahi</ulink>
902
833
        </term>
903
834
      <listitem>
904
835
        <para>
909
840
      </varlistentry>
910
841
      <varlistentry>
911
842
        <term>
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
843
          <ulink url="http://www.gnu.org/software/gnutls/"
 
844
          >GnuTLS</ulink>
913
845
        </term>
914
846
      <listitem>
915
847
        <para>
916
848
          GnuTLS is the library this client uses to implement TLS for
917
849
          communicating securely with the server, and at the same time
918
 
          send the public key to the server.
 
850
          send the public OpenPGP key to the server.
919
851
        </para>
920
852
      </listitem>
921
853
      </varlistentry>
922
854
      <varlistentry>
923
855
        <term>
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
856
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
925
857
                 >GPGME</ulink>
926
858
        </term>
927
859
        <listitem>
965
897
      </varlistentry>
966
898
      <varlistentry>
967
899
        <term>
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
 
          Protocol Version 1.2</citetitle>
 
900
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
901
          Protocol Version 1.1</citetitle>
970
902
        </term>
971
903
      <listitem>
972
904
        <para>
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
905
          TLS 1.1 is the protocol implemented by GnuTLS.
974
906
        </para>
975
907
      </listitem>
976
908
      </varlistentry>
987
919
      </varlistentry>
988
920
      <varlistentry>
989
921
        <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
 
922
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
923
          Security</citetitle>
1006
924
        </term>
1007
925
      <listitem>
1008
926
        <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.
 
927
          This is implemented by GnuTLS and used by this program so
 
928
          that OpenPGP keys can be used.
1012
929
        </para>
1013
930
      </listitem>
1014
931
      </varlistentry>