1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY TIMESTAMP "2012-06-13">
6
<!ENTITY % common SYSTEM "../common.ent">
4
<!ENTITY VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
6
<!ENTITY TIMESTAMP "2008-09-04">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
37
34
<holder>Teddy Hogeborn</holder>
38
35
<holder>Björn Påhlsson</holder>
40
37
<xi:include href="../legalnotice.xml"/>
44
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
42
<manvolnum>8mandos</manvolnum>
133
115
</refsynopsisdiv>
135
117
<refsect1 id="description">
136
118
<title>DESCRIPTION</title>
138
120
<command>&COMMANDNAME;</command> is a client program that
139
121
communicates with <citerefentry><refentrytitle
140
122
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
141
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
146
confidentiality. This client program keeps running, trying all
147
servers on the network, until it receives a satisfactory reply
148
or a TERM signal. After all servers have been tried, all
149
servers are periodically retried. If no servers are found it
150
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
159
<citerefentry><refentrytitle>netdevice</refentrytitle>
160
<manvolnum>7</manvolnum></citerefentry>). (If the
161
<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).
167
Before network interfaces are selected, all <quote>network
168
hooks</quote> are run; see <xref linkend="network-hooks"/>.
123
to get a password. It uses IPv6 link-local addresses to get
124
network connectivity, Zeroconf to find servers, and TLS with an
125
OpenPGP key to ensure authenticity and confidentiality. It
126
keeps running, trying all servers on the network, until it
127
receives a satisfactory reply or a TERM signal is received.
171
130
This program is not meant to be run directly; it is really meant
228
<term><option>--interface=<replaceable
229
>NAME</replaceable></option></term>
187
<term><option>--interface=
188
<replaceable>NAME</replaceable></option></term>
231
190
<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.
193
Network interface that will be brought up and scanned for
194
Mandos servers to connect to. The default it
195
<quote><literal>eth0</literal></quote>.
240
198
If the <option>--connect</option> option is used, this
241
199
specifies the interface to use to connect to the address
245
Note that since this program will normally run in the
246
initial RAM disk environment, the interface must be an
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"/>.
256
<replaceable>NAME</replaceable> can be the string
257
<quote><literal>none</literal></quote>; this will not use
258
any specific interface, and will not bring up an interface
259
on startup. This is not recommended, and only meant for
314
<term><option>--delay=<replaceable
315
>SECONDS</replaceable></option></term>
318
After bringing a network interface up, the program waits
319
for the interface to arrive in a <quote>running</quote>
320
state before proceeding. During this time, the kernel log
321
level will be lowered to reduce clutter on the system
322
console, alleviating any other plugins which might be
323
using the system console. This option sets the upper
324
limit of seconds to wait. The default is 2.5 seconds.
330
<term><option>--retry=<replaceable
331
>SECONDS</replaceable></option></term>
334
All Mandos servers are tried repeatedly until a password
335
is received. This value specifies, in seconds, how long
336
between each successive try <emphasis>for the same
337
server</emphasis>. The default is 10 seconds.
343
<term><option>--network-hook-dir=<replaceable
344
>DIR</replaceable></option></term>
347
Network hook directory. The default directory is
348
<quote><filename class="directory"
349
>/lib/mandos/network-hooks.d</filename></quote>.
355
254
<term><option>--debug</option></term>
412
311
<filename>/etc/crypttab</filename>, but it would then be
413
312
impossible to enter a password for the encrypted root disk at
414
313
the console, since this program does not read from the console
415
at all. This is why a separate plugin runner (<citerefentry>
416
<refentrytitle>plugin-runner</refentrytitle>
417
<manvolnum>8mandos</manvolnum></citerefentry>) is used to run
418
both this program and others in in parallel,
419
<emphasis>one</emphasis> of which (<citerefentry>
314
at all. This is why a separate plugin (<citerefentry>
420
315
<refentrytitle>password-prompt</refentrytitle>
421
<manvolnum>8mandos</manvolnum></citerefentry>) will prompt for
422
passwords on the system console.
316
<manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
will be run in parallel to this one by the plugin runner.
449
<refsect1 id="network-hooks">
450
<title>NETWORK HOOKS</title>
452
If a network interface like a bridge or tunnel is required to
453
find a Mandos server, this requires the interface to be up and
454
running before <command>&COMMANDNAME;</command> starts looking
455
for Mandos servers. This can be accomplished by creating a
456
<quote>network hook</quote> program, and placing it in a special
460
Before the network is used (and again before program exit), any
461
runnable programs found in the network hook directory are run
462
with the argument <quote><literal>start</literal></quote> or
463
<quote><literal>stop</literal></quote>. This should bring up or
464
down, respectively, any network interface which
465
<command>&COMMANDNAME;</command> should use.
467
<refsect2 id="hook-requirements">
468
<title>REQUIREMENTS</title>
470
A network hook must be an executable file, and its name must
471
consist entirely of upper and lower case letters, digits,
472
underscores, periods, and hyphens.
475
A network hook will receive one argument, which can be one of
480
<term><literal>start</literal></term>
483
This should make the network hook create (if necessary)
484
and bring up a network interface.
489
<term><literal>stop</literal></term>
492
This should make the network hook take down a network
493
interface, and delete it if it did not exist previously.
498
<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.
508
It is not necessary to print any non-executable files
509
already in the network hook directory, these will be
510
copied implicitly if they otherwise satisfy the name
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
The network hook will be provided with a number of environment
535
<term><envar>MANDOSNETHOOKDIR</envar></term>
538
The network hook directory, specified to
539
<command>&COMMANDNAME;</command> by the
540
<option>--network-hook-dir</option> option. Note: this
541
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.
548
<term><envar>DEVICE</envar></term>
551
The network interfaces, as specified to
552
<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.
561
<term><envar>MODE</envar></term>
564
This will be the same as the first argument;
565
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>.
573
<term><envar>VERBOSITY</envar></term>
576
This will be the <quote><literal>1</literal></quote> if
577
the <option>--debug</option> option is passed to
578
<command>&COMMANDNAME;</command>, otherwise
579
<quote><literal>0</literal></quote>.
584
<term><envar>DELAY</envar></term>
587
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>.
610
A hook may not read from standard input, and should be
611
restrictive in printing to standard output or standard error
612
unless <varname>VERBOSITY</varname> is
613
<quote><literal>1</literal></quote>.
618
<refsect1 id="files">
619
345
<title>FILES</title>
732
447
The only remaining weak point is that someone with physical
733
448
access to the client hard drive might turn off the client
734
449
computer, read the OpenPGP keys directly from the hard drive,
735
and communicate with the server. To safeguard against this, the
736
server is supposed to notice the client disappearing and stop
737
giving out the encrypted data. Therefore, it is important to
738
set the timeout and checker interval values tightly on the
739
server. See <citerefentry><refentrytitle
450
and communicate with the server. The defense against this is
451
that the server is supposed to notice the client disappearing
452
and will stop giving out the encrypted data. Therefore, it is
453
important to set the timeout and checker interval values tightly
454
on the server. See <citerefentry><refentrytitle
740
455
>mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>.