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 TIMESTAMP "2008-08-31">
5
<!ENTITY TIMESTAMP "2011-10-22">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
38
<holder>Teddy Hogeborn</holder>
35
39
<holder>Björn Påhlsson</holder>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
41
<xi:include href="legalnotice.xml"/>
63
45
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
<manvolnum>8</manvolnum>
122
113
<arg choice="plain"><option>--check</option></arg>
124
115
</refsynopsisdiv>
126
117
<refsect1 id="description">
127
118
<title>DESCRIPTION</title>
129
120
<command>&COMMANDNAME;</command> is a server daemon which
130
121
handles incoming request for passwords for a pre-defined list of
131
client host computers. The Mandos server uses Zeroconf to
132
announce itself on the local network, and uses TLS to
133
communicate securely with and to authenticate the clients. The
134
Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
link-local addresses, since the clients will probably not have
136
any other addresses configured (see <xref linkend="overview"/>).
137
Any authenticated client is then given the stored pre-encrypted
138
password for that specific client.
122
client host computers. For an introduction, see
123
<citerefentry><refentrytitle>intro</refentrytitle>
124
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
uses Zeroconf to announce itself on the local network, and uses
126
TLS to communicate securely with and to authenticate the
127
clients. The Mandos server uses IPv6 to allow Mandos clients to
128
use IPv6 link-local addresses, since the clients will probably
129
not have any other addresses configured (see <xref
130
linkend="overview"/>). Any authenticated client is then given
131
the stored pre-encrypted password for that specific client.
143
135
<refsect1 id="purpose">
144
136
<title>PURPOSE</title>
147
138
The purpose of this is to enable <emphasis>remote and unattended
148
139
rebooting</emphasis> of client host computer with an
149
140
<emphasis>encrypted root file system</emphasis>. See <xref
150
141
linkend="overview"/> for details.
155
145
<refsect1 id="options">
156
146
<title>OPTIONS</title>
149
<term><option>--help</option></term>
160
150
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
153
Show a help message and exit
159
<term><option>--interface</option>
160
<replaceable>NAME</replaceable></term>
170
161
<term><option>-i</option>
171
162
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
164
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
169
<term><option>--address
170
<replaceable>ADDRESS</replaceable></option></term>
172
<replaceable>ADDRESS</replaceable></option></term>
183
174
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
180
<replaceable>PORT</replaceable></option></term>
182
<replaceable>PORT</replaceable></option></term>
191
184
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
189
<term><option>--check</option></term>
199
192
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
199
<term><option>--debug</option></term>
208
201
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
206
<term><option>--debuglevel
207
<replaceable>LEVEL</replaceable></option></term>
210
Set the debugging log level.
211
<replaceable>LEVEL</replaceable> is a string, one of
212
<quote><literal>CRITICAL</literal></quote>,
213
<quote><literal>ERROR</literal></quote>,
214
<quote><literal>WARNING</literal></quote>,
215
<quote><literal>INFO</literal></quote>, or
216
<quote><literal>DEBUG</literal></quote>, in order of
217
increasing verbosity. The default level is
218
<quote><literal>WARNING</literal></quote>.
224
<term><option>--priority <replaceable>
225
PRIORITY</replaceable></option></term>
216
227
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
232
<term><option>--servicename
233
<replaceable>NAME</replaceable></option></term>
224
235
<xi:include href="mandos-options.xml"
225
236
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
241
<term><option>--configdir
242
<replaceable>DIRECTORY</replaceable></option></term>
234
245
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
256
<term><option>--version</option></term>
248
259
Prints the program version and exit.
265
<term><option>--no-dbus</option></term>
267
<xi:include href="mandos-options.xml" xpointer="dbus"/>
269
See also <xref linkend="dbus_interface"/>.
275
<term><option>--no-ipv6</option></term>
277
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
<term><option>--no-restore</option></term>
284
<xi:include href="mandos-options.xml" xpointer="restore"/>
255
290
<refsect1 id="overview">
256
291
<title>OVERVIEW</title>
257
292
<xi:include href="overview.xml"/>
259
294
This program is the server part. It is a normal server program
260
295
and will run in a normal system environment, not in an initial
261
RAM disk environment.
296
<acronym>RAM</acronym> disk environment.
265
300
<refsect1 id="protocol">
266
301
<title>NETWORK PROTOCOL</title>
320
355
</tbody></tgroup></table>
323
358
<refsect1 id="checking">
324
359
<title>CHECKING</title>
326
361
The server will, by default, continually check that the clients
327
362
are still up. If a client has not been confirmed as being up
328
363
for some time, the client is assumed to be compromised and is no
329
longer eligible to receive the encrypted password. The timeout,
330
checker program, and interval between checks can be configured
331
both globally and per client; see <citerefentry>
364
longer eligible to receive the encrypted password. (Manual
365
intervention is required to re-enable a client.) The timeout,
366
extended timeout, checker program, and interval between checks
367
can be configured both globally and per client; see
368
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
<manvolnum>5</manvolnum></citerefentry>. A client successfully
370
receiving its password will also be treated as a successful
375
<refsect1 id="approval">
376
<title>APPROVAL</title>
378
The server can be configured to require manual approval for a
379
client before it is sent its secret. The delay to wait for such
380
approval and the default action (approve or deny) can be
381
configured both globally and per client; see <citerefentry>
332
382
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
383
<manvolnum>5</manvolnum></citerefentry>. By default all clients
384
will be approved immediately without delay.
387
This can be used to deny a client its secret if not manually
388
approved within a specified time. It can also be used to make
389
the server delay before giving a client its secret, allowing
390
optional manual denying of this specific client.
337
395
<refsect1 id="logging">
338
396
<title>LOGGING</title>
340
398
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
399
<filename class="devicefile">/dev/log</filename>. With the
342
400
<option>--debug</option> option, it will log even more messages,
343
401
and also show them on the console.
405
<refsect1 id="dbus_interface">
406
<title>D-BUS INTERFACE</title>
408
The server will by default provide a D-Bus system bus interface.
409
This interface will only be accessible by the root user or a
410
Mandos-specific user, if such a user exists. For documentation
411
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
415
<refsect1 id="exit_status">
348
416
<title>EXIT STATUS</title>
404
<term><filename>/var/run/mandos/mandos.pid</filename></term>
472
<term><filename>/var/run/mandos.pid</filename></term>
407
The file containing the process id of
408
<command>&COMMANDNAME;</command>.
475
The file containing the process id of the
476
<command>&COMMANDNAME;</command> process started last.
413
<term><filename>/dev/log</filename></term>
481
<term><filename class="devicefile">/dev/log</filename></term>
416
484
The Unix domain socket to where local syslog messages are
439
507
backtrace. This could be considered a feature.
442
Currently, if a client is declared <quote>invalid</quote> due to
443
having timed out, the server does not record this fact onto
444
permanent storage. This has some security implications, see
445
<xref linkend="CLIENTS"/>.
448
There is currently no way of querying the server of the current
449
status of clients, other than analyzing its <systemitem
450
class="service">syslog</systemitem> output.
510
Currently, if a client is disabled due to having timed out, the
511
server does not record this fact onto permanent storage. This
512
has some security implications, see <xref linkend="clients"/>.
453
515
There is no fine-grained control over logging and debug output.
533
596
If a client is compromised, its downtime should be duly noted
534
by the server which would therefore declare the client
535
invalid. But if the server was ever restarted, it would
536
re-read its client list from its configuration file and again
537
regard all clients therein as valid, and hence eligible to
538
receive their passwords. Therefore, be careful when
539
restarting servers if it is suspected that a client has, in
540
fact, been compromised by parties who may now be running a
541
fake Mandos client with the keys from the non-encrypted
542
initial RAM image of the client host. What should be done in
543
that case (if restarting the server program really is
544
necessary) is to stop the server program, edit the
545
configuration file to omit any suspect clients, and restart
597
by the server which would therefore disable the client. But
598
if the server was ever restarted, it would re-read its client
599
list from its configuration file and again regard all clients
600
therein as enabled, and hence eligible to receive their
601
passwords. Therefore, be careful when restarting servers if
602
it is suspected that a client has, in fact, been compromised
603
by parties who may now be running a fake Mandos client with
604
the keys from the non-encrypted initial <acronym>RAM</acronym>
605
image of the client host. What should be done in that case
606
(if restarting the server program really is necessary) is to
607
stop the server program, edit the configuration file to omit
608
any suspect clients, and restart the server program.
549
611
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
612
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
613
<manvolnum>8mandos</manvolnum></citerefentry>.
556
618
<refsect1 id="see_also">
557
619
<title>SEE ALSO</title>
560
<refentrytitle>mandos-clients.conf</refentrytitle>
561
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
<refentrytitle>mandos.conf</refentrytitle>
563
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
<refentrytitle>password-request</refentrytitle>
565
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
<citerefentry><refentrytitle>intro</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
<manvolnum>5</manvolnum></citerefentry>,
625
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
<manvolnum>5</manvolnum></citerefentry>,
627
<citerefentry><refentrytitle>mandos-client</refentrytitle>
628
<manvolnum>8mandos</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>sh</refentrytitle>
630
<manvolnum>1</manvolnum></citerefentry>