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 "2012-06-13">
5
<!ENTITY TIMESTAMP "2011-11-27">
6
6
<!ENTITY % common SYSTEM "../common.ent">
64
64
><replaceable>PORT</replaceable></option></arg>
68
68
<arg choice="plain"><option>--interface
69
<replaceable>NAME</replaceable><arg rep='repeat'
70
>,<replaceable>NAME</replaceable></arg></option></arg>
71
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
72
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
139
137
communicates with <citerefentry><refentrytitle
140
138
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
141
139
to get a password. In slightly more detail, this client program
142
brings up network interfaces, uses the interfaces’ IPv6
143
link-local addresses to get network connectivity, uses Zeroconf
144
to find servers on the local network, and communicates with
145
servers using TLS with an OpenPGP key to ensure authenticity and
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
146
144
confidentiality. This client program keeps running, trying all
147
145
servers on the network, until it receives a satisfactory reply
148
146
or a TERM signal. After all servers have been tried, all
150
148
will wait indefinitely for new servers to appear.
153
The network interfaces are selected like this: If any interfaces
154
are specified using the <option>--interface</option> option,
155
those interface are used. Otherwise,
156
<command>&COMMANDNAME;</command> will use all interfaces that
157
are not loopback interfaces, are not point-to-point interfaces,
158
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
159
157
<citerefentry><refentrytitle>netdevice</refentrytitle>
160
158
<manvolnum>7</manvolnum></citerefentry>). (If the
161
159
<option>--connect</option> option is used, point-to-point
162
interfaces and non-broadcast interfaces are accepted.) If any
163
used interfaces are not up and running, they are first taken up
164
(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
167
Before network interfaces are selected, all <quote>network
167
Before a network interface is selected, all <quote>network
168
168
hooks</quote> are run; see <xref linkend="network-hooks"/>.
231
231
<replaceable>NAME</replaceable></option></term>
234
Comma separated list of network interfaces that will be
235
brought up and scanned for Mandos servers to connect to.
236
The default is the empty string, which will automatically
237
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
240
240
If the <option>--connect</option> option is used, this
245
245
Note that since this program will normally run in the
246
246
initial RAM disk environment, the interface must be an
247
247
interface which exists at that stage. Thus, the interface
248
can normally not be a pseudo-interface such as
249
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
250
will not exist until much later in the boot process, and
251
can not be used by this program, unless created by a
252
<quote>network hook</quote> — see <xref
253
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"/>.
256
255
<replaceable>NAME</replaceable> can be the string
315
314
>SECONDS</replaceable></option></term>
318
After bringing a network interface up, the program waits
317
After bringing the network interface up, the program waits
319
318
for the interface to arrive in a <quote>running</quote>
320
319
state before proceeding. During this time, the kernel log
321
320
level will be lowered to reduce clutter on the system
470
469
A network hook must be an executable file, and its name must
471
470
consist entirely of upper and lower case letters, digits,
472
underscores, periods, and hyphens.
471
underscores, and hyphens.
475
474
A network hook will receive one argument, which can be one of
498
497
<term><literal>files</literal></term>
501
This should make the network hook print, <emphasis>one
502
file per line</emphasis>, all the files needed for it to
503
run. (These files will be copied into the initial RAM
504
filesystem.) Typical use is for a network hook which is
505
a shell script to print its needed binaries.
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.
508
507
It is not necessary to print any non-executable files
516
<term><literal>modules</literal></term>
519
This should make the network hook print, <emphasis>on
520
separate lines</emphasis>, all the kernel modules needed
521
for it to run. (These modules will be copied into the
522
initial RAM filesystem.) For instance, a tunnel
524
<quote><literal>tun</literal></quote> module.
530
516
The network hook will be provided with a number of environment
539
525
<command>&COMMANDNAME;</command> by the
540
526
<option>--network-hook-dir</option> option. Note: this
541
527
should <emphasis>always</emphasis> be used by the
542
network hook to refer to itself or any files in the hook
543
directory it may require.
528
network hook to refer to itself or any files it may
548
534
<term><envar>DEVICE</envar></term>
551
The network interfaces, as specified to
537
The network interface, as specified to
552
538
<command>&COMMANDNAME;</command> by the
553
<option>--interface</option> option, combined to one
554
string and separated by commas. If this is set, and
555
does not contain the interface a hook will bring up,
556
there is no reason for a hook to continue.
539
<option>--interface</option> option. If this is not the
540
interface a hook will bring up, there is no reason for a
564
549
This will be the same as the first argument;
565
550
i.e. <quote><literal>start</literal></quote>,
566
<quote><literal>stop</literal></quote>,
567
<quote><literal>files</literal></quote>, or
568
<quote><literal>modules</literal></quote>.
551
<quote><literal>stop</literal></quote>, or
552
<quote><literal>files</literal></quote>.
587
571
This will be the same as the <option>--delay</option>
588
option passed to <command>&COMMANDNAME;</command>. Is
589
only set if <envar>MODE</envar> is
590
<quote><literal>start</literal></quote> or
591
<quote><literal>stop</literal></quote>.
596
<term><envar>CONNECT</envar></term>
599
This will be the same as the <option>--connect</option>
600
option passed to <command>&COMMANDNAME;</command>. Is
601
only set if <option>--connect</option> is passed and
602
<envar>MODE</envar> is
603
<quote><literal>start</literal></quote> or
604
<quote><literal>stop</literal></quote>.
572
option passed to <command>&COMMANDNAME;</command>.
added
removed
plugins.d/mandos-client.xml
