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 "2011-08-08">
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>
111
100
<arg choice="plain"><option>--check</option></arg>
113
102
</refsynopsisdiv>
115
104
<refsect1 id="description">
116
105
<title>DESCRIPTION</title>
118
107
<command>&COMMANDNAME;</command> is a server daemon which
119
108
handles incoming request for passwords for a pre-defined list of
120
client host computers. For an introduction, see
121
<citerefentry><refentrytitle>intro</refentrytitle>
122
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
123
uses Zeroconf to announce itself on the local network, and uses
124
TLS to communicate securely with and to authenticate the
125
clients. The Mandos server uses IPv6 to allow Mandos clients to
126
use IPv6 link-local addresses, since the clients will probably
127
not have any other addresses configured (see <xref
128
linkend="overview"/>). Any authenticated client is then given
129
the stored pre-encrypted password for that specific client.
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
password for that specific client.
133
121
<refsect1 id="purpose">
134
122
<title>PURPOSE</title>
136
125
The purpose of this is to enable <emphasis>remote and unattended
137
126
rebooting</emphasis> of client host computer with an
138
127
<emphasis>encrypted root file system</emphasis>. See <xref
139
128
linkend="overview"/> for details.
143
133
<refsect1 id="options">
144
134
<title>OPTIONS</title>
147
138
<term><option>--help</option></term>
199
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
204
<term><option>--debuglevel
205
<replaceable>LEVEL</replaceable></option></term>
208
Set the debugging log level.
209
<replaceable>LEVEL</replaceable> is a string, one of
210
<quote><literal>CRITICAL</literal></quote>,
211
<quote><literal>ERROR</literal></quote>,
212
<quote><literal>WARNING</literal></quote>,
213
<quote><literal>INFO</literal></quote>, or
214
<quote><literal>DEBUG</literal></quote>, in order of
215
increasing verbosity. The default level is
216
<quote><literal>WARNING</literal></quote>.
222
195
<term><option>--priority <replaceable>
223
196
PRIORITY</replaceable></option></term>
263
<term><option>--no-dbus</option></term>
265
<xi:include href="mandos-options.xml" xpointer="dbus"/>
267
See also <xref linkend="dbus_interface"/>.
273
<term><option>--no-ipv6</option></term>
275
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
237
<refsect1 id="overview">
282
238
<title>OVERVIEW</title>
283
239
<xi:include href="overview.xml"/>
285
241
This program is the server part. It is a normal server program
286
242
and will run in a normal system environment, not in an initial
287
<acronym>RAM</acronym> disk environment.
243
RAM disk environment.
291
247
<refsect1 id="protocol">
292
248
<title>NETWORK PROTOCOL</title>
346
302
</tbody></tgroup></table>
349
305
<refsect1 id="checking">
350
306
<title>CHECKING</title>
352
308
The server will, by default, continually check that the clients
353
309
are still up. If a client has not been confirmed as being up
354
310
for some time, the client is assumed to be compromised and is no
355
longer eligible to receive the encrypted password. (Manual
356
intervention is required to re-enable a client.) The timeout,
357
extended timeout, checker program, and interval between checks
358
can be configured both globally and per client; see
359
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
<manvolnum>5</manvolnum></citerefentry>. A client successfully
361
receiving its password will also be treated as a successful
366
<refsect1 id="approval">
367
<title>APPROVAL</title>
369
The server can be configured to require manual approval for a
370
client before it is sent its secret. The delay to wait for such
371
approval and the default action (approve or deny) can be
372
configured both globally and per client; see <citerefentry>
311
longer eligible to receive the encrypted password. The timeout,
312
checker program, and interval between checks can be configured
313
both globally and per client; see <citerefentry>
373
314
<refentrytitle>mandos-clients.conf</refentrytitle>
374
<manvolnum>5</manvolnum></citerefentry>. By default all clients
375
will be approved immediately without delay.
378
This can be used to deny a client its secret if not manually
379
approved within a specified time. It can also be used to make
380
the server delay before giving a client its secret, allowing
381
optional manual denying of this specific client.
315
<manvolnum>5</manvolnum></citerefentry>.
386
319
<refsect1 id="logging">
387
320
<title>LOGGING</title>
392
325
and also show them on the console.
396
<refsect1 id="dbus_interface">
397
<title>D-BUS INTERFACE</title>
399
The server will by default provide a D-Bus system bus interface.
400
This interface will only be accessible by the root user or a
401
Mandos-specific user, if such a user exists. For documentation
402
of the D-Bus API, see the file <filename>DBUS-API</filename>.
406
329
<refsect1 id="exit_status">
407
330
<title>EXIT STATUS</title>
498
421
backtrace. This could be considered a feature.
501
Currently, if a client is disabled due to having timed out, the
502
server does not record this fact onto permanent storage. This
503
has some security implications, see <xref linkend="clients"/>.
424
Currently, if a client is declared <quote>invalid</quote> due to
425
having timed out, the server does not record this fact onto
426
permanent storage. This has some security implications, see
427
<xref linkend="CLIENTS"/>.
430
There is currently no way of querying the server of the current
431
status of clients, other than analyzing its <systemitem
432
class="service">syslog</systemitem> output.
506
435
There is no fine-grained control over logging and debug output.
590
515
If a client is compromised, its downtime should be duly noted
591
by the server which would therefore disable the client. But
592
if the server was ever restarted, it would re-read its client
593
list from its configuration file and again regard all clients
594
therein as enabled, and hence eligible to receive their
595
passwords. Therefore, be careful when restarting servers if
596
it is suspected that a client has, in fact, been compromised
597
by parties who may now be running a fake Mandos client with
598
the keys from the non-encrypted initial <acronym>RAM</acronym>
599
image of the client host. What should be done in that case
600
(if restarting the server program really is necessary) is to
601
stop the server program, edit the configuration file to omit
602
any suspect clients, and restart the server program.
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial RAM image of the client host. What should be done in
525
that case (if restarting the server program really is
526
necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
605
531
For more details on client-side security, see
606
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
607
533
<manvolnum>8mandos</manvolnum></citerefentry>.
612
538
<refsect1 id="see_also">
613
539
<title>SEE ALSO</title>
615
<citerefentry><refentrytitle>intro</refentrytitle>
616
<manvolnum>8mandos</manvolnum></citerefentry>,
617
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
618
<manvolnum>5</manvolnum></citerefentry>,
619
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
620
<manvolnum>5</manvolnum></citerefentry>,
621
<citerefentry><refentrytitle>mandos-client</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>sh</refentrytitle>
624
<manvolnum>1</manvolnum></citerefentry>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
