1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
5
<!ENTITY TIMESTAMP "2016-07-03">
6
<!ENTITY % common SYSTEM "common.ent">
11
<title>&COMMANDNAME;</title>
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&COMMANDNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
17
19
<firstname>Björn</firstname>
18
20
<surname>Påhlsson</surname>
20
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
24
26
<firstname>Teddy</firstname>
25
27
<surname>Hogeborn</surname>
27
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
33
43
<holder>Teddy Hogeborn</holder>
34
44
<holder>Björn Påhlsson</holder>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
46
<xi:include href="legalnotice.xml"/>
62
50
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
51
<manvolnum>8</manvolnum>
67
55
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
57
Gives encrypted passwords to authenticated Mandos clients
75
63
<command>&COMMANDNAME;</command>
76
<arg>--interface<arg choice="plain">IF</arg></arg>
77
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
<arg>--port<arg choice="plain">PORT</arg></arg>
79
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
80
<arg>--servicename<arg choice="plain">NAME</arg></arg>
81
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
85
<command>&COMMANDNAME;</command>
86
<arg>-i<arg choice="plain">IF</arg></arg>
87
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
<arg>-p<arg choice="plain">PORT</arg></arg>
89
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
90
<arg>--servicename<arg choice="plain">NAME</arg></arg>
91
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
65
<arg choice="plain"><option>--interface
66
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>-i
68
<replaceable>NAME</replaceable></option></arg>
72
<arg choice="plain"><option>--address
73
<replaceable>ADDRESS</replaceable></option></arg>
74
<arg choice="plain"><option>-a
75
<replaceable>ADDRESS</replaceable></option></arg>
79
<arg choice="plain"><option>--port
80
<replaceable>PORT</replaceable></option></arg>
81
<arg choice="plain"><option>-p
82
<replaceable>PORT</replaceable></option></arg>
85
<arg><option>--priority
86
<replaceable>PRIORITY</replaceable></option></arg>
88
<arg><option>--servicename
89
<replaceable>NAME</replaceable></option></arg>
91
<arg><option>--configdir
92
<replaceable>DIRECTORY</replaceable></option></arg>
94
<arg><option>--debug</option></arg>
96
<arg><option>--debuglevel
97
<replaceable>LEVEL</replaceable></option></arg>
99
<arg><option>--no-dbus</option></arg>
101
<arg><option>--no-ipv6</option></arg>
103
<arg><option>--no-restore</option></arg>
105
<arg><option>--statedir
106
<replaceable>DIRECTORY</replaceable></option></arg>
108
<arg><option>--socket
109
<replaceable>FD</replaceable></option></arg>
111
<arg><option>--foreground</option></arg>
113
<arg><option>--no-zeroconf</option></arg>
95
116
<command>&COMMANDNAME;</command>
96
117
<group choice="req">
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
118
<arg choice="plain"><option>--help</option></arg>
119
<arg choice="plain"><option>-h</option></arg>
102
123
<command>&COMMANDNAME;</command>
103
<arg choice="plain">--version</arg>
124
<arg choice="plain"><option>--version</option></arg>
106
127
<command>&COMMANDNAME;</command>
107
<arg choice="plain">--check</arg>
128
<arg choice="plain"><option>--check</option></arg>
109
130
</refsynopsisdiv>
111
132
<refsect1 id="description">
112
133
<title>DESCRIPTION</title>
114
135
<command>&COMMANDNAME;</command> is a server daemon which
115
136
handles incoming request for passwords for a pre-defined list of
116
client host computers. The Mandos server uses Zeroconf to
117
announce itself on the local network, and uses TLS to
118
communicate securely with and to authenticate the clients. The
119
Mandos server uses IPv6 to allow Mandos clients to use IPv6
120
link-local addresses, since the clients will probably not have
121
any other addresses configured (see <xref linkend="overview"/>).
122
Any authenticated client is then given the stored pre-encrypted
123
password for that specific client.
137
client host computers. For an introduction, see
138
<citerefentry><refentrytitle>intro</refentrytitle>
139
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
uses Zeroconf to announce itself on the local network, and uses
141
TLS to communicate securely with and to authenticate the
142
clients. The Mandos server uses IPv6 to allow Mandos clients to
143
use IPv6 link-local addresses, since the clients will probably
144
not have any other addresses configured (see <xref
145
linkend="overview"/>). Any authenticated client is then given
146
the stored pre-encrypted password for that specific client.
128
150
<refsect1 id="purpose">
129
151
<title>PURPOSE</title>
132
153
The purpose of this is to enable <emphasis>remote and unattended
133
154
rebooting</emphasis> of client host computer with an
134
155
<emphasis>encrypted root file system</emphasis>. See <xref
135
156
linkend="overview"/> for details.
140
160
<refsect1 id="options">
141
161
<title>OPTIONS</title>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
164
<term><option>--help</option></term>
165
<term><option>-h</option></term>
148
168
Show a help message and exit
154
<term><literal>-i</literal>, <literal>--interface <replaceable>
155
IF</replaceable></literal></term>
158
Only announce the server and listen to requests on network
159
interface <replaceable>IF</replaceable>. Default is to
160
use all available interfaces. <emphasis>Note:</emphasis>
161
a failure to bind to the specified interface is not
162
considered critical, and the server does not exit.
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
<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.
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>
174
<term><option>--interface</option>
175
<replaceable>NAME</replaceable></term>
176
<term><option>-i</option>
177
<replaceable>NAME</replaceable></term>
179
<xi:include href="mandos-options.xml" xpointer="interface"/>
184
<term><option>--address
185
<replaceable>ADDRESS</replaceable></option></term>
187
<replaceable>ADDRESS</replaceable></option></term>
189
<xi:include href="mandos-options.xml" xpointer="address"/>
195
<replaceable>PORT</replaceable></option></term>
197
<replaceable>PORT</replaceable></option></term>
199
<xi:include href="mandos-options.xml" xpointer="port"/>
204
<term><option>--check</option></term>
200
207
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
223
clients. The default is
224
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
See <citerefentry><refentrytitle>gnutls_priority_init
226
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
for the syntax. <emphasis>Warning</emphasis>: changing
228
this may make the TLS handshake fail, making communication
229
with clients impossible.
235
<term><literal>--servicename <replaceable>NAME</replaceable>
239
Zeroconf service name. The default is
240
<quote><literal>Mandos</literal></quote>. You only need
241
to change this if you for some reason want to run more
242
than one server on the same <emphasis>host</emphasis>,
243
which would not normally be useful. If there are name
244
collisions on the same <emphasis>network</emphasis>, the
245
newer server will automatically rename itself to
246
<quote><literal>Mandos #2</literal></quote>, and so on;
247
therefore, this option is not needed in that case.
253
<term><literal>--configdir <replaceable>DIR</replaceable>
214
<term><option>--debug</option></term>
216
<xi:include href="mandos-options.xml" xpointer="debug"/>
221
<term><option>--debuglevel
222
<replaceable>LEVEL</replaceable></option></term>
225
Set the debugging log level.
226
<replaceable>LEVEL</replaceable> is a string, one of
227
<quote><literal>CRITICAL</literal></quote>,
228
<quote><literal>ERROR</literal></quote>,
229
<quote><literal>WARNING</literal></quote>,
230
<quote><literal>INFO</literal></quote>, or
231
<quote><literal>DEBUG</literal></quote>, in order of
232
increasing verbosity. The default level is
233
<quote><literal>WARNING</literal></quote>.
239
<term><option>--priority <replaceable>
240
PRIORITY</replaceable></option></term>
242
<xi:include href="mandos-options.xml" xpointer="priority"/>
247
<term><option>--servicename
248
<replaceable>NAME</replaceable></option></term>
250
<xi:include href="mandos-options.xml"
251
xpointer="servicename"/>
256
<term><option>--configdir
257
<replaceable>DIRECTORY</replaceable></option></term>
257
260
Directory to search for configuration files. Default is
268
<term><literal>--version</literal></term>
271
<term><option>--version</option></term>
271
274
Prints the program version and exit.
280
<term><option>--no-dbus</option></term>
282
<xi:include href="mandos-options.xml" xpointer="dbus"/>
284
See also <xref linkend="dbus_interface"/>.
290
<term><option>--no-ipv6</option></term>
292
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
297
<term><option>--no-restore</option></term>
299
<xi:include href="mandos-options.xml" xpointer="restore"/>
301
See also <xref linkend="persistent_state"/>.
307
<term><option>--statedir
308
<replaceable>DIRECTORY</replaceable></option></term>
310
<xi:include href="mandos-options.xml" xpointer="statedir"/>
315
<term><option>--socket
316
<replaceable>FD</replaceable></option></term>
318
<xi:include href="mandos-options.xml" xpointer="socket"/>
323
<term><option>--foreground</option></term>
325
<xi:include href="mandos-options.xml"
326
xpointer="foreground"/>
331
<term><option>--no-zeroconf</option></term>
333
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
278
340
<refsect1 id="overview">
279
341
<title>OVERVIEW</title>
342
<xi:include href="overview.xml"/>
282
344
This program is the server part. It is a normal server program
283
345
and will run in a normal system environment, not in an initial
284
RAM disk environment.
346
<acronym>RAM</acronym> disk environment.
288
350
<refsect1 id="protocol">
289
351
<title>NETWORK PROTOCOL</title>
343
405
</tbody></tgroup></table>
346
408
<refsect1 id="checking">
347
409
<title>CHECKING</title>
349
411
The server will, by default, continually check that the clients
350
412
are still up. If a client has not been confirmed as being up
351
413
for some time, the client is assumed to be compromised and is no
352
longer eligible to receive the encrypted password. The timeout,
353
checker program, and interval between checks can be configured
354
both globally and per client; see <citerefentry>
355
<refentrytitle>mandos.conf</refentrytitle>
356
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
414
longer eligible to receive the encrypted password. (Manual
415
intervention is required to re-enable a client.) The timeout,
416
extended timeout, checker program, and interval between checks
417
can be configured both globally and per client; see
418
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
<manvolnum>5</manvolnum></citerefentry>.
423
<refsect1 id="approval">
424
<title>APPROVAL</title>
426
The server can be configured to require manual approval for a
427
client before it is sent its secret. The delay to wait for such
428
approval and the default action (approve or deny) can be
429
configured both globally and per client; see <citerefentry>
357
430
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>.
431
<manvolnum>5</manvolnum></citerefentry>. By default all clients
432
will be approved immediately without delay.
435
This can be used to deny a client its secret if not manually
436
approved within a specified time. It can also be used to make
437
the server delay before giving a client its secret, allowing
438
optional manual denying of this specific client.
362
443
<refsect1 id="logging">
363
444
<title>LOGGING</title>
365
The server will send log messaged with various severity levels
366
to <filename>/dev/log</filename>. With the
446
The server will send log message with various severity levels to
447
<filename class="devicefile">/dev/log</filename>. With the
367
448
<option>--debug</option> option, it will log even more messages,
368
449
and also show them on the console.
453
<refsect1 id="persistent_state">
454
<title>PERSISTENT STATE</title>
456
Client settings, initially read from
457
<filename>clients.conf</filename>, are persistent across
458
restarts, and run-time changes will override settings in
459
<filename>clients.conf</filename>. However, if a setting is
460
<emphasis>changed</emphasis> (or a client added, or removed) in
461
<filename>clients.conf</filename>, this will take precedence.
465
<refsect1 id="dbus_interface">
466
<title>D-BUS INTERFACE</title>
468
The server will by default provide a D-Bus system bus interface.
469
This interface will only be accessible by the root user or a
470
Mandos-specific user, if such a user exists. For documentation
471
of the D-Bus API, see the file <filename>DBUS-API</filename>.
372
475
<refsect1 id="exit_status">
373
476
<title>EXIT STATUS</title>
555
661
compromised if they are gone for too long.
558
If a client is compromised, its downtime should be duly noted
559
by the server which would therefore declare the client
560
invalid. But if the server was ever restarted, it would
561
re-read its client list from its configuration file and again
562
regard all clients therein as valid, and hence eligible to
563
receive their passwords. Therefore, be careful when
564
restarting servers if you suspect that a client has, in fact,
565
been compromised by parties who may now be running a fake
566
Mandos client with the keys from the non-encrypted initial RAM
567
image of the client host. What should be done in that case
568
(if restarting the server program really is necessary) is to
569
stop the server program, edit the configuration file to omit
570
any suspect clients, and restart the server program.
573
664
For more details on client-side security, see
574
<citerefentry><refentrytitle>password-request</refentrytitle>
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
575
666
<manvolnum>8mandos</manvolnum></citerefentry>.
580
671
<refsect1 id="see_also">
581
672
<title>SEE ALSO</title>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<manvolnum>1</manvolnum></citerefentry>
586
<refentrytitle>password-request</refentrytitle>
587
<manvolnum>8mandos</manvolnum>
592
This is the actual program which talks to this server.
593
Note that it is normally not invoked directly, and is only
594
run in the initial RAM disk environment, and not on a
595
fully started system.
601
688
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
636
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
Unicast Addresses</citation>
722
RFC 4291: <citetitle>IP Version 6 Addressing
723
Architecture</citetitle>
642
The clients use IPv6 link-local addresses, which are
643
immediately usable since a link-local addresses is
644
automatically assigned to a network interfaces when it is
728
<term>Section 2.2: <citetitle>Text Representation of
729
Addresses</citetitle></term>
730
<listitem><para/></listitem>
733
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
734
Address</citetitle></term>
735
<listitem><para/></listitem>
738
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
739
Addresses</citetitle></term>
742
The clients use IPv6 link-local addresses, which are
743
immediately usable since a link-local addresses is
744
automatically assigned to a network interfaces when it
651
<citation>RFC 4346: <citetitle>The Transport Layer Security
652
(TLS) Protocol Version 1.1</citetitle></citation>
754
RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
Protocol Version 1.2</citetitle>
656
TLS 1.1 is the protocol implemented by GnuTLS.
759
TLS 1.2 is the protocol implemented by GnuTLS.
662
<citation>RFC 4880: <citetitle>OpenPGP Message
663
Format</citetitle></citation>
765
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>