/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: 2019-02-09 23:34:15 UTC
  • Revision ID: teddy@recompile.se-20190209233415-m1ntebuepwna1xg1
Doc fix: Change some "/etc/mandos" to "/etc/keys/mandos"

* clients.conf: Change "/etc/mandos" to "/etc/keys/mandos" where
                appropriate
* mandos-keygen.xml: - '' -

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 "2011-11-27">
 
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
36
37
      <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>
37
45
      <holder>Teddy Hogeborn</holder>
38
46
      <holder>Björn Påhlsson</holder>
39
47
    </copyright>
64
72
        ><replaceable>PORT</replaceable></option></arg>
65
73
      </group>
66
74
      <sbr/>
67
 
      <group>
 
75
      <group rep='repeat'>
68
76
        <arg choice="plain"><option>--interface
69
 
        <replaceable>NAME</replaceable></option></arg>
70
 
        <arg choice="plain"><option>-i
71
 
        <replaceable>NAME</replaceable></option></arg>
 
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>
72
82
      </group>
73
83
      <sbr/>
74
84
      <group>
85
95
        <replaceable>FILE</replaceable></option></arg>
86
96
      </group>
87
97
      <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/>
88
112
      <arg>
89
113
        <option>--priority <replaceable>STRING</replaceable></option>
90
114
      </arg>
94
118
      </arg>
95
119
      <sbr/>
96
120
      <arg>
 
121
        <option>--dh-params <replaceable>FILE</replaceable></option>
 
122
      </arg>
 
123
      <sbr/>
 
124
      <arg>
97
125
        <option>--delay <replaceable>SECONDS</replaceable></option>
98
126
      </arg>
99
127
      <sbr/>
137
165
      communicates with <citerefentry><refentrytitle
138
166
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
167
      to get a password.  In slightly more detail, this client program
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
 
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
147
175
      servers are periodically retried.  If no servers are found it
148
176
      will wait indefinitely for new servers to appear.
149
177
    </para>
150
178
    <para>
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
 
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
157
185
      <citerefentry><refentrytitle>netdevice</refentrytitle>
158
186
      <manvolnum>7</manvolnum></citerefentry>).  (If the
159
187
      <option>--connect</option> option is used, point-to-point
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).
 
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).
165
191
    </para>
166
192
    <para>
167
 
      Before a network interface is selected, all <quote>network
 
193
      Before network interfaces are selected, all <quote>network
168
194
      hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
195
    </para>
170
196
    <para>
218
244
            assumed to separate the address from the port number.
219
245
          </para>
220
246
          <para>
221
 
            This option is normally only useful for testing and
222
 
            debugging.
 
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.
223
250
          </para>
224
251
        </listitem>
225
252
      </varlistentry>
226
253
      
227
254
      <varlistentry>
228
255
        <term><option>--interface=<replaceable
229
 
        >NAME</replaceable></option></term>
 
256
        >NAME</replaceable><arg rep='repeat'>,<replaceable
 
257
        >NAME</replaceable></arg></option></term>
230
258
        <term><option>-i
231
 
        <replaceable>NAME</replaceable></option></term>
 
259
        <replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
 
260
        >NAME</replaceable></arg></option></term>
232
261
        <listitem>
233
262
          <para>
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.
 
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.
238
267
          </para>
239
268
          <para>
240
 
            If the <option>--connect</option> option is used, this
241
 
            specifies the interface to use to connect to the address
242
 
            given.
 
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.
243
273
          </para>
244
274
          <para>
245
275
            Note that since this program will normally run in the
246
276
            initial RAM disk environment, the interface must be an
247
277
            interface which exists at that stage.  Thus, the interface
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"/>.
 
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"/>.
253
284
          </para>
254
285
          <para>
255
286
            <replaceable>NAME</replaceable> can be the string
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.
 
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.
260
291
          </para>
261
292
        </listitem>
262
293
      </varlistentry>
290
321
      </varlistentry>
291
322
      
292
323
      <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>
293
352
        <term><option>--priority=<replaceable
294
353
        >STRING</replaceable></option></term>
295
354
        <listitem>
304
363
        <listitem>
305
364
          <para>
306
365
            Sets the number of bits to use for the prime number in the
307
 
            TLS Diffie-Hellman key exchange.  Default is 1024.
 
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.
308
388
          </para>
309
389
        </listitem>
310
390
      </varlistentry>
314
394
        >SECONDS</replaceable></option></term>
315
395
        <listitem>
316
396
          <para>
317
 
            After bringing the network interface up, the program waits
 
397
            After bringing a network interface up, the program waits
318
398
            for the interface to arrive in a <quote>running</quote>
319
399
            state before proceeding.  During this time, the kernel log
320
400
            level will be lowered to reduce clutter on the system
437
517
  
438
518
  <refsect1 id="environment">
439
519
    <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>
440
533
    <para>
441
 
      This program does not use any environment variables, not even
442
 
      the ones provided by <citerefentry><refentrytitle
 
534
      This program does not use any other environment variables, not
 
535
      even the ones provided by <citerefentry><refentrytitle
443
536
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
537
    </citerefentry>.
445
538
    </para>
507
600
              It is not necessary to print any non-executable files
508
601
              already in the network hook directory, these will be
509
602
              copied implicitly if they otherwise satisfy the name
510
 
              requirement.
 
603
              requirements.
511
604
            </para>
512
605
          </listitem>
513
606
        </varlistentry>
547
640
          <term><envar>DEVICE</envar></term>
548
641
          <listitem>
549
642
            <para>
550
 
              The network interface, as specified to
 
643
              The network interfaces, as specified to
551
644
              <command>&COMMANDNAME;</command> by the
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.
 
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.
555
649
            </para>
556
650
          </listitem>
557
651
        </varlistentry>
631
725
        </listitem>
632
726
      </varlistentry>
633
727
      <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>
634
742
        <term><filename
635
743
        class="directory">/lib/mandos/network-hooks.d</filename></term>
636
744
        <listitem>
644
752
    </variablelist>
645
753
  </refsect1>
646
754
  
647
 
<!--   <refsect1 id="bugs"> -->
648
 
<!--     <title>BUGS</title> -->
649
 
<!--     <para> -->
650
 
<!--     </para> -->
651
 
<!--   </refsect1> -->
 
755
  <refsect1 id="bugs">
 
756
    <title>BUGS</title>
 
757
    <xi:include href="../bugs.xml"/>
 
758
  </refsect1>
652
759
  
653
760
  <refsect1 id="example">
654
761
    <title>EXAMPLE</title>
660
767
    </para>
661
768
    <informalexample>
662
769
      <para>
663
 
        Normal invocation needs no options, if the network interface
664
 
        is <quote>eth0</quote>:
 
770
        Normal invocation needs no options, if the network interfaces
 
771
        can be automatically determined:
665
772
      </para>
666
773
      <para>
667
774
        <userinput>&COMMANDNAME;</userinput>
669
776
    </informalexample>
670
777
    <informalexample>
671
778
      <para>
672
 
        Search for Mandos servers (and connect to them) using another
673
 
        interface:
 
779
        Search for Mandos servers (and connect to them) using one
 
780
        specific interface:
674
781
      </para>
675
782
      <para>
676
783
        <!-- do not wrap this line -->
679
786
    </informalexample>
680
787
    <informalexample>
681
788
      <para>
682
 
        Run in debug mode, and use a custom key:
 
789
        Run in debug mode, and use custom keys:
683
790
      </para>
684
791
      <para>
685
792
 
686
793
<!-- do not wrap this line -->
687
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
 
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>
688
795
 
689
796
      </para>
690
797
    </informalexample>
691
798
    <informalexample>
692
799
      <para>
693
 
        Run in debug mode, with a custom key, and do not use Zeroconf
 
800
        Run in debug mode, with custom keys, and do not use Zeroconf
694
801
        to locate a server; connect directly to the IPv6 link-local
695
802
        address <quote><systemitem class="ipaddress"
696
803
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
699
806
      <para>
700
807
 
701
808
<!-- do not wrap this line -->
702
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
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>
703
810
 
704
811
      </para>
705
812
    </informalexample>
729
836
    <para>
730
837
      The only remaining weak point is that someone with physical
731
838
      access to the client hard drive might turn off the client
732
 
      computer, read the OpenPGP keys directly from the hard drive,
733
 
      and communicate with the server.  To safeguard against this, the
734
 
      server is supposed to notice the client disappearing and stop
735
 
      giving out the encrypted data.  Therefore, it is important to
736
 
      set the timeout and checker interval values tightly on the
737
 
      server.  See <citerefentry><refentrytitle
 
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
738
845
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
739
846
    </para>
740
847
    <para>
741
848
      It will also help if the checker program on the server is
742
849
      configured to request something from the client which can not be
743
 
      spoofed by someone else on the network, unlike unencrypted
744
 
      <acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
 
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.
745
853
    </para>
746
854
    <para>
747
855
      <emphasis>Note</emphasis>: This makes it completely insecure to
793
901
      </varlistentry>
794
902
      <varlistentry>
795
903
        <term>
796
 
          <ulink url="http://www.gnu.org/software/gnutls/"
797
 
          >GnuTLS</ulink>
 
904
          <ulink url="https://www.gnutls.org/">GnuTLS</ulink>
798
905
        </term>
799
906
      <listitem>
800
907
        <para>
801
908
          GnuTLS is the library this client uses to implement TLS for
802
909
          communicating securely with the server, and at the same time
803
 
          send the public OpenPGP key to the server.
 
910
          send the public key to the server.
804
911
        </para>
805
912
      </listitem>
806
913
      </varlistentry>
807
914
      <varlistentry>
808
915
        <term>
809
 
          <ulink url="http://www.gnupg.org/related_software/gpgme/"
 
916
          <ulink url="https://www.gnupg.org/related_software/gpgme/"
810
917
                 >GPGME</ulink>
811
918
        </term>
812
919
        <listitem>
840
947
              <para>
841
948
                This client uses IPv6 link-local addresses, which are
842
949
                immediately usable since a link-local addresses is
843
 
                automatically assigned to a network interfaces when it
 
950
                automatically assigned to a network interface when it
844
951
                is brought up.
845
952
              </para>
846
953
            </listitem>
850
957
      </varlistentry>
851
958
      <varlistentry>
852
959
        <term>
853
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
854
 
          Protocol Version 1.1</citetitle>
 
960
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
961
          Protocol Version 1.2</citetitle>
855
962
        </term>
856
963
      <listitem>
857
964
        <para>
858
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
965
          TLS 1.2 is the protocol implemented by GnuTLS.
859
966
        </para>
860
967
      </listitem>
861
968
      </varlistentry>
872
979
      </varlistentry>
873
980
      <varlistentry>
874
981
        <term>
875
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
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
876
997
          Security</citetitle>
877
998
        </term>
878
999
      <listitem>
879
1000
        <para>
880
 
          This is implemented by GnuTLS and used by this program so
881
 
          that OpenPGP keys can be used.
 
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.
882
1004
        </para>
883
1005
      </listitem>
884
1006
      </varlistentry>