/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

* initramfs-tools-hook: Set DEVICE for network hooks.

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 "2019-02-09">
 
5
<!ENTITY TIMESTAMP "2011-11-27">
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
36
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
37
      <holder>Teddy Hogeborn</holder>
46
38
      <holder>Björn Påhlsson</holder>
47
39
    </copyright>
72
64
        ><replaceable>PORT</replaceable></option></arg>
73
65
      </group>
74
66
      <sbr/>
75
 
      <group rep='repeat'>
 
67
      <group>
76
68
        <arg choice="plain"><option>--interface
77
 
        <replaceable>NAME</replaceable><arg rep='repeat'
78
 
        >,<replaceable>NAME</replaceable></arg></option></arg>
79
 
        <arg choice="plain"><option>-i <replaceable>NAME</replaceable
80
 
        ><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
81
 
        ></option></arg>
 
69
        <replaceable>NAME</replaceable></option></arg>
 
70
        <arg choice="plain"><option>-i
 
71
        <replaceable>NAME</replaceable></option></arg>
82
72
      </group>
83
73
      <sbr/>
84
74
      <group>
95
85
        <replaceable>FILE</replaceable></option></arg>
96
86
      </group>
97
87
      <sbr/>
98
 
      <group>
99
 
        <arg choice="plain"><option>--tls-privkey
100
 
        <replaceable>FILE</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-t
102
 
        <replaceable>FILE</replaceable></option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group>
106
 
        <arg choice="plain"><option>--tls-pubkey
107
 
        <replaceable>FILE</replaceable></option></arg>
108
 
        <arg choice="plain"><option>-T
109
 
        <replaceable>FILE</replaceable></option></arg>
110
 
      </group>
111
 
      <sbr/>
112
88
      <arg>
113
89
        <option>--priority <replaceable>STRING</replaceable></option>
114
90
      </arg>
118
94
      </arg>
119
95
      <sbr/>
120
96
      <arg>
121
 
        <option>--dh-params <replaceable>FILE</replaceable></option>
122
 
      </arg>
123
 
      <sbr/>
124
 
      <arg>
125
97
        <option>--delay <replaceable>SECONDS</replaceable></option>
126
98
      </arg>
127
99
      <sbr/>
165
137
      communicates with <citerefentry><refentrytitle
166
138
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
167
139
      to get a password.  In slightly more detail, this client program
168
 
      brings up network interfaces, uses the interfaces’ IPv6
169
 
      link-local addresses to get network connectivity, uses Zeroconf
170
 
      to find servers on the local network, and communicates with
171
 
      servers using TLS with a raw public key to ensure authenticity
172
 
      and confidentiality.  This client program keeps running, trying
173
 
      all servers on the network, until it receives a satisfactory
174
 
      reply or a TERM signal.  After all servers have been tried, all
 
140
      brings up a network interface, uses the interface’s IPv6
 
141
      link-local address to get network connectivity, uses Zeroconf to
 
142
      find servers on the local network, and communicates with servers
 
143
      using TLS with an OpenPGP key to ensure authenticity and
 
144
      confidentiality.  This client program keeps running, trying all
 
145
      servers on the network, until it receives a satisfactory reply
 
146
      or a TERM signal.  After all servers have been tried, all
175
147
      servers are periodically retried.  If no servers are found it
176
148
      will wait indefinitely for new servers to appear.
177
149
    </para>
178
150
    <para>
179
 
      The network interfaces are selected like this: If any interfaces
180
 
      are specified using the <option>--interface</option> option,
181
 
      those interface are used.  Otherwise,
182
 
      <command>&COMMANDNAME;</command> will use all interfaces that
183
 
      are not loopback interfaces, are not point-to-point interfaces,
184
 
      are capable of broadcasting and do not have the NOARP flag (see
 
151
      The network interface is selected like this: If an interface is
 
152
      specified using the <option>--interface</option> option, that
 
153
      interface is used.  Otherwise, <command>&COMMANDNAME;</command>
 
154
      will choose any interface that is up and running and is not a
 
155
      loopback interface, is not a point-to-point interface, is
 
156
      capable of broadcasting and does not have the NOARP flag (see
185
157
      <citerefentry><refentrytitle>netdevice</refentrytitle>
186
158
      <manvolnum>7</manvolnum></citerefentry>).  (If the
187
159
      <option>--connect</option> option is used, point-to-point
188
 
      interfaces and non-broadcast interfaces are accepted.)  If any
189
 
      used interfaces are not up and running, they are first taken up
190
 
      (and later taken down again on program exit).
 
160
      interfaces and non-broadcast interfaces are accepted.)  If no
 
161
      acceptable interfaces are found, re-run the check but without
 
162
      the <quote>up and running</quote> requirement, and manually take
 
163
      the selected interface up (and later take it down on program
 
164
      exit).
191
165
    </para>
192
166
    <para>
193
 
      Before network interfaces are selected, all <quote>network
 
167
      Before a network interface is selected, all <quote>network
194
168
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
195
169
    </para>
196
170
    <para>
244
218
            assumed to separate the address from the port number.
245
219
          </para>
246
220
          <para>
247
 
            Normally, Zeroconf would be used to locate Mandos servers,
248
 
            in which case this option would only be used when testing
249
 
            and debugging.
 
221
            This option is normally only useful for testing and
 
222
            debugging.
250
223
          </para>
251
224
        </listitem>
252
225
      </varlistentry>
253
226
      
254
227
      <varlistentry>
255
228
        <term><option>--interface=<replaceable
256
 
        >NAME</replaceable><arg rep='repeat'>,<replaceable
257
 
        >NAME</replaceable></arg></option></term>
 
229
        >NAME</replaceable></option></term>
258
230
        <term><option>-i
259
 
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
260
 
        >NAME</replaceable></arg></option></term>
 
231
        <replaceable>NAME</replaceable></option></term>
261
232
        <listitem>
262
233
          <para>
263
 
            Comma separated list of network interfaces that will be
264
 
            brought up and scanned for Mandos servers to connect to.
265
 
            The default is the empty string, which will automatically
266
 
            use all appropriate interfaces.
 
234
            Network interface that will be brought up and scanned for
 
235
            Mandos servers to connect to.  The default is the empty
 
236
            string, which will automatically choose an appropriate
 
237
            interface.
267
238
          </para>
268
239
          <para>
269
 
            If the <option>--connect</option> option is used, and
270
 
            exactly one interface name is specified (except
271
 
            <quote><literal>none</literal></quote>), this specifies
272
 
            the interface to use to connect to the address given.
 
240
            If the <option>--connect</option> option is used, this
 
241
            specifies the interface to use to connect to the address
 
242
            given.
273
243
          </para>
274
244
          <para>
275
245
            Note that since this program will normally run in the
276
246
            initial RAM disk environment, the interface must be an
277
247
            interface which exists at that stage.  Thus, the interface
278
 
            can normally not be a pseudo-interface such as
279
 
            <quote>br0</quote> or <quote>tun0</quote>; such interfaces
280
 
            will not exist until much later in the boot process, and
281
 
            can not be used by this program, unless created by a
282
 
            <quote>network hook</quote> — see <xref
283
 
            linkend="network-hooks"/>.
 
248
            can not be a pseudo-interface such as <quote>br0</quote>
 
249
            or <quote>tun0</quote>; such interfaces will not exist
 
250
            until much later in the boot process, and can not be used
 
251
            by this program, unless created by a <quote>network
 
252
            hook</quote> — see <xref linkend="network-hooks"/>.
284
253
          </para>
285
254
          <para>
286
255
            <replaceable>NAME</replaceable> can be the string
287
 
            <quote><literal>none</literal></quote>; this will make
288
 
            <command>&COMMANDNAME;</command> only bring up interfaces
289
 
            specified <emphasis>before</emphasis> this string.  This
290
 
            is not recommended, and only meant for advanced users.
 
256
            <quote><literal>none</literal></quote>; this will not use
 
257
            any specific interface, and will not bring up an interface
 
258
            on startup.  This is not recommended, and only meant for
 
259
            advanced users.
291
260
          </para>
292
261
        </listitem>
293
262
      </varlistentry>
321
290
      </varlistentry>
322
291
      
323
292
      <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
293
        <term><option>--priority=<replaceable
353
294
        >STRING</replaceable></option></term>
354
295
        <listitem>
363
304
        <listitem>
364
305
          <para>
365
306
            Sets the number of bits to use for the prime number in the
366
 
            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.
371
 
          </para>
372
 
        </listitem>
373
 
      </varlistentry>
374
 
      
375
 
      <varlistentry>
376
 
        <term><option>--dh-params=<replaceable
377
 
        >FILE</replaceable></option></term>
378
 
        <listitem>
379
 
          <para>
380
 
            Specifies a PEM-encoded PKCS#3 file to read the parameters
381
 
            needed by the TLS Diffie-Hellman key exchange from.  If
382
 
            this option is not given, or if the file for some reason
383
 
            could not be used, the parameters will be generated on
384
 
            startup, which will take some time and processing power.
385
 
            Those using servers running under time, power or processor
386
 
            constraints may want to generate such a file in advance
387
 
            and use this option.
 
307
            TLS Diffie-Hellman key exchange.  Default is 1024.
388
308
          </para>
389
309
        </listitem>
390
310
      </varlistentry>
394
314
        >SECONDS</replaceable></option></term>
395
315
        <listitem>
396
316
          <para>
397
 
            After bringing a network interface up, the program waits
 
317
            After bringing the network interface up, the program waits
398
318
            for the interface to arrive in a <quote>running</quote>
399
319
            state before proceeding.  During this time, the kernel log
400
320
            level will be lowered to reduce clutter on the system
517
437
  
518
438
  <refsect1 id="environment">
519
439
    <title>ENVIRONMENT</title>
520
 
    <variablelist>
521
 
      <varlistentry>
522
 
        <term><envar>MANDOSPLUGINHELPERDIR</envar></term>
523
 
        <listitem>
524
 
          <para>
525
 
            This environment variable will be assumed to contain the
526
 
            directory containing any helper executables.  The use and
527
 
            nature of these helper executables, if any, is
528
 
            purposefully not documented.
529
 
        </para>
530
 
        </listitem>
531
 
      </varlistentry>
532
 
    </variablelist>
533
440
    <para>
534
 
      This program does not use any other environment variables, not
535
 
      even the ones provided by <citerefentry><refentrytitle
 
441
      This program does not use any environment variables, not even
 
442
      the ones provided by <citerefentry><refentrytitle
536
443
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
537
444
    </citerefentry>.
538
445
    </para>
600
507
              It is not necessary to print any non-executable files
601
508
              already in the network hook directory, these will be
602
509
              copied implicitly if they otherwise satisfy the name
603
 
              requirements.
 
510
              requirement.
604
511
            </para>
605
512
          </listitem>
606
513
        </varlistentry>
640
547
          <term><envar>DEVICE</envar></term>
641
548
          <listitem>
642
549
            <para>
643
 
              The network interfaces, as specified to
 
550
              The network interface, as specified to
644
551
              <command>&COMMANDNAME;</command> by the
645
 
              <option>--interface</option> option, combined to one
646
 
              string and separated by commas.  If this is set, and
647
 
              does not contain the interface a hook will bring up,
648
 
              there is no reason for a hook to continue.
 
552
              <option>--interface</option> option.  If this is not the
 
553
              interface a hook will bring up, there is no reason for a
 
554
              hook to continue.
649
555
            </para>
650
556
          </listitem>
651
557
        </varlistentry>
677
583
          <listitem>
678
584
            <para>
679
585
              This will be the same as the <option>--delay</option>
680
 
              option passed to <command>&COMMANDNAME;</command>.  Is
681
 
              only set if <envar>MODE</envar> is
682
 
              <quote><literal>start</literal></quote> or
683
 
              <quote><literal>stop</literal></quote>.
684
 
            </para>
685
 
          </listitem>
686
 
        </varlistentry>
687
 
        <varlistentry>
688
 
          <term><envar>CONNECT</envar></term>
689
 
          <listitem>
690
 
            <para>
691
 
              This will be the same as the <option>--connect</option>
692
 
              option passed to <command>&COMMANDNAME;</command>.  Is
693
 
              only set if <option>--connect</option> is passed and
694
 
              <envar>MODE</envar> is
695
 
              <quote><literal>start</literal></quote> or
696
 
              <quote><literal>stop</literal></quote>.
 
586
              option passed to <command>&COMMANDNAME;</command>.
697
587
            </para>
698
588
          </listitem>
699
589
        </varlistentry>
725
615
        </listitem>
726
616
      </varlistentry>
727
617
      <varlistentry>
728
 
        <term><filename>/conf/conf.d/mandos/tls-pubkey.pem</filename
729
 
        ></term>
730
 
        <term><filename>/conf/conf.d/mandos/tls-privkey.pem</filename
731
 
        ></term>
732
 
        <listitem>
733
 
          <para>
734
 
            Public and private raw key files, in <quote>PEM</quote>
735
 
            format.  These are the default file names, they can be
736
 
            changed with the <option>--tls-pubkey</option> and
737
 
            <option>--tls-privkey</option> options.
738
 
          </para>
739
 
        </listitem>
740
 
      </varlistentry>
741
 
      <varlistentry>
742
618
        <term><filename
743
619
        class="directory">/lib/mandos/network-hooks.d</filename></term>
744
620
        <listitem>
752
628
    </variablelist>
753
629
  </refsect1>
754
630
  
755
 
  <refsect1 id="bugs">
756
 
    <title>BUGS</title>
757
 
    <xi:include href="../bugs.xml"/>
758
 
  </refsect1>
 
631
<!--   <refsect1 id="bugs"> -->
 
632
<!--     <title>BUGS</title> -->
 
633
<!--     <para> -->
 
634
<!--     </para> -->
 
635
<!--   </refsect1> -->
759
636
  
760
637
  <refsect1 id="example">
761
638
    <title>EXAMPLE</title>
767
644
    </para>
768
645
    <informalexample>
769
646
      <para>
770
 
        Normal invocation needs no options, if the network interfaces
771
 
        can be automatically determined:
 
647
        Normal invocation needs no options, if the network interface
 
648
        is <quote>eth0</quote>:
772
649
      </para>
773
650
      <para>
774
651
        <userinput>&COMMANDNAME;</userinput>
776
653
    </informalexample>
777
654
    <informalexample>
778
655
      <para>
779
 
        Search for Mandos servers (and connect to them) using one
780
 
        specific interface:
 
656
        Search for Mandos servers (and connect to them) using another
 
657
        interface:
781
658
      </para>
782
659
      <para>
783
660
        <!-- do not wrap this line -->
786
663
    </informalexample>
787
664
    <informalexample>
788
665
      <para>
789
 
        Run in debug mode, and use custom keys:
 
666
        Run in debug mode, and use a custom key:
790
667
      </para>
791
668
      <para>
792
669
 
793
670
<!-- do not wrap this line -->
794
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --tls-pubkey keydir/tls-pubkey.pem --tls-privkey keydir/tls-privkey.pem</userinput>
 
671
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
795
672
 
796
673
      </para>
797
674
    </informalexample>
798
675
    <informalexample>
799
676
      <para>
800
 
        Run in debug mode, with custom keys, and do not use Zeroconf
 
677
        Run in debug mode, with a custom key, and do not use Zeroconf
801
678
        to locate a server; connect directly to the IPv6 link-local
802
679
        address <quote><systemitem class="ipaddress"
803
680
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
806
683
      <para>
807
684
 
808
685
<!-- do not wrap this line -->
809
 
<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>
 
686
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
810
687
 
811
688
      </para>
812
689
    </informalexample>
836
713
    <para>
837
714
      The only remaining weak point is that someone with physical
838
715
      access to the client hard drive might turn off the client
839
 
      computer, read the OpenPGP and TLS keys directly from the hard
840
 
      drive, and communicate with the server.  To safeguard against
841
 
      this, the server is supposed to notice the client disappearing
842
 
      and stop giving out the encrypted data.  Therefore, it is
843
 
      important to set the timeout and checker interval values tightly
844
 
      on the server.  See <citerefentry><refentrytitle
 
716
      computer, read the OpenPGP keys directly from the hard drive,
 
717
      and communicate with the server.  To safeguard against this, the
 
718
      server is supposed to notice the client disappearing and stop
 
719
      giving out the encrypted data.  Therefore, it is important to
 
720
      set the timeout and checker interval values tightly on the
 
721
      server.  See <citerefentry><refentrytitle
845
722
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
846
723
    </para>
847
724
    <para>
848
725
      It will also help if the checker program on the server is
849
726
      configured to request something from the client which can not be
850
 
      spoofed by someone else on the network, like SSH server key
851
 
      fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
852
 
      echo (<quote>ping</quote>) replies.
 
727
      spoofed by someone else on the network, unlike unencrypted
 
728
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
853
729
    </para>
854
730
    <para>
855
731
      <emphasis>Note</emphasis>: This makes it completely insecure to
901
777
      </varlistentry>
902
778
      <varlistentry>
903
779
        <term>
904
 
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
 
780
          <ulink url="http://www.gnu.org/software/gnutls/"
 
781
          >GnuTLS</ulink>
905
782
        </term>
906
783
      <listitem>
907
784
        <para>
908
785
          GnuTLS is the library this client uses to implement TLS for
909
786
          communicating securely with the server, and at the same time
910
 
          send the public key to the server.
 
787
          send the public OpenPGP key to the server.
911
788
        </para>
912
789
      </listitem>
913
790
      </varlistentry>
914
791
      <varlistentry>
915
792
        <term>
916
 
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
 
793
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
917
794
                 >GPGME</ulink>
918
795
        </term>
919
796
        <listitem>
947
824
              <para>
948
825
                This client uses IPv6 link-local addresses, which are
949
826
                immediately usable since a link-local addresses is
950
 
                automatically assigned to a network interface when it
 
827
                automatically assigned to a network interfaces when it
951
828
                is brought up.
952
829
              </para>
953
830
            </listitem>
957
834
      </varlistentry>
958
835
      <varlistentry>
959
836
        <term>
960
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
961
 
          Protocol Version 1.2</citetitle>
 
837
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
838
          Protocol Version 1.1</citetitle>
962
839
        </term>
963
840
      <listitem>
964
841
        <para>
965
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
842
          TLS 1.1 is the protocol implemented by GnuTLS.
966
843
        </para>
967
844
      </listitem>
968
845
      </varlistentry>
979
856
      </varlistentry>
980
857
      <varlistentry>
981
858
        <term>
982
 
          RFC 7250: <citetitle>Using Raw Public Keys in Transport
983
 
          Layer Security (TLS) and Datagram Transport Layer Security
984
 
          (DTLS)</citetitle>
985
 
        </term>
986
 
      <listitem>
987
 
        <para>
988
 
          This is implemented by GnuTLS in version 3.6.6 and is, if
989
 
          present, used by this program so that raw public keys can be
990
 
          used.
991
 
        </para>
992
 
      </listitem>
993
 
      </varlistentry>
994
 
      <varlistentry>
995
 
        <term>
996
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
859
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
997
860
          Security</citetitle>
998
861
        </term>
999
862
      <listitem>
1000
863
        <para>
1001
 
          This is implemented by GnuTLS before version 3.6.0 and is,
1002
 
          if present, used by this program so that OpenPGP keys can be
1003
 
          used.
 
864
          This is implemented by GnuTLS and used by this program so
 
865
          that OpenPGP keys can be used.
1004
866
        </para>
1005
867
      </listitem>
1006
868
      </varlistentry>