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 "2017-02-23">
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
44
<holder>Teddy Hogeborn</holder>
35
45
<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/"/>.
47
<xi:include href="legalnotice.xml"/>
63
51
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
52
<manvolnum>8</manvolnum>
105
93
<replaceable>DIRECTORY</replaceable></option></arg>
107
95
<arg><option>--debug</option></arg>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
100
<arg><option>--no-dbus</option></arg>
102
<arg><option>--no-ipv6</option></arg>
104
<arg><option>--no-restore</option></arg>
106
<arg><option>--statedir
107
<replaceable>DIRECTORY</replaceable></option></arg>
109
<arg><option>--socket
110
<replaceable>FD</replaceable></option></arg>
112
<arg><option>--foreground</option></arg>
114
<arg><option>--no-zeroconf</option></arg>
110
117
<command>&COMMANDNAME;</command>
122
129
<arg choice="plain"><option>--check</option></arg>
124
131
</refsynopsisdiv>
126
133
<refsect1 id="description">
127
134
<title>DESCRIPTION</title>
129
136
<command>&COMMANDNAME;</command> is a server daemon which
130
137
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.
138
client host computers. For an introduction, see
139
<citerefentry><refentrytitle>intro</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
uses Zeroconf to announce itself on the local network, and uses
142
TLS to communicate securely with and to authenticate the
143
clients. The Mandos server uses IPv6 to allow Mandos clients to
144
use IPv6 link-local addresses, since the clients will probably
145
not have any other addresses configured (see <xref
146
linkend="overview"/>). Any authenticated client is then given
147
the stored pre-encrypted password for that specific client.
143
151
<refsect1 id="purpose">
144
152
<title>PURPOSE</title>
147
154
The purpose of this is to enable <emphasis>remote and unattended
148
155
rebooting</emphasis> of client host computer with an
149
156
<emphasis>encrypted root file system</emphasis>. See <xref
150
157
linkend="overview"/> for details.
155
161
<refsect1 id="options">
156
162
<title>OPTIONS</title>
165
<term><option>--help</option></term>
160
166
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
169
Show a help message and exit
175
<term><option>--interface</option>
176
<replaceable>NAME</replaceable></term>
170
177
<term><option>-i</option>
171
178
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
180
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
185
<term><option>--address
186
<replaceable>ADDRESS</replaceable></option></term>
188
<replaceable>ADDRESS</replaceable></option></term>
183
190
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
196
<replaceable>PORT</replaceable></option></term>
198
<replaceable>PORT</replaceable></option></term>
191
200
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
205
<term><option>--check</option></term>
199
208
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
215
<term><option>--debug</option></term>
208
217
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
222
<term><option>--debuglevel
223
<replaceable>LEVEL</replaceable></option></term>
226
Set the debugging log level.
227
<replaceable>LEVEL</replaceable> is a string, one of
228
<quote><literal>CRITICAL</literal></quote>,
229
<quote><literal>ERROR</literal></quote>,
230
<quote><literal>WARNING</literal></quote>,
231
<quote><literal>INFO</literal></quote>, or
232
<quote><literal>DEBUG</literal></quote>, in order of
233
increasing verbosity. The default level is
234
<quote><literal>WARNING</literal></quote>.
240
<term><option>--priority <replaceable>
241
PRIORITY</replaceable></option></term>
216
243
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
248
<term><option>--servicename
249
<replaceable>NAME</replaceable></option></term>
224
251
<xi:include href="mandos-options.xml"
225
252
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
257
<term><option>--configdir
258
<replaceable>DIRECTORY</replaceable></option></term>
234
261
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
272
<term><option>--version</option></term>
248
275
Prints the program version and exit.
281
<term><option>--no-dbus</option></term>
283
<xi:include href="mandos-options.xml" xpointer="dbus"/>
285
See also <xref linkend="dbus_interface"/>.
291
<term><option>--no-ipv6</option></term>
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
298
<term><option>--no-restore</option></term>
300
<xi:include href="mandos-options.xml" xpointer="restore"/>
302
See also <xref linkend="persistent_state"/>.
308
<term><option>--statedir
309
<replaceable>DIRECTORY</replaceable></option></term>
311
<xi:include href="mandos-options.xml" xpointer="statedir"/>
316
<term><option>--socket
317
<replaceable>FD</replaceable></option></term>
319
<xi:include href="mandos-options.xml" xpointer="socket"/>
324
<term><option>--foreground</option></term>
326
<xi:include href="mandos-options.xml"
327
xpointer="foreground"/>
332
<term><option>--no-zeroconf</option></term>
334
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
255
341
<refsect1 id="overview">
256
342
<title>OVERVIEW</title>
257
343
<xi:include href="overview.xml"/>
259
345
This program is the server part. It is a normal server program
260
346
and will run in a normal system environment, not in an initial
261
RAM disk environment.
347
<acronym>RAM</acronym> disk environment.
265
351
<refsect1 id="protocol">
266
352
<title>NETWORK PROTOCOL</title>
320
406
</tbody></tgroup></table>
323
409
<refsect1 id="checking">
324
410
<title>CHECKING</title>
326
412
The server will, by default, continually check that the clients
327
413
are still up. If a client has not been confirmed as being up
328
414
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>
415
longer eligible to receive the encrypted password. (Manual
416
intervention is required to re-enable a client.) The timeout,
417
extended timeout, checker program, and interval between checks
418
can be configured both globally and per client; see
419
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
420
<manvolnum>5</manvolnum></citerefentry>.
424
<refsect1 id="approval">
425
<title>APPROVAL</title>
427
The server can be configured to require manual approval for a
428
client before it is sent its secret. The delay to wait for such
429
approval and the default action (approve or deny) can be
430
configured both globally and per client; see <citerefentry>
332
431
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
432
<manvolnum>5</manvolnum></citerefentry>. By default all clients
433
will be approved immediately without delay.
436
This can be used to deny a client its secret if not manually
437
approved within a specified time. It can also be used to make
438
the server delay before giving a client its secret, allowing
439
optional manual denying of this specific client.
337
444
<refsect1 id="logging">
338
445
<title>LOGGING</title>
340
447
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
448
<filename class="devicefile">/dev/log</filename>. With the
342
449
<option>--debug</option> option, it will log even more messages,
343
450
and also show them on the console.
454
<refsect1 id="persistent_state">
455
<title>PERSISTENT STATE</title>
457
Client settings, initially read from
458
<filename>clients.conf</filename>, are persistent across
459
restarts, and run-time changes will override settings in
460
<filename>clients.conf</filename>. However, if a setting is
461
<emphasis>changed</emphasis> (or a client added, or removed) in
462
<filename>clients.conf</filename>, this will take precedence.
466
<refsect1 id="dbus_interface">
467
<title>D-BUS INTERFACE</title>
469
The server will by default provide a D-Bus system bus interface.
470
This interface will only be accessible by the root user or a
471
Mandos-specific user, if such a user exists. For documentation
472
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
476
<refsect1 id="exit_status">
348
477
<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>.
413
<term><filename>/dev/log</filename></term>
533
<term><filename>/run/mandos.pid</filename></term>
536
The file containing the process id of the
537
<command>&COMMANDNAME;</command> process started last.
538
<emphasis >Note:</emphasis> If the <filename
539
class="directory">/run</filename> directory does not
540
exist, <filename>/var/run/mandos.pid</filename> will be
547
class="directory">/var/lib/mandos</filename></term>
550
Directory where persistent state will be saved. Change
551
this with the <option>--statedir</option> option. See
552
also the <option>--no-restore</option> option.
557
<term><filename class="devicefile">/dev/log</filename></term>
416
560
The Unix domain socket to where local syslog messages are
439
583
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
586
There is no fine-grained control over logging and debug output.
456
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
589
This server does not check the expire time of clients’ OpenPGP
592
<xi:include href="bugs.xml"/>
463
595
<refsect1 id="example">
473
605
<informalexample>
475
607
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:
608
the <filename class="directory">~/mandos</filename> directory,
609
and use the Zeroconf service name <quote>Test</quote> to not
610
collide with any other official Mandos server on this host:
530
662
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
665
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
667
<manvolnum>8mandos</manvolnum></citerefentry>.
556
672
<refsect1 id="see_also">
557
673
<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>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>mandos-client</refentrytitle>
682
<manvolnum>8mandos</manvolnum></citerefentry>,
683
<citerefentry><refentrytitle>sh</refentrytitle>
684
<manvolnum>1</manvolnum></citerefentry>