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 "2010-09-11">
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>
36
34
<holder>Teddy Hogeborn</holder>
37
35
<holder>Björn Påhlsson</holder>
39
<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/"/>.
43
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
<manvolnum>8</manvolnum>
48
68
<refname><command>&COMMANDNAME;</command></refname>
50
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
56
76
<command>&COMMANDNAME;</command>
58
<arg choice="plain"><option>--interface
59
<replaceable>NAME</replaceable></option></arg>
60
<arg choice="plain"><option>-i
61
<replaceable>NAME</replaceable></option></arg>
65
<arg choice="plain"><option>--address
66
<replaceable>ADDRESS</replaceable></option></arg>
67
<arg choice="plain"><option>-a
68
<replaceable>ADDRESS</replaceable></option></arg>
72
<arg choice="plain"><option>--port
73
<replaceable>PORT</replaceable></option></arg>
74
<arg choice="plain"><option>-p
75
<replaceable>PORT</replaceable></option></arg>
78
<arg><option>--priority
79
<replaceable>PRIORITY</replaceable></option></arg>
81
<arg><option>--servicename
82
<replaceable>NAME</replaceable></option></arg>
84
<arg><option>--configdir
85
<replaceable>DIRECTORY</replaceable></option></arg>
87
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</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>
94
96
<command>&COMMANDNAME;</command>
95
97
<group choice="req">
96
<arg choice="plain"><option>--help</option></arg>
97
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
101
103
<command>&COMMANDNAME;</command>
102
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
105
107
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
108
110
</refsynopsisdiv>
110
112
<refsect1 id="description">
111
113
<title>DESCRIPTION</title>
121
123
Any authenticated client is then given the stored pre-encrypted
122
124
password for that specific client.
126
129
<refsect1 id="purpose">
127
130
<title>PURPOSE</title>
129
133
The purpose of this is to enable <emphasis>remote and unattended
130
134
rebooting</emphasis> of client host computer with an
131
135
<emphasis>encrypted root file system</emphasis>. See <xref
132
136
linkend="overview"/> for details.
136
141
<refsect1 id="options">
137
142
<title>OPTIONS</title>
140
<term><option>--help</option></term>
141
<term><option>-h</option></term>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
144
149
Show a help message and exit
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
152
<term><option>-i</option>
153
<replaceable>NAME</replaceable></term>
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
155
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
165
166
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
175
174
<xi:include href="mandos-options.xml" xpointer="port"/>
180
<term><option>--check</option></term>
179
<term><literal>--check</literal></term>
183
182
Run the server’s self-tests. This includes any unit
190
<term><option>--debug</option></term>
189
<term><literal>--debug</literal></term>
192
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
200
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
208
207
<xi:include href="mandos-options.xml"
209
208
xpointer="servicename"/>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
218
217
Directory to search for configuration files. Default is
229
<term><option>--version</option></term>
228
<term><literal>--version</literal></term>
232
231
Prints the program version and exit.
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
256
238
<refsect1 id="overview">
257
239
<title>OVERVIEW</title>
258
240
<xi:include href="overview.xml"/>
260
242
This program is the server part. It is a normal server program
261
243
and will run in a normal system environment, not in an initial
262
<acronym>RAM</acronym> disk environment.
244
RAM disk environment.
266
248
<refsect1 id="protocol">
267
249
<title>NETWORK PROTOCOL</title>
321
303
</tbody></tgroup></table>
324
306
<refsect1 id="checking">
325
307
<title>CHECKING</title>
327
309
The server will, by default, continually check that the clients
328
310
are still up. If a client has not been confirmed as being up
329
311
for some time, the client is assumed to be compromised and is no
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
312
longer eligible to receive the encrypted password. The timeout,
332
313
checker program, and interval between checks can be configured
333
314
both globally and per client; see <citerefentry>
334
315
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
316
<manvolnum>5</manvolnum></citerefentry>.
341
320
<refsect1 id="logging">
342
321
<title>LOGGING</title>
347
326
and also show them on the console.
351
<refsect1 id="dbus_interface">
352
<title>D-BUS INTERFACE</title>
354
The server will by default provide a D-Bus system bus interface.
355
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists. For documentation
357
of the D-Bus API, see the file <filename>DBUS-API</filename>.
361
330
<refsect1 id="exit_status">
362
331
<title>EXIT STATUS</title>
453
422
backtrace. This could be considered a feature.
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
has some security implications, see <xref linkend="clients"/>.
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.
461
436
There is no fine-grained control over logging and debug output.
510
481
</informalexample>
513
484
<refsect1 id="security">
514
485
<title>SECURITY</title>
515
<refsect2 id="server">
486
<refsect2 id="SERVER">
516
487
<title>SERVER</title>
518
489
Running this <command>&COMMANDNAME;</command> server program
519
490
should not in itself present any security risk to the host
520
computer running it. The program switches to a non-root user
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.
524
<refsect2 id="clients">
495
<refsect2 id="CLIENTS">
525
496
<title>CLIENTS</title>
527
498
The server only gives out its stored data to clients which
534
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
535
506
<manvolnum>5</manvolnum></citerefentry>)
536
507
<emphasis>must</emphasis> be made non-readable by anyone
537
except the user starting the server (usually root).
508
except the user running the server.
540
511
As detailed in <xref linkend="checking"/>, the status of all
545
516
If a client is compromised, its downtime should be duly noted
546
by the server which would therefore disable the client. But
547
if the server was ever restarted, it would re-read its client
548
list from its configuration file and again regard all clients
549
therein as enabled, and hence eligible to receive their
550
passwords. Therefore, be careful when restarting servers if
551
it is suspected that a client has, in fact, been compromised
552
by parties who may now be running a fake Mandos client with
553
the keys from the non-encrypted initial <acronym>RAM</acronym>
554
image of the client host. What should be done in that case
555
(if restarting the server program really is necessary) is to
556
stop the server program, edit the configuration file to omit
557
any suspect clients, and restart the server program.
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
560
532
For more details on client-side security, see
561
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
562
534
<manvolnum>8mandos</manvolnum></citerefentry>.
567
539
<refsect1 id="see_also">
568
540
<title>SEE ALSO</title>
572
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
573
545
<refentrytitle>mandos.conf</refentrytitle>
574
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
<refentrytitle>mandos-client</refentrytitle>
547
<refentrytitle>password-request</refentrytitle>
576
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
577
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>