/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: 2016-03-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

Since we have a real certificate now, change all links to the home
page to use HTTPS.

* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -

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 "2025-06-27">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
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
 
      <year>2020</year>
47
 
      <year>2021</year>
48
 
      <year>2022</year>
49
 
      <year>2023</year>
50
 
      <year>2024</year>
51
43
      <holder>Teddy Hogeborn</holder>
52
44
      <holder>Björn Påhlsson</holder>
53
45
    </copyright>
101
93
        <replaceable>FILE</replaceable></option></arg>
102
94
      </group>
103
95
      <sbr/>
104
 
      <group>
105
 
        <arg choice="plain"><option>--tls-privkey
106
 
        <replaceable>FILE</replaceable></option></arg>
107
 
        <arg choice="plain"><option>-t
108
 
        <replaceable>FILE</replaceable></option></arg>
109
 
      </group>
110
 
      <sbr/>
111
 
      <group>
112
 
        <arg choice="plain"><option>--tls-pubkey
113
 
        <replaceable>FILE</replaceable></option></arg>
114
 
        <arg choice="plain"><option>-T
115
 
        <replaceable>FILE</replaceable></option></arg>
116
 
      </group>
117
 
      <sbr/>
118
96
      <arg>
119
97
        <option>--priority <replaceable>STRING</replaceable></option>
120
98
      </arg>
174
152
      brings up network interfaces, uses the interfaces’ IPv6
175
153
      link-local addresses to get network connectivity, uses Zeroconf
176
154
      to find servers on the local network, and communicates with
177
 
      servers using TLS with a raw public key to ensure authenticity
178
 
      and confidentiality.  This client program keeps running, trying
179
 
      all servers on the network, until it receives a satisfactory
180
 
      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
181
159
      servers are periodically retried.  If no servers are found it
182
160
      will wait indefinitely for new servers to appear.
183
161
    </para>
201
179
    </para>
202
180
    <para>
203
181
      This program is not meant to be run directly; it is really meant
204
 
      to be run by other programs in the initial
205
 
      <acronym>RAM</acronym> disk environment; see <xref
206
 
      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.
207
189
    </para>
208
190
  </refsect1>
209
191
  
221
203
    <title>OPTIONS</title>
222
204
    <para>
223
205
      This program is commonly not invoked from the command line; it
224
 
      is normally started by another program as described in <xref
225
 
      linkend="description"/>.  Any command line options this program
226
 
      accepts are therefore normally provided by the invoking program,
227
 
      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.
228
212
    </para>
229
213
    
230
214
    <variablelist>
321
305
      </varlistentry>
322
306
      
323
307
      <varlistentry>
324
 
        <term><option>--tls-pubkey=<replaceable
325
 
        >FILE</replaceable></option></term>
326
 
        <term><option>-T
327
 
        <replaceable>FILE</replaceable></option></term>
328
 
        <listitem>
329
 
          <para>
330
 
            TLS raw public key file name.  The default name is
331
 
            <quote><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
332
 
            ></quote>.
333
 
          </para>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
 
337
 
      <varlistentry>
338
 
        <term><option>--tls-privkey=<replaceable
339
 
        >FILE</replaceable></option></term>
340
 
        <term><option>-t
341
 
        <replaceable>FILE</replaceable></option></term>
342
 
        <listitem>
343
 
          <para>
344
 
            TLS secret key file name.  The default name is
345
 
            <quote><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
346
 
            ></quote>.
347
 
          </para>
348
 
        </listitem>
349
 
      </varlistentry>
350
 
 
351
 
      <varlistentry>
352
308
        <term><option>--priority=<replaceable
353
309
        >STRING</replaceable></option></term>
354
310
        <listitem>
364
320
          <para>
365
321
            Sets the number of bits to use for the prime number in the
366
322
            TLS Diffie-Hellman key exchange.  The default value is
367
 
            selected automatically based on the GnuTLS security
368
 
            profile set in its priority string.  Note that if the
369
 
            <option>--dh-params</option> option is used, the values
370
 
            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.
371
326
          </para>
372
327
        </listitem>
373
328
      </varlistentry>
481
436
    <title>OVERVIEW</title>
482
437
    <xi:include href="../overview.xml"/>
483
438
    <para>
484
 
      This program is the client part.  It is run automatically in an
485
 
      initial <acronym>RAM</acronym> disk environment.
486
 
    </para>
487
 
    <para>
488
 
      In an initial <acronym>RAM</acronym> disk environment using
489
 
      <citerefentry><refentrytitle>systemd</refentrytitle>
490
 
      <manvolnum>1</manvolnum></citerefentry>, this program is started
491
 
      by the <application>Mandos</application> <citerefentry>
492
 
      <refentrytitle>password-agent</refentrytitle>
493
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn is
494
 
      started automatically by the <citerefentry>
495
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
496
 
      </citerefentry> <quote>Password Agent</quote> system.
497
 
    </para>
498
 
    <para>
499
 
      In the case of a non-<citerefentry>
500
 
      <refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum>
501
 
      </citerefentry> environment, this program is started as a plugin
502
 
      of the <application>Mandos</application> <citerefentry>
503
 
      <refentrytitle>plugin-runner</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
505
 
      initial <acronym>RAM</acronym> disk environment because it is
506
 
      specified as a <quote>keyscript</quote> in the <citerefentry>
507
 
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
508
 
      </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.
509
443
    </para>
510
444
    <para>
511
445
      This program could, theoretically, be used as a keyscript in
512
446
      <filename>/etc/crypttab</filename>, but it would then be
513
447
      impossible to enter a password for the encrypted root disk at
514
448
      the console, since this program does not read from the console
515
 
      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.
516
457
    </para>
517
458
  </refsect1>
518
459
  
538
479
          <para>
539
480
            This environment variable will be assumed to contain the
540
481
            directory containing any helper executables.  The use and
541
 
            nature of these helper executables, if any, is purposely
542
 
            not documented.
 
482
            nature of these helper executables, if any, is
 
483
            purposefully not documented.
543
484
        </para>
544
485
        </listitem>
545
486
      </varlistentry>
739
680
        </listitem>
740
681
      </varlistentry>
741
682
      <varlistentry>
742
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
743
 
        ></term>
744
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
745
 
        ></term>
746
 
        <listitem>
747
 
          <para>
748
 
            Public and private raw key files, in <quote>PEM</quote>
749
 
            format.  These are the default file names, they can be
750
 
            changed with the <option>--tls-pubkey</option> and
751
 
            <option>--tls-privkey</option> options.
752
 
          </para>
753
 
        </listitem>
754
 
      </varlistentry>
755
 
      <varlistentry>
756
683
        <term><filename
757
684
        class="directory">/lib/mandos/network-hooks.d</filename></term>
758
685
        <listitem>
775
702
    <title>EXAMPLE</title>
776
703
    <para>
777
704
      Note that normally, command line options will not be given
778
 
      directly, but passed on via the program responsible for starting
779
 
      this program; see <xref linkend="overview"/>.
 
705
      directly, but via options for the Mandos <citerefentry
 
706
      ><refentrytitle>plugin-runner</refentrytitle>
 
707
      <manvolnum>8mandos</manvolnum></citerefentry>.
780
708
    </para>
781
709
    <informalexample>
782
710
      <para>
799
727
    </informalexample>
800
728
    <informalexample>
801
729
      <para>
802
 
        Run in debug mode, and use custom keys:
 
730
        Run in debug mode, and use a custom key:
803
731
      </para>
804
732
      <para>
805
733
 
806
734
<!-- do not wrap this line -->
807
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
735
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
808
736
 
809
737
      </para>
810
738
    </informalexample>
811
739
    <informalexample>
812
740
      <para>
813
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
741
        Run in debug mode, with a custom key, and do not use Zeroconf
814
742
        to locate a server; connect directly to the IPv6 link-local
815
743
        address <quote><systemitem class="ipaddress"
816
744
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
819
747
      <para>
820
748
 
821
749
<!-- do not wrap this line -->
822
 
<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>
 
750
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
823
751
 
824
752
      </para>
825
753
    </informalexample>
828
756
  <refsect1 id="security">
829
757
    <title>SECURITY</title>
830
758
    <para>
831
 
      This program assumes that it is set-uid to root, and will switch
832
 
      back to the original (and presumably non-privileged) user and
833
 
      group after bringing up the network interface.
 
759
      This program is set-uid to root, but will switch back to the
 
760
      original (and presumably non-privileged) user and group after
 
761
      bringing up the network interface.
834
762
    </para>
835
763
    <para>
836
764
      To use this program for its intended purpose (see <xref
849
777
    <para>
850
778
      The only remaining weak point is that someone with physical
851
779
      access to the client hard drive might turn off the client
852
 
      computer, read the OpenPGP and TLS keys directly from the hard
853
 
      drive, and communicate with the server.  To safeguard against
854
 
      this, the server is supposed to notice the client disappearing
855
 
      and stop giving out the encrypted data.  Therefore, it is
856
 
      important to set the timeout and checker interval values tightly
857
 
      on the server.  See <citerefentry><refentrytitle
 
780
      computer, read the OpenPGP keys directly from the hard drive,
 
781
      and communicate with the server.  To safeguard against this, the
 
782
      server is supposed to notice the client disappearing and stop
 
783
      giving out the encrypted data.  Therefore, it is important to
 
784
      set the timeout and checker interval values tightly on the
 
785
      server.  See <citerefentry><refentrytitle
858
786
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
859
787
    </para>
860
788
    <para>
884
812
      <manvolnum>5</manvolnum></citerefentry>,
885
813
      <citerefentry><refentrytitle>mandos</refentrytitle>
886
814
      <manvolnum>8</manvolnum></citerefentry>,
887
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
815
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
888
816
      <manvolnum>8mandos</manvolnum></citerefentry>,
889
817
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
890
818
      <manvolnum>8mandos</manvolnum></citerefentry>
903
831
      </varlistentry>
904
832
      <varlistentry>
905
833
        <term>
906
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
834
          <ulink url="http://www.avahi.org/">Avahi</ulink>
907
835
        </term>
908
836
      <listitem>
909
837
        <para>
914
842
      </varlistentry>
915
843
      <varlistentry>
916
844
        <term>
917
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
845
          <ulink url="http://www.gnu.org/software/gnutls/"
 
846
          >GnuTLS</ulink>
918
847
        </term>
919
848
      <listitem>
920
849
        <para>
921
850
          GnuTLS is the library this client uses to implement TLS for
922
851
          communicating securely with the server, and at the same time
923
 
          send the public key to the server.
 
852
          send the public OpenPGP key to the server.
924
853
        </para>
925
854
      </listitem>
926
855
      </varlistentry>
927
856
      <varlistentry>
928
857
        <term>
929
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
858
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
930
859
                 >GPGME</ulink>
931
860
        </term>
932
861
        <listitem>
970
899
      </varlistentry>
971
900
      <varlistentry>
972
901
        <term>
973
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
974
 
          Protocol Version 1.2</citetitle>
 
902
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
903
          Protocol Version 1.1</citetitle>
975
904
        </term>
976
905
      <listitem>
977
906
        <para>
978
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
907
          TLS 1.1 is the protocol implemented by GnuTLS.
979
908
        </para>
980
909
      </listitem>
981
910
      </varlistentry>
992
921
      </varlistentry>
993
922
      <varlistentry>
994
923
        <term>
995
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
996
 
          Layer Security (TLS) and Datagram Transport Layer Security
997
 
          (DTLS)</citetitle>
998
 
        </term>
999
 
      <listitem>
1000
 
        <para>
1001
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
1002
 
          present, used by this program so that raw public keys can be
1003
 
          used.
1004
 
        </para>
1005
 
      </listitem>
1006
 
      </varlistentry>
1007
 
      <varlistentry>
1008
 
        <term>
1009
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
924
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
1010
925
          Security</citetitle>
1011
926
        </term>
1012
927
      <listitem>
1013
928
        <para>
1014
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1015
 
          if present, used by this program so that OpenPGP keys can be
1016
 
          used.
 
929
          This is implemented by GnuTLS and used by this program so
 
930
          that OpenPGP keys can be used.
1017
931
        </para>
1018
932
      </listitem>
1019
933
      </varlistentry>