64
67
><replaceable>PORT</replaceable></option></arg>
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
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.
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
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).
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"/>.
218
225
assumed to separate the address from the port number.
221
This option is normally only useful for testing and
228
Normally, Zeroconf would be used to locate Mandos servers,
229
in which case this option would only be used when testing
228
236
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
237
>NAME</replaceable><arg rep='repeat'>,<replaceable
238
>NAME</replaceable></arg></option></term>
231
<replaceable>NAME</replaceable></option></term>
240
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
241
>NAME</replaceable></arg></option></term>
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
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.
240
If the <option>--connect</option> option is used, this
241
specifies the interface to use to connect to the address
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.
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"/>.
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
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.
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.
328
<term><option>--dh-params=<replaceable
329
>FILE</replaceable></option></term>
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
438
470
<refsect1 id="environment">
439
471
<title>ENVIRONMENT</title>
474
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
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.
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>
547
592
<term><envar>DEVICE</envar></term>
550
The network interface, as specified to
595
The network interfaces, as specified to
551
596
<command>&COMMANDNAME;</command> by the
552
<option>--interface</option> option. If this is not the
553
interface a hook will bring up, there is no reason for a
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.
585
631
This will be the same as the <option>--delay</option>
586
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>.
640
<term><envar>CONNECT</envar></term>
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>.
725
787
It will also help if the checker program on the server is
726
788
configured to request something from the client which can not be
727
spoofed by someone else on the network, unlike unencrypted
728
<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.
731
794
<emphasis>Note</emphasis>: This makes it completely insecure to
added
removed
plugins.d/mandos-client.xml
