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 VERSION "1.0">
5
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-08-29">
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<title>Mandos Manual</title>
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<date>&TIMESTAMP;</date>
18
<firstname>Björn</firstname>
19
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
25
<firstname>Teddy</firstname>
26
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
34
<holder>Teddy Hogeborn</holder>
35
<holder>Björn Påhlsson</holder>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
<manvolnum>8</manvolnum>
68
<refname><command>&COMMANDNAME;</command></refname>
70
Sends encrypted passwords to authenticated Mandos clients
76
<command>&COMMANDNAME;</command>
77
<arg>--interface<arg choice="plain">NAME</arg></arg>
78
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
<arg>--port<arg choice="plain">PORT</arg></arg>
80
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
<arg>--servicename<arg choice="plain">NAME</arg></arg>
82
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
86
<command>&COMMANDNAME;</command>
87
<arg>-i<arg choice="plain">NAME</arg></arg>
88
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
<arg>-p<arg choice="plain">PORT</arg></arg>
90
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
<arg>--servicename<arg choice="plain">NAME</arg></arg>
92
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
96
<command>&COMMANDNAME;</command>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
103
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--version</arg>
107
<command>&COMMANDNAME;</command>
108
<arg choice="plain">--check</arg>
112
<refsect1 id="description">
113
<title>DESCRIPTION</title>
115
<command>&COMMANDNAME;</command> is a server daemon which
116
handles incoming request for passwords for a pre-defined list of
117
client host computers. The Mandos server uses Zeroconf to
118
announce itself on the local network, and uses TLS to
119
communicate securely with and to authenticate the clients. The
120
Mandos server uses IPv6 to allow Mandos clients to use IPv6
121
link-local addresses, since the clients will probably not have
122
any other addresses configured (see <xref linkend="overview"/>).
123
Any authenticated client is then given the stored pre-encrypted
124
password for that specific client.
129
<refsect1 id="purpose">
130
<title>PURPOSE</title>
133
The purpose of this is to enable <emphasis>remote and unattended
134
rebooting</emphasis> of client host computer with an
135
<emphasis>encrypted root file system</emphasis>. See <xref
136
linkend="overview"/> for details.
141
<refsect1 id="options">
142
<title>OPTIONS</title>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
149
Show a help message and exit
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
166
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
174
<xi:include href="mandos-options.xml" xpointer="port"/>
179
<term><literal>--check</literal></term>
182
Run the server’s self-tests. This includes any unit
189
<term><literal>--debug</literal></term>
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
207
<xi:include href="mandos-options.xml"
208
xpointer="servicename"/>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
217
Directory to search for configuration files. Default is
218
<quote><literal>/etc/mandos</literal></quote>. See
219
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
220
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
221
<refentrytitle>mandos-clients.conf</refentrytitle>
222
<manvolnum>5</manvolnum></citerefentry>.
228
<term><literal>--version</literal></term>
231
Prints the program version and exit.
238
<refsect1 id="overview">
239
<title>OVERVIEW</title>
240
<xi:include href="overview.xml"/>
242
This program is the server part. It is a normal server program
243
and will run in a normal system environment, not in an initial
244
RAM disk environment.
248
<refsect1 id="protocol">
249
<title>NETWORK PROTOCOL</title>
251
The Mandos server announces itself as a Zeroconf service of type
252
<quote><literal>_mandos._tcp</literal></quote>. The Mandos
253
client connects to the announced address and port, and sends a
254
line of text where the first whitespace-separated field is the
255
protocol version, which currently is
256
<quote><literal>1</literal></quote>. The client and server then
257
start a TLS protocol handshake with a slight quirk: the Mandos
258
server program acts as a TLS <quote>client</quote> while the
259
connecting Mandos client acts as a TLS <quote>server</quote>.
260
The Mandos client must supply an OpenPGP certificate, and the
261
fingerprint of this certificate is used by the Mandos server to
262
look up (in a list read from <filename>clients.conf</filename>
263
at start time) which binary blob to give the client. No other
264
authentication or authorization is done by the server.
267
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
269
<entry>Mandos Client</entry>
270
<entry>Direction</entry>
271
<entry>Mandos Server</entry>
275
<entry>Connect</entry>
276
<entry>-><!-- → --></entry>
279
<entry><quote><literal>1\r\n</literal></quote></entry>
280
<entry>-><!-- → --></entry>
283
<entry>TLS handshake <emphasis>as TLS <quote>server</quote>
285
<entry><-><!-- ⟷ --></entry>
286
<entry>TLS handshake <emphasis>as TLS <quote>client</quote>
290
<entry>OpenPGP public key (part of TLS handshake)</entry>
291
<entry>-><!-- → --></entry>
295
<entry><-<!-- ← --></entry>
296
<entry>Binary blob (client will assume OpenPGP data)</entry>
300
<entry><-<!-- ← --></entry>
303
</tbody></tgroup></table>
306
<refsect1 id="checking">
307
<title>CHECKING</title>
309
The server will, by default, continually check that the clients
310
are still up. If a client has not been confirmed as being up
311
for some time, the client is assumed to be compromised and is no
312
longer eligible to receive the encrypted password. The timeout,
313
checker program, and interval between checks can be configured
314
both globally and per client; see <citerefentry>
315
<refentrytitle>mandos-clients.conf</refentrytitle>
316
<manvolnum>5</manvolnum></citerefentry>.
320
<refsect1 id="logging">
321
<title>LOGGING</title>
323
The server will send log message with various severity levels to
324
<filename>/dev/log</filename>. With the
325
<option>--debug</option> option, it will log even more messages,
326
and also show them on the console.
330
<refsect1 id="exit_status">
331
<title>EXIT STATUS</title>
333
The server will exit with a non-zero exit status only when a
334
critical error is encountered.
338
<refsect1 id="environment">
339
<title>ENVIRONMENT</title>
342
<term><varname>PATH</varname></term>
345
To start the configured checker (see <xref
346
linkend="checking"/>), the server uses
347
<filename>/bin/sh</filename>, which in turn uses
348
<varname>PATH</varname> to search for matching commands if
349
an absolute path is not given. See <citerefentry>
350
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
361
Use the <option>--configdir</option> option to change where
362
<command>&COMMANDNAME;</command> looks for its configurations
363
files. The default file names are listed here.
367
<term><filename>/etc/mandos/mandos.conf</filename></term>
370
Server-global settings. See
371
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
372
<manvolnum>5</manvolnum></citerefentry> for details.
377
<term><filename>/etc/mandos/clients.conf</filename></term>
380
List of clients and client-specific settings. See
381
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
382
<manvolnum>5</manvolnum></citerefentry> for details.
387
<term><filename>/var/run/mandos/mandos.pid</filename></term>
390
The file containing the process id of
391
<command>&COMMANDNAME;</command>.
396
<term><filename>/dev/log</filename></term>
399
The Unix domain socket to where local syslog messages are
405
<term><filename>/bin/sh</filename></term>
408
This is used to start the configured checker command for
409
each client. See <citerefentry>
410
<refentrytitle>mandos-clients.conf</refentrytitle>
411
<manvolnum>5</manvolnum></citerefentry> for details.
421
This server might, on especially fatal errors, emit a Python
422
backtrace. This could be considered a feature.
425
Currently, if a client is declared <quote>invalid</quote> due to
426
having timed out, the server does not record this fact onto
427
permanent storage. This has some security implications, see
428
<xref linkend="CLIENTS"/>.
431
There is currently no way of querying the server of the current
432
status of clients, other than analyzing its <systemitem
433
class="service">syslog</systemitem> output.
436
There is no fine-grained control over logging and debug output.
439
Debug mode is conflated with running in the foreground.
442
The console log messages does not show a timestamp.
446
<refsect1 id="example">
447
<title>EXAMPLE</title>
450
Normal invocation needs no options:
453
<userinput>&COMMANDNAME;</userinput>
458
Run the server in debug mode, read configuration files from
459
the <filename>~/mandos</filename> directory, and use the
460
Zeroconf service name <quote>Test</quote> to not collide with
461
any other official Mandos server on this host:
465
<!-- do not wrap this line -->
466
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
472
Run the server normally, but only listen to one interface and
473
only on the link-local address on that interface:
477
<!-- do not wrap this line -->
478
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
484
<refsect1 id="security">
485
<title>SECURITY</title>
486
<refsect2 id="SERVER">
487
<title>SERVER</title>
489
Running this <command>&COMMANDNAME;</command> server program
490
should not in itself present any security risk to the host
491
computer running it. The program does not need any special
492
privileges to run, and is designed to run as a non-root user.
495
<refsect2 id="CLIENTS">
496
<title>CLIENTS</title>
498
The server only gives out its stored data to clients which
499
does have the OpenPGP key of the stored fingerprint. This is
500
guaranteed by the fact that the client sends its OpenPGP
501
public key in the TLS handshake; this ensures it to be
502
genuine. The server computes the fingerprint of the key
503
itself and looks up the fingerprint in its list of
504
clients. The <filename>clients.conf</filename> file (see
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
<manvolnum>5</manvolnum></citerefentry>)
507
<emphasis>must</emphasis> be made non-readable by anyone
508
except the user running the server.
511
As detailed in <xref linkend="checking"/>, the status of all
512
client computers will continually be checked and be assumed
513
compromised if they are gone for too long.
516
If a client is compromised, its downtime should be duly noted
517
by the server which would therefore declare the client
518
invalid. But if the server was ever restarted, it would
519
re-read its client list from its configuration file and again
520
regard all clients therein as valid, and hence eligible to
521
receive their passwords. Therefore, be careful when
522
restarting servers if it is suspected that a client has, in
523
fact, been compromised by parties who may now be running a
524
fake Mandos client with the keys from the non-encrypted
525
initial RAM image of the client host. What should be done in
526
that case (if restarting the server program really is
527
necessary) is to stop the server program, edit the
528
configuration file to omit any suspect clients, and restart
532
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
534
<manvolnum>8mandos</manvolnum></citerefentry>.
539
<refsect1 id="see_also">
540
<title>SEE ALSO</title>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>password-request</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
555
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
559
Zeroconf is the network protocol standard used by clients
560
for finding this Mandos server on the local network.
566
<ulink url="http://www.avahi.org/">Avahi</ulink>
570
Avahi is the library this server calls to implement
571
Zeroconf service announcements.
577
<ulink url="http://www.gnu.org/software/gnutls/"
582
GnuTLS is the library this server uses to implement TLS for
583
communicating securely with the client, and at the same time
584
confidently get the client’s public OpenPGP key.
590
RFC 4291: <citetitle>IP Version 6 Addressing
591
Architecture</citetitle>
596
<term>Section 2.2: <citetitle>Text Representation of
597
Addresses</citetitle></term>
598
<listitem><para/></listitem>
601
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
602
Address</citetitle></term>
603
<listitem><para/></listitem>
606
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
607
Addresses</citetitle></term>
610
The clients use IPv6 link-local addresses, which are
611
immediately usable since a link-local addresses is
612
automatically assigned to a network interfaces when it
622
RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
Protocol Version 1.1</citetitle>
627
TLS 1.1 is the protocol implemented by GnuTLS.
633
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
637
The data sent to clients is binary encrypted OpenPGP data.
643
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
648
This is implemented by GnuTLS and used by this server so
649
that OpenPGP keys can be used.
656
<!-- Local Variables: -->
657
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
658
<!-- time-stamp-end: "[\"']>" -->
659
<!-- time-stamp-format: "%:y-%02m-%02d" -->