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 VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
5
<!ENTITY TIMESTAMP "2010-09-25">
6
<!ENTITY % common SYSTEM "common.ent">
11
<title>&COMMANDNAME;</title>
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&COMMANDNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
17
19
<firstname>Björn</firstname>
33
36
<holder>Teddy Hogeborn</holder>
34
37
<holder>Björn Påhlsson</holder>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
39
<xi:include href="legalnotice.xml"/>
62
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
44
<manvolnum>8</manvolnum>
67
48
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
50
Gives encrypted passwords to authenticated Mandos clients
75
56
<command>&COMMANDNAME;</command>
76
<arg>--interface<arg choice="plain">IF</arg></arg>
77
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
<arg>--port<arg choice="plain">PORT</arg></arg>
79
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
80
<arg>--servicename<arg choice="plain">NAME</arg></arg>
81
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
85
<command>&COMMANDNAME;</command>
86
<arg>-i<arg choice="plain">IF</arg></arg>
87
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
<arg>-p<arg choice="plain">PORT</arg></arg>
89
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
90
<arg>--servicename<arg choice="plain">NAME</arg></arg>
91
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
58
<arg choice="plain"><option>--interface
59
<replaceable>NAME</replaceable></option></arg>
60
<arg choice="plain"><option>-i
61
<replaceable>NAME</replaceable></option></arg>
65
<arg choice="plain"><option>--address
66
<replaceable>ADDRESS</replaceable></option></arg>
67
<arg choice="plain"><option>-a
68
<replaceable>ADDRESS</replaceable></option></arg>
72
<arg choice="plain"><option>--port
73
<replaceable>PORT</replaceable></option></arg>
74
<arg choice="plain"><option>-p
75
<replaceable>PORT</replaceable></option></arg>
78
<arg><option>--priority
79
<replaceable>PRIORITY</replaceable></option></arg>
81
<arg><option>--servicename
82
<replaceable>NAME</replaceable></option></arg>
84
<arg><option>--configdir
85
<replaceable>DIRECTORY</replaceable></option></arg>
87
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
95
94
<command>&COMMANDNAME;</command>
96
95
<group choice="req">
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
96
<arg choice="plain"><option>--help</option></arg>
97
<arg choice="plain"><option>-h</option></arg>
102
101
<command>&COMMANDNAME;</command>
103
<arg choice="plain">--version</arg>
102
<arg choice="plain"><option>--version</option></arg>
106
105
<command>&COMMANDNAME;</command>
107
<arg choice="plain">--check</arg>
106
<arg choice="plain"><option>--check</option></arg>
109
108
</refsynopsisdiv>
111
110
<refsect1 id="description">
112
111
<title>DESCRIPTION</title>
122
121
Any authenticated client is then given the stored pre-encrypted
123
122
password for that specific client.
128
126
<refsect1 id="purpose">
129
127
<title>PURPOSE</title>
132
129
The purpose of this is to enable <emphasis>remote and unattended
133
130
rebooting</emphasis> of client host computer with an
134
131
<emphasis>encrypted root file system</emphasis>. See <xref
135
132
linkend="overview"/> for details.
140
136
<refsect1 id="options">
141
137
<title>OPTIONS</title>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
140
<term><option>--help</option></term>
141
<term><option>-h</option></term>
148
144
Show a help message and exit
154
<term><literal>-i</literal>, <literal>--interface <replaceable>
155
IF</replaceable></literal></term>
158
Only announce the server and listen to requests on network
159
interface <replaceable>IF</replaceable>. Default is to
160
use all available interfaces. <emphasis>Note:</emphasis>
161
a failure to bind to the specified interface is not
162
considered critical, and the server does not exit.
168
<term><literal>-a</literal>, <literal>--address <replaceable>
169
ADDRESS</replaceable></literal></term>
172
If this option is used, the server will only listen to a
173
specific address. This must currently be an IPv6 address;
174
an IPv4 address can be specified using the
175
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
Also, if a link-local address is specified, an interface
177
should be set, since a link-local address is only valid on
178
a single interface. By default, the server will listen to
179
all available addresses.
185
<term><literal>-p</literal>, <literal>--port <replaceable>
186
PORT</replaceable></literal></term>
189
If this option is used, the server to bind to that
190
port. By default, the server will listen to an arbitrary
191
port given by the operating system.
197
<term><literal>--check</literal></term>
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
152
<term><option>-i</option>
153
<replaceable>NAME</replaceable></term>
155
<xi:include href="mandos-options.xml" xpointer="interface"/>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
165
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
175
<xi:include href="mandos-options.xml" xpointer="port"/>
180
<term><option>--check</option></term>
200
183
Run the server’s self-tests. This includes any unit
207
<term><literal>--debug</literal></term>
210
If the server is run in debug mode, it will run in the
211
foreground and print a lot of debugging information. The
212
default is <emphasis>not</emphasis> to run in debug mode.
218
<term><literal>--priority <replaceable>
219
PRIORITY</replaceable></literal></term>
222
GnuTLS priority string for the TLS handshake with the
223
clients. The default is
224
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
See <citerefentry><refentrytitle>gnutls_priority_init
226
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
for the syntax. <emphasis>Warning</emphasis>: changing
228
this may make the TLS handshake fail, making communication
229
with clients impossible.
235
<term><literal>--servicename <replaceable>NAME</replaceable>
239
Zeroconf service name. The default is
240
<quote><literal>Mandos</literal></quote>. You only need
241
to change this if you for some reason want to run more
242
than one server on the same <emphasis>host</emphasis>,
243
which would not normally be useful. If there are name
244
collisions on the same <emphasis>network</emphasis>, the
245
newer server will automatically rename itself to
246
<quote><literal>Mandos #2</literal></quote>, and so on;
247
therefore, this option is not needed in that case.
253
<term><literal>--configdir <replaceable>DIR</replaceable>
190
<term><option>--debug</option></term>
192
<xi:include href="mandos-options.xml" xpointer="debug"/>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
208
<xi:include href="mandos-options.xml"
209
xpointer="servicename"/>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
257
218
Directory to search for configuration files. Default is
268
<term><literal>--version</literal></term>
229
<term><option>--version</option></term>
271
232
Prints the program version and exit.
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
256
<refsect1 id="overview">
279
257
<title>OVERVIEW</title>
258
<xi:include href="overview.xml"/>
282
260
This program is the server part. It is a normal server program
283
261
and will run in a normal system environment, not in an initial
284
RAM disk environment.
262
<acronym>RAM</acronym> disk environment.
288
266
<refsect1 id="protocol">
289
267
<title>NETWORK PROTOCOL</title>
343
321
</tbody></tgroup></table>
346
324
<refsect1 id="checking">
347
325
<title>CHECKING</title>
349
327
The server will, by default, continually check that the clients
350
328
are still up. If a client has not been confirmed as being up
351
329
for some time, the client is assumed to be compromised and is no
352
longer eligible to receive the encrypted password. The timeout,
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
353
332
checker program, and interval between checks can be configured
354
333
both globally and per client; see <citerefentry>
355
<refentrytitle>mandos.conf</refentrytitle>
356
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
357
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>.
334
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
341
<refsect1 id="approval">
342
<title>APPROVAL</title>
344
The server can be configured to require manual approval for a
345
client before it is sent its secret. The delay to wait for such
346
approval and the default action (approve or deny) can be
347
configured both globally and per client; see <citerefentry>
348
<refentrytitle>mandos-clients.conf</refentrytitle>
349
<manvolnum>5</manvolnum></citerefentry>. By default all clients
350
will be approved immediately without delay.
353
This can be used to deny a client its secret if not manually
354
approved within a specified time. It can also be used to make
355
the server delay before giving a client its secret, allowing
356
optional manual denying of this specific client.
362
361
<refsect1 id="logging">
363
362
<title>LOGGING</title>
365
The server will send log messaged with various severity levels
366
to <filename>/dev/log</filename>. With the
364
The server will send log message with various severity levels to
365
<filename>/dev/log</filename>. With the
367
366
<option>--debug</option> option, it will log even more messages,
368
367
and also show them on the console.
371
<refsect1 id="dbus_interface">
372
<title>D-BUS INTERFACE</title>
374
The server will by default provide a D-Bus system bus interface.
375
This interface will only be accessible by the root user or a
376
Mandos-specific user, if such a user exists. For documentation
377
of the D-Bus API, see the file <filename>DBUS-API</filename>.
372
381
<refsect1 id="exit_status">
373
382
<title>EXIT STATUS</title>
464
473
backtrace. This could be considered a feature.
467
Currently, if a client is declared <quote>invalid</quote> due to
468
having timed out, the server does not record this fact onto
469
permanent storage. This has some security implications, see
470
<xref linkend="CLIENTS"/>.
473
There is currently no way of querying the server of the current
474
status of clients, other than analyzing its <systemitem
475
class="service">syslog</systemitem> output.
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
478
481
There is no fine-grained control over logging and debug output.
519
526
<!-- do not wrap this line -->
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
527
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
523
530
</informalexample>
526
533
<refsect1 id="security">
527
534
<title>SECURITY</title>
528
<refsect2 id="SERVER">
535
<refsect2 id="server">
529
536
<title>SERVER</title>
531
538
Running this <command>&COMMANDNAME;</command> server program
532
539
should not in itself present any security risk to the host
533
computer running it. The program does not need any special
534
privileges to run, and is designed to run as a non-root user.
540
computer running it. The program switches to a non-root user
537
<refsect2 id="CLIENTS">
544
<refsect2 id="clients">
538
545
<title>CLIENTS</title>
540
547
The server only gives out its stored data to clients which
558
565
If a client is compromised, its downtime should be duly noted
559
by the server which would therefore declare the client
560
invalid. But if the server was ever restarted, it would
561
re-read its client list from its configuration file and again
562
regard all clients therein as valid, and hence eligible to
563
receive their passwords. Therefore, be careful when
564
restarting servers if you suspect that a client has, in fact,
565
been compromised by parties who may now be running a fake
566
Mandos client with the keys from the non-encrypted initial RAM
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
567
574
image of the client host. What should be done in that case
568
575
(if restarting the server program really is necessary) is to
569
576
stop the server program, edit the configuration file to omit
573
580
For more details on client-side security, see
574
<citerefentry><refentrytitle>password-request</refentrytitle>
581
<citerefentry><refentrytitle>mandos-client</refentrytitle>
575
582
<manvolnum>8mandos</manvolnum></citerefentry>.
580
587
<refsect1 id="see_also">
581
588
<title>SEE ALSO</title>
591
<refentrytitle>mandos-clients.conf</refentrytitle>
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
593
<refentrytitle>mandos.conf</refentrytitle>
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
595
<refentrytitle>mandos-client</refentrytitle>
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
586
<refentrytitle>password-request</refentrytitle>
587
<manvolnum>8mandos</manvolnum>
592
This is the actual program which talks to this server.
593
Note that it is normally not invoked directly, and is only
594
run in the initial RAM disk environment, and not on a
595
fully started system.
601
603
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
636
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
Unicast Addresses</citation>
638
RFC 4291: <citetitle>IP Version 6 Addressing
639
Architecture</citetitle>
642
The clients use IPv6 link-local addresses, which are
643
immediately usable since a link-local addresses is
644
automatically assigned to a network interfaces when it is
644
<term>Section 2.2: <citetitle>Text Representation of
645
Addresses</citetitle></term>
646
<listitem><para/></listitem>
649
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
650
Address</citetitle></term>
651
<listitem><para/></listitem>
654
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
655
Addresses</citetitle></term>
658
The clients use IPv6 link-local addresses, which are
659
immediately usable since a link-local addresses is
660
automatically assigned to a network interfaces when it
651
<citation>RFC 4346: <citetitle>The Transport Layer Security
652
(TLS) Protocol Version 1.1</citetitle></citation>
670
RFC 4346: <citetitle>The Transport Layer Security (TLS)
671
Protocol Version 1.1</citetitle>