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-26">
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>
86
83
<replaceable>DIRECTORY</replaceable></option></arg>
88
85
<arg><option>--debug</option></arg>
90
<arg><option>--debuglevel
91
<replaceable>LEVEL</replaceable></option></arg>
93
<arg><option>--no-dbus</option></arg>
95
<arg><option>--no-ipv6</option></arg>
98
88
<command>&COMMANDNAME;</command>
125
115
Any authenticated client is then given the stored pre-encrypted
126
116
password for that specific client.
130
121
<refsect1 id="purpose">
131
122
<title>PURPOSE</title>
133
125
The purpose of this is to enable <emphasis>remote and unattended
134
126
rebooting</emphasis> of client host computer with an
135
127
<emphasis>encrypted root file system</emphasis>. See <xref
136
128
linkend="overview"/> for details.
140
133
<refsect1 id="options">
141
134
<title>OPTIONS</title>
144
138
<term><option>--help</option></term>
196
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
201
<term><option>--debuglevel
202
<replaceable>LEVEL</replaceable></option></term>
205
Set the debugging log level.
206
<replaceable>LEVEL</replaceable> is a string, one of
207
<quote><literal>CRITICAL</literal></quote>,
208
<quote><literal>ERROR</literal></quote>,
209
<quote><literal>WARNING</literal></quote>,
210
<quote><literal>INFO</literal></quote>, or
211
<quote><literal>DEBUG</literal></quote>, in order of
212
increasing verbosity. The default level is
213
<quote><literal>WARNING</literal></quote>.
219
195
<term><option>--priority <replaceable>
220
196
PRIORITY</replaceable></option></term>
260
<term><option>--no-dbus</option></term>
262
<xi:include href="mandos-options.xml" xpointer="dbus"/>
264
See also <xref linkend="dbus_interface"/>.
270
<term><option>--no-ipv6</option></term>
272
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
237
<refsect1 id="overview">
279
238
<title>OVERVIEW</title>
280
239
<xi:include href="overview.xml"/>
282
241
This program is the server part. It is a normal server program
283
242
and will run in a normal system environment, not in an initial
284
<acronym>RAM</acronym> disk environment.
243
RAM disk environment.
288
247
<refsect1 id="protocol">
289
248
<title>NETWORK PROTOCOL</title>
343
302
</tbody></tgroup></table>
346
305
<refsect1 id="checking">
347
306
<title>CHECKING</title>
349
308
The server will, by default, continually check that the clients
350
309
are still up. If a client has not been confirmed as being up
351
310
for some time, the client is assumed to be compromised and is no
352
longer eligible to receive the encrypted password. (Manual
353
intervention is required to re-enable a client.) The timeout,
311
longer eligible to receive the encrypted password. The timeout,
354
312
checker program, and interval between checks can be configured
355
313
both globally and per client; see <citerefentry>
356
314
<refentrytitle>mandos-clients.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry>. A client successfully
358
receiving its password will also be treated as a successful
363
<refsect1 id="approval">
364
<title>APPROVAL</title>
366
The server can be configured to require manual approval for a
367
client before it is sent its secret. The delay to wait for such
368
approval and the default action (approve or deny) can be
369
configured both globally and per client; see <citerefentry>
370
<refentrytitle>mandos-clients.conf</refentrytitle>
371
<manvolnum>5</manvolnum></citerefentry>. By default all clients
372
will be approved immediately without delay.
375
This can be used to deny a client its secret if not manually
376
approved within a specified time. It can also be used to make
377
the server delay before giving a client its secret, allowing
378
optional manual denying of this specific client.
315
<manvolnum>5</manvolnum></citerefentry>.
383
319
<refsect1 id="logging">
384
320
<title>LOGGING</title>
389
325
and also show them on the console.
393
<refsect1 id="dbus_interface">
394
<title>D-BUS INTERFACE</title>
396
The server will by default provide a D-Bus system bus interface.
397
This interface will only be accessible by the root user or a
398
Mandos-specific user, if such a user exists. For documentation
399
of the D-Bus API, see the file <filename>DBUS-API</filename>.
403
329
<refsect1 id="exit_status">
404
330
<title>EXIT STATUS</title>
460
<term><filename>/var/run/mandos.pid</filename></term>
386
<term><filename>/var/run/mandos/mandos.pid</filename></term>
463
The file containing the process id of the
464
<command>&COMMANDNAME;</command> process started last.
389
The file containing the process id of
390
<command>&COMMANDNAME;</command>.
495
421
backtrace. This could be considered a feature.
498
Currently, if a client is disabled due to having timed out, the
499
server does not record this fact onto permanent storage. This
500
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.
503
435
There is no fine-grained control over logging and debug output.
506
438
Debug mode is conflated with running in the foreground.
509
The console log messages do not show a time stamp.
512
This server does not check the expire time of clients’ OpenPGP
441
The console log messages does not show a timestamp.
552
480
</informalexample>
555
483
<refsect1 id="security">
556
484
<title>SECURITY</title>
557
<refsect2 id="server">
485
<refsect2 id="SERVER">
558
486
<title>SERVER</title>
560
488
Running this <command>&COMMANDNAME;</command> server program
561
489
should not in itself present any security risk to the host
562
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.
566
<refsect2 id="clients">
494
<refsect2 id="CLIENTS">
567
495
<title>CLIENTS</title>
569
497
The server only gives out its stored data to clients which
576
504
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
505
<manvolnum>5</manvolnum></citerefentry>)
578
506
<emphasis>must</emphasis> be made non-readable by anyone
579
except the user starting the server (usually root).
507
except the user running the server.
582
510
As detailed in <xref linkend="checking"/>, the status of all
587
515
If a client is compromised, its downtime should be duly noted
588
by the server which would therefore disable the client. But
589
if the server was ever restarted, it would re-read its client
590
list from its configuration file and again regard all clients
591
therein as enabled, and hence eligible to receive their
592
passwords. Therefore, be careful when restarting servers if
593
it is suspected that a client has, in fact, been compromised
594
by parties who may now be running a fake Mandos client with
595
the keys from the non-encrypted initial <acronym>RAM</acronym>
596
image of the client host. What should be done in that case
597
(if restarting the server program really is necessary) is to
598
stop the server program, edit the configuration file to omit
599
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
602
531
For more details on client-side security, see
603
<citerefentry><refentrytitle>mandos-client</refentrytitle>
532
<citerefentry><refentrytitle>password-request</refentrytitle>
604
533
<manvolnum>8mandos</manvolnum></citerefentry>.
609
538
<refsect1 id="see_also">
610
539
<title>SEE ALSO</title>
614
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
544
<refentrytitle>mandos.conf</refentrytitle>
616
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
<refentrytitle>mandos-client</refentrytitle>
546
<refentrytitle>password-request</refentrytitle>
618
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
