/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: 2016-02-29 22:51:57 UTC
  • mfrom: (334 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • Revision ID: teddy@recompile.se-20160229225157-if6c17o8ziwncvro
Merge from release branch.

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 "2016-02-28">
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
43
      <holder>Teddy Hogeborn</holder>
47
44
      <holder>Björn Påhlsson</holder>
48
45
    </copyright>
96
93
        <replaceable>FILE</replaceable></option></arg>
97
94
      </group>
98
95
      <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
96
      <arg>
114
97
        <option>--priority <replaceable>STRING</replaceable></option>
115
98
      </arg>
169
152
      brings up network interfaces, uses the interfaces’ IPv6
170
153
      link-local addresses to get network connectivity, uses Zeroconf
171
154
      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
 
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
176
159
      servers are periodically retried.  If no servers are found it
177
160
      will wait indefinitely for new servers to appear.
178
161
    </para>
196
179
    </para>
197
180
    <para>
198
181
      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"/>.
 
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.
202
189
    </para>
203
190
  </refsect1>
204
191
  
216
203
    <title>OPTIONS</title>
217
204
    <para>
218
205
      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.
 
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.
223
212
    </para>
224
213
    
225
214
    <variablelist>
316
305
      </varlistentry>
317
306
      
318
307
      <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
308
        <term><option>--priority=<replaceable
348
309
        >STRING</replaceable></option></term>
349
310
        <listitem>
359
320
          <para>
360
321
            Sets the number of bits to use for the prime number in the
361
322
            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.
 
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.
366
326
          </para>
367
327
        </listitem>
368
328
      </varlistentry>
476
436
    <title>OVERVIEW</title>
477
437
    <xi:include href="../overview.xml"/>
478
438
    <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.
 
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.
504
443
    </para>
505
444
    <para>
506
445
      This program could, theoretically, be used as a keyscript in
507
446
      <filename>/etc/crypttab</filename>, but it would then be
508
447
      impossible to enter a password for the encrypted root disk at
509
448
      the console, since this program does not read from the console
510
 
      at all.
 
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.
511
457
    </para>
512
458
  </refsect1>
513
459
  
533
479
          <para>
534
480
            This environment variable will be assumed to contain the
535
481
            directory containing any helper executables.  The use and
536
 
            nature of these helper executables, if any, is purposely
537
 
            not documented.
 
482
            nature of these helper executables, if any, is
 
483
            purposefully not documented.
538
484
        </para>
539
485
        </listitem>
540
486
      </varlistentry>
734
680
        </listitem>
735
681
      </varlistentry>
736
682
      <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
683
        <term><filename
752
684
        class="directory">/lib/mandos/network-hooks.d</filename></term>
753
685
        <listitem>
761
693
    </variablelist>
762
694
  </refsect1>
763
695
  
764
 
  <refsect1 id="bugs">
765
 
    <title>BUGS</title>
766
 
    <xi:include href="../bugs.xml"/>
767
 
  </refsect1>
 
696
<!--   <refsect1 id="bugs"> -->
 
697
<!--     <title>BUGS</title> -->
 
698
<!--     <para> -->
 
699
<!--     </para> -->
 
700
<!--   </refsect1> -->
768
701
  
769
702
  <refsect1 id="example">
770
703
    <title>EXAMPLE</title>
771
704
    <para>
772
705
      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"/>.
 
706
      directly, but via options for the Mandos <citerefentry
 
707
      ><refentrytitle>plugin-runner</refentrytitle>
 
708
      <manvolnum>8mandos</manvolnum></citerefentry>.
775
709
    </para>
776
710
    <informalexample>
777
711
      <para>
794
728
    </informalexample>
795
729
    <informalexample>
796
730
      <para>
797
 
        Run in debug mode, and use custom keys:
 
731
        Run in debug mode, and use a custom key:
798
732
      </para>
799
733
      <para>
800
734
 
801
735
<!-- 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>
 
736
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
803
737
 
804
738
      </para>
805
739
    </informalexample>
806
740
    <informalexample>
807
741
      <para>
808
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
742
        Run in debug mode, with a custom key, and do not use Zeroconf
809
743
        to locate a server; connect directly to the IPv6 link-local
810
744
        address <quote><systemitem class="ipaddress"
811
745
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
748
      <para>
815
749
 
816
750
<!-- 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>
 
751
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
818
752
 
819
753
      </para>
820
754
    </informalexample>
823
757
  <refsect1 id="security">
824
758
    <title>SECURITY</title>
825
759
    <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.
 
760
      This program is set-uid to root, but will switch back to the
 
761
      original (and presumably non-privileged) user and group after
 
762
      bringing up the network interface.
829
763
    </para>
830
764
    <para>
831
765
      To use this program for its intended purpose (see <xref
844
778
    <para>
845
779
      The only remaining weak point is that someone with physical
846
780
      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
 
781
      computer, read the OpenPGP keys directly from the hard drive,
 
782
      and communicate with the server.  To safeguard against this, the
 
783
      server is supposed to notice the client disappearing and stop
 
784
      giving out the encrypted data.  Therefore, it is important to
 
785
      set the timeout and checker interval values tightly on the
 
786
      server.  See <citerefentry><refentrytitle
853
787
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
788
    </para>
855
789
    <para>
879
813
      <manvolnum>5</manvolnum></citerefentry>,
880
814
      <citerefentry><refentrytitle>mandos</refentrytitle>
881
815
      <manvolnum>8</manvolnum></citerefentry>,
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
816
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
883
817
      <manvolnum>8mandos</manvolnum></citerefentry>,
884
818
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
819
      <manvolnum>8mandos</manvolnum></citerefentry>
898
832
      </varlistentry>
899
833
      <varlistentry>
900
834
        <term>
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
835
          <ulink url="http://www.avahi.org/">Avahi</ulink>
902
836
        </term>
903
837
      <listitem>
904
838
        <para>
909
843
      </varlistentry>
910
844
      <varlistentry>
911
845
        <term>
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
846
          <ulink url="http://www.gnu.org/software/gnutls/"
 
847
          >GnuTLS</ulink>
913
848
        </term>
914
849
      <listitem>
915
850
        <para>
916
851
          GnuTLS is the library this client uses to implement TLS for
917
852
          communicating securely with the server, and at the same time
918
 
          send the public key to the server.
 
853
          send the public OpenPGP key to the server.
919
854
        </para>
920
855
      </listitem>
921
856
      </varlistentry>
922
857
      <varlistentry>
923
858
        <term>
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
859
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
925
860
                 >GPGME</ulink>
926
861
        </term>
927
862
        <listitem>
965
900
      </varlistentry>
966
901
      <varlistentry>
967
902
        <term>
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
 
          Protocol Version 1.2</citetitle>
 
903
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
904
          Protocol Version 1.1</citetitle>
970
905
        </term>
971
906
      <listitem>
972
907
        <para>
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
908
          TLS 1.1 is the protocol implemented by GnuTLS.
974
909
        </para>
975
910
      </listitem>
976
911
      </varlistentry>
987
922
      </varlistentry>
988
923
      <varlistentry>
989
924
        <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
 
925
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
926
          Security</citetitle>
1006
927
        </term>
1007
928
      <listitem>
1008
929
        <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.
 
930
          This is implemented by GnuTLS and used by this program so
 
931
          that OpenPGP keys can be used.
1012
932
        </para>
1013
933
      </listitem>
1014
934
      </varlistentry>