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 "2010-09-11">
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>
85
83
<replaceable>DIRECTORY</replaceable></option></arg>
87
85
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
94
88
<command>&COMMANDNAME;</command>
121
115
Any authenticated client is then given the stored pre-encrypted
122
116
password for that specific client.
126
121
<refsect1 id="purpose">
127
122
<title>PURPOSE</title>
129
125
The purpose of this is to enable <emphasis>remote and unattended
130
126
rebooting</emphasis> of client host computer with an
131
127
<emphasis>encrypted root file system</emphasis>. See <xref
132
128
linkend="overview"/> for details.
136
133
<refsect1 id="options">
137
134
<title>OPTIONS</title>
140
138
<term><option>--help</option></term>
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
256
237
<refsect1 id="overview">
257
238
<title>OVERVIEW</title>
258
239
<xi:include href="overview.xml"/>
260
241
This program is the server part. It is a normal server program
261
242
and will run in a normal system environment, not in an initial
262
<acronym>RAM</acronym> disk environment.
243
RAM disk environment.
266
247
<refsect1 id="protocol">
267
248
<title>NETWORK PROTOCOL</title>
321
302
</tbody></tgroup></table>
324
305
<refsect1 id="checking">
325
306
<title>CHECKING</title>
327
308
The server will, by default, continually check that the clients
328
309
are still up. If a client has not been confirmed as being up
329
310
for some time, the client is assumed to be compromised and is no
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
311
longer eligible to receive the encrypted password. The timeout,
332
312
checker program, and interval between checks can be configured
333
313
both globally and per client; see <citerefentry>
334
314
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
315
<manvolnum>5</manvolnum></citerefentry>.
341
319
<refsect1 id="logging">
342
320
<title>LOGGING</title>
347
325
and also show them on the console.
351
<refsect1 id="dbus_interface">
352
<title>D-BUS INTERFACE</title>
354
The server will by default provide a D-Bus system bus interface.
355
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists. For documentation
357
of the D-Bus API, see the file <filename>DBUS-API</filename>.
361
329
<refsect1 id="exit_status">
362
330
<title>EXIT STATUS</title>
453
421
backtrace. This could be considered a feature.
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
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.
461
435
There is no fine-grained control over logging and debug output.
464
438
Debug mode is conflated with running in the foreground.
467
The console log messages do not show a time stamp.
470
This server does not check the expire time of clients’ OpenPGP
441
The console log messages does not show a timestamp.
510
480
</informalexample>
513
483
<refsect1 id="security">
514
484
<title>SECURITY</title>
515
<refsect2 id="server">
485
<refsect2 id="SERVER">
516
486
<title>SERVER</title>
518
488
Running this <command>&COMMANDNAME;</command> server program
519
489
should not in itself present any security risk to the host
520
computer running it. The program switches to a non-root user
490
computer running it. The program does not need any special
491
privileges to run, and is designed to run as a non-root user.
524
<refsect2 id="clients">
494
<refsect2 id="CLIENTS">
525
495
<title>CLIENTS</title>
527
497
The server only gives out its stored data to clients which
534
504
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
535
505
<manvolnum>5</manvolnum></citerefentry>)
536
506
<emphasis>must</emphasis> be made non-readable by anyone
537
except the user starting the server (usually root).
507
except the user running the server.
540
510
As detailed in <xref linkend="checking"/>, the status of all
545
515
If a client is compromised, its downtime should be duly noted
546
by the server which would therefore disable the client. But
547
if the server was ever restarted, it would re-read its client
548
list from its configuration file and again regard all clients
549
therein as enabled, and hence eligible to receive their
550
passwords. Therefore, be careful when restarting servers if
551
it is suspected that a client has, in fact, been compromised
552
by parties who may now be running a fake Mandos client with
553
the keys from the non-encrypted initial <acronym>RAM</acronym>
554
image of the client host. What should be done in that case
555
(if restarting the server program really is necessary) is to
556
stop the server program, edit the configuration file to omit
557
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
560
531
For more details on client-side security, see
561
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
562
533
<manvolnum>8mandos</manvolnum></citerefentry>.
567
538
<refsect1 id="see_also">
568
539
<title>SEE ALSO</title>
572
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
573
544
<refentrytitle>mandos.conf</refentrytitle>
574
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
<refentrytitle>mandos-client</refentrytitle>
546
<refentrytitle>password-request</refentrytitle>
576
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
577
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
