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 "2013-10-20">
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>
40
34
<holder>Teddy Hogeborn</holder>
41
35
<holder>Björn Påhlsson</holder>
43
<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/"/>.
47
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
48
64
<manvolnum>8</manvolnum>
89
105
<replaceable>DIRECTORY</replaceable></option></arg>
91
107
<arg><option>--debug</option></arg>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
96
<arg><option>--no-dbus</option></arg>
98
<arg><option>--no-ipv6</option></arg>
100
<arg><option>--no-restore</option></arg>
102
<arg><option>--statedir
103
<replaceable>DIRECTORY</replaceable></option></arg>
105
<arg><option>--socket
106
<replaceable>FD</replaceable></option></arg>
108
<arg><option>--foreground</option></arg>
111
110
<command>&COMMANDNAME;</command>
123
122
<arg choice="plain"><option>--check</option></arg>
125
124
</refsynopsisdiv>
127
126
<refsect1 id="description">
128
127
<title>DESCRIPTION</title>
130
129
<command>&COMMANDNAME;</command> is a server daemon which
131
130
handles incoming request for passwords for a pre-defined list of
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
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.
145
143
<refsect1 id="purpose">
146
144
<title>PURPOSE</title>
148
147
The purpose of this is to enable <emphasis>remote and unattended
149
148
rebooting</emphasis> of client host computer with an
150
149
<emphasis>encrypted root file system</emphasis>. See <xref
151
150
linkend="overview"/> for details.
155
155
<refsect1 id="options">
156
156
<title>OPTIONS</title>
160
<term><option>-h</option></term>
159
161
<term><option>--help</option></term>
160
<term><option>-h</option></term>
163
164
Show a help message and exit
170
<term><option>-i</option>
171
<replaceable>NAME</replaceable></term>
169
172
<term><option>--interface</option>
170
173
<replaceable>NAME</replaceable></term>
171
<term><option>-i</option>
172
<replaceable>NAME</replaceable></term>
174
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
179
<term><option>--address
180
<replaceable>ADDRESS</replaceable></option></term>
182
<replaceable>ADDRESS</replaceable></option></term>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
184
183
<xi:include href="mandos-options.xml" xpointer="address"/>
190
<replaceable>PORT</replaceable></option></term>
192
<replaceable>PORT</replaceable></option></term>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
194
191
<xi:include href="mandos-options.xml" xpointer="port"/>
199
<term><option>--check</option></term>
196
<term><literal>--check</literal></term>
202
199
Run the server’s self-tests. This includes any unit
209
<term><option>--debug</option></term>
206
<term><literal>--debug</literal></term>
211
208
<xi:include href="mandos-options.xml" xpointer="debug"/>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
234
<term><option>--priority <replaceable>
235
PRIORITY</replaceable></option></term>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
237
216
<xi:include href="mandos-options.xml" xpointer="priority"/>
242
<term><option>--servicename
243
<replaceable>NAME</replaceable></option></term>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
245
224
<xi:include href="mandos-options.xml"
246
225
xpointer="servicename"/>
251
<term><option>--configdir
252
<replaceable>DIRECTORY</replaceable></option></term>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
255
234
Directory to search for configuration files. Default is
266
<term><option>--version</option></term>
245
<term><literal>--version</literal></term>
269
248
Prints the program version and exit.
275
<term><option>--no-dbus</option></term>
277
<xi:include href="mandos-options.xml" xpointer="dbus"/>
279
See also <xref linkend="dbus_interface"/>.
285
<term><option>--no-ipv6</option></term>
287
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
<term><option>--no-restore</option></term>
294
<xi:include href="mandos-options.xml" xpointer="restore"/>
296
See also <xref linkend="persistent_state"/>.
302
<term><option>--statedir
303
<replaceable>DIRECTORY</replaceable></option></term>
305
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
<term><option>--socket
311
<replaceable>FD</replaceable></option></term>
313
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
<term><option>--foreground</option></term>
320
<xi:include href="mandos-options.xml"
321
xpointer="foreground"/>
328
255
<refsect1 id="overview">
329
256
<title>OVERVIEW</title>
330
257
<xi:include href="overview.xml"/>
332
259
This program is the server part. It is a normal server program
333
260
and will run in a normal system environment, not in an initial
334
<acronym>RAM</acronym> disk environment.
261
RAM disk environment.
338
265
<refsect1 id="protocol">
339
266
<title>NETWORK PROTOCOL</title>
393
320
</tbody></tgroup></table>
396
323
<refsect1 id="checking">
397
324
<title>CHECKING</title>
399
326
The server will, by default, continually check that the clients
400
327
are still up. If a client has not been confirmed as being up
401
328
for some time, the client is assumed to be compromised and is no
402
longer eligible to receive the encrypted password. (Manual
403
intervention is required to re-enable a client.) The timeout,
404
extended timeout, checker program, and interval between checks
405
can be configured both globally and per client; see
406
<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>
407
333
<manvolnum>5</manvolnum></citerefentry>.
411
<refsect1 id="approval">
412
<title>APPROVAL</title>
414
The server can be configured to require manual approval for a
415
client before it is sent its secret. The delay to wait for such
416
approval and the default action (approve or deny) can be
417
configured both globally and per client; see <citerefentry>
418
<refentrytitle>mandos-clients.conf</refentrytitle>
419
<manvolnum>5</manvolnum></citerefentry>. By default all clients
420
will be approved immediately without delay.
423
This can be used to deny a client its secret if not manually
424
approved within a specified time. It can also be used to make
425
the server delay before giving a client its secret, allowing
426
optional manual denying of this specific client.
431
337
<refsect1 id="logging">
432
338
<title>LOGGING</title>
434
340
The server will send log message with various severity levels to
435
<filename class="devicefile">/dev/log</filename>. With the
341
<filename>/dev/log</filename>. With the
436
342
<option>--debug</option> option, it will log even more messages,
437
343
and also show them on the console.
441
<refsect1 id="persistent_state">
442
<title>PERSISTENT STATE</title>
444
Client settings, initially read from
445
<filename>clients.conf</filename>, are persistent across
446
restarts, and run-time changes will override settings in
447
<filename>clients.conf</filename>. However, if a setting is
448
<emphasis>changed</emphasis> (or a client added, or removed) in
449
<filename>clients.conf</filename>, this will take precedence.
453
<refsect1 id="dbus_interface">
454
<title>D-BUS INTERFACE</title>
456
The server will by default provide a D-Bus system bus interface.
457
This interface will only be accessible by the root user or a
458
Mandos-specific user, if such a user exists. For documentation
459
of the D-Bus API, see the file <filename>DBUS-API</filename>.
463
347
<refsect1 id="exit_status">
464
348
<title>EXIT STATUS</title>
520
<term><filename>/run/mandos.pid</filename></term>
523
The file containing the process id of the
524
<command>&COMMANDNAME;</command> process started last.
529
<term><filename class="devicefile">/dev/log</filename></term>
533
class="directory">/var/lib/mandos</filename></term>
536
Directory where persistent state will be saved. Change
537
this with the <option>--statedir</option> option. See
538
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>.
569
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.
572
453
There is no fine-grained control over logging and debug output.
575
This server does not check the expire time of clients’ OpenPGP
456
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
590
473
<informalexample>
592
475
Run the server in debug mode, read configuration files from
593
the <filename class="directory">~/mandos</filename> directory,
594
and use the Zeroconf service name <quote>Test</quote> to not
595
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:
647
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
650
549
For more details on client-side security, see
651
<citerefentry><refentrytitle>mandos-client</refentrytitle>
550
<citerefentry><refentrytitle>password-request</refentrytitle>
652
551
<manvolnum>8mandos</manvolnum></citerefentry>.
657
556
<refsect1 id="see_also">
658
557
<title>SEE ALSO</title>
660
<citerefentry><refentrytitle>intro</refentrytitle>
661
<manvolnum>8mandos</manvolnum></citerefentry>,
662
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
663
<manvolnum>5</manvolnum></citerefentry>,
664
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
665
<manvolnum>5</manvolnum></citerefentry>,
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
667
<manvolnum>8mandos</manvolnum></citerefentry>,
668
<citerefentry><refentrytitle>sh</refentrytitle>
669
<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>