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 "2012-01-01">
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
39
<holder>Teddy Hogeborn</holder>
35
40
<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/"/>.
42
<xi:include href="legalnotice.xml"/>
63
46
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
47
<manvolnum>8</manvolnum>
105
88
<replaceable>DIRECTORY</replaceable></option></arg>
107
90
<arg><option>--debug</option></arg>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
95
<arg><option>--no-dbus</option></arg>
97
<arg><option>--no-ipv6</option></arg>
99
<arg><option>--no-restore</option></arg>
101
<arg><option>--statedir
102
<replaceable>DIRECTORY</replaceable></option></arg>
110
105
<command>&COMMANDNAME;</command>
122
117
<arg choice="plain"><option>--check</option></arg>
124
119
</refsynopsisdiv>
126
121
<refsect1 id="description">
127
122
<title>DESCRIPTION</title>
129
124
<command>&COMMANDNAME;</command> is a server daemon which
130
125
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.
126
client host computers. For an introduction, see
127
<citerefentry><refentrytitle>intro</refentrytitle>
128
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
uses Zeroconf to announce itself on the local network, and uses
130
TLS to communicate securely with and to authenticate the
131
clients. The Mandos server uses IPv6 to allow Mandos clients to
132
use IPv6 link-local addresses, since the clients will probably
133
not have any other addresses configured (see <xref
134
linkend="overview"/>). Any authenticated client is then given
135
the stored pre-encrypted password for that specific client.
143
139
<refsect1 id="purpose">
144
140
<title>PURPOSE</title>
147
142
The purpose of this is to enable <emphasis>remote and unattended
148
143
rebooting</emphasis> of client host computer with an
149
144
<emphasis>encrypted root file system</emphasis>. See <xref
150
145
linkend="overview"/> for details.
155
149
<refsect1 id="options">
156
150
<title>OPTIONS</title>
153
<term><option>--help</option></term>
160
154
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
157
Show a help message and exit
163
<term><option>--interface</option>
164
<replaceable>NAME</replaceable></term>
170
165
<term><option>-i</option>
171
166
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
168
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
173
<term><option>--address
174
<replaceable>ADDRESS</replaceable></option></term>
176
<replaceable>ADDRESS</replaceable></option></term>
183
178
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
184
<replaceable>PORT</replaceable></option></term>
186
<replaceable>PORT</replaceable></option></term>
191
188
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
193
<term><option>--check</option></term>
199
196
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
203
<term><option>--debug</option></term>
208
205
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
210
<term><option>--debuglevel
211
<replaceable>LEVEL</replaceable></option></term>
214
Set the debugging log level.
215
<replaceable>LEVEL</replaceable> is a string, one of
216
<quote><literal>CRITICAL</literal></quote>,
217
<quote><literal>ERROR</literal></quote>,
218
<quote><literal>WARNING</literal></quote>,
219
<quote><literal>INFO</literal></quote>, or
220
<quote><literal>DEBUG</literal></quote>, in order of
221
increasing verbosity. The default level is
222
<quote><literal>WARNING</literal></quote>.
228
<term><option>--priority <replaceable>
229
PRIORITY</replaceable></option></term>
216
231
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
236
<term><option>--servicename
237
<replaceable>NAME</replaceable></option></term>
224
239
<xi:include href="mandos-options.xml"
225
240
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
245
<term><option>--configdir
246
<replaceable>DIRECTORY</replaceable></option></term>
234
249
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
260
<term><option>--version</option></term>
248
263
Prints the program version and exit.
269
<term><option>--no-dbus</option></term>
271
<xi:include href="mandos-options.xml" xpointer="dbus"/>
273
See also <xref linkend="dbus_interface"/>.
279
<term><option>--no-ipv6</option></term>
281
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
286
<term><option>--no-restore</option></term>
288
<xi:include href="mandos-options.xml" xpointer="restore"/>
290
See also <xref linkend="persistent_state"/>.
296
<term><option>--statedir
297
<replaceable>DIRECTORY</replaceable></option></term>
299
<xi:include href="mandos-options.xml" xpointer="statedir"/>
255
305
<refsect1 id="overview">
256
306
<title>OVERVIEW</title>
257
307
<xi:include href="overview.xml"/>
259
309
This program is the server part. It is a normal server program
260
310
and will run in a normal system environment, not in an initial
261
RAM disk environment.
311
<acronym>RAM</acronym> disk environment.
265
315
<refsect1 id="protocol">
266
316
<title>NETWORK PROTOCOL</title>
320
370
</tbody></tgroup></table>
323
373
<refsect1 id="checking">
324
374
<title>CHECKING</title>
326
376
The server will, by default, continually check that the clients
327
377
are still up. If a client has not been confirmed as being up
328
378
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>
379
longer eligible to receive the encrypted password. (Manual
380
intervention is required to re-enable a client.) The timeout,
381
extended timeout, checker program, and interval between checks
382
can be configured both globally and per client; see
383
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
<manvolnum>5</manvolnum></citerefentry>. A client successfully
385
receiving its password will also be treated as a successful
390
<refsect1 id="approval">
391
<title>APPROVAL</title>
393
The server can be configured to require manual approval for a
394
client before it is sent its secret. The delay to wait for such
395
approval and the default action (approve or deny) can be
396
configured both globally and per client; see <citerefentry>
332
397
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
398
<manvolnum>5</manvolnum></citerefentry>. By default all clients
399
will be approved immediately without delay.
402
This can be used to deny a client its secret if not manually
403
approved within a specified time. It can also be used to make
404
the server delay before giving a client its secret, allowing
405
optional manual denying of this specific client.
337
410
<refsect1 id="logging">
338
411
<title>LOGGING</title>
340
413
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
414
<filename class="devicefile">/dev/log</filename>. With the
342
415
<option>--debug</option> option, it will log even more messages,
343
416
and also show them on the console.
420
<refsect1 id="persistent_state">
421
<title>PERSISTENT STATE</title>
423
Client settings, initially read from
424
<filename>clients.conf</filename>, are persistent across
425
restarts, and run-time changes will override settings in
426
<filename>clients.conf</filename>. However, if a setting is
427
<emphasis>changed</emphasis> (or a client added, or removed) in
428
<filename>clients.conf</filename>, this will take precedence.
432
<refsect1 id="dbus_interface">
433
<title>D-BUS INTERFACE</title>
435
The server will by default provide a D-Bus system bus interface.
436
This interface will only be accessible by the root user or a
437
Mandos-specific user, if such a user exists. For documentation
438
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
442
<refsect1 id="exit_status">
348
443
<title>EXIT STATUS</title>
404
<term><filename>/var/run/mandos/mandos.pid</filename></term>
407
The file containing the process id of
408
<command>&COMMANDNAME;</command>.
499
<term><filename>/var/run/mandos.pid</filename></term>
502
The file containing the process id of the
503
<command>&COMMANDNAME;</command> process started last.
508
<term><filename class="devicefile">/dev/log</filename></term>
512
class="directory">/var/lib/mandos</filename></term>
515
Directory where persistent state will be saved. Change
516
this with the <option>--statedir</option> option. See
517
also the <option>--no-restore</option> option.
439
548
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.
453
551
There is no fine-grained control over logging and debug output.
456
554
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
557
This server does not check the expire time of clients’ OpenPGP
473
572
<informalexample>
475
574
Run the server in debug mode, read configuration files from
476
the <filename>~/mandos</filename> directory, and use the
477
Zeroconf service name <quote>Test</quote> to not collide with
478
any other official Mandos server on this host:
575
the <filename class="directory">~/mandos</filename> directory,
576
and use the Zeroconf service name <quote>Test</quote> to not
577
collide with any other official Mandos server on this host:
530
629
compromised if they are gone for too long.
533
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
549
632
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
634
<manvolnum>8mandos</manvolnum></citerefentry>.
556
639
<refsect1 id="see_also">
557
640
<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>
642
<citerefentry><refentrytitle>intro</refentrytitle>
643
<manvolnum>8mandos</manvolnum></citerefentry>,
644
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
<manvolnum>5</manvolnum></citerefentry>,
646
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
647
<manvolnum>5</manvolnum></citerefentry>,
648
<citerefentry><refentrytitle>mandos-client</refentrytitle>
649
<manvolnum>8mandos</manvolnum></citerefentry>,
650
<citerefentry><refentrytitle>sh</refentrytitle>
651
<manvolnum>1</manvolnum></citerefentry>