68
68
<refname><command>&COMMANDNAME;</command></refname>
70
Sends encrypted passwords to authenticated Mandos clients
70
Gives encrypted passwords to authenticated Mandos clients
76
76
<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>
78
<arg choice="plain"><option>--interface
79
<replaceable>NAME</replaceable></option></arg>
80
<arg choice="plain"><option>-i
81
<replaceable>NAME</replaceable></option></arg>
85
<arg choice="plain"><option>--address
86
<replaceable>ADDRESS</replaceable></option></arg>
87
<arg choice="plain"><option>-a
88
<replaceable>ADDRESS</replaceable></option></arg>
92
<arg choice="plain"><option>--port
93
<replaceable>PORT</replaceable></option></arg>
94
<arg choice="plain"><option>-p
95
<replaceable>PORT</replaceable></option></arg>
98
<arg><option>--priority
99
<replaceable>PRIORITY</replaceable></option></arg>
101
<arg><option>--servicename
102
<replaceable>NAME</replaceable></option></arg>
104
<arg><option>--configdir
105
<replaceable>DIRECTORY</replaceable></option></arg>
107
<arg><option>--debug</option></arg>
110
<command>&COMMANDNAME;</command>
112
<arg choice="plain"><option>--help</option></arg>
113
<arg choice="plain"><option>-h</option></arg>
117
<command>&COMMANDNAME;</command>
118
<arg choice="plain"><option>--version</option></arg>
121
<command>&COMMANDNAME;</command>
122
<arg choice="plain"><option>--check</option></arg>
107
124
</refsynopsisdiv>
109
126
<refsect1 id="description">
112
129
<command>&COMMANDNAME;</command> is a server daemon which
113
130
handles incoming request for passwords for a pre-defined list of
114
131
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 yet. Any
119
authenticated client is then given the pre-encrypted password
120
for that specific client.
132
announce itself on the local network, and uses TLS to
133
communicate securely with and to authenticate the clients. The
134
Mandos server uses IPv6 to allow Mandos clients to use IPv6
135
link-local addresses, since the clients will probably not have
136
any other addresses configured (see <xref linkend="overview"/>).
137
Any authenticated client is then given the stored pre-encrypted
138
password for that specific client.
125
143
<refsect1 id="purpose">
126
144
<title>PURPOSE</title>
129
147
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
148
rebooting</emphasis> of client host computer with an
149
<emphasis>encrypted root file system</emphasis>. See <xref
150
linkend="overview"/> for details.
142
155
<refsect1 id="options">
143
156
<title>OPTIONS</title>
147
<term><literal>-h</literal>, <literal>--help</literal></term>
160
<term><option>--help</option></term>
161
<term><option>-h</option></term>
150
164
Show a help message and exit
156
<term><literal>-i</literal>, <literal>--interface <replaceable>
157
IF</replaceable></literal></term>
160
Only announce the server and listen to requests on network
161
interface <replaceable>IF</replaceable>. Default is to
162
use all available interfaces.
168
<term><literal>-a</literal>, <literal>--address <replaceable>
169
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
"<literal>::FFFF:192.0.2.3</literal>" syntax. Also, if a
176
link-local address is specified, an interface should be
177
set, since a link-local address is only valid on a single
178
interface. By default, the server will listen to all
185
<term><literal>-p</literal>, <literal>--port <replaceable>
186
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.
197
<term><literal>--check</literal></term>
200
Run the server's self-tests. This includes any unit
170
<term><option>--interface</option>
171
<replaceable>NAME</replaceable></term>
172
<term><option>-i</option>
173
<replaceable>NAME</replaceable></term>
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><option>--address
181
<replaceable>ADDRESS</replaceable></option></term>
183
<replaceable>ADDRESS</replaceable></option></term>
185
<xi:include href="mandos-options.xml" xpointer="address"/>
191
<replaceable>PORT</replaceable></option></term>
193
<replaceable>PORT</replaceable></option></term>
195
<xi:include href="mandos-options.xml" xpointer="port"/>
200
<term><option>--check</option></term>
203
Run the server’s self-tests. This includes any unit
207
<term><literal>--debug</literal></term>
210
If the server is run in debug mode, it will run in the
211
foreground and print a lot of debugging information. The
212
default is <emphasis>not</emphasis> to run in debug mode.
218
<term><literal>--priority <replaceable>
219
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
"<literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal>".
228
<emphasis>Warning</emphasis>: changing this may make the
229
TLS handshake fail, making communication with clients
236
<term><literal>--servicename <replaceable>NAME</replaceable>
240
Zeroconf service name. The default is
241
"<literal>Mandos</literal>". You only need to change this
242
if you for some reason want to run more than one server on
243
the same <emphasis>host</emphasis>. If there are name
244
collisions on the same <emphasis>network</emphasis>, the
245
new server will automatically rename itself to "Mandos
252
<term><literal>--configdir <replaceable>DIR</replaceable>
210
<term><option>--debug</option></term>
212
<xi:include href="mandos-options.xml" xpointer="debug"/>
217
<term><option>--priority <replaceable>
218
PRIORITY</replaceable></option></term>
220
<xi:include href="mandos-options.xml" xpointer="priority"/>
225
<term><option>--servicename
226
<replaceable>NAME</replaceable></option></term>
228
<xi:include href="mandos-options.xml"
229
xpointer="servicename"/>
234
<term><option>--configdir
235
<replaceable>DIRECTORY</replaceable></option></term>
256
238
Directory to search for configuration files. Default is
257
"<literal>/etc/mandos</literal>". See <citerefentry>
258
<refentrytitle>mandos.conf</refentrytitle>
239
<quote><literal>/etc/mandos</literal></quote>. See
240
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
259
241
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
260
242
<refentrytitle>mandos-clients.conf</refentrytitle>
261
243
<manvolnum>5</manvolnum></citerefentry>.
267
<term><literal>--version</literal></term>
249
<term><option>--version</option></term>
270
252
Prints the program version and exit.
259
<refsect1 id="overview">
260
<title>OVERVIEW</title>
261
<xi:include href="overview.xml"/>
263
This program is the server part. It is a normal server program
264
and will run in a normal system environment, not in an initial
265
RAM disk environment.
277
269
<refsect1 id="protocol">
278
270
<title>NETWORK PROTOCOL</title>
280
272
The Mandos server announces itself as a Zeroconf service of type
281
"<literal>_mandos._tcp</literal>". The Mandos client connects
282
to the announced address and port, and sends a line of text
283
where the first whitespace-separated field is the protocol
284
version, which currently is "<literal>1</literal>". The client
285
and server then start a TLS protocol handshake with a slight
286
quirk: the Mandos server program acts as a TLS "client" while
287
the connecting Mandos client acts as a TLS "server". The Mandos
288
client must supply an OpenPGP certificate, and the fingerprint
289
of this certificate is used by the Mandos server to look up (in
290
a list read from a file at start time) which binary blob to give
291
the client. No other authentication or authorization is done by
273
<quote><literal>_mandos._tcp</literal></quote>. The Mandos
274
client connects to the announced address and port, and sends a
275
line of text where the first whitespace-separated field is the
276
protocol version, which currently is
277
<quote><literal>1</literal></quote>. The client and server then
278
start a TLS protocol handshake with a slight quirk: the Mandos
279
server program acts as a TLS <quote>client</quote> while the
280
connecting Mandos client acts as a TLS <quote>server</quote>.
281
The Mandos client must supply an OpenPGP certificate, and the
282
fingerprint of this certificate is used by the Mandos server to
283
look up (in a list read from <filename>clients.conf</filename>
284
at start time) which binary blob to give the client. No other
285
authentication or authorization is done by the server.
294
<informaltable><tgroup cols="3"><thead>
288
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
296
290
<entry>Mandos Client</entry>
297
291
<entry>Direction</entry>
359
<refsect1 id="environment">
360
<title>ENVIRONMENT</title>
363
<term><envar>PATH</envar></term>
366
To start the configured checker (see <xref
367
linkend="checking"/>), the server uses
368
<filename>/bin/sh</filename>, which in turn uses
369
<varname>PATH</varname> to search for matching commands if
370
an absolute path is not given. See <citerefentry>
371
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
379
<refsect1 id="file">
352
380
<title>FILES</title>
356
<filename>/etc/mandos/mandos.conf</filename> See <citerefentry>
357
<refentrytitle>mandos.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>.
361
<filename>/etc/mandos/clients.conf</filename> See <citerefentry>
382
Use the <option>--configdir</option> option to change where
383
<command>&COMMANDNAME;</command> looks for its configurations
384
files. The default file names are listed here.
388
<term><filename>/etc/mandos/mandos.conf</filename></term>
391
Server-global settings. See
392
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
<manvolnum>5</manvolnum></citerefentry> for details.
398
<term><filename>/etc/mandos/clients.conf</filename></term>
401
List of clients and client-specific settings. See
402
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
403
<manvolnum>5</manvolnum></citerefentry> for details.
408
<term><filename>/var/run/mandos/mandos.pid</filename></term>
411
The file containing the process id of
412
<command>&COMMANDNAME;</command>.
417
<term><filename>/dev/log</filename></term>
420
The Unix domain socket to where local syslog messages are
426
<term><filename>/bin/sh</filename></term>
429
This is used to start the configured checker command for
430
each client. See <citerefentry>
362
431
<refentrytitle>mandos-clients.conf</refentrytitle>
363
<manvolnum>5</manvolnum></citerefentry>.
366
<filename>/var/run/mandos/mandos.pid</filename>
432
<manvolnum>5</manvolnum></citerefentry> for details.
372
439
<refsect1 id="bugs">
373
440
<title>BUGS</title>
378
<refsect1 id="examples">
379
<title>EXAMPLES</title>
442
This server might, on especially fatal errors, emit a Python
443
backtrace. This could be considered a feature.
446
Currently, if a client is declared <quote>invalid</quote> due to
447
having timed out, the server does not record this fact onto
448
permanent storage. This has some security implications, see
449
<xref linkend="CLIENTS"/>.
452
There is currently no way of querying the server of the current
453
status of clients, other than analyzing its <systemitem
454
class="service">syslog</systemitem> output.
457
There is no fine-grained control over logging and debug output.
460
Debug mode is conflated with running in the foreground.
463
The console log messages does not show a timestamp.
467
<refsect1 id="example">
468
<title>EXAMPLE</title>
471
Normal invocation needs no options:
474
<userinput>&COMMANDNAME;</userinput>
479
Run the server in debug mode, read configuration files from
480
the <filename>~/mandos</filename> directory, and use the
481
Zeroconf service name <quote>Test</quote> to not collide with
482
any other official Mandos server on this host:
486
<!-- do not wrap this line -->
487
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
493
Run the server normally, but only listen to one interface and
494
only on the link-local address on that interface:
498
<!-- do not wrap this line -->
499
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
384
505
<refsect1 id="security">
385
506
<title>SECURITY</title>
507
<refsect2 id="SERVER">
508
<title>SERVER</title>
510
Running this <command>&COMMANDNAME;</command> server program
511
should not in itself present any security risk to the host
512
computer running it. The program does not need any special
513
privileges to run, and is designed to run as a non-root user.
516
<refsect2 id="CLIENTS">
517
<title>CLIENTS</title>
519
The server only gives out its stored data to clients which
520
does have the OpenPGP key of the stored fingerprint. This is
521
guaranteed by the fact that the client sends its OpenPGP
522
public key in the TLS handshake; this ensures it to be
523
genuine. The server computes the fingerprint of the key
524
itself and looks up the fingerprint in its list of
525
clients. The <filename>clients.conf</filename> file (see
526
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
<manvolnum>5</manvolnum></citerefentry>)
528
<emphasis>must</emphasis> be made non-readable by anyone
529
except the user running the server.
532
As detailed in <xref linkend="checking"/>, the status of all
533
client computers will continually be checked and be assumed
534
compromised if they are gone for too long.
537
If a client is compromised, its downtime should be duly noted
538
by the server which would therefore declare the client
539
invalid. But if the server was ever restarted, it would
540
re-read its client list from its configuration file and again
541
regard all clients therein as valid, and hence eligible to
542
receive their passwords. Therefore, be careful when
543
restarting servers if it is suspected that a client has, in
544
fact, been compromised by parties who may now be running a
545
fake Mandos client with the keys from the non-encrypted
546
initial RAM image of the client host. What should be done in
547
that case (if restarting the server program really is
548
necessary) is to stop the server program, edit the
549
configuration file to omit any suspect clients, and restart
553
For more details on client-side security, see
554
<citerefentry><refentrytitle>password-request</refentrytitle>
555
<manvolnum>8mandos</manvolnum></citerefentry>.
390
560
<refsect1 id="see_also">
391
561
<title>SEE ALSO</title>
392
<itemizedlist spacing="compact">
394
<citerefentry><refentrytitle>password-request</refentrytitle>
395
<manvolnum>8mandos</manvolnum></citerefentry>
399
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
400
<manvolnum>8mandos</manvolnum></citerefentry>
404
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
408
<ulink url="http://www.avahi.org/">Avahi</ulink>
413
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
417
<citation>RFC 4880: <citetitle>OpenPGP Message
418
Format</citetitle></citation>
422
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
423
Transport Layer Security</citetitle></citation>
427
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
428
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
429
Unicast Addresses</citation>
564
<refentrytitle>mandos-clients.conf</refentrytitle>
565
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>mandos.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>password-request</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
576
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
580
Zeroconf is the network protocol standard used by clients
581
for finding this Mandos server on the local network.
587
<ulink url="http://www.avahi.org/">Avahi</ulink>
591
Avahi is the library this server calls to implement
592
Zeroconf service announcements.
598
<ulink url="http://www.gnu.org/software/gnutls/"
603
GnuTLS is the library this server uses to implement TLS for
604
communicating securely with the client, and at the same time
605
confidently get the client’s public OpenPGP key.
611
RFC 4291: <citetitle>IP Version 6 Addressing
612
Architecture</citetitle>
617
<term>Section 2.2: <citetitle>Text Representation of
618
Addresses</citetitle></term>
619
<listitem><para/></listitem>
622
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
Address</citetitle></term>
624
<listitem><para/></listitem>
627
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
Addresses</citetitle></term>
631
The clients use IPv6 link-local addresses, which are
632
immediately usable since a link-local addresses is
633
automatically assigned to a network interfaces when it
643
RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
Protocol Version 1.1</citetitle>
648
TLS 1.1 is the protocol implemented by GnuTLS.
654
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
658
The data sent to clients is binary encrypted OpenPGP data.
664
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
669
This is implemented by GnuTLS and used by this server so
670
that OpenPGP keys can be used.
677
<!-- Local Variables: -->
678
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
679
<!-- time-stamp-end: "[\"']>" -->
680
<!-- time-stamp-format: "%:y-%02m-%02d" -->