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
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2010-09-26">
5
<!ENTITY TIMESTAMP "2025-06-27">
6
6
<!ENTITY % common SYSTEM "common.ent">
19
19
<firstname>Björn</firstname>
20
20
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
26
26
<firstname>Teddy</firstname>
27
27
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
93
105
<arg><option>--no-dbus</option></arg>
95
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>
98
122
<command>&COMMANDNAME;</command>
115
139
<title>DESCRIPTION</title>
117
141
<command>&COMMANDNAME;</command> is a server daemon which
118
handles incoming request for passwords for a pre-defined list of
119
client host computers. The Mandos server uses Zeroconf to
120
announce itself on the local network, and uses TLS to
121
communicate securely with and to authenticate the clients. The
122
Mandos server uses IPv6 to allow Mandos clients to use IPv6
123
link-local addresses, since the clients will probably not have
124
any other addresses configured (see <xref linkend="overview"/>).
125
Any authenticated client is then given the stored pre-encrypted
126
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.
272
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"/>
297
365
start a TLS protocol handshake with a slight quirk: the Mandos
298
366
server program acts as a TLS <quote>client</quote> while the
299
367
connecting Mandos client acts as a TLS <quote>server</quote>.
300
The Mandos client must supply an OpenPGP certificate, and the
301
fingerprint of this certificate is used by the Mandos server to
302
look up (in a list read from <filename>clients.conf</filename>
303
at start time) which binary blob to give the client. No other
304
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.
307
375
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
351
419
for some time, the client is assumed to be compromised and is no
352
420
longer eligible to receive the encrypted password. (Manual
353
421
intervention is required to re-enable a client.) The timeout,
354
checker program, and interval between checks can be configured
355
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos-clients.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry>. A client successfully
358
receiving its password will also be treated as a successful
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>.
384
450
<title>LOGGING</title>
386
452
The server will send log message with various severity levels to
387
<filename>/dev/log</filename>. With the
453
<filename class="devicefile">/dev/log</filename>. With the
388
454
<option>--debug</option> option, it will log even more messages,
389
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.
393
471
<refsect1 id="dbus_interface">
394
472
<title>D-BUS INTERFACE</title>
460
<term><filename>/var/run/mandos.pid</filename></term>
538
<term><filename>/run/mandos.pid</filename></term>
463
541
The file containing the process id of the
464
542
<command>&COMMANDNAME;</command> process started last.
469
<term><filename>/dev/log</filename></term>
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>
472
565
The Unix domain socket to where local syslog messages are
495
588
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"/>.
503
591
There is no fine-grained control over logging and debug output.
506
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
593
<xi:include href="bugs.xml"/>
517
596
<refsect1 id="example">
527
606
<informalexample>
529
608
Run the server in debug mode, read configuration files from
530
the <filename>~/mandos</filename> directory, and use the
531
Zeroconf service name <quote>Test</quote> to not collide with
532
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:
567
646
<title>CLIENTS</title>
569
648
The server only gives out its stored data to clients which
570
does have the OpenPGP key of the stored fingerprint. This is
571
guaranteed by the fact that the client sends its OpenPGP
572
public key in the TLS handshake; this ensures it to be
573
genuine. The server computes the fingerprint of the key
574
itself and looks up the fingerprint in its list of
575
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>
576
655
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
656
<manvolnum>5</manvolnum></citerefentry>)
578
657
<emphasis>must</emphasis> be made non-readable by anyone
584
663
compromised if they are gone for too long.
587
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.
602
666
For more details on client-side security, see
603
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
604
668
<manvolnum>8mandos</manvolnum></citerefentry>.
609
673
<refsect1 id="see_also">
610
674
<title>SEE ALSO</title>
613
<refentrytitle>mandos-clients.conf</refentrytitle>
614
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
<refentrytitle>mandos.conf</refentrytitle>
616
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
<refentrytitle>mandos-client</refentrytitle>
618
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
<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>
647
<ulink url="http://www.gnu.org/software/gnutls/"
712
<ulink url="https://gnutls.org/">GnuTLS</ulink>
652
716
GnuTLS is the library this server uses to implement TLS for
653
717
communicating securely with the client, and at the same time
654
confidently get the client’s public OpenPGP key.
718
confidently get the client’s public key.
680
744
The clients use IPv6 link-local addresses, which are
681
immediately usable since a link-local addresses is
745
immediately usable since a link-local address is
682
746
automatically assigned to a network interfaces when it
692
RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
Protocol Version 1.1</citetitle>
756
RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
Protocol Version 1.2</citetitle>
697
TLS 1.1 is the protocol implemented by GnuTLS.
761
TLS 1.2 is the protocol implemented by GnuTLS.
713
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
718
This is implemented by GnuTLS and used by this server so
719
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
added
removed
mandos.xml
