To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to plugins.d/mandos-client.xml
- browse files at revision 334
- compare with another revision
- download diff
- download tarball
- view history from revision 334
- Committer: Teddy Hogeborn
- Date: 2016-02-29 21:28:39 UTC
- Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
- files added:
- debian/mandos-client.examples
- 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 "2016-02-28">
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>
37
43
<holder>Teddy Hogeborn</holder>
38
44
<holder>Björn Påhlsson</holder>
39
45
</copyright>
64
70
><replaceable>PORT</replaceable></option></arg>
65
71
</group>
66
72
<sbr/>
67
<group>
73
<group rep='repeat'>
68
74
<arg choice="plain"><option>--interface
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
75
<replaceable>NAME</replaceable><arg rep='repeat'
76
>,<replaceable>NAME</replaceable></arg></option></arg>
77
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
78
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
79
></option></arg>
72
80
</group>
73
81
<sbr/>
74
82
<group>
94
102
</arg>
95
103
<sbr/>
96
104
<arg>
105
<option>--dh-params <replaceable>FILE</replaceable></option>
106
</arg>
107
<sbr/>
108
<arg>
97
109
<option>--delay <replaceable>SECONDS</replaceable></option>
98
110
</arg>
99
111
<sbr/>
137
149
communicates with <citerefentry><refentrytitle
138
150
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
151
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
152
brings up network interfaces, uses the interfaces’ IPv6
153
link-local addresses to get network connectivity, uses Zeroconf
154
to find servers on the local network, and communicates with
155
servers using TLS with an OpenPGP key to ensure authenticity and
144
156
confidentiality. This client program keeps running, trying all
145
157
servers on the network, until it receives a satisfactory reply
146
158
or a TERM signal. After all servers have been tried, all
148
160
will wait indefinitely for new servers to appear.
149
161
</para>
150
162
<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
163
The network interfaces are selected like this: If any interfaces
164
are specified using the <option>--interface</option> option,
165
those interface are used. Otherwise,
166
<command>&COMMANDNAME;</command> will use all interfaces that
167
are not loopback interfaces, are not point-to-point interfaces,
168
are capable of broadcasting and do not have the NOARP flag (see
157
169
<citerefentry><refentrytitle>netdevice</refentrytitle>
158
170
<manvolnum>7</manvolnum></citerefentry>). (If the
159
171
<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).
172
interfaces and non-broadcast interfaces are accepted.) If any
173
used interfaces are not up and running, they are first taken up
174
(and later taken down again on program exit).
165
175
</para>
166
176
<para>
167
Before a network interface is selected, all <quote>network
177
Before network interfaces are selected, all <quote>network
168
178
hooks</quote> are run; see <xref linkend="network-hooks"/>.
169
179
</para>
170
180
<para>
218
228
assumed to separate the address from the port number.
219
229
</para>
220
230
<para>
221
This option is normally only useful for testing and
222
debugging.
231
Normally, Zeroconf would be used to locate Mandos servers,
232
in which case this option would only be used when testing
233
and debugging.
223
234
</para>
224
235
</listitem>
225
236
</varlistentry>
226
237
227
238
<varlistentry>
228
239
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
240
>NAME</replaceable><arg rep='repeat'>,<replaceable
241
>NAME</replaceable></arg></option></term>
230
242
<term><option>-i
231
<replaceable>NAME</replaceable></option></term>
243
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
244
>NAME</replaceable></arg></option></term>
232
245
<listitem>
233
246
<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.
247
Comma separated list of network interfaces that will be
248
brought up and scanned for Mandos servers to connect to.
249
The default is the empty string, which will automatically
250
use all appropriate interfaces.
238
251
</para>
239
252
<para>
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
242
given.
253
If the <option>--connect</option> option is used, and
254
exactly one interface name is specified (except
255
<quote><literal>none</literal></quote>), this specifies
256
the interface to use to connect to the address given.
243
257
</para>
244
258
<para>
245
259
Note that since this program will normally run in the
246
260
initial RAM disk environment, the interface must be an
247
261
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"/>.
262
can normally not be a pseudo-interface such as
263
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
264
will not exist until much later in the boot process, and
265
can not be used by this program, unless created by a
266
<quote>network hook</quote> — see <xref
267
linkend="network-hooks"/>.
253
268
</para>
254
269
<para>
255
270
<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.
271
<quote><literal>none</literal></quote>; this will make
272
<command>&COMMANDNAME;</command> only bring up interfaces
273
specified <emphasis>before</emphasis> this string. This
274
is not recommended, and only meant for advanced users.
260
275
</para>
261
276
</listitem>
262
277
</varlistentry>
304
319
<listitem>
305
320
<para>
306
321
Sets the number of bits to use for the prime number in the
307
TLS Diffie-Hellman key exchange. Default is 1024.
322
TLS Diffie-Hellman key exchange. The default value is
323
selected automatically based on the OpenPGP key. Note
324
that if the <option>--dh-params</option> option is used,
325
the values from that file will be used instead.
326
</para>
327
</listitem>
328
</varlistentry>
329
330
<varlistentry>
331
<term><option>--dh-params=<replaceable
332
>FILE</replaceable></option></term>
333
<listitem>
334
<para>
335
Specifies a PEM-encoded PKCS#3 file to read the parameters
336
needed by the TLS Diffie-Hellman key exchange from. If
337
this option is not given, or if the file for some reason
338
could not be used, the parameters will be generated on
339
startup, which will take some time and processing power.
340
Those using servers running under time, power or processor
341
constraints may want to generate such a file in advance
342
and use this option.
308
343
</para>
309
344
</listitem>
310
345
</varlistentry>
314
349
>SECONDS</replaceable></option></term>
315
350
<listitem>
316
351
<para>
317
After bringing the network interface up, the program waits
352
After bringing a network interface up, the program waits
318
353
for the interface to arrive in a <quote>running</quote>
319
354
state before proceeding. During this time, the kernel log
320
355
level will be lowered to reduce clutter on the system
437
472
438
473
<refsect1 id="environment">
439
474
<title>ENVIRONMENT</title>
475
<variablelist>
476
<varlistentry>
477
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
478
<listitem>
479
<para>
480
This environment variable will be assumed to contain the
481
directory containing any helper executables. The use and
482
nature of these helper executables, if any, is
483
purposefully not documented.
484
</para>
485
</listitem>
486
</varlistentry>
487
</variablelist>
440
488
<para>
441
This program does not use any environment variables, not even
442
the ones provided by <citerefentry><refentrytitle
489
This program does not use any other environment variables, not
490
even the ones provided by <citerefentry><refentrytitle
443
491
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
444
492
</citerefentry>.
445
493
</para>
468
516
<para>
469
517
A network hook must be an executable file, and its name must
470
518
consist entirely of upper and lower case letters, digits,
471
underscores, and hyphens.
519
underscores, periods, and hyphens.
472
520
</para>
473
521
<para>
474
522
A network hook will receive one argument, which can be one of
497
545
<term><literal>files</literal></term>
498
546
<listitem>
499
547
<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.
548
This should make the network hook print, <emphasis>one
549
file per line</emphasis>, all the files needed for it to
550
run. (These files will be copied into the initial RAM
551
filesystem.) Typical use is for a network hook which is
552
a shell script to print its needed binaries.
505
553
</para>
506
554
<para>
507
555
It is not necessary to print any non-executable files
508
556
already in the network hook directory, these will be
509
557
copied implicitly if they otherwise satisfy the name
510
requirement.
558
requirements.
559
</para>
560
</listitem>
561
</varlistentry>
562
<varlistentry>
563
<term><literal>modules</literal></term>
564
<listitem>
565
<para>
566
This should make the network hook print, <emphasis>on
567
separate lines</emphasis>, all the kernel modules needed
568
for it to run. (These modules will be copied into the
569
initial RAM filesystem.) For instance, a tunnel
570
interface needs the
571
<quote><literal>tun</literal></quote> module.
511
572
</para>
512
573
</listitem>
513
574
</varlistentry>
525
586
<command>&COMMANDNAME;</command> by the
526
587
<option>--network-hook-dir</option> option. Note: this
527
588
should <emphasis>always</emphasis> be used by the
528
network hook to refer to itself or any files it may
529
require.
589
network hook to refer to itself or any files in the hook
590
directory it may require.
530
591
</para>
531
592
</listitem>
532
593
</varlistentry>
534
595
<term><envar>DEVICE</envar></term>
535
596
<listitem>
536
597
<para>
537
The network interface, as specified to
598
The network interfaces, as specified to
538
599
<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.
600
<option>--interface</option> option, combined to one
601
string and separated by commas. If this is set, and
602
does not contain the interface a hook will bring up,
603
there is no reason for a hook to continue.
542
604
</para>
543
605
</listitem>
544
606
</varlistentry>
548
610
<para>
549
611
This will be the same as the first argument;
550
612
i.e. <quote><literal>start</literal></quote>,
551
<quote><literal>stop</literal></quote>, or
552
<quote><literal>files</literal></quote>.
613
<quote><literal>stop</literal></quote>,
614
<quote><literal>files</literal></quote>, or
615
<quote><literal>modules</literal></quote>.
553
616
</para>
554
617
</listitem>
555
618
</varlistentry>
569
632
<listitem>
570
633
<para>
571
634
This will be the same as the <option>--delay</option>
572
option passed to <command>&COMMANDNAME;</command>.
635
option passed to <command>&COMMANDNAME;</command>. Is
636
only set if <envar>MODE</envar> is
637
<quote><literal>start</literal></quote> or
638
<quote><literal>stop</literal></quote>.
639
</para>
640
</listitem>
641
</varlistentry>
642
<varlistentry>
643
<term><envar>CONNECT</envar></term>
644
<listitem>
645
<para>
646
This will be the same as the <option>--connect</option>
647
option passed to <command>&COMMANDNAME;</command>. Is
648
only set if <option>--connect</option> is passed and
649
<envar>MODE</envar> is
650
<quote><literal>start</literal></quote> or
651
<quote><literal>stop</literal></quote>.
573
652
</para>
574
653
</listitem>
575
654
</varlistentry>
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
810
890
<para>
811
891
This client uses IPv6 link-local addresses, which are
812
892
immediately usable since a link-local addresses is
813
automatically assigned to a network interfaces when it
893
automatically assigned to a network interface when it
814
894
is brought up.
815
895
</para>
816
896
</listitem>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0