64
71
><replaceable>PORT</replaceable></option></arg>
68
75
<arg choice="plain"><option>--interface
69
<replaceable>NAME</replaceable></option></arg>
70
<arg choice="plain"><option>-i
71
<replaceable>NAME</replaceable></option></arg>
76
<replaceable>NAME</replaceable><arg rep='repeat'
77
>,<replaceable>NAME</replaceable></arg></option></arg>
78
<arg choice="plain"><option>-i <replaceable>NAME</replaceable
79
><arg rep='repeat'>,<replaceable>NAME</replaceable></arg
137
150
communicates with <citerefentry><refentrytitle
138
151
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
139
152
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
153
brings up network interfaces, uses the interfaces’ IPv6
154
link-local addresses to get network connectivity, uses Zeroconf
155
to find servers on the local network, and communicates with
156
servers using TLS with an OpenPGP key to ensure authenticity and
144
157
confidentiality. This client program keeps running, trying all
145
158
servers on the network, until it receives a satisfactory reply
146
159
or a TERM signal. After all servers have been tried, all
148
161
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
164
The network interfaces are selected like this: If any interfaces
165
are specified using the <option>--interface</option> option,
166
those interface are used. Otherwise,
167
<command>&COMMANDNAME;</command> will use all interfaces that
168
are not loopback interfaces, are not point-to-point interfaces,
169
are capable of broadcasting and do not have the NOARP flag (see
157
170
<citerefentry><refentrytitle>netdevice</refentrytitle>
158
171
<manvolnum>7</manvolnum></citerefentry>). (If the
159
172
<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
173
interfaces and non-broadcast interfaces are accepted.) If any
174
used interfaces are not up and running, they are first taken up
175
(and later taken down again on program exit).
167
Before a network interface is selected, all <quote>network
178
Before network interfaces are selected, all <quote>network
168
179
hooks</quote> are run; see <xref linkend="network-hooks"/>.
218
229
assumed to separate the address from the port number.
221
This option is normally only useful for testing and
232
Normally, Zeroconf would be used to locate Mandos servers,
233
in which case this option would only be used when testing
228
240
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
241
>NAME</replaceable><arg rep='repeat'>,<replaceable
242
>NAME</replaceable></arg></option></term>
231
<replaceable>NAME</replaceable></option></term>
244
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
245
>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
248
Comma separated list of network interfaces that will be
249
brought up and scanned for Mandos servers to connect to.
250
The default is the empty string, which will automatically
251
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
254
If the <option>--connect</option> option is used, and
255
exactly one interface name is specified (except
256
<quote><literal>none</literal></quote>), this specifies
257
the interface to use to connect to the address given.
245
260
Note that since this program will normally run in the
246
261
initial RAM disk environment, the interface must be an
247
262
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"/>.
263
can normally not be a pseudo-interface such as
264
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
265
will not exist until much later in the boot process, and
266
can not be used by this program, unless created by a
267
<quote>network hook</quote> — see <xref
268
linkend="network-hooks"/>.
255
271
<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
272
<quote><literal>none</literal></quote>; this will make
273
<command>&COMMANDNAME;</command> only bring up interfaces
274
specified <emphasis>before</emphasis> this string. This
275
is not recommended, and only meant for advanced users.
306
322
Sets the number of bits to use for the prime number in the
307
TLS Diffie-Hellman key exchange. Default is 1024.
323
TLS Diffie-Hellman key exchange. The default value is
324
selected automatically based on the OpenPGP key. Note
325
that if the <option>--dh-params</option> option is used,
326
the values from that file will be used instead.
332
<term><option>--dh-params=<replaceable
333
>FILE</replaceable></option></term>
336
Specifies a PEM-encoded PKCS#3 file to read the parameters
337
needed by the TLS Diffie-Hellman key exchange from. If
338
this option is not given, or if the file for some reason
339
could not be used, the parameters will be generated on
340
startup, which will take some time and processing power.
341
Those using servers running under time, power or processor
342
constraints may want to generate such a file in advance
438
474
<refsect1 id="environment">
439
475
<title>ENVIRONMENT</title>
478
<term><envar>MANDOSPLUGINHELPERDIR</envar></term>
481
This environment variable will be assumed to contain the
482
directory containing any helper executables. The use and
483
nature of these helper executables, if any, is
484
purposefully not documented.
441
This program does not use any environment variables, not even
442
the ones provided by <citerefentry><refentrytitle
490
This program does not use any other environment variables, not
491
even the ones provided by <citerefentry><refentrytitle
443
492
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
547
596
<term><envar>DEVICE</envar></term>
550
The network interface, as specified to
599
The network interfaces, as specified to
551
600
<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
601
<option>--interface</option> option, combined to one
602
string and separated by commas. If this is set, and
603
does not contain the interface a hook will bring up,
604
there is no reason for a hook to continue.
741
790
It will also help if the checker program on the server is
742
791
configured to request something from the client which can not be
743
spoofed by someone else on the network, unlike unencrypted
744
<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.
747
797
<emphasis>Note</emphasis>: This makes it completely insecure to