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
- browse files at revision 904
- compare with another revision
- download diff
- download tarball
- view history from revision 904
- Committer: Teddy Hogeborn
- Date: 2017-08-20 14:08:59 UTC
- Revision ID: teddy@recompile.se-20170820140859-6niaa0ebf6bdovfn
Use || instead of -o in shell scripts.
* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -
* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -
- files added:
- bugs.xml
- debian/upstream
- plugin-helpers
- files modified:
- .bzrignore
added
removed
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 "2017-02-23">
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>
37
44
<holder>Teddy Hogeborn</holder>
38
45
<holder>Björn Påhlsson</holder>
39
46
</copyright>
64
71
><replaceable>PORT</replaceable></option></arg>
65
72
</group>
66
73
<sbr/>
67
<group>
74
<group rep='repeat'>
68
75
<arg choice="plain"><option>--interface
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
76
<replaceable>NAME</replaceable><arg rep='repeat'
77
>,<replaceable>NAME</replaceable></arg></option></arg>
78
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
79
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
80
></option></arg>
72
81
</group>
73
82
<sbr/>
74
83
<group>
94
103
</arg>
95
104
<sbr/>
96
105
<arg>
106
<option>--dh-params <replaceable>FILE</replaceable></option>
107
</arg>
108
<sbr/>
109
<arg>
97
110
<option>--delay <replaceable>SECONDS</replaceable></option>
98
111
</arg>
99
112
<sbr/>
137
150
communicates with <citerefentry><refentrytitle
138
151
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
152
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
153
brings up network interfaces, uses the interfaces’ IPv6
154
link-local addresses to get network connectivity, uses Zeroconf
155
to find servers on the local network, and communicates with
156
servers using TLS with an OpenPGP key to ensure authenticity and
144
157
confidentiality. This client program keeps running, trying all
145
158
servers on the network, until it receives a satisfactory reply
146
159
or a TERM signal. After all servers have been tried, all
148
161
will wait indefinitely for new servers to appear.
149
162
</para>
150
163
<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
164
The network interfaces are selected like this: If any interfaces
165
are specified using the <option>--interface</option> option,
166
those interface are used. Otherwise,
167
<command>&COMMANDNAME;</command> will use all interfaces that
168
are not loopback interfaces, are not point-to-point interfaces,
169
are capable of broadcasting and do not have the NOARP flag (see
157
170
<citerefentry><refentrytitle>netdevice</refentrytitle>
158
171
<manvolnum>7</manvolnum></citerefentry>). (If the
159
172
<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).
173
interfaces and non-broadcast interfaces are accepted.) If any
174
used interfaces are not up and running, they are first taken up
175
(and later taken down again on program exit).
165
176
</para>
166
177
<para>
167
Before a network interface is selected, all <quote>network
178
Before network interfaces are selected, all <quote>network
168
179
hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
180
</para>
170
181
<para>
218
229
assumed to separate the address from the port number.
219
230
</para>
220
231
<para>
221
This option is normally only useful for testing and
222
debugging.
232
Normally, Zeroconf would be used to locate Mandos servers,
233
in which case this option would only be used when testing
234
and debugging.
223
235
</para>
224
236
</listitem>
225
237
</varlistentry>
226
238
227
239
<varlistentry>
228
240
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
241
>NAME</replaceable><arg rep='repeat'>,<replaceable
242
>NAME</replaceable></arg></option></term>
230
243
<term><option>-i
231
<replaceable>NAME</replaceable></option></term>
244
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
245
>NAME</replaceable></arg></option></term>
232
246
<listitem>
233
247
<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.
248
Comma separated list of network interfaces that will be
249
brought up and scanned for Mandos servers to connect to.
250
The default is the empty string, which will automatically
251
use all appropriate interfaces.
238
252
</para>
239
253
<para>
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
242
given.
254
If the <option>--connect</option> option is used, and
255
exactly one interface name is specified (except
256
<quote><literal>none</literal></quote>), this specifies
257
the interface to use to connect to the address given.
243
258
</para>
244
259
<para>
245
260
Note that since this program will normally run in the
246
261
initial RAM disk environment, the interface must be an
247
262
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"/>.
263
can normally not be a pseudo-interface such as
264
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
265
will not exist until much later in the boot process, and
266
can not be used by this program, unless created by a
267
<quote>network hook</quote> — see <xref
268
linkend="network-hooks"/>.
253
269
</para>
254
270
<para>
255
271
<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.
272
<quote><literal>none</literal></quote>; this will make
273
<command>&COMMANDNAME;</command> only bring up interfaces
274
specified <emphasis>before</emphasis> this string. This
275
is not recommended, and only meant for advanced users.
260
276
</para>
261
277
</listitem>
262
278
</varlistentry>
304
320
<listitem>
305
321
<para>
306
322
Sets the number of bits to use for the prime number in the
307
TLS Diffie-Hellman key exchange. Default is 1024.
323
TLS Diffie-Hellman key exchange. The default value is
324
selected automatically based on the OpenPGP key. Note
325
that if the <option>--dh-params</option> option is used,
326
the values from that file will be used instead.
327
</para>
328
</listitem>
329
</varlistentry>
330
331
<varlistentry>
332
<term><option>--dh-params=<replaceable
333
>FILE</replaceable></option></term>
334
<listitem>
335
<para>
336
Specifies a PEM-encoded PKCS#3 file to read the parameters
337
needed by the TLS Diffie-Hellman key exchange from. If
338
this option is not given, or if the file for some reason
339
could not be used, the parameters will be generated on
340
startup, which will take some time and processing power.
341
Those using servers running under time, power or processor
342
constraints may want to generate such a file in advance
343
and use this option.
308
344
</para>
309
345
</listitem>
310
346
</varlistentry>
314
350
>SECONDS</replaceable></option></term>
315
351
<listitem>
316
352
<para>
317
After bringing the network interface up, the program waits
353
After bringing a network interface up, the program waits
318
354
for the interface to arrive in a <quote>running</quote>
319
355
state before proceeding. During this time, the kernel log
320
356
level will be lowered to reduce clutter on the system
437
473
438
474
<refsect1 id="environment">
439
475
<title>ENVIRONMENT</title>
476
<variablelist>
477
<varlistentry>
478
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
479
<listitem>
480
<para>
481
This environment variable will be assumed to contain the
482
directory containing any helper executables. The use and
483
nature of these helper executables, if any, is
484
purposefully not documented.
485
</para>
486
</listitem>
487
</varlistentry>
488
</variablelist>
440
489
<para>
441
This program does not use any environment variables, not even
442
the ones provided by <citerefentry><refentrytitle
490
This program does not use any other environment variables, not
491
even the ones provided by <citerefentry><refentrytitle
443
492
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
493
</citerefentry>.
445
494
</para>
468
517
<para>
469
518
A network hook must be an executable file, and its name must
470
519
consist entirely of upper and lower case letters, digits,
471
underscores, and hyphens.
520
underscores, periods, and hyphens.
472
521
</para>
473
522
<para>
474
523
A network hook will receive one argument, which can be one of
497
546
<term><literal>files</literal></term>
498
547
<listitem>
499
548
<para>
500
This should make the network hook print, <emphasis>on
501
separate lines</emphasis>, all the files needed for it
502
to run. (These files will be copied into the initial
503
RAM filesystem.) Intended use is for a network hook
504
which is a shell script to print its needed binaries.
549
This should make the network hook print, <emphasis>one
550
file per line</emphasis>, all the files needed for it to
551
run. (These files will be copied into the initial RAM
552
filesystem.) Typical use is for a network hook which is
553
a shell script to print its needed binaries.
505
554
</para>
506
555
<para>
507
556
It is not necessary to print any non-executable files
508
557
already in the network hook directory, these will be
509
558
copied implicitly if they otherwise satisfy the name
510
requirement.
559
requirements.
560
</para>
561
</listitem>
562
</varlistentry>
563
<varlistentry>
564
<term><literal>modules</literal></term>
565
<listitem>
566
<para>
567
This should make the network hook print, <emphasis>on
568
separate lines</emphasis>, all the kernel modules needed
569
for it to run. (These modules will be copied into the
570
initial RAM filesystem.) For instance, a tunnel
571
interface needs the
572
<quote><literal>tun</literal></quote> module.
511
573
</para>
512
574
</listitem>
513
575
</varlistentry>
525
587
<command>&COMMANDNAME;</command> by the
526
588
<option>--network-hook-dir</option> option. Note: this
527
589
should <emphasis>always</emphasis> be used by the
528
network hook to refer to itself or any files it may
529
require.
590
network hook to refer to itself or any files in the hook
591
directory it may require.
530
592
</para>
531
593
</listitem>
532
594
</varlistentry>
534
596
<term><envar>DEVICE</envar></term>
535
597
<listitem>
536
598
<para>
537
The network interface, as specified to
599
The network interfaces, as specified to
538
600
<command>&COMMANDNAME;</command> by the
539
<option>--interface</option> option. If this is not the
540
interface a hook will bring up, there is no reason for a
541
hook to continue.
601
<option>--interface</option> option, combined to one
602
string and separated by commas. If this is set, and
603
does not contain the interface a hook will bring up,
604
there is no reason for a hook to continue.
542
605
</para>
543
606
</listitem>
544
607
</varlistentry>
548
611
<para>
549
612
This will be the same as the first argument;
550
613
i.e. <quote><literal>start</literal></quote>,
551
<quote><literal>stop</literal></quote>, or
552
<quote><literal>files</literal></quote>.
614
<quote><literal>stop</literal></quote>,
615
<quote><literal>files</literal></quote>, or
616
<quote><literal>modules</literal></quote>.
553
617
</para>
554
618
</listitem>
555
619
</varlistentry>
569
633
<listitem>
570
634
<para>
571
635
This will be the same as the <option>--delay</option>
572
option passed to <command>&COMMANDNAME;</command>.
636
option passed to <command>&COMMANDNAME;</command>. Is
637
only set if <envar>MODE</envar> is
638
<quote><literal>start</literal></quote> or
639
<quote><literal>stop</literal></quote>.
640
</para>
641
</listitem>
642
</varlistentry>
643
<varlistentry>
644
<term><envar>CONNECT</envar></term>
645
<listitem>
646
<para>
647
This will be the same as the <option>--connect</option>
648
option passed to <command>&COMMANDNAME;</command>. Is
649
only set if <option>--connect</option> is passed and
650
<envar>MODE</envar> is
651
<quote><literal>start</literal></quote> or
652
<quote><literal>stop</literal></quote>.
573
653
</para>
574
654
</listitem>
575
655
</varlistentry>
614
694
</variablelist>
615
695
</refsect1>
616
696
617
<!-- <refsect1 id="bugs"> -->
618
<!-- <title>BUGS</title> -->
619
<!-- <para> -->
620
<!-- </para> -->
621
<!-- </refsect1> -->
697
<refsect1 id="bugs">
698
<title>BUGS</title>
699
<xi:include href="../bugs.xml"/>
700
</refsect1>
622
701
623
702
<refsect1 id="example">
624
703
<title>EXAMPLE</title>
630
709
</para>
631
710
<informalexample>
632
711
<para>
633
Normal invocation needs no options, if the network interface
634
is <quote>eth0</quote>:
712
Normal invocation needs no options, if the network interfaces
713
can be automatically determined:
635
714
</para>
636
715
<para>
637
716
<userinput>&COMMANDNAME;</userinput>
639
718
</informalexample>
640
719
<informalexample>
641
720
<para>
642
Search for Mandos servers (and connect to them) using another
643
interface:
721
Search for Mandos servers (and connect to them) using one
722
specific interface:
644
723
</para>
645
724
<para>
646
725
<!-- do not wrap this line -->
710
789
<para>
711
790
It will also help if the checker program on the server is
712
791
configured to request something from the client which can not be
713
spoofed by someone else on the network, unlike unencrypted
714
<acronym>ICMP</acronym> echo (<quote>ping</quote>) replies.
792
spoofed by someone else on the network, like SSH server key
793
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
794
echo (<quote>ping</quote>) replies.
715
795
</para>
716
796
<para>
717
797
<emphasis>Note</emphasis>: This makes it completely insecure to
763
843
</varlistentry>
764
844
<varlistentry>
765
845
<term>
766
<ulink url="http://www.gnu.org/software/gnutls/"
767
>GnuTLS</ulink>
846
<ulink url="https://www.gnutls.org/">GnuTLS</ulink>
768
847
</term>
769
848
<listitem>
770
849
<para>
776
855
</varlistentry>
777
856
<varlistentry>
778
857
<term>
779
<ulink url="http://www.gnupg.org/related_software/gpgme/"
858
<ulink url="https://www.gnupg.org/related_software/gpgme/"
780
859
>GPGME</ulink>
781
860
</term>
782
861
<listitem>
810
889
<para>
811
890
This client uses IPv6 link-local addresses, which are
812
891
immediately usable since a link-local addresses is
813
automatically assigned to a network interfaces when it
892
automatically assigned to a network interface when it
814
893
is brought up.
815
894
</para>
816
895
</listitem>
820
899
</varlistentry>
821
900
<varlistentry>
822
901
<term>
823
RFC 4346: <citetitle>The Transport Layer Security (TLS)
824
Protocol Version 1.1</citetitle>
902
RFC 5246: <citetitle>The Transport Layer Security (TLS)
903
Protocol Version 1.2</citetitle>
825
904
</term>
826
905
<listitem>
827
906
<para>
828
TLS 1.1 is the protocol implemented by GnuTLS.
907
TLS 1.2 is the protocol implemented by GnuTLS.
829
908
</para>
830
909
</listitem>
831
910
</varlistentry>
842
921
</varlistentry>
843
922
<varlistentry>
844
923
<term>
845
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
924
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
846
925
Security</citetitle>
847
926
</term>
848
927
<listitem>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0