1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos">
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
<title>&COMMANDNAME;</title>
13
<!-- NWalsh's docbook scripts use this to generate the footer: -->
11
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
12
<productname>&COMMANDNAME;</productname>
15
13
<productnumber>&VERSION;</productnumber>
76
74
<command>&COMMANDNAME;</command>
77
<arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
<arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
<arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
<arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
<arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
<arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
<arg choice='opt'>--debug</arg>
86
<command>&COMMANDNAME;</command>
87
<arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
<arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
<arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
<arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
<arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
<arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
<arg choice='opt'>--debug</arg>
96
<command>&COMMANDNAME;</command>
97
<arg choice='plain'>--help</arg>
100
<command>&COMMANDNAME;</command>
101
<arg choice='plain'>--version</arg>
104
<command>&COMMANDNAME;</command>
105
<arg choice='plain'>--check</arg>
75
<arg>--interface<arg choice="plain">IF</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">IF</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
94
<command>&COMMANDNAME;</command>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
101
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
105
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
107
108
</refsynopsisdiv>
112
113
<command>&COMMANDNAME;</command> is a server daemon which
113
114
handles incoming request for passwords for a pre-defined list of
114
115
client host computers. The Mandos server uses Zeroconf to
115
announce itself on the local network, and uses GnuTLS to
116
communicate securely with and to authenticate the clients.
117
Mandos uses IPv6 link-local addresses, since the clients are
118
assumed to not have any other addresses configured. Any
119
authenticated client is then given the pre-encrypted password
120
for that specific client.
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.
129
131
The purpose of this is to enable <emphasis>remote and unattended
130
rebooting</emphasis> of any client host computer with an
131
<emphasis>encrypted root file system</emphasis>. The client
132
host computer should start a Mandos client in the initial RAM
133
disk environment, the Mandos client program communicates with
134
this server program to get an encrypted password, which is then
135
decrypted and used to unlock the encrypted root file system.
136
The client host computer can then continue its boot sequence
132
rebooting</emphasis> of client host computer with an
133
<emphasis>encrypted root file system</emphasis>. See <xref
134
linkend="overview"/> for details.
168
161
<term><literal>-a</literal>, <literal>--address <replaceable>
169
162
ADDRESS</replaceable></literal></term>
172
If this option is used, the server will only listen to a
173
specific address. This must currently be an IPv6 address;
174
an IPv4 address can be specified using the
175
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
Also, if a link-local address is specified, an interface
177
should be set, since a link-local address is only valid on
178
a single interface. By default, the server will listen to
179
all available addresses.
164
<xi:include href="mandos-options.xml" xpointer="address"/>
185
169
<term><literal>-p</literal>, <literal>--port <replaceable>
186
170
PORT</replaceable></literal></term>
189
If this option is used, the server to bind to that
190
port. By default, the server will listen to an arbitrary
191
port given by the operating system.
172
<xi:include href="mandos-options.xml" xpointer="port"/>
218
194
<term><literal>--priority <replaceable>
219
195
PRIORITY</replaceable></literal></term>
222
GnuTLS priority string for the TLS handshake with the
224
<citerefentry><refentrytitle>gnutls_priority_init
225
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
for the syntax. The default is
227
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
<emphasis>Warning</emphasis>: changing this may make the
229
TLS handshake fail, making communication with clients
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
236
202
<term><literal>--servicename <replaceable>NAME</replaceable>
237
203
</literal></term>
240
Zeroconf service name. The default is
241
<quote><literal>Mandos</literal></quote>. You only need
242
to change this if you for some reason want to run more
243
than one server on the same <emphasis>host</emphasis>,
244
which would not normally be useful. If there are name
245
collisions on the same <emphasis>network</emphasis>, the
246
newer server will automatically rename itself to
247
<quote><literal>Mandos #2</literal></quote>, and so on,
248
therefore this option is not needed in that case.
205
<xi:include href="mandos-options.xml"
206
xpointer="servicename"/>
341
308
are still up. If a client has not been confirmed as being up
342
309
for some time, the client is assumed to be compromised and is no
343
310
longer eligible to receive the encrypted password. The timeout,
344
checker program and interval between checks can be configured
311
checker program, and interval between checks can be configured
345
312
both globally and per client; see <citerefentry>
346
313
<refentrytitle>mandos.conf</refentrytitle>
347
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
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>
371
358
<refsect1 id="file">
372
359
<title>FILES</title>
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.
420
418
<refsect1 id="bugs">
421
419
<title>BUGS</title>
423
421
This server might, on especially fatal errors, emit a Python
424
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.
428
<refsect1 id="examples">
429
<title>EXAMPLES</title>
446
<refsect1 id="example">
447
<title>EXAMPLE</title>
430
448
<informalexample>
432
450
Normal invocation needs no options:
437
455
</informalexample>
438
456
<informalexample>
440
Run the server in debug mode and read configuration files from
441
the <filename>~/mandos</filename> directory:
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:
464
484
<refsect1 id="security">
465
485
<title>SECURITY</title>
486
<refsect2 id="SERVER">
467
487
<title>SERVER</title>
469
Running the server should not in itself present any security
470
risk to the host computer running it.
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">
474
496
<title>CLIENTS</title>
476
498
The server only gives out its stored data to clients which
481
503
itself and looks up the fingerprint in its list of
482
504
clients. The <filename>clients.conf</filename> file (see
483
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
<manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
by anyone except the user running the server.
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
488
532
For more details on client-side security, see
495
539
<refsect1 id="see_also">
496
540
<title>SEE ALSO</title>
497
<itemizedlist spacing="compact">
499
<citerefentry><refentrytitle>password-request</refentrytitle>
500
<manvolnum>8mandos</manvolnum></citerefentry>
504
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
<manvolnum>8mandos</manvolnum></citerefentry>
509
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
513
<ulink url="http://www.avahi.org/">Avahi</ulink>
518
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
522
<citation>RFC 4880: <citetitle>OpenPGP Message
523
Format</citetitle></citation>
527
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
Transport Layer Security</citetitle></citation>
532
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
Unicast Addresses</citation>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum>
551
This is the actual program which talks to this server.
552
Note that it is normally not invoked directly, and is only
553
run in the initial RAM disk environment, and not on a
554
fully started system.
560
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
564
Zeroconf is the network protocol standard used by clients
565
for finding this Mandos server on the local network.
571
<ulink url="http://www.avahi.org/">Avahi</ulink>
575
Avahi is the library this server calls to implement
576
Zeroconf service announcements.
583
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
587
GnuTLS is the library this server uses to implement TLS for
588
communicating securely with the client, and at the same time
589
confidently get the client’s public OpenPGP key.
595
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
Unicast Addresses</citation>
601
The clients use IPv6 link-local addresses, which are
602
immediately usable since a link-local addresses is
603
automatically assigned to a network interfaces when it is
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>
615
TLS 1.1 is the protocol implemented by GnuTLS.
621
<citation>RFC 4880: <citetitle>OpenPGP Message
622
Format</citetitle></citation>
626
The data sent to clients is binary encrypted OpenPGP data.
632
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
633
Transport Layer Security</citetitle></citation>
637
This is implemented by GnuTLS and used by this server so
638
that OpenPGP keys can be used.