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 "2015-12-06">
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
42
<holder>Teddy Hogeborn</holder>
35
43
<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/"/>.
45
<xi:include href="legalnotice.xml"/>
63
49
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
50
<manvolnum>8</manvolnum>
105
91
<replaceable>DIRECTORY</replaceable></option></arg>
107
93
<arg><option>--debug</option></arg>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
98
<arg><option>--no-dbus</option></arg>
100
<arg><option>--no-ipv6</option></arg>
102
<arg><option>--no-restore</option></arg>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
110
<arg><option>--foreground</option></arg>
112
<arg><option>--no-zeroconf</option></arg>
110
115
<command>&COMMANDNAME;</command>
122
127
<arg choice="plain"><option>--check</option></arg>
124
129
</refsynopsisdiv>
126
131
<refsect1 id="description">
127
132
<title>DESCRIPTION</title>
129
134
<command>&COMMANDNAME;</command> is a server daemon which
130
135
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.
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
143
149
<refsect1 id="purpose">
144
150
<title>PURPOSE</title>
147
152
The purpose of this is to enable <emphasis>remote and unattended
148
153
rebooting</emphasis> of client host computer with an
149
154
<emphasis>encrypted root file system</emphasis>. See <xref
150
155
linkend="overview"/> for details.
155
159
<refsect1 id="options">
156
160
<title>OPTIONS</title>
163
<term><option>--help</option></term>
160
164
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
167
Show a help message and exit
173
<term><option>--interface</option>
174
<replaceable>NAME</replaceable></term>
170
175
<term><option>-i</option>
171
176
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
178
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
183
<term><option>--address
184
<replaceable>ADDRESS</replaceable></option></term>
186
<replaceable>ADDRESS</replaceable></option></term>
183
188
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
194
<replaceable>PORT</replaceable></option></term>
196
<replaceable>PORT</replaceable></option></term>
191
198
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
203
<term><option>--check</option></term>
199
206
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
213
<term><option>--debug</option></term>
208
215
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
238
<term><option>--priority <replaceable>
239
PRIORITY</replaceable></option></term>
216
241
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
246
<term><option>--servicename
247
<replaceable>NAME</replaceable></option></term>
224
249
<xi:include href="mandos-options.xml"
225
250
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
255
<term><option>--configdir
256
<replaceable>DIRECTORY</replaceable></option></term>
234
259
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
270
<term><option>--version</option></term>
248
273
Prints the program version and exit.
279
<term><option>--no-dbus</option></term>
281
<xi:include href="mandos-options.xml" xpointer="dbus"/>
283
See also <xref linkend="dbus_interface"/>.
289
<term><option>--no-ipv6</option></term>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
<term><option>--no-restore</option></term>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
300
See also <xref linkend="persistent_state"/>.
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
322
<term><option>--foreground</option></term>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
330
<term><option>--no-zeroconf</option></term>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
255
339
<refsect1 id="overview">
256
340
<title>OVERVIEW</title>
257
341
<xi:include href="overview.xml"/>
259
343
This program is the server part. It is a normal server program
260
344
and will run in a normal system environment, not in an initial
261
RAM disk environment.
345
<acronym>RAM</acronym> disk environment.
265
349
<refsect1 id="protocol">
266
350
<title>NETWORK PROTOCOL</title>
320
404
</tbody></tgroup></table>
323
407
<refsect1 id="checking">
324
408
<title>CHECKING</title>
326
410
The server will, by default, continually check that the clients
327
411
are still up. If a client has not been confirmed as being up
328
412
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>
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
<manvolnum>5</manvolnum></citerefentry>.
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
332
429
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
337
442
<refsect1 id="logging">
338
443
<title>LOGGING</title>
340
445
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
342
447
<option>--debug</option> option, it will log even more messages,
343
448
and also show them on the console.
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
464
<refsect1 id="dbus_interface">
465
<title>D-BUS INTERFACE</title>
467
The server will by default provide a D-Bus system bus interface.
468
This interface will only be accessible by the root user or a
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
474
<refsect1 id="exit_status">
348
475
<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>
531
<term><filename>/run/mandos.pid</filename></term>
534
The file containing the process id of the
535
<command>&COMMANDNAME;</command> process started last.
536
<emphasis >Note:</emphasis> If the <filename
537
class="directory">/run</filename> directory does not
538
exist, <filename>/var/run/mandos.pid</filename> will be
545
class="directory">/var/lib/mandos</filename></term>
548
Directory where persistent state will be saved. Change
549
this with the <option>--statedir</option> option. See
550
also the <option>--no-restore</option> option.
555
<term><filename class="devicefile">/dev/log</filename></term>
416
558
The Unix domain socket to where local syslog messages are
439
581
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
584
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.
587
This server does not check the expire time of clients’ OpenPGP
473
602
<informalexample>
475
604
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:
605
the <filename class="directory">~/mandos</filename> directory,
606
and use the Zeroconf service name <quote>Test</quote> to not
607
collide with any other official Mandos server on this host:
530
659
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
662
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
663
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
664
<manvolnum>8mandos</manvolnum></citerefentry>.
556
669
<refsect1 id="see_also">
557
670
<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>
672
<citerefentry><refentrytitle>intro</refentrytitle>
673
<manvolnum>8mandos</manvolnum></citerefentry>,
674
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
675
<manvolnum>5</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-client</refentrytitle>
679
<manvolnum>8mandos</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>sh</refentrytitle>
681
<manvolnum>1</manvolnum></citerefentry>