/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-07 15:49:49 UTC
  • Revision ID: teddy@recompile.se-20150707154949-vbuj4pc6wf3o1vgz
mandos.service: Use Type=dbus (implicitly).

mandos.service ([Service]/Type): Removed.
               ([Service]/BusName): Uncommented; set to
                                    "se.recompile.Mandos".

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-06">
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>
119
99
      </arg>
120
100
      <sbr/>
121
101
      <arg>
122
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
123
 
      </arg>
124
 
      <sbr/>
125
 
      <arg>
126
102
        <option>--delay <replaceable>SECONDS</replaceable></option>
127
103
      </arg>
128
104
      <sbr/>
169
145
      brings up network interfaces, uses the interfaces’ IPv6
170
146
      link-local addresses to get network connectivity, uses Zeroconf
171
147
      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
 
148
      servers using TLS with an OpenPGP key to ensure authenticity and
 
149
      confidentiality.  This client program keeps running, trying all
 
150
      servers on the network, until it receives a satisfactory reply
 
151
      or a TERM signal.  After all servers have been tried, all
176
152
      servers are periodically retried.  If no servers are found it
177
153
      will wait indefinitely for new servers to appear.
178
154
    </para>
196
172
    </para>
197
173
    <para>
198
174
      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"/>.
 
175
      to run as a plugin of the <application>Mandos</application>
 
176
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
177
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
178
      initial <acronym>RAM</acronym> disk environment because it is
 
179
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
180
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
181
      </citerefentry> file.
202
182
    </para>
203
183
  </refsect1>
204
184
  
216
196
    <title>OPTIONS</title>
217
197
    <para>
218
198
      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.
 
199
      is normally started by the <application>Mandos</application>
 
200
      plugin runner, see <citerefentry><refentrytitle
 
201
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
202
      </citerefentry>.  Any command line options this program accepts
 
203
      are therefore normally provided by the plugin runner, and not
 
204
      directly.
223
205
    </para>
224
206
    
225
207
    <variablelist>
316
298
      </varlistentry>
317
299
      
318
300
      <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
301
        <term><option>--priority=<replaceable
348
302
        >STRING</replaceable></option></term>
349
303
        <listitem>
359
313
          <para>
360
314
            Sets the number of bits to use for the prime number in the
361
315
            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.
 
316
            selected automatically based on the OpenPGP key.
383
317
          </para>
384
318
        </listitem>
385
319
      </varlistentry>
476
410
    <title>OVERVIEW</title>
477
411
    <xi:include href="../overview.xml"/>
478
412
    <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.
 
413
      This program is the client part.  It is a plugin started by
 
414
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
415
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
416
      an initial <acronym>RAM</acronym> disk environment.
504
417
    </para>
505
418
    <para>
506
419
      This program could, theoretically, be used as a keyscript in
507
420
      <filename>/etc/crypttab</filename>, but it would then be
508
421
      impossible to enter a password for the encrypted root disk at
509
422
      the console, since this program does not read from the console
510
 
      at all.
 
423
      at all.  This is why a separate plugin runner (<citerefentry>
 
424
      <refentrytitle>plugin-runner</refentrytitle>
 
425
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
426
      both this program and others in in parallel,
 
427
      <emphasis>one</emphasis> of which (<citerefentry>
 
428
      <refentrytitle>password-prompt</refentrytitle>
 
429
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
430
      passwords on the system console.
511
431
    </para>
512
432
  </refsect1>
513
433
  
533
453
          <para>
534
454
            This environment variable will be assumed to contain the
535
455
            directory containing any helper executables.  The use and
536
 
            nature of these helper executables, if any, is purposely
537
 
            not documented.
 
456
            nature of these helper executables, if any, is
 
457
            purposefully not documented.
538
458
        </para>
539
459
        </listitem>
540
460
      </varlistentry>
734
654
        </listitem>
735
655
      </varlistentry>
736
656
      <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
657
        <term><filename
752
658
        class="directory">/lib/mandos/network-hooks.d</filename></term>
753
659
        <listitem>
761
667
    </variablelist>
762
668
  </refsect1>
763
669
  
764
 
  <refsect1 id="bugs">
765
 
    <title>BUGS</title>
766
 
    <xi:include href="../bugs.xml"/>
767
 
  </refsect1>
 
670
<!--   <refsect1 id="bugs"> -->
 
671
<!--     <title>BUGS</title> -->
 
672
<!--     <para> -->
 
673
<!--     </para> -->
 
674
<!--   </refsect1> -->
768
675
  
769
676
  <refsect1 id="example">
770
677
    <title>EXAMPLE</title>
771
678
    <para>
772
679
      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"/>.
 
680
      directly, but via options for the Mandos <citerefentry
 
681
      ><refentrytitle>plugin-runner</refentrytitle>
 
682
      <manvolnum>8mandos</manvolnum></citerefentry>.
775
683
    </para>
776
684
    <informalexample>
777
685
      <para>
794
702
    </informalexample>
795
703
    <informalexample>
796
704
      <para>
797
 
        Run in debug mode, and use custom keys:
 
705
        Run in debug mode, and use a custom key:
798
706
      </para>
799
707
      <para>
800
708
 
801
709
<!-- 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>
 
710
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
803
711
 
804
712
      </para>
805
713
    </informalexample>
806
714
    <informalexample>
807
715
      <para>
808
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
716
        Run in debug mode, with a custom key, and do not use Zeroconf
809
717
        to locate a server; connect directly to the IPv6 link-local
810
718
        address <quote><systemitem class="ipaddress"
811
719
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
814
722
      <para>
815
723
 
816
724
<!-- 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>
 
725
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
818
726
 
819
727
      </para>
820
728
    </informalexample>
823
731
  <refsect1 id="security">
824
732
    <title>SECURITY</title>
825
733
    <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.
 
734
      This program is set-uid to root, but will switch back to the
 
735
      original (and presumably non-privileged) user and group after
 
736
      bringing up the network interface.
829
737
    </para>
830
738
    <para>
831
739
      To use this program for its intended purpose (see <xref
844
752
    <para>
845
753
      The only remaining weak point is that someone with physical
846
754
      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
 
755
      computer, read the OpenPGP keys directly from the hard drive,
 
756
      and communicate with the server.  To safeguard against this, the
 
757
      server is supposed to notice the client disappearing and stop
 
758
      giving out the encrypted data.  Therefore, it is important to
 
759
      set the timeout and checker interval values tightly on the
 
760
      server.  See <citerefentry><refentrytitle
853
761
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
854
762
    </para>
855
763
    <para>
879
787
      <manvolnum>5</manvolnum></citerefentry>,
880
788
      <citerefentry><refentrytitle>mandos</refentrytitle>
881
789
      <manvolnum>8</manvolnum></citerefentry>,
882
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
790
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
883
791
      <manvolnum>8mandos</manvolnum></citerefentry>,
884
792
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
885
793
      <manvolnum>8mandos</manvolnum></citerefentry>
898
806
      </varlistentry>
899
807
      <varlistentry>
900
808
        <term>
901
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
809
          <ulink url="http://www.avahi.org/">Avahi</ulink>
902
810
        </term>
903
811
      <listitem>
904
812
        <para>
909
817
      </varlistentry>
910
818
      <varlistentry>
911
819
        <term>
912
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
820
          <ulink url="http://www.gnu.org/software/gnutls/"
 
821
          >GnuTLS</ulink>
913
822
        </term>
914
823
      <listitem>
915
824
        <para>
916
825
          GnuTLS is the library this client uses to implement TLS for
917
826
          communicating securely with the server, and at the same time
918
 
          send the public key to the server.
 
827
          send the public OpenPGP key to the server.
919
828
        </para>
920
829
      </listitem>
921
830
      </varlistentry>
922
831
      <varlistentry>
923
832
        <term>
924
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
833
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
925
834
                 >GPGME</ulink>
926
835
        </term>
927
836
        <listitem>
965
874
      </varlistentry>
966
875
      <varlistentry>
967
876
        <term>
968
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
969
 
          Protocol Version 1.2</citetitle>
 
877
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
878
          Protocol Version 1.1</citetitle>
970
879
        </term>
971
880
      <listitem>
972
881
        <para>
973
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
882
          TLS 1.1 is the protocol implemented by GnuTLS.
974
883
        </para>
975
884
      </listitem>
976
885
      </varlistentry>
987
896
      </varlistentry>
988
897
      <varlistentry>
989
898
        <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
 
899
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1005
900
          Security</citetitle>
1006
901
        </term>
1007
902
      <listitem>
1008
903
        <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.
 
904
          This is implemented by GnuTLS and used by this program so
 
905
          that OpenPGP keys can be used.
1012
906
        </para>
1013
907
      </listitem>
1014
908
      </varlistentry>