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-09-04">
5
<!ENTITY TIMESTAMP "2011-02-27">
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>
83
87
<replaceable>DIRECTORY</replaceable></option></arg>
85
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
88
99
<command>&COMMANDNAME;</command>
186
197
<xi:include href="mandos-options.xml" xpointer="debug"/>
202
<term><option>--debuglevel
203
<replaceable>LEVEL</replaceable></option></term>
206
Set the debugging log level.
207
<replaceable>LEVEL</replaceable> is a string, one of
208
<quote><literal>CRITICAL</literal></quote>,
209
<quote><literal>ERROR</literal></quote>,
210
<quote><literal>WARNING</literal></quote>,
211
<quote><literal>INFO</literal></quote>, or
212
<quote><literal>DEBUG</literal></quote>, in order of
213
increasing verbosity. The default level is
214
<quote><literal>WARNING</literal></quote>.
191
220
<term><option>--priority <replaceable>
192
221
PRIORITY</replaceable></option></term>
261
<term><option>--no-dbus</option></term>
263
<xi:include href="mandos-options.xml" xpointer="dbus"/>
265
See also <xref linkend="dbus_interface"/>.
271
<term><option>--no-ipv6</option></term>
273
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
233
279
<refsect1 id="overview">
234
280
<title>OVERVIEW</title>
235
281
<xi:include href="overview.xml"/>
298
344
</tbody></tgroup></table>
301
347
<refsect1 id="checking">
302
348
<title>CHECKING</title>
304
350
The server will, by default, continually check that the clients
305
351
are still up. If a client has not been confirmed as being up
306
352
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
353
longer eligible to receive the encrypted password. (Manual
354
intervention is required to re-enable a client.) The timeout,
308
355
checker program, and interval between checks can be configured
309
356
both globally and per client; see <citerefentry>
310
357
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
358
<manvolnum>5</manvolnum></citerefentry>. A client successfully
359
receiving its password will also be treated as a successful
364
<refsect1 id="approval">
365
<title>APPROVAL</title>
367
The server can be configured to require manual approval for a
368
client before it is sent its secret. The delay to wait for such
369
approval and the default action (approve or deny) can be
370
configured both globally and per client; see <citerefentry>
371
<refentrytitle>mandos-clients.conf</refentrytitle>
372
<manvolnum>5</manvolnum></citerefentry>. By default all clients
373
will be approved immediately without delay.
376
This can be used to deny a client its secret if not manually
377
approved within a specified time. It can also be used to make
378
the server delay before giving a client its secret, allowing
379
optional manual denying of this specific client.
315
384
<refsect1 id="logging">
316
385
<title>LOGGING</title>
321
390
and also show them on the console.
394
<refsect1 id="dbus_interface">
395
<title>D-BUS INTERFACE</title>
397
The server will by default provide a D-Bus system bus interface.
398
This interface will only be accessible by the root user or a
399
Mandos-specific user, if such a user exists. For documentation
400
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
404
<refsect1 id="exit_status">
326
405
<title>EXIT STATUS</title>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
461
<term><filename>/var/run/mandos.pid</filename></term>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
464
The file containing the process id of the
465
<command>&COMMANDNAME;</command> process started last.
417
496
backtrace. This could be considered a feature.
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
499
Currently, if a client is disabled due to having timed out, the
500
server does not record this fact onto permanent storage. This
501
has some security implications, see <xref linkend="clients"/>.
431
504
There is no fine-grained control over logging and debug output.
434
507
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a time stamp.
510
The console log messages do not show a time stamp.
440
513
This server does not check the expire time of clients’ OpenPGP
480
553
</informalexample>
483
556
<refsect1 id="security">
484
557
<title>SECURITY</title>
485
<refsect2 id="SERVER">
558
<refsect2 id="server">
486
559
<title>SERVER</title>
488
561
Running this <command>&COMMANDNAME;</command> server program
489
562
should not in itself present any security risk to the host
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.
563
computer running it. The program switches to a non-root user
494
<refsect2 id="CLIENTS">
567
<refsect2 id="clients">
495
568
<title>CLIENTS</title>
497
570
The server only gives out its stored data to clients which
504
577
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
578
<manvolnum>5</manvolnum></citerefentry>)
506
579
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
580
except the user starting the server (usually root).
510
583
As detailed in <xref linkend="checking"/>, the status of all
515
588
If a client is compromised, its downtime should be duly noted
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 <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
589
by the server which would therefore disable the client. But
590
if the server was ever restarted, it would re-read its client
591
list from its configuration file and again regard all clients
592
therein as enabled, and hence eligible to receive their
593
passwords. Therefore, be careful when restarting servers if
594
it is suspected that a client has, in fact, been compromised
595
by parties who may now be running a fake Mandos client with
596
the keys from the non-encrypted initial <acronym>RAM</acronym>
597
image of the client host. What should be done in that case
598
(if restarting the server program really is necessary) is to
599
stop the server program, edit the configuration file to omit
600
any suspect clients, and restart the server program.
531
603
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
604
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
605
<manvolnum>8mandos</manvolnum></citerefentry>.
538
610
<refsect1 id="see_also">
539
611
<title>SEE ALSO</title>
543
615
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
616
<refentrytitle>mandos.conf</refentrytitle>
545
617
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
618
<refentrytitle>mandos-client</refentrytitle>
547
619
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
620
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
added
removed
mandos.xml
