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"/>.
228
228
<term><option>--interface=<replaceable
229
>NAME</replaceable><arg rep='repeat'>,<replaceable
230
>NAME</replaceable></arg></option></term>
229
>NAME</replaceable></option></term>
232
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
233
>NAME</replaceable></arg></option></term>
231
<replaceable>NAME</replaceable></option></term>
236
Comma separated list of network interfaces that will be
237
brought up and scanned for Mandos servers to connect to.
238
The default is the empty string, which will automatically
239
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
242
If the <option>--connect</option> option is used, and
243
exactly one interface name is specified (except
244
<quote><literal>none</literal></quote>), this specifies
245
the interface to use to connect to the address given.
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
248
245
Note that since this program will normally run in the
249
246
initial RAM disk environment, the interface must be an
250
247
interface which exists at that stage. Thus, the interface
251
can normally not be a pseudo-interface such as
252
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
253
will not exist until much later in the boot process, and
254
can not be used by this program, unless created by a
255
<quote>network hook</quote> — see <xref
256
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"/>.
259
255
<replaceable>NAME</replaceable> can be the string
260
<quote><literal>none</literal></quote>; this will make
261
<command>&COMMANDNAME;</command> not bring up
262
<emphasis>any</emphasis> interfaces specified
263
<emphasis>after</emphasis> this string. This is not
264
recommended, and only meant for advanced users.
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
319
314
>SECONDS</replaceable></option></term>
322
After bringing a network interface up, the program waits
317
After bringing the network interface up, the program waits
323
318
for the interface to arrive in a <quote>running</quote>
324
319
state before proceeding. During this time, the kernel log
325
320
level will be lowered to reduce clutter on the system
474
469
A network hook must be an executable file, and its name must
475
470
consist entirely of upper and lower case letters, digits,
476
underscores, periods, and hyphens.
471
underscores, and hyphens.
479
474
A network hook will receive one argument, which can be one of
502
497
<term><literal>files</literal></term>
505
This should make the network hook print, <emphasis>one
506
file per line</emphasis>, all the files needed for it to
507
run. (These files will be copied into the initial RAM
508
filesystem.) Typical use is for a network hook which is
509
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.
512
507
It is not necessary to print any non-executable files
513
508
already in the network hook directory, these will be
514
509
copied implicitly if they otherwise satisfy the name
520
<term><literal>modules</literal></term>
523
This should make the network hook print, <emphasis>on
524
separate lines</emphasis>, all the kernel modules needed
525
for it to run. (These modules will be copied into the
526
initial RAM filesystem.) For instance, a tunnel
528
<quote><literal>tun</literal></quote> module.
552
534
<term><envar>DEVICE</envar></term>
555
The network interfaces, as specified to
537
The network interface, as specified to
556
538
<command>&COMMANDNAME;</command> by the
557
<option>--interface</option> option, combined to one
558
string and separated by commas. If this is set, and
559
does not contain the interface a hook will bring up,
560
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
568
549
This will be the same as the first argument;
569
550
i.e. <quote><literal>start</literal></quote>,
570
<quote><literal>stop</literal></quote>,
571
<quote><literal>files</literal></quote>, or
572
<quote><literal>modules</literal></quote>.
551
<quote><literal>stop</literal></quote>, or
552
<quote><literal>files</literal></quote>.
591
571
This will be the same as the <option>--delay</option>
592
option passed to <command>&COMMANDNAME;</command>. Is
593
only set if <envar>MODE</envar> is
594
<quote><literal>start</literal></quote> or
595
<quote><literal>stop</literal></quote>.
600
<term><envar>CONNECT</envar></term>
603
This will be the same as the <option>--connect</option>
604
option passed to <command>&COMMANDNAME;</command>. Is
605
only set if <option>--connect</option> is passed and
606
<envar>MODE</envar> is
607
<quote><literal>start</literal></quote> or
608
<quote><literal>stop</literal></quote>.
572
option passed to <command>&COMMANDNAME;</command>.