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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2012-05-26">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-31">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
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>
39
34
<holder>Teddy Hogeborn</holder>
40
35
<holder>Björn Påhlsson</holder>
42
<xi:include href="legalnotice.xml"/>
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/"/>.
46
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
47
64
<manvolnum>8</manvolnum>
88
105
<replaceable>DIRECTORY</replaceable></option></arg>
90
107
<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>
104
<arg><option>--socket
105
<replaceable>FD</replaceable></option></arg>
108
110
<command>&COMMANDNAME;</command>
120
122
<arg choice="plain"><option>--check</option></arg>
122
124
</refsynopsisdiv>
124
126
<refsect1 id="description">
125
127
<title>DESCRIPTION</title>
127
129
<command>&COMMANDNAME;</command> is a server daemon which
128
130
handles incoming request for passwords for a pre-defined list of
129
client host computers. For an introduction, see
130
<citerefentry><refentrytitle>intro</refentrytitle>
131
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
uses Zeroconf to announce itself on the local network, and uses
133
TLS to communicate securely with and to authenticate the
134
clients. The Mandos server uses IPv6 to allow Mandos clients to
135
use IPv6 link-local addresses, since the clients will probably
136
not have any other addresses configured (see <xref
137
linkend="overview"/>). Any authenticated client is then given
138
the stored pre-encrypted password for that specific client.
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.
142
143
<refsect1 id="purpose">
143
144
<title>PURPOSE</title>
145
147
The purpose of this is to enable <emphasis>remote and unattended
146
148
rebooting</emphasis> of client host computer with an
147
149
<emphasis>encrypted root file system</emphasis>. See <xref
148
150
linkend="overview"/> for details.
152
155
<refsect1 id="options">
153
156
<title>OPTIONS</title>
160
<term><option>-h</option></term>
156
161
<term><option>--help</option></term>
157
<term><option>-h</option></term>
160
164
Show a help message and exit
170
<term><option>-i</option>
171
<replaceable>NAME</replaceable></term>
166
172
<term><option>--interface</option>
167
173
<replaceable>NAME</replaceable></term>
168
<term><option>-i</option>
169
<replaceable>NAME</replaceable></term>
171
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
176
<term><option>--address
177
<replaceable>ADDRESS</replaceable></option></term>
179
<replaceable>ADDRESS</replaceable></option></term>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
181
183
<xi:include href="mandos-options.xml" xpointer="address"/>
187
<replaceable>PORT</replaceable></option></term>
189
<replaceable>PORT</replaceable></option></term>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
191
191
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><option>--check</option></term>
196
<term><literal>--check</literal></term>
199
199
Run the server’s self-tests. This includes any unit
206
<term><option>--debug</option></term>
206
<term><literal>--debug</literal></term>
208
208
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><option>--debuglevel
214
<replaceable>LEVEL</replaceable></option></term>
217
Set the debugging log level.
218
<replaceable>LEVEL</replaceable> is a string, one of
219
<quote><literal>CRITICAL</literal></quote>,
220
<quote><literal>ERROR</literal></quote>,
221
<quote><literal>WARNING</literal></quote>,
222
<quote><literal>INFO</literal></quote>, or
223
<quote><literal>DEBUG</literal></quote>, in order of
224
increasing verbosity. The default level is
225
<quote><literal>WARNING</literal></quote>.
231
<term><option>--priority <replaceable>
232
PRIORITY</replaceable></option></term>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
234
216
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<term><option>--servicename
240
<replaceable>NAME</replaceable></option></term>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
242
224
<xi:include href="mandos-options.xml"
243
225
xpointer="servicename"/>
248
<term><option>--configdir
249
<replaceable>DIRECTORY</replaceable></option></term>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
252
234
Directory to search for configuration files. Default is
263
<term><option>--version</option></term>
245
<term><literal>--version</literal></term>
266
248
Prints the program version and exit.
272
<term><option>--no-dbus</option></term>
274
<xi:include href="mandos-options.xml" xpointer="dbus"/>
276
See also <xref linkend="dbus_interface"/>.
282
<term><option>--no-ipv6</option></term>
284
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
<term><option>--no-restore</option></term>
291
<xi:include href="mandos-options.xml" xpointer="restore"/>
293
See also <xref linkend="persistent_state"/>.
299
<term><option>--statedir
300
<replaceable>DIRECTORY</replaceable></option></term>
302
<xi:include href="mandos-options.xml" xpointer="statedir"/>
307
<term><option>--socket
308
<replaceable>FD</replaceable></option></term>
310
<xi:include href="mandos-options.xml" xpointer="socket"/>
317
255
<refsect1 id="overview">
318
256
<title>OVERVIEW</title>
319
257
<xi:include href="overview.xml"/>
321
259
This program is the server part. It is a normal server program
322
260
and will run in a normal system environment, not in an initial
323
<acronym>RAM</acronym> disk environment.
261
RAM disk environment.
327
265
<refsect1 id="protocol">
328
266
<title>NETWORK PROTOCOL</title>
382
320
</tbody></tgroup></table>
385
323
<refsect1 id="checking">
386
324
<title>CHECKING</title>
388
326
The server will, by default, continually check that the clients
389
327
are still up. If a client has not been confirmed as being up
390
328
for some time, the client is assumed to be compromised and is no
391
longer eligible to receive the encrypted password. (Manual
392
intervention is required to re-enable a client.) The timeout,
393
extended timeout, checker program, and interval between checks
394
can be configured both globally and per client; see
395
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
332
<refentrytitle>mandos-clients.conf</refentrytitle>
396
333
<manvolnum>5</manvolnum></citerefentry>.
400
<refsect1 id="approval">
401
<title>APPROVAL</title>
403
The server can be configured to require manual approval for a
404
client before it is sent its secret. The delay to wait for such
405
approval and the default action (approve or deny) can be
406
configured both globally and per client; see <citerefentry>
407
<refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>. By default all clients
409
will be approved immediately without delay.
412
This can be used to deny a client its secret if not manually
413
approved within a specified time. It can also be used to make
414
the server delay before giving a client its secret, allowing
415
optional manual denying of this specific client.
420
337
<refsect1 id="logging">
421
338
<title>LOGGING</title>
423
340
The server will send log message with various severity levels to
424
<filename class="devicefile">/dev/log</filename>. With the
341
<filename>/dev/log</filename>. With the
425
342
<option>--debug</option> option, it will log even more messages,
426
343
and also show them on the console.
430
<refsect1 id="persistent_state">
431
<title>PERSISTENT STATE</title>
433
Client settings, initially read from
434
<filename>clients.conf</filename>, are persistent across
435
restarts, and run-time changes will override settings in
436
<filename>clients.conf</filename>. However, if a setting is
437
<emphasis>changed</emphasis> (or a client added, or removed) in
438
<filename>clients.conf</filename>, this will take precedence.
442
<refsect1 id="dbus_interface">
443
<title>D-BUS INTERFACE</title>
445
The server will by default provide a D-Bus system bus interface.
446
This interface will only be accessible by the root user or a
447
Mandos-specific user, if such a user exists. For documentation
448
of the D-Bus API, see the file <filename>DBUS-API</filename>.
452
347
<refsect1 id="exit_status">
453
348
<title>EXIT STATUS</title>
509
<term><filename>/var/run/mandos.pid</filename></term>
512
The file containing the process id of the
513
<command>&COMMANDNAME;</command> process started last.
518
<term><filename class="devicefile">/dev/log</filename></term>
522
class="directory">/var/lib/mandos</filename></term>
525
Directory where persistent state will be saved. Change
526
this with the <option>--statedir</option> option. See
527
also the <option>--no-restore</option> option.
404
<term><filename>/var/run/mandos/mandos.pid</filename></term>
407
The file containing the process id of
408
<command>&COMMANDNAME;</command>.
558
439
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.
561
453
There is no fine-grained control over logging and debug output.
564
456
Debug mode is conflated with running in the foreground.
567
This server does not check the expire time of clients’ OpenPGP
459
The console log messages does not show a timestamp.
582
473
<informalexample>
584
475
Run the server in debug mode, read configuration files from
585
the <filename class="directory">~/mandos</filename> directory,
586
and use the Zeroconf service name <quote>Test</quote> to not
587
collide with any other official Mandos server on this host:
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:
639
530
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
642
549
For more details on client-side security, see
643
<citerefentry><refentrytitle>mandos-client</refentrytitle>
550
<citerefentry><refentrytitle>password-request</refentrytitle>
644
551
<manvolnum>8mandos</manvolnum></citerefentry>.
649
556
<refsect1 id="see_also">
650
557
<title>SEE ALSO</title>
652
<citerefentry><refentrytitle>intro</refentrytitle>
653
<manvolnum>8mandos</manvolnum></citerefentry>,
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
<manvolnum>5</manvolnum></citerefentry>,
656
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
<manvolnum>5</manvolnum></citerefentry>,
658
<citerefentry><refentrytitle>mandos-client</refentrytitle>
659
<manvolnum>8mandos</manvolnum></citerefentry>,
660
<citerefentry><refentrytitle>sh</refentrytitle>
661
<manvolnum>1</manvolnum></citerefentry>
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>