/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: 2018-08-19 01:35:11 UTC
  • Revision ID: teddy@recompile.se-20180819013511-cku25q9yeub3dnr0
Adapt to changes in cryptsetup; use "cryptroot-unlock" program

* Makefile (install-client-nokey): Also install new script files
  "mandos-to-cryptroot-unlock" and "initramfs-tools-script-stop".
* debian/mandos-client.dirs: Add
  "usr/share/initramfs-tools/scripts/local-premount".
* initramfs-tools-hook: Also copy "mandos-to-cryptroot-unlock".
* initramfs-tools-script: Only modify keyscript setting in cryptroot
  file if the file exists, otherwise start
  "mandos-to-cryptroot-unlock" in background.
* initramfs-tools-script-stop: New script to make sure plugin-runner
  has stopped before continuing.
* mandos-to-cryptroot-unlock: New script to run plugin-runner and feed
  any password it gets into the "cryptroot-unlock" program.

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 "2018-02-08">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
42
42
      <year>2016</year>
43
43
      <year>2017</year>
44
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
45
      <holder>Teddy Hogeborn</holder>
52
46
      <holder>Björn Påhlsson</holder>
53
47
    </copyright>
101
95
        <replaceable>FILE</replaceable></option></arg>
102
96
      </group>
103
97
      <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
98
      <arg>
119
99
        <option>--priority <replaceable>STRING</replaceable></option>
120
100
      </arg>
174
154
      brings up network interfaces, uses the interfaces’ IPv6
175
155
      link-local addresses to get network connectivity, uses Zeroconf
176
156
      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
 
157
      servers using TLS with an OpenPGP key to ensure authenticity and
 
158
      confidentiality.  This client program keeps running, trying all
 
159
      servers on the network, until it receives a satisfactory reply
 
160
      or a TERM signal.  After all servers have been tried, all
181
161
      servers are periodically retried.  If no servers are found it
182
162
      will wait indefinitely for new servers to appear.
183
163
    </para>
201
181
    </para>
202
182
    <para>
203
183
      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"/>.
 
184
      to run as a plugin of the <application>Mandos</application>
 
185
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
186
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
187
      initial <acronym>RAM</acronym> disk environment because it is
 
188
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
189
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
190
      </citerefentry> file.
207
191
    </para>
208
192
  </refsect1>
209
193
  
221
205
    <title>OPTIONS</title>
222
206
    <para>
223
207
      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.
 
208
      is normally started by the <application>Mandos</application>
 
209
      plugin runner, see <citerefentry><refentrytitle
 
210
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
 
211
      </citerefentry>.  Any command line options this program accepts
 
212
      are therefore normally provided by the plugin runner, and not
 
213
      directly.
228
214
    </para>
229
215
    
230
216
    <variablelist>
321
307
      </varlistentry>
322
308
      
323
309
      <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
310
        <term><option>--priority=<replaceable
353
311
        >STRING</replaceable></option></term>
354
312
        <listitem>
364
322
          <para>
365
323
            Sets the number of bits to use for the prime number in the
366
324
            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.
 
325
            selected automatically based on the OpenPGP key.  Note
 
326
            that if the <option>--dh-params</option> option is used,
 
327
            the values from that file will be used instead.
371
328
          </para>
372
329
        </listitem>
373
330
      </varlistentry>
481
438
    <title>OVERVIEW</title>
482
439
    <xi:include href="../overview.xml"/>
483
440
    <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.
 
441
      This program is the client part.  It is a plugin started by
 
442
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
443
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
444
      an initial <acronym>RAM</acronym> disk environment.
509
445
    </para>
510
446
    <para>
511
447
      This program could, theoretically, be used as a keyscript in
512
448
      <filename>/etc/crypttab</filename>, but it would then be
513
449
      impossible to enter a password for the encrypted root disk at
514
450
      the console, since this program does not read from the console
515
 
      at all.
 
451
      at all.  This is why a separate plugin runner (<citerefentry>
 
452
      <refentrytitle>plugin-runner</refentrytitle>
 
453
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
 
454
      both this program and others in in parallel,
 
455
      <emphasis>one</emphasis> of which (<citerefentry>
 
456
      <refentrytitle>password-prompt</refentrytitle>
 
457
      <manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
 
458
      passwords on the system console.
516
459
    </para>
517
460
  </refsect1>
518
461
  
538
481
          <para>
539
482
            This environment variable will be assumed to contain the
540
483
            directory containing any helper executables.  The use and
541
 
            nature of these helper executables, if any, is purposely
542
 
            not documented.
 
484
            nature of these helper executables, if any, is
 
485
            purposefully not documented.
543
486
        </para>
544
487
        </listitem>
545
488
      </varlistentry>
739
682
        </listitem>
740
683
      </varlistentry>
741
684
      <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
685
        <term><filename
757
686
        class="directory">/lib/mandos/network-hooks.d</filename></term>
758
687
        <listitem>
775
704
    <title>EXAMPLE</title>
776
705
    <para>
777
706
      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"/>.
 
707
      directly, but via options for the Mandos <citerefentry
 
708
      ><refentrytitle>plugin-runner</refentrytitle>
 
709
      <manvolnum>8mandos</manvolnum></citerefentry>.
780
710
    </para>
781
711
    <informalexample>
782
712
      <para>
799
729
    </informalexample>
800
730
    <informalexample>
801
731
      <para>
802
 
        Run in debug mode, and use custom keys:
 
732
        Run in debug mode, and use a custom key:
803
733
      </para>
804
734
      <para>
805
735
 
806
736
<!-- 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>
 
737
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
808
738
 
809
739
      </para>
810
740
    </informalexample>
811
741
    <informalexample>
812
742
      <para>
813
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
743
        Run in debug mode, with a custom key, and do not use Zeroconf
814
744
        to locate a server; connect directly to the IPv6 link-local
815
745
        address <quote><systemitem class="ipaddress"
816
746
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
819
749
      <para>
820
750
 
821
751
<!-- 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>
 
752
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
823
753
 
824
754
      </para>
825
755
    </informalexample>
828
758
  <refsect1 id="security">
829
759
    <title>SECURITY</title>
830
760
    <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.
 
761
      This program is set-uid to root, but will switch back to the
 
762
      original (and presumably non-privileged) user and group after
 
763
      bringing up the network interface.
834
764
    </para>
835
765
    <para>
836
766
      To use this program for its intended purpose (see <xref
849
779
    <para>
850
780
      The only remaining weak point is that someone with physical
851
781
      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
 
782
      computer, read the OpenPGP keys directly from the hard drive,
 
783
      and communicate with the server.  To safeguard against this, the
 
784
      server is supposed to notice the client disappearing and stop
 
785
      giving out the encrypted data.  Therefore, it is important to
 
786
      set the timeout and checker interval values tightly on the
 
787
      server.  See <citerefentry><refentrytitle
858
788
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
859
789
    </para>
860
790
    <para>
884
814
      <manvolnum>5</manvolnum></citerefentry>,
885
815
      <citerefentry><refentrytitle>mandos</refentrytitle>
886
816
      <manvolnum>8</manvolnum></citerefentry>,
887
 
      <citerefentry><refentrytitle>password-agent</refentrytitle>
 
817
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
888
818
      <manvolnum>8mandos</manvolnum></citerefentry>,
889
819
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
890
820
      <manvolnum>8mandos</manvolnum></citerefentry>
903
833
      </varlistentry>
904
834
      <varlistentry>
905
835
        <term>
906
 
          <ulink url="https://www.avahi.org/">Avahi</ulink>
 
836
          <ulink url="http://www.avahi.org/">Avahi</ulink>
907
837
        </term>
908
838
      <listitem>
909
839
        <para>
920
850
        <para>
921
851
          GnuTLS is the library this client uses to implement TLS for
922
852
          communicating securely with the server, and at the same time
923
 
          send the public key to the server.
 
853
          send the public OpenPGP key to the server.
924
854
        </para>
925
855
      </listitem>
926
856
      </varlistentry>
992
922
      </varlistentry>
993
923
      <varlistentry>
994
924
        <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
925
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
1010
926
          Security</citetitle>
1011
927
        </term>
1012
928
      <listitem>
1013
929
        <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.
 
930
          This is implemented by GnuTLS and used by this program so
 
931
          that OpenPGP keys can be used.
1017
932
        </para>
1018
933
      </listitem>
1019
934
      </varlistentry>