1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2009-09-10">
6
<!ENTITY % common SYSTEM "common.ent">
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
19
<firstname>Björn</firstname>
20
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
26
<firstname>Teddy</firstname>
27
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
36
<holder>Teddy Hogeborn</holder>
37
<holder>Björn Påhlsson</holder>
39
<xi:include href="legalnotice.xml"/>
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
<manvolnum>8</manvolnum>
48
<refname><command>&COMMANDNAME;</command></refname>
50
Gives encrypted passwords to authenticated Mandos clients
56
<command>&COMMANDNAME;</command>
58
<arg choice="plain"><option>--interface
59
<replaceable>NAME</replaceable></option></arg>
60
<arg choice="plain"><option>-i
61
<replaceable>NAME</replaceable></option></arg>
65
<arg choice="plain"><option>--address
66
<replaceable>ADDRESS</replaceable></option></arg>
67
<arg choice="plain"><option>-a
68
<replaceable>ADDRESS</replaceable></option></arg>
72
<arg choice="plain"><option>--port
73
<replaceable>PORT</replaceable></option></arg>
74
<arg choice="plain"><option>-p
75
<replaceable>PORT</replaceable></option></arg>
78
<arg><option>--priority
79
<replaceable>PRIORITY</replaceable></option></arg>
81
<arg><option>--servicename
82
<replaceable>NAME</replaceable></option></arg>
84
<arg><option>--configdir
85
<replaceable>DIRECTORY</replaceable></option></arg>
87
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
94
<command>&COMMANDNAME;</command>
96
<arg choice="plain"><option>--help</option></arg>
97
<arg choice="plain"><option>-h</option></arg>
101
<command>&COMMANDNAME;</command>
102
<arg choice="plain"><option>--version</option></arg>
105
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--check</option></arg>
110
<refsect1 id="description">
111
<title>DESCRIPTION</title>
113
<command>&COMMANDNAME;</command> is a server daemon which
114
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
password for that specific client.
126
<refsect1 id="purpose">
127
<title>PURPOSE</title>
129
The purpose of this is to enable <emphasis>remote and unattended
130
rebooting</emphasis> of client host computer with an
131
<emphasis>encrypted root file system</emphasis>. See <xref
132
linkend="overview"/> for details.
136
<refsect1 id="options">
137
<title>OPTIONS</title>
140
<term><option>--help</option></term>
141
<term><option>-h</option></term>
144
Show a help message and exit
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
152
<term><option>-i</option>
153
<replaceable>NAME</replaceable></term>
155
<xi:include href="mandos-options.xml" xpointer="interface"/>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
165
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
175
<xi:include href="mandos-options.xml" xpointer="port"/>
180
<term><option>--check</option></term>
183
Run the server’s self-tests. This includes any unit
190
<term><option>--debug</option></term>
192
<xi:include href="mandos-options.xml" xpointer="debug"/>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
208
<xi:include href="mandos-options.xml"
209
xpointer="servicename"/>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
218
Directory to search for configuration files. Default is
219
<quote><literal>/etc/mandos</literal></quote>. See
220
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
221
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
222
<refentrytitle>mandos-clients.conf</refentrytitle>
223
<manvolnum>5</manvolnum></citerefentry>.
229
<term><option>--version</option></term>
232
Prints the program version and exit.
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
<refsect1 id="overview">
257
<title>OVERVIEW</title>
258
<xi:include href="overview.xml"/>
260
This program is the server part. It is a normal server program
261
and will run in a normal system environment, not in an initial
262
<acronym>RAM</acronym> disk environment.
266
<refsect1 id="protocol">
267
<title>NETWORK PROTOCOL</title>
269
The Mandos server announces itself as a Zeroconf service of type
270
<quote><literal>_mandos._tcp</literal></quote>. The Mandos
271
client connects to the announced address and port, and sends a
272
line of text where the first whitespace-separated field is the
273
protocol version, which currently is
274
<quote><literal>1</literal></quote>. The client and server then
275
start a TLS protocol handshake with a slight quirk: the Mandos
276
server program acts as a TLS <quote>client</quote> while the
277
connecting Mandos client acts as a TLS <quote>server</quote>.
278
The Mandos client must supply an OpenPGP certificate, and the
279
fingerprint of this certificate is used by the Mandos server to
280
look up (in a list read from <filename>clients.conf</filename>
281
at start time) which binary blob to give the client. No other
282
authentication or authorization is done by the server.
285
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
287
<entry>Mandos Client</entry>
288
<entry>Direction</entry>
289
<entry>Mandos Server</entry>
293
<entry>Connect</entry>
294
<entry>-><!-- → --></entry>
297
<entry><quote><literal>1\r\n</literal></quote></entry>
298
<entry>-><!-- → --></entry>
301
<entry>TLS handshake <emphasis>as TLS <quote>server</quote>
303
<entry><-><!-- ⟷ --></entry>
304
<entry>TLS handshake <emphasis>as TLS <quote>client</quote>
308
<entry>OpenPGP public key (part of TLS handshake)</entry>
309
<entry>-><!-- → --></entry>
313
<entry><-<!-- ← --></entry>
314
<entry>Binary blob (client will assume OpenPGP data)</entry>
318
<entry><-<!-- ← --></entry>
321
</tbody></tgroup></table>
324
<refsect1 id="checking">
325
<title>CHECKING</title>
327
The server will, by default, continually check that the clients
328
are still up. If a client has not been confirmed as being up
329
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,
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
334
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>.
339
<refsect1 id="logging">
340
<title>LOGGING</title>
342
The server will send log message with various severity levels to
343
<filename>/dev/log</filename>. With the
344
<option>--debug</option> option, it will log even more messages,
345
and also show them on the console.
349
<refsect1 id="dbus_interface">
350
<title>D-BUS INTERFACE</title>
352
The server will by default provide a D-Bus system bus interface.
353
This interface will only be accessible by the root user or a
354
Mandos-specific user, if such a user exists.
359
<refsect1 id="exit_status">
360
<title>EXIT STATUS</title>
362
The server will exit with a non-zero exit status only when a
363
critical error is encountered.
367
<refsect1 id="environment">
368
<title>ENVIRONMENT</title>
371
<term><envar>PATH</envar></term>
374
To start the configured checker (see <xref
375
linkend="checking"/>), the server uses
376
<filename>/bin/sh</filename>, which in turn uses
377
<varname>PATH</varname> to search for matching commands if
378
an absolute path is not given. See <citerefentry>
379
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
387
<refsect1 id="files">
390
Use the <option>--configdir</option> option to change where
391
<command>&COMMANDNAME;</command> looks for its configurations
392
files. The default file names are listed here.
396
<term><filename>/etc/mandos/mandos.conf</filename></term>
399
Server-global settings. See
400
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
401
<manvolnum>5</manvolnum></citerefentry> for details.
406
<term><filename>/etc/mandos/clients.conf</filename></term>
409
List of clients and client-specific settings. See
410
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
411
<manvolnum>5</manvolnum></citerefentry> for details.
416
<term><filename>/var/run/mandos.pid</filename></term>
419
The file containing the process id of
420
<command>&COMMANDNAME;</command>.
425
<term><filename>/dev/log</filename></term>
428
The Unix domain socket to where local syslog messages are
434
<term><filename>/bin/sh</filename></term>
437
This is used to start the configured checker command for
438
each client. See <citerefentry>
439
<refentrytitle>mandos-clients.conf</refentrytitle>
440
<manvolnum>5</manvolnum></citerefentry> for details.
450
This server might, on especially fatal errors, emit a Python
451
backtrace. This could be considered a feature.
454
Currently, if a client is declared <quote>invalid</quote> due to
455
having timed out, the server does not record this fact onto
456
permanent storage. This has some security implications, see
457
<xref linkend="clients"/>.
460
There is currently no way of querying the server of the current
461
status of clients, other than analyzing its <systemitem
462
class="service">syslog</systemitem> output.
465
There is no fine-grained control over logging and debug output.
468
Debug mode is conflated with running in the foreground.
471
The console log messages do not show a time stamp.
474
This server does not check the expire time of clients’ OpenPGP
479
<refsect1 id="example">
480
<title>EXAMPLE</title>
483
Normal invocation needs no options:
486
<userinput>&COMMANDNAME;</userinput>
491
Run the server in debug mode, read configuration files from
492
the <filename>~/mandos</filename> directory, and use the
493
Zeroconf service name <quote>Test</quote> to not collide with
494
any other official Mandos server on this host:
498
<!-- do not wrap this line -->
499
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
505
Run the server normally, but only listen to one interface and
506
only on the link-local address on that interface:
510
<!-- do not wrap this line -->
511
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
517
<refsect1 id="security">
518
<title>SECURITY</title>
519
<refsect2 id="server">
520
<title>SERVER</title>
522
Running this <command>&COMMANDNAME;</command> server program
523
should not in itself present any security risk to the host
524
computer running it. The program switches to a non-root user
528
<refsect2 id="clients">
529
<title>CLIENTS</title>
531
The server only gives out its stored data to clients which
532
does have the OpenPGP key of the stored fingerprint. This is
533
guaranteed by the fact that the client sends its OpenPGP
534
public key in the TLS handshake; this ensures it to be
535
genuine. The server computes the fingerprint of the key
536
itself and looks up the fingerprint in its list of
537
clients. The <filename>clients.conf</filename> file (see
538
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
539
<manvolnum>5</manvolnum></citerefentry>)
540
<emphasis>must</emphasis> be made non-readable by anyone
541
except the user starting the server (usually root).
544
As detailed in <xref linkend="checking"/>, the status of all
545
client computers will continually be checked and be assumed
546
compromised if they are gone for too long.
549
If a client is compromised, its downtime should be duly noted
550
by the server which would therefore declare the client
551
invalid. But if the server was ever restarted, it would
552
re-read its client list from its configuration file and again
553
regard all clients therein as valid, and hence eligible to
554
receive their passwords. Therefore, be careful when
555
restarting servers if it is suspected that a client has, in
556
fact, been compromised by parties who may now be running a
557
fake Mandos client with the keys from the non-encrypted
558
initial <acronym>RAM</acronym> image of the client host. What
559
should be done in that case (if restarting the server program
560
really is necessary) is to stop the server program, edit the
561
configuration file to omit any suspect clients, and restart
565
For more details on client-side security, see
566
<citerefentry><refentrytitle>mandos-client</refentrytitle>
567
<manvolnum>8mandos</manvolnum></citerefentry>.
572
<refsect1 id="see_also">
573
<title>SEE ALSO</title>
576
<refentrytitle>mandos-clients.conf</refentrytitle>
577
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
<refentrytitle>mandos.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos-client</refentrytitle>
581
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
588
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
592
Zeroconf is the network protocol standard used by clients
593
for finding this Mandos server on the local network.
599
<ulink url="http://www.avahi.org/">Avahi</ulink>
603
Avahi is the library this server calls to implement
604
Zeroconf service announcements.
610
<ulink url="http://www.gnu.org/software/gnutls/"
615
GnuTLS is the library this server uses to implement TLS for
616
communicating securely with the client, and at the same time
617
confidently get the client’s public OpenPGP key.
623
RFC 4291: <citetitle>IP Version 6 Addressing
624
Architecture</citetitle>
629
<term>Section 2.2: <citetitle>Text Representation of
630
Addresses</citetitle></term>
631
<listitem><para/></listitem>
634
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
635
Address</citetitle></term>
636
<listitem><para/></listitem>
639
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
640
Addresses</citetitle></term>
643
The clients use IPv6 link-local addresses, which are
644
immediately usable since a link-local addresses is
645
automatically assigned to a network interfaces when it
655
RFC 4346: <citetitle>The Transport Layer Security (TLS)
656
Protocol Version 1.1</citetitle>
660
TLS 1.1 is the protocol implemented by GnuTLS.
666
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
670
The data sent to clients is binary encrypted OpenPGP data.
676
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
681
This is implemented by GnuTLS and used by this server so
682
that OpenPGP keys can be used.
689
<!-- Local Variables: -->
690
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
691
<!-- time-stamp-end: "[\"']>" -->
692
<!-- time-stamp-format: "%:y-%02m-%02d" -->