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 "2013-10-26">
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
40
<holder>Teddy Hogeborn</holder>
35
41
<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/"/>.
43
<xi:include href="legalnotice.xml"/>
63
47
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
48
<manvolnum>8</manvolnum>
105
89
<replaceable>DIRECTORY</replaceable></option></arg>
107
91
<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>
110
111
<command>&COMMANDNAME;</command>
122
123
<arg choice="plain"><option>--check</option></arg>
124
125
</refsynopsisdiv>
126
127
<refsect1 id="description">
127
128
<title>DESCRIPTION</title>
129
130
<command>&COMMANDNAME;</command> is a server daemon which
130
131
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.
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.
143
145
<refsect1 id="purpose">
144
146
<title>PURPOSE</title>
147
148
The purpose of this is to enable <emphasis>remote and unattended
148
149
rebooting</emphasis> of client host computer with an
149
150
<emphasis>encrypted root file system</emphasis>. See <xref
150
151
linkend="overview"/> for details.
155
155
<refsect1 id="options">
156
156
<title>OPTIONS</title>
159
<term><option>--help</option></term>
160
160
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
163
Show a help message and exit
169
<term><option>--interface</option>
170
<replaceable>NAME</replaceable></term>
170
171
<term><option>-i</option>
171
172
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
174
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
179
<term><option>--address
180
<replaceable>ADDRESS</replaceable></option></term>
182
<replaceable>ADDRESS</replaceable></option></term>
183
184
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
190
<replaceable>PORT</replaceable></option></term>
192
<replaceable>PORT</replaceable></option></term>
191
194
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
199
<term><option>--check</option></term>
199
202
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
209
<term><option>--debug</option></term>
208
211
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
216
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
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>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
243
<term><option>--servicename
244
<replaceable>NAME</replaceable></option></term>
224
246
<xi:include href="mandos-options.xml"
225
247
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
252
<term><option>--configdir
253
<replaceable>DIRECTORY</replaceable></option></term>
234
256
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
267
<term><option>--version</option></term>
248
270
Prints the program version and exit.
276
<term><option>--no-dbus</option></term>
278
<xi:include href="mandos-options.xml" xpointer="dbus"/>
280
See also <xref linkend="dbus_interface"/>.
286
<term><option>--no-ipv6</option></term>
288
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
<term><option>--no-restore</option></term>
295
<xi:include href="mandos-options.xml" xpointer="restore"/>
297
See also <xref linkend="persistent_state"/>.
303
<term><option>--statedir
304
<replaceable>DIRECTORY</replaceable></option></term>
306
<xi:include href="mandos-options.xml" xpointer="statedir"/>
311
<term><option>--socket
312
<replaceable>FD</replaceable></option></term>
314
<xi:include href="mandos-options.xml" xpointer="socket"/>
319
<term><option>--foreground</option></term>
321
<xi:include href="mandos-options.xml"
322
xpointer="foreground"/>
255
329
<refsect1 id="overview">
256
330
<title>OVERVIEW</title>
257
331
<xi:include href="overview.xml"/>
259
333
This program is the server part. It is a normal server program
260
334
and will run in a normal system environment, not in an initial
261
RAM disk environment.
335
<acronym>RAM</acronym> disk environment.
265
339
<refsect1 id="protocol">
266
340
<title>NETWORK PROTOCOL</title>
320
394
</tbody></tgroup></table>
323
397
<refsect1 id="checking">
324
398
<title>CHECKING</title>
326
400
The server will, by default, continually check that the clients
327
401
are still up. If a client has not been confirmed as being up
328
402
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>
403
longer eligible to receive the encrypted password. (Manual
404
intervention is required to re-enable a client.) The timeout,
405
extended timeout, checker program, and interval between checks
406
can be configured both globally and per client; see
407
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>.
412
<refsect1 id="approval">
413
<title>APPROVAL</title>
415
The server can be configured to require manual approval for a
416
client before it is sent its secret. The delay to wait for such
417
approval and the default action (approve or deny) can be
418
configured both globally and per client; see <citerefentry>
332
419
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
420
<manvolnum>5</manvolnum></citerefentry>. By default all clients
421
will be approved immediately without delay.
424
This can be used to deny a client its secret if not manually
425
approved within a specified time. It can also be used to make
426
the server delay before giving a client its secret, allowing
427
optional manual denying of this specific client.
337
432
<refsect1 id="logging">
338
433
<title>LOGGING</title>
340
435
The server will send log message with various severity levels to
341
<filename>/dev/log</filename>. With the
436
<filename class="devicefile">/dev/log</filename>. With the
342
437
<option>--debug</option> option, it will log even more messages,
343
438
and also show them on the console.
442
<refsect1 id="persistent_state">
443
<title>PERSISTENT STATE</title>
445
Client settings, initially read from
446
<filename>clients.conf</filename>, are persistent across
447
restarts, and run-time changes will override settings in
448
<filename>clients.conf</filename>. However, if a setting is
449
<emphasis>changed</emphasis> (or a client added, or removed) in
450
<filename>clients.conf</filename>, this will take precedence.
454
<refsect1 id="dbus_interface">
455
<title>D-BUS INTERFACE</title>
457
The server will by default provide a D-Bus system bus interface.
458
This interface will only be accessible by the root user or a
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
347
464
<refsect1 id="exit_status">
348
465
<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>.
521
<term><filename>/run/mandos.pid</filename></term>
524
The file containing the process id of the
525
<command>&COMMANDNAME;</command> process started last.
526
<emphasis >Note:</emphasis> If the <filename
527
class="directory">/run</filename> directory does not
528
exist, <filename>/var/run/mandos.pid</filename> will be
534
<term><filename class="devicefile">/dev/log</filename></term>
538
class="directory">/var/lib/mandos</filename></term>
541
Directory where persistent state will be saved. Change
542
this with the <option>--statedir</option> option. See
543
also the <option>--no-restore</option> option.
439
574
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
577
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.
580
This server does not check the expire time of clients’ OpenPGP
473
595
<informalexample>
475
597
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:
598
the <filename class="directory">~/mandos</filename> directory,
599
and use the Zeroconf service name <quote>Test</quote> to not
600
collide with any other official Mandos server on this host:
530
652
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
655
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
656
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
657
<manvolnum>8mandos</manvolnum></citerefentry>.
556
662
<refsect1 id="see_also">
557
663
<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>
665
<citerefentry><refentrytitle>intro</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
<manvolnum>5</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
<manvolnum>5</manvolnum></citerefentry>,
671
<citerefentry><refentrytitle>mandos-client</refentrytitle>
672
<manvolnum>8mandos</manvolnum></citerefentry>,
673
<citerefentry><refentrytitle>sh</refentrytitle>
674
<manvolnum>1</manvolnum></citerefentry>