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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2015-12-06">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-29">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
42
34
<holder>Teddy Hogeborn</holder>
43
35
<holder>Björn Påhlsson</holder>
45
<xi:include href="legalnotice.xml"/>
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/"/>.
49
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
50
64
<manvolnum>8</manvolnum>
54
68
<refname><command>&COMMANDNAME;</command></refname>
56
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
62
76
<command>&COMMANDNAME;</command>
64
<arg choice="plain"><option>--interface
65
<replaceable>NAME</replaceable></option></arg>
66
<arg choice="plain"><option>-i
67
<replaceable>NAME</replaceable></option></arg>
71
<arg choice="plain"><option>--address
72
<replaceable>ADDRESS</replaceable></option></arg>
73
<arg choice="plain"><option>-a
74
<replaceable>ADDRESS</replaceable></option></arg>
78
<arg choice="plain"><option>--port
79
<replaceable>PORT</replaceable></option></arg>
80
<arg choice="plain"><option>-p
81
<replaceable>PORT</replaceable></option></arg>
84
<arg><option>--priority
85
<replaceable>PRIORITY</replaceable></option></arg>
87
<arg><option>--servicename
88
<replaceable>NAME</replaceable></option></arg>
90
<arg><option>--configdir
91
<replaceable>DIRECTORY</replaceable></option></arg>
93
<arg><option>--debug</option></arg>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
98
<arg><option>--no-dbus</option></arg>
100
<arg><option>--no-ipv6</option></arg>
102
<arg><option>--no-restore</option></arg>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
110
<arg><option>--foreground</option></arg>
112
<arg><option>--no-zeroconf</option></arg>
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>
115
96
<command>&COMMANDNAME;</command>
116
97
<group choice="req">
117
<arg choice="plain"><option>--help</option></arg>
118
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
122
103
<command>&COMMANDNAME;</command>
123
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
126
107
<command>&COMMANDNAME;</command>
127
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
129
110
</refsynopsisdiv>
131
112
<refsect1 id="description">
132
113
<title>DESCRIPTION</title>
134
115
<command>&COMMANDNAME;</command> is a server daemon which
135
116
handles incoming request for passwords for a pre-defined list of
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
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.
149
129
<refsect1 id="purpose">
150
130
<title>PURPOSE</title>
152
133
The purpose of this is to enable <emphasis>remote and unattended
153
134
rebooting</emphasis> of client host computer with an
154
135
<emphasis>encrypted root file system</emphasis>. See <xref
155
136
linkend="overview"/> for details.
159
141
<refsect1 id="options">
160
142
<title>OPTIONS</title>
163
<term><option>--help</option></term>
164
<term><option>-h</option></term>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
167
149
Show a help message and exit
173
<term><option>--interface</option>
174
<replaceable>NAME</replaceable></term>
175
<term><option>-i</option>
176
<replaceable>NAME</replaceable></term>
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
178
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
183
<term><option>--address
184
<replaceable>ADDRESS</replaceable></option></term>
186
<replaceable>ADDRESS</replaceable></option></term>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
188
166
<xi:include href="mandos-options.xml" xpointer="address"/>
194
<replaceable>PORT</replaceable></option></term>
196
<replaceable>PORT</replaceable></option></term>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
198
174
<xi:include href="mandos-options.xml" xpointer="port"/>
203
<term><option>--check</option></term>
179
<term><literal>--check</literal></term>
206
182
Run the server’s self-tests. This includes any unit
213
<term><option>--debug</option></term>
189
<term><literal>--debug</literal></term>
215
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
238
<term><option>--priority <replaceable>
239
PRIORITY</replaceable></option></term>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
241
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
246
<term><option>--servicename
247
<replaceable>NAME</replaceable></option></term>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
249
207
<xi:include href="mandos-options.xml"
250
208
xpointer="servicename"/>
255
<term><option>--configdir
256
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
259
217
Directory to search for configuration files. Default is
270
<term><option>--version</option></term>
228
<term><literal>--version</literal></term>
273
231
Prints the program version and exit.
279
<term><option>--no-dbus</option></term>
281
<xi:include href="mandos-options.xml" xpointer="dbus"/>
283
See also <xref linkend="dbus_interface"/>.
289
<term><option>--no-ipv6</option></term>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
<term><option>--no-restore</option></term>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
300
See also <xref linkend="persistent_state"/>.
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
322
<term><option>--foreground</option></term>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
330
<term><option>--no-zeroconf</option></term>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
339
238
<refsect1 id="overview">
340
239
<title>OVERVIEW</title>
341
240
<xi:include href="overview.xml"/>
343
242
This program is the server part. It is a normal server program
344
243
and will run in a normal system environment, not in an initial
345
<acronym>RAM</acronym> disk environment.
244
RAM disk environment.
349
248
<refsect1 id="protocol">
350
249
<title>NETWORK PROTOCOL</title>
404
303
</tbody></tgroup></table>
407
306
<refsect1 id="checking">
408
307
<title>CHECKING</title>
410
309
The server will, by default, continually check that the clients
411
310
are still up. If a client has not been confirmed as being up
412
311
for some time, the client is assumed to be compromised and is no
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
418
316
<manvolnum>5</manvolnum></citerefentry>.
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
429
<refentrytitle>mandos-clients.conf</refentrytitle>
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
442
320
<refsect1 id="logging">
443
321
<title>LOGGING</title>
445
323
The server will send log message with various severity levels to
446
<filename class="devicefile">/dev/log</filename>. With the
324
<filename>/dev/log</filename>. With the
447
325
<option>--debug</option> option, it will log even more messages,
448
326
and also show them on the console.
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
464
<refsect1 id="dbus_interface">
465
<title>D-BUS INTERFACE</title>
467
The server will by default provide a D-Bus system bus interface.
468
This interface will only be accessible by the root user or a
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
474
330
<refsect1 id="exit_status">
475
331
<title>EXIT STATUS</title>
659
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
662
532
For more details on client-side security, see
663
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
664
534
<manvolnum>8mandos</manvolnum></citerefentry>.
669
539
<refsect1 id="see_also">
670
540
<title>SEE ALSO</title>
672
<citerefentry><refentrytitle>intro</refentrytitle>
673
<manvolnum>8mandos</manvolnum></citerefentry>,
674
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
675
<manvolnum>5</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-client</refentrytitle>
679
<manvolnum>8mandos</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>sh</refentrytitle>
681
<manvolnum>1</manvolnum></citerefentry>
543
<refentrytitle>mandos.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos-clients.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>