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-03">
5
<!ENTITY TIMESTAMP "2025-06-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>
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
49
<holder>Teddy Hogeborn</holder>
35
50
<holder>Björn Påhlsson</holder>
37
52
<xi:include href="legalnotice.xml"/>
41
56
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
57
<manvolnum>8</manvolnum>
83
98
<replaceable>DIRECTORY</replaceable></option></arg>
85
100
<arg><option>--debug</option></arg>
102
<arg><option>--debuglevel
103
<replaceable>LEVEL</replaceable></option></arg>
105
<arg><option>--no-dbus</option></arg>
107
<arg><option>--no-ipv6</option></arg>
109
<arg><option>--no-restore</option></arg>
111
<arg><option>--statedir
112
<replaceable>DIRECTORY</replaceable></option></arg>
114
<arg><option>--socket
115
<replaceable>FD</replaceable></option></arg>
117
<arg><option>--foreground</option></arg>
119
<arg><option>--no-zeroconf</option></arg>
88
122
<command>&COMMANDNAME;</command>
100
134
<arg choice="plain"><option>--check</option></arg>
102
136
</refsynopsisdiv>
104
138
<refsect1 id="description">
105
139
<title>DESCRIPTION</title>
107
141
<command>&COMMANDNAME;</command> is a server daemon which
108
handles incoming request for passwords for a pre-defined list of
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.
142
handles incoming requests for passwords for a pre-defined list
143
of client host computers. For an introduction, see
144
<citerefentry><refentrytitle>intro</refentrytitle>
145
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
146
uses Zeroconf to announce itself on the local network, and uses
147
TLS to communicate securely with and to authenticate the
148
clients. The Mandos server uses IPv6 to allow Mandos clients to
149
use IPv6 link-local addresses, since the clients will probably
150
not have any other addresses configured (see <xref
151
linkend="overview"/>). Any authenticated client is then given
152
the stored pre-encrypted password for that specific client.
186
222
<xi:include href="mandos-options.xml" xpointer="debug"/>
227
<term><option>--debuglevel
228
<replaceable>LEVEL</replaceable></option></term>
231
Set the debugging log level.
232
<replaceable>LEVEL</replaceable> is a string, one of
233
<quote><literal>CRITICAL</literal></quote>,
234
<quote><literal>ERROR</literal></quote>,
235
<quote><literal>WARNING</literal></quote>,
236
<quote><literal>INFO</literal></quote>, or
237
<quote><literal>DEBUG</literal></quote>, in order of
238
increasing verbosity. The default level is
239
<quote><literal>WARNING</literal></quote>.
191
245
<term><option>--priority <replaceable>
192
246
PRIORITY</replaceable></option></term>
286
<term><option>--no-dbus</option></term>
288
<xi:include href="mandos-options.xml" xpointer="dbus"/>
290
See also <xref linkend="dbus_interface"/>.
296
<term><option>--no-ipv6</option></term>
298
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
303
<term><option>--no-restore</option></term>
305
<xi:include href="mandos-options.xml" xpointer="restore"/>
307
See also <xref linkend="persistent_state"/>.
313
<term><option>--statedir
314
<replaceable>DIRECTORY</replaceable></option></term>
316
<xi:include href="mandos-options.xml" xpointer="statedir"/>
321
<term><option>--socket
322
<replaceable>FD</replaceable></option></term>
324
<xi:include href="mandos-options.xml" xpointer="socket"/>
329
<term><option>--foreground</option></term>
331
<xi:include href="mandos-options.xml"
332
xpointer="foreground"/>
337
<term><option>--no-zeroconf</option></term>
339
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
233
346
<refsect1 id="overview">
234
347
<title>OVERVIEW</title>
235
348
<xi:include href="overview.xml"/>
252
365
start a TLS protocol handshake with a slight quirk: the Mandos
253
366
server program acts as a TLS <quote>client</quote> while the
254
367
connecting Mandos client acts as a TLS <quote>server</quote>.
255
The Mandos client must supply an OpenPGP certificate, and the
256
fingerprint of this certificate is used by the Mandos server to
257
look up (in a list read from <filename>clients.conf</filename>
258
at start time) which binary blob to give the client. No other
259
authentication or authorization is done by the server.
368
The Mandos client must supply a TLS public key, and the key ID
369
of this public key is used by the Mandos server to look up (in a
370
list read from <filename>clients.conf</filename> at start time)
371
which binary blob to give the client. No other authentication
372
or authorization is done by the server.
262
375
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
298
411
</tbody></tgroup></table>
301
414
<refsect1 id="checking">
302
415
<title>CHECKING</title>
304
417
The server will, by default, continually check that the clients
305
418
are still up. If a client has not been confirmed as being up
306
419
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
420
longer eligible to receive the encrypted password. (Manual
421
intervention is required to re-enable a client.) The timeout,
422
extended timeout, checker program, and interval between checks
423
can be configured both globally and per client; see
424
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
425
<manvolnum>5</manvolnum></citerefentry>.
429
<refsect1 id="approval">
430
<title>APPROVAL</title>
432
The server can be configured to require manual approval for a
433
client before it is sent its secret. The delay to wait for such
434
approval and the default action (approve or deny) can be
435
configured both globally and per client; see <citerefentry>
310
436
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
437
<manvolnum>5</manvolnum></citerefentry>. By default all clients
438
will be approved immediately without delay.
441
This can be used to deny a client its secret if not manually
442
approved within a specified time. It can also be used to make
443
the server delay before giving a client its secret, allowing
444
optional manual denying of this specific client.
315
449
<refsect1 id="logging">
316
450
<title>LOGGING</title>
318
452
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
453
<filename class="devicefile">/dev/log</filename>. With the
320
454
<option>--debug</option> option, it will log even more messages,
321
455
and also show them on the console.
459
<refsect1 id="persistent_state">
460
<title>PERSISTENT STATE</title>
462
Client settings, initially read from
463
<filename>clients.conf</filename>, are persistent across
464
restarts, and run-time changes will override settings in
465
<filename>clients.conf</filename>. However, if a setting is
466
<emphasis>changed</emphasis> (or a client added, or removed) in
467
<filename>clients.conf</filename>, this will take precedence.
471
<refsect1 id="dbus_interface">
472
<title>D-BUS INTERFACE</title>
474
The server will by default provide a D-Bus system bus interface.
475
This interface will only be accessible by the root user or a
476
Mandos-specific user, if such a user exists. For documentation
477
of the D-Bus API, see the file <filename>DBUS-API</filename>.
325
481
<refsect1 id="exit_status">
326
482
<title>EXIT STATUS</title>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
391
<term><filename>/dev/log</filename></term>
538
<term><filename>/run/mandos.pid</filename></term>
541
The file containing the process id of the
542
<command>&COMMANDNAME;</command> process started last.
543
<emphasis >Note:</emphasis> If the <filename
544
class="directory">/run</filename> directory does not
545
exist, <filename>/var/run/mandos.pid</filename> will be
552
class="directory">/var/lib/mandos</filename></term>
555
Directory where persistent state will be saved. Change
556
this with the <option>--statedir</option> option. See
557
also the <option>--no-restore</option> option.
562
<term><filename class="devicefile">/dev/log</filename></term>
394
565
The Unix domain socket to where local syslog messages are
417
588
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.
431
591
There is no fine-grained control over logging and debug output.
434
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a timestamp.
440
This server does not check the expire time of clients’ OpenPGP
593
<xi:include href="bugs.xml"/>
445
596
<refsect1 id="example">
455
606
<informalexample>
457
608
Run the server in debug mode, read configuration files from
458
the <filename>~/mandos</filename> directory, and use the
459
Zeroconf service name <quote>Test</quote> to not collide with
460
any other official Mandos server on this host:
609
the <filename class="directory">~/mandos</filename> directory,
610
and use the Zeroconf service name <quote>Test</quote> to not
611
collide with any other official Mandos server on this host:
480
631
</informalexample>
483
634
<refsect1 id="security">
484
635
<title>SECURITY</title>
485
<refsect2 id="SERVER">
636
<refsect2 id="server">
486
637
<title>SERVER</title>
488
639
Running this <command>&COMMANDNAME;</command> server program
489
640
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.
641
computer running it. The program switches to a non-root user
494
<refsect2 id="CLIENTS">
645
<refsect2 id="clients">
495
646
<title>CLIENTS</title>
497
648
The server only gives out its stored data to clients which
498
does have the OpenPGP key of the stored fingerprint. This is
499
guaranteed by the fact that the client sends its OpenPGP
500
public key in the TLS handshake; this ensures it to be
501
genuine. The server computes the fingerprint of the key
502
itself and looks up the fingerprint in its list of
503
clients. The <filename>clients.conf</filename> file (see
649
does have the correct key ID of the stored key ID. This is
650
guaranteed by the fact that the client sends its public key in
651
the TLS handshake; this ensures it to be genuine. The server
652
computes the key ID of the key itself and looks up the key ID
653
in its list of clients. The <filename>clients.conf</filename>
504
655
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
656
<manvolnum>5</manvolnum></citerefentry>)
506
657
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
658
except the user starting the server (usually root).
510
661
As detailed in <xref linkend="checking"/>, the status of all
512
663
compromised if they are gone for too long.
515
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
531
666
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
668
<manvolnum>8mandos</manvolnum></citerefentry>.
538
673
<refsect1 id="see_also">
539
674
<title>SEE ALSO</title>
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>
676
<citerefentry><refentrytitle>intro</refentrytitle>
677
<manvolnum>8mandos</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
<manvolnum>5</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>mandos-client</refentrytitle>
683
<manvolnum>8mandos</manvolnum></citerefentry>,
684
<citerefentry><refentrytitle>sh</refentrytitle>
685
<manvolnum>1</manvolnum></citerefentry>
642
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
This is implemented by GnuTLS and used by this server so
648
that OpenPGP keys can be used.
777
RFC 7250: <citetitle>Using Raw Public Keys in Transport
778
Layer Security (TLS) and Datagram Transport Layer Security
783
This is implemented by GnuTLS version 3.6.6 and is, if
784
present, used by this server so that raw public keys can be
791
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
792
Security (TLS) Authentication</citetitle>
796
This is implemented by GnuTLS before version 3.6.0 and is,
797
if present, used by this server so that OpenPGP keys can be