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 "2016-03-05">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-30">
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>
43
34
<holder>Teddy Hogeborn</holder>
44
35
<holder>Björn Påhlsson</holder>
46
<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/"/>.
50
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
51
64
<manvolnum>8</manvolnum>
92
105
<replaceable>DIRECTORY</replaceable></option></arg>
94
107
<arg><option>--debug</option></arg>
96
<arg><option>--debuglevel
97
<replaceable>LEVEL</replaceable></option></arg>
99
<arg><option>--no-dbus</option></arg>
101
<arg><option>--no-ipv6</option></arg>
103
<arg><option>--no-restore</option></arg>
105
<arg><option>--statedir
106
<replaceable>DIRECTORY</replaceable></option></arg>
108
<arg><option>--socket
109
<replaceable>FD</replaceable></option></arg>
111
<arg><option>--foreground</option></arg>
113
<arg><option>--no-zeroconf</option></arg>
116
110
<command>&COMMANDNAME;</command>
117
111
<group choice="req">
112
<arg choice="plain"><option>-h</option></arg>
118
113
<arg choice="plain"><option>--help</option></arg>
119
<arg choice="plain"><option>-h</option></arg>
128
122
<arg choice="plain"><option>--check</option></arg>
130
124
</refsynopsisdiv>
132
126
<refsect1 id="description">
133
127
<title>DESCRIPTION</title>
135
129
<command>&COMMANDNAME;</command> is a server daemon which
136
130
handles incoming request for passwords for a pre-defined list of
137
client host computers. For an introduction, see
138
<citerefentry><refentrytitle>intro</refentrytitle>
139
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
uses Zeroconf to announce itself on the local network, and uses
141
TLS to communicate securely with and to authenticate the
142
clients. The Mandos server uses IPv6 to allow Mandos clients to
143
use IPv6 link-local addresses, since the clients will probably
144
not have any other addresses configured (see <xref
145
linkend="overview"/>). Any authenticated client is then given
146
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.
150
143
<refsect1 id="purpose">
151
144
<title>PURPOSE</title>
153
147
The purpose of this is to enable <emphasis>remote and unattended
154
148
rebooting</emphasis> of client host computer with an
155
149
<emphasis>encrypted root file system</emphasis>. See <xref
156
150
linkend="overview"/> for details.
160
155
<refsect1 id="options">
161
156
<title>OPTIONS</title>
160
<term><option>-h</option></term>
164
161
<term><option>--help</option></term>
165
<term><option>-h</option></term>
168
164
Show a help message and exit
170
<term><option>-i</option>
171
<replaceable>NAME</replaceable></term>
174
172
<term><option>--interface</option>
175
173
<replaceable>NAME</replaceable></term>
176
<term><option>-i</option>
177
<replaceable>NAME</replaceable></term>
179
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
184
<term><option>--address
185
<replaceable>ADDRESS</replaceable></option></term>
187
<replaceable>ADDRESS</replaceable></option></term>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
189
183
<xi:include href="mandos-options.xml" xpointer="address"/>
195
<replaceable>PORT</replaceable></option></term>
197
<replaceable>PORT</replaceable></option></term>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
199
191
<xi:include href="mandos-options.xml" xpointer="port"/>
204
<term><option>--check</option></term>
196
<term><literal>--check</literal></term>
207
199
Run the server’s self-tests. This includes any unit
214
<term><option>--debug</option></term>
206
<term><literal>--debug</literal></term>
216
208
<xi:include href="mandos-options.xml" xpointer="debug"/>
221
<term><option>--debuglevel
222
<replaceable>LEVEL</replaceable></option></term>
225
Set the debugging log level.
226
<replaceable>LEVEL</replaceable> is a string, one of
227
<quote><literal>CRITICAL</literal></quote>,
228
<quote><literal>ERROR</literal></quote>,
229
<quote><literal>WARNING</literal></quote>,
230
<quote><literal>INFO</literal></quote>, or
231
<quote><literal>DEBUG</literal></quote>, in order of
232
increasing verbosity. The default level is
233
<quote><literal>WARNING</literal></quote>.
239
<term><option>--priority <replaceable>
240
PRIORITY</replaceable></option></term>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
242
216
<xi:include href="mandos-options.xml" xpointer="priority"/>
247
<term><option>--servicename
248
<replaceable>NAME</replaceable></option></term>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
250
224
<xi:include href="mandos-options.xml"
251
225
xpointer="servicename"/>
256
<term><option>--configdir
257
<replaceable>DIRECTORY</replaceable></option></term>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
260
234
Directory to search for configuration files. Default is
271
<term><option>--version</option></term>
245
<term><literal>--version</literal></term>
274
248
Prints the program version and exit.
280
<term><option>--no-dbus</option></term>
282
<xi:include href="mandos-options.xml" xpointer="dbus"/>
284
See also <xref linkend="dbus_interface"/>.
290
<term><option>--no-ipv6</option></term>
292
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
297
<term><option>--no-restore</option></term>
299
<xi:include href="mandos-options.xml" xpointer="restore"/>
301
See also <xref linkend="persistent_state"/>.
307
<term><option>--statedir
308
<replaceable>DIRECTORY</replaceable></option></term>
310
<xi:include href="mandos-options.xml" xpointer="statedir"/>
315
<term><option>--socket
316
<replaceable>FD</replaceable></option></term>
318
<xi:include href="mandos-options.xml" xpointer="socket"/>
323
<term><option>--foreground</option></term>
325
<xi:include href="mandos-options.xml"
326
xpointer="foreground"/>
331
<term><option>--no-zeroconf</option></term>
333
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
340
255
<refsect1 id="overview">
341
256
<title>OVERVIEW</title>
342
257
<xi:include href="overview.xml"/>
344
259
This program is the server part. It is a normal server program
345
260
and will run in a normal system environment, not in an initial
346
<acronym>RAM</acronym> disk environment.
261
RAM disk environment.
350
265
<refsect1 id="protocol">
351
266
<title>NETWORK PROTOCOL</title>
405
320
</tbody></tgroup></table>
408
323
<refsect1 id="checking">
409
324
<title>CHECKING</title>
411
326
The server will, by default, continually check that the clients
412
327
are still up. If a client has not been confirmed as being up
413
328
for some time, the client is assumed to be compromised and is no
414
longer eligible to receive the encrypted password. (Manual
415
intervention is required to re-enable a client.) The timeout,
416
extended timeout, checker program, and interval between checks
417
can be configured both globally and per client; see
418
<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>
419
333
<manvolnum>5</manvolnum></citerefentry>.
423
<refsect1 id="approval">
424
<title>APPROVAL</title>
426
The server can be configured to require manual approval for a
427
client before it is sent its secret. The delay to wait for such
428
approval and the default action (approve or deny) can be
429
configured both globally and per client; see <citerefentry>
430
<refentrytitle>mandos-clients.conf</refentrytitle>
431
<manvolnum>5</manvolnum></citerefentry>. By default all clients
432
will be approved immediately without delay.
435
This can be used to deny a client its secret if not manually
436
approved within a specified time. It can also be used to make
437
the server delay before giving a client its secret, allowing
438
optional manual denying of this specific client.
443
337
<refsect1 id="logging">
444
338
<title>LOGGING</title>
446
340
The server will send log message with various severity levels to
447
<filename class="devicefile">/dev/log</filename>. With the
341
<filename>/dev/log</filename>. With the
448
342
<option>--debug</option> option, it will log even more messages,
449
343
and also show them on the console.
453
<refsect1 id="persistent_state">
454
<title>PERSISTENT STATE</title>
456
Client settings, initially read from
457
<filename>clients.conf</filename>, are persistent across
458
restarts, and run-time changes will override settings in
459
<filename>clients.conf</filename>. However, if a setting is
460
<emphasis>changed</emphasis> (or a client added, or removed) in
461
<filename>clients.conf</filename>, this will take precedence.
465
<refsect1 id="dbus_interface">
466
<title>D-BUS INTERFACE</title>
468
The server will by default provide a D-Bus system bus interface.
469
This interface will only be accessible by the root user or a
470
Mandos-specific user, if such a user exists. For documentation
471
of the D-Bus API, see the file <filename>DBUS-API</filename>.
475
347
<refsect1 id="exit_status">
476
348
<title>EXIT STATUS</title>
532
<term><filename>/run/mandos.pid</filename></term>
535
The file containing the process id of the
536
<command>&COMMANDNAME;</command> process started last.
537
<emphasis >Note:</emphasis> If the <filename
538
class="directory">/run</filename> directory does not
539
exist, <filename>/var/run/mandos.pid</filename> will be
546
class="directory">/var/lib/mandos</filename></term>
549
Directory where persistent state will be saved. Change
550
this with the <option>--statedir</option> option. See
551
also the <option>--no-restore</option> option.
556
<term><filename class="devicefile">/dev/log</filename></term>
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>
559
416
The Unix domain socket to where local syslog messages are
582
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.
585
453
There is no fine-grained control over logging and debug output.
588
This server does not check the expire time of clients’ OpenPGP
591
<xi:include href="bugs.xml"/>
456
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
594
463
<refsect1 id="example">
604
473
<informalexample>
606
475
Run the server in debug mode, read configuration files from
607
the <filename class="directory">~/mandos</filename> directory,
608
and use the Zeroconf service name <quote>Test</quote> to not
609
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:
661
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
664
549
For more details on client-side security, see
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
550
<citerefentry><refentrytitle>password-request</refentrytitle>
666
551
<manvolnum>8mandos</manvolnum></citerefentry>.
671
556
<refsect1 id="see_also">
672
557
<title>SEE ALSO</title>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<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>