/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

* network-hooks.d/bridge: Bug fix - use the found brctl.

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