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