101
<option>--delay <replaceable>SECONDS</replaceable></option>
105
<option>--retry <replaceable>SECONDS</replaceable></option>
109
<option>--network-hook-dir
110
<replaceable>DIR</replaceable></option>
124
114
<option>--debug</option>
128
118
<command>&COMMANDNAME;</command>
129
119
<group choice="req">
130
<arg choice='plain'><option>--help</option></arg>
131
<arg choice='plain'><option>-?</option></arg>
120
<arg choice="plain"><option>--help</option></arg>
121
<arg choice="plain"><option>-?</option></arg>
135
125
<command>&COMMANDNAME;</command>
136
<arg choice='plain'><option>--usage</option></arg>
126
<arg choice="plain"><option>--usage</option></arg>
139
129
<command>&COMMANDNAME;</command>
140
130
<group choice="req">
141
<arg choice='plain'><option>--version</option></arg>
142
<arg choice='plain'><option>-V</option></arg>
131
<arg choice="plain"><option>--version</option></arg>
132
<arg choice="plain"><option>-V</option></arg>
145
135
</refsynopsisdiv>
147
137
<refsect1 id="description">
148
138
<title>DESCRIPTION</title>
150
<command>&COMMANDNAME;</command> is a mandos plugin that works
151
like a client program that through avahi detects mandos servers,
152
sets up a gnutls connect and request a encrypted password. Any
153
passwords given is automaticly decrypted and passed to
140
<command>&COMMANDNAME;</command> is a client program that
141
communicates with <citerefentry><refentrytitle
142
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
143
to get a password. In slightly more detail, this client program
144
brings up network interfaces, uses the interfaces’ IPv6
145
link-local addresses to get network connectivity, uses Zeroconf
146
to find servers on the local network, and communicates with
147
servers using TLS with an OpenPGP key to ensure authenticity and
148
confidentiality. This client program keeps running, trying all
149
servers on the network, until it receives a satisfactory reply
150
or a TERM signal. After all servers have been tried, all
151
servers are periodically retried. If no servers are found it
152
will wait indefinitely for new servers to appear.
155
The network interfaces are selected like this: If any interfaces
156
are specified using the <option>--interface</option> option,
157
those interface are used. Otherwise,
158
<command>&COMMANDNAME;</command> will use all interfaces that
159
are not loopback interfaces, are not point-to-point interfaces,
160
are capable of broadcasting and do not have the NOARP flag (see
161
<citerefentry><refentrytitle>netdevice</refentrytitle>
162
<manvolnum>7</manvolnum></citerefentry>). (If the
163
<option>--connect</option> option is used, point-to-point
164
interfaces and non-broadcast interfaces are accepted.) If any
165
used interfaces are not up and running, they are first taken up
166
(and later taken down again on program exit).
169
Before network interfaces are selected, all <quote>network
170
hooks</quote> are run; see <xref linkend="network-hooks"/>.
173
This program is not meant to be run directly; it is really meant
174
to run as a plugin of the <application>Mandos</application>
175
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
176
<manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
177
initial <acronym>RAM</acronym> disk environment because it is
178
specified as a <quote>keyscript</quote> in the <citerefentry>
179
<refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
180
</citerefentry> file.
184
<refsect1 id="purpose">
185
<title>PURPOSE</title>
187
The purpose of this is to enable <emphasis>remote and unattended
188
rebooting</emphasis> of client host computer with an
189
<emphasis>encrypted root file system</emphasis>. See <xref
190
linkend="overview"/> for details.
158
194
<refsect1 id="options">
159
195
<title>OPTIONS</title>
161
Commonly not invoked as command lines but from configuration
162
file of plugin runner.
197
This program is commonly not invoked from the command line; it
198
is normally started by the <application>Mandos</application>
199
plugin runner, see <citerefentry><refentrytitle
200
>plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
201
</citerefentry>. Any command line options this program accepts
202
are therefore normally provided by the plugin runner, and not
167
<term><literal>-c</literal>, <literal>--connect=<replaceable>
168
IP</replaceable></literal></term>
171
Connect directly to a specified mandos server
177
<term><literal>-d</literal>, <literal>--keydir=<replaceable>
178
KEYDIR</replaceable></literal></term>
181
Directory where the openpgp keyring is
187
<term><literal>-i</literal>, <literal>--interface=
188
<replaceable>INTERFACE</replaceable></literal></term>
191
Interface that Avahi will conntect through
197
<term><literal>-p</literal>, <literal>--pubkey=<replaceable>
198
PUBKEY</replaceable></literal></term>
201
Public openpgp key for gnutls authentication
207
<term><literal>-s</literal>, <literal>--seckey=<replaceable>
208
SECKEY</replaceable></literal></term>
211
Secret openpgp key for gnutls authentication
217
<term><literal>--priority=<replaceable>PRIORITY</replaceable>
227
<term><literal>--dh-bits=<replaceable>BITS</replaceable>
231
dh-bits to use in gnutls communication
237
<term><literal>--debug</literal></term>
246
<term><literal>-?</literal>, <literal>--help</literal></term>
255
<term><literal>--usage</literal></term>
258
Gives a short usage message
264
<term><literal>-V</literal>, <literal>--version</literal></term>
267
Prints the program version
208
<term><option>--connect=<replaceable
209
>ADDRESS</replaceable><literal>:</literal><replaceable
210
>PORT</replaceable></option></term>
212
<replaceable>ADDRESS</replaceable><literal>:</literal
213
><replaceable>PORT</replaceable></option></term>
216
Do not use Zeroconf to locate servers. Connect directly
217
to only one specified <application>Mandos</application>
218
server. Note that an IPv6 address has colon characters in
219
it, so the <emphasis>last</emphasis> colon character is
220
assumed to separate the address from the port number.
223
Normally, Zeroconf would be used to locate Mandos servers,
224
in which case this option would only be used when testing
231
<term><option>--interface=<replaceable
232
>NAME</replaceable><arg rep='repeat'>,<replaceable
233
>NAME</replaceable></arg></option></term>
235
<replaceable>NAME</replaceable><arg rep='repeat'>,<replaceable
236
>NAME</replaceable></arg></option></term>
239
Comma separated list of network interfaces that will be
240
brought up and scanned for Mandos servers to connect to.
241
The default is the empty string, which will automatically
242
use all appropriate interfaces.
245
If the <option>--connect</option> option is used, and
246
exactly one interface name is specified (except
247
<quote><literal>none</literal></quote>), this specifies
248
the interface to use to connect to the address given.
251
Note that since this program will normally run in the
252
initial RAM disk environment, the interface must be an
253
interface which exists at that stage. Thus, the interface
254
can normally not be a pseudo-interface such as
255
<quote>br0</quote> or <quote>tun0</quote>; such interfaces
256
will not exist until much later in the boot process, and
257
can not be used by this program, unless created by a
258
<quote>network hook</quote> — see <xref
259
linkend="network-hooks"/>.
262
<replaceable>NAME</replaceable> can be the string
263
<quote><literal>none</literal></quote>; this will make
264
<command>&COMMANDNAME;</command> only bring up interfaces
265
specified <emphasis>before</emphasis> this string. This
266
is not recommended, and only meant for advanced users.
272
<term><option>--pubkey=<replaceable
273
>FILE</replaceable></option></term>
275
<replaceable>FILE</replaceable></option></term>
278
OpenPGP public key file name. The default name is
279
<quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
286
<term><option>--seckey=<replaceable
287
>FILE</replaceable></option></term>
289
<replaceable>FILE</replaceable></option></term>
292
OpenPGP secret key file name. The default name is
293
<quote><filename>/conf/conf.d/mandos/seckey.txt</filename
300
<term><option>--priority=<replaceable
301
>STRING</replaceable></option></term>
303
<xi:include href="../mandos-options.xml"
304
xpointer="priority"/>
309
<term><option>--dh-bits=<replaceable
310
>BITS</replaceable></option></term>
313
Sets the number of bits to use for the prime number in the
314
TLS Diffie-Hellman key exchange. The default value is
315
selected automatically based on the OpenPGP key.
321
<term><option>--delay=<replaceable
322
>SECONDS</replaceable></option></term>
325
After bringing a network interface up, the program waits
326
for the interface to arrive in a <quote>running</quote>
327
state before proceeding. During this time, the kernel log
328
level will be lowered to reduce clutter on the system
329
console, alleviating any other plugins which might be
330
using the system console. This option sets the upper
331
limit of seconds to wait. The default is 2.5 seconds.
337
<term><option>--retry=<replaceable
338
>SECONDS</replaceable></option></term>
341
All Mandos servers are tried repeatedly until a password
342
is received. This value specifies, in seconds, how long
343
between each successive try <emphasis>for the same
344
server</emphasis>. The default is 10 seconds.
350
<term><option>--network-hook-dir=<replaceable
351
>DIR</replaceable></option></term>
354
Network hook directory. The default directory is
355
<quote><filename class="directory"
356
>/lib/mandos/network-hooks.d</filename></quote>.
362
<term><option>--debug</option></term>
365
Enable debug mode. This will enable a lot of output to
366
standard error about what the program is doing. The
367
program will still perform all other functions normally.
370
It will also enable debug mode in the Avahi and GnuTLS
371
libraries, making them print large amounts of debugging
378
<term><option>--help</option></term>
379
<term><option>-?</option></term>
382
Gives a help message about options and their meanings.
388
<term><option>--usage</option></term>
391
Gives a short usage message.
397
<term><option>--version</option></term>
398
<term><option>-V</option></term>
401
Prints the program version.
408
<refsect1 id="overview">
409
<title>OVERVIEW</title>
410
<xi:include href="../overview.xml"/>
412
This program is the client part. It is a plugin started by
413
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
414
<manvolnum>8mandos</manvolnum></citerefentry> which will run in
415
an initial <acronym>RAM</acronym> disk environment.
418
This program could, theoretically, be used as a keyscript in
419
<filename>/etc/crypttab</filename>, but it would then be
420
impossible to enter a password for the encrypted root disk at
421
the console, since this program does not read from the console
422
at all. This is why a separate plugin runner (<citerefentry>
423
<refentrytitle>plugin-runner</refentrytitle>
424
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
425
both this program and others in in parallel,
426
<emphasis>one</emphasis> of which (<citerefentry>
427
<refentrytitle>password-prompt</refentrytitle>
428
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
429
passwords on the system console.
274
433
<refsect1 id="exit_status">
275
434
<title>EXIT STATUS</title>
436
This program will exit with a successful (zero) exit status if a
437
server could be found and the password received from it could be
438
successfully decrypted and output on standard output. The
439
program will exit with a non-zero exit status only if a critical
440
error occurs. Otherwise, it will forever connect to any
441
discovered <application>Mandos</application> servers, trying to
442
get a decryptable password and print it.
280
446
<refsect1 id="environment">
281
447
<title>ENVIRONMENT</title>
449
This program does not use any environment variables, not even
450
the ones provided by <citerefentry><refentrytitle
451
>cryptsetup</refentrytitle><manvolnum>8</manvolnum>
456
<refsect1 id="network-hooks">
457
<title>NETWORK HOOKS</title>
459
If a network interface like a bridge or tunnel is required to
460
find a Mandos server, this requires the interface to be up and
461
running before <command>&COMMANDNAME;</command> starts looking
462
for Mandos servers. This can be accomplished by creating a
463
<quote>network hook</quote> program, and placing it in a special
467
Before the network is used (and again before program exit), any
468
runnable programs found in the network hook directory are run
469
with the argument <quote><literal>start</literal></quote> or
470
<quote><literal>stop</literal></quote>. This should bring up or
471
down, respectively, any network interface which
472
<command>&COMMANDNAME;</command> should use.
474
<refsect2 id="hook-requirements">
475
<title>REQUIREMENTS</title>
477
A network hook must be an executable file, and its name must
478
consist entirely of upper and lower case letters, digits,
479
underscores, periods, and hyphens.
482
A network hook will receive one argument, which can be one of
487
<term><literal>start</literal></term>
490
This should make the network hook create (if necessary)
491
and bring up a network interface.
496
<term><literal>stop</literal></term>
499
This should make the network hook take down a network
500
interface, and delete it if it did not exist previously.
505
<term><literal>files</literal></term>
508
This should make the network hook print, <emphasis>one
509
file per line</emphasis>, all the files needed for it to
510
run. (These files will be copied into the initial RAM
511
filesystem.) Typical use is for a network hook which is
512
a shell script to print its needed binaries.
515
It is not necessary to print any non-executable files
516
already in the network hook directory, these will be
517
copied implicitly if they otherwise satisfy the name
523
<term><literal>modules</literal></term>
526
This should make the network hook print, <emphasis>on
527
separate lines</emphasis>, all the kernel modules needed
528
for it to run. (These modules will be copied into the
529
initial RAM filesystem.) For instance, a tunnel
531
<quote><literal>tun</literal></quote> module.
537
The network hook will be provided with a number of environment
542
<term><envar>MANDOSNETHOOKDIR</envar></term>
545
The network hook directory, specified to
546
<command>&COMMANDNAME;</command> by the
547
<option>--network-hook-dir</option> option. Note: this
548
should <emphasis>always</emphasis> be used by the
549
network hook to refer to itself or any files in the hook
550
directory it may require.
555
<term><envar>DEVICE</envar></term>
558
The network interfaces, as specified to
559
<command>&COMMANDNAME;</command> by the
560
<option>--interface</option> option, combined to one
561
string and separated by commas. If this is set, and
562
does not contain the interface a hook will bring up,
563
there is no reason for a hook to continue.
568
<term><envar>MODE</envar></term>
571
This will be the same as the first argument;
572
i.e. <quote><literal>start</literal></quote>,
573
<quote><literal>stop</literal></quote>,
574
<quote><literal>files</literal></quote>, or
575
<quote><literal>modules</literal></quote>.
580
<term><envar>VERBOSITY</envar></term>
583
This will be the <quote><literal>1</literal></quote> if
584
the <option>--debug</option> option is passed to
585
<command>&COMMANDNAME;</command>, otherwise
586
<quote><literal>0</literal></quote>.
591
<term><envar>DELAY</envar></term>
594
This will be the same as the <option>--delay</option>
595
option passed to <command>&COMMANDNAME;</command>. Is
596
only set if <envar>MODE</envar> is
597
<quote><literal>start</literal></quote> or
598
<quote><literal>stop</literal></quote>.
603
<term><envar>CONNECT</envar></term>
606
This will be the same as the <option>--connect</option>
607
option passed to <command>&COMMANDNAME;</command>. Is
608
only set if <option>--connect</option> is passed and
609
<envar>MODE</envar> is
610
<quote><literal>start</literal></quote> or
611
<quote><literal>stop</literal></quote>.
617
A hook may not read from standard input, and should be
618
restrictive in printing to standard output or standard error
619
unless <varname>VERBOSITY</varname> is
620
<quote><literal>1</literal></quote>.
625
<refsect1 id="files">
287
626
<title>FILES</title>
629
<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
631
<term><filename>/conf/conf.d/mandos/seckey.txt</filename
635
OpenPGP public and private key files, in <quote>ASCII
636
Armor</quote> format. These are the default file names,
637
they can be changed with the <option>--pubkey</option> and
638
<option>--seckey</option> options.
644
class="directory">/lib/mandos/network-hooks.d</filename></term>
647
Directory where network hooks are located. Change this
648
with the <option>--network-hook-dir</option> option. See
649
<xref linkend="network-hooks"/>.
656
<!-- <refsect1 id="bugs"> -->
657
<!-- <title>BUGS</title> -->
298
662
<refsect1 id="example">
299
663
<title>EXAMPLE</title>
665
Note that normally, command line options will not be given
666
directly, but via options for the Mandos <citerefentry
667
><refentrytitle>plugin-runner</refentrytitle>
668
<manvolnum>8mandos</manvolnum></citerefentry>.
672
Normal invocation needs no options, if the network interfaces
673
can be automatically determined:
676
<userinput>&COMMANDNAME;</userinput>
681
Search for Mandos servers (and connect to them) using one
685
<!-- do not wrap this line -->
686
<userinput>&COMMANDNAME; --interface eth1</userinput>
691
Run in debug mode, and use a custom key:
695
<!-- do not wrap this line -->
696
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
702
Run in debug mode, with a custom key, and do not use Zeroconf
703
to locate a server; connect directly to the IPv6 link-local
704
address <quote><systemitem class="ipaddress"
705
>fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
706
using interface eth2:
710
<!-- do not wrap this line -->
711
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
304
717
<refsect1 id="security">
305
718
<title>SECURITY</title>
720
This program is set-uid to root, but will switch back to the
721
original (and presumably non-privileged) user and group after
722
bringing up the network interface.
725
To use this program for its intended purpose (see <xref
726
linkend="purpose"/>), the password for the root file system will
727
have to be given out to be stored in a server computer, after
728
having been encrypted using an OpenPGP key. This encrypted data
729
which will be stored in a server can only be decrypted by the
730
OpenPGP key, and the data will only be given out to those
731
clients who can prove they actually have that key. This key,
732
however, is stored unencrypted on the client side in its initial
733
<acronym>RAM</acronym> disk image file system. This is normally
734
readable by all, but this is normally fixed during installation
735
of this program; file permissions are set so that no-one is able
739
The only remaining weak point is that someone with physical
740
access to the client hard drive might turn off the client
741
computer, read the OpenPGP keys directly from the hard drive,
742
and communicate with the server. To safeguard against this, the
743
server is supposed to notice the client disappearing and stop
744
giving out the encrypted data. Therefore, it is important to
745
set the timeout and checker interval values tightly on the
746
server. See <citerefentry><refentrytitle
747
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
750
It will also help if the checker program on the server is
751
configured to request something from the client which can not be
752
spoofed by someone else on the network, like SSH server key
753
fingerprints, and unlike unencrypted <acronym>ICMP</acronym>
754
echo (<quote>ping</quote>) replies.
757
<emphasis>Note</emphasis>: This makes it completely insecure to
758
have <application >Mandos</application> clients which dual-boot
759
to another operating system which is <emphasis>not</emphasis>
760
trusted to keep the initial <acronym>RAM</acronym> disk image
310
765
<refsect1 id="see_also">
311
766
<title>SEE ALSO</title>
768
<citerefentry><refentrytitle>intro</refentrytitle>
769
<manvolnum>8mandos</manvolnum></citerefentry>,
770
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
771
<manvolnum>8</manvolnum></citerefentry>,
772
<citerefentry><refentrytitle>crypttab</refentrytitle>
773
<manvolnum>5</manvolnum></citerefentry>,
313
774
<citerefentry><refentrytitle>mandos</refentrytitle>
314
775
<manvolnum>8</manvolnum></citerefentry>,
315
776
<citerefentry><refentrytitle>password-prompt</refentrytitle>