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 TIMESTAMP "2008-08-29">
5
<!ENTITY TIMESTAMP "2010-09-25">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
34
36
<holder>Teddy Hogeborn</holder>
35
37
<holder>Björn Påhlsson</holder>
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/"/>.
39
<xi:include href="legalnotice.xml"/>
63
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
<manvolnum>8</manvolnum>
68
48
<refname><command>&COMMANDNAME;</command></refname>
70
Sends encrypted passwords to authenticated Mandos clients
50
Gives encrypted passwords to authenticated Mandos clients
76
56
<command>&COMMANDNAME;</command>
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>
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>
96
94
<command>&COMMANDNAME;</command>
97
95
<group choice="req">
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
96
<arg choice="plain"><option>--help</option></arg>
97
<arg choice="plain"><option>-h</option></arg>
103
101
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--version</arg>
102
<arg choice="plain"><option>--version</option></arg>
107
105
<command>&COMMANDNAME;</command>
108
<arg choice="plain">--check</arg>
106
<arg choice="plain"><option>--check</option></arg>
110
108
</refsynopsisdiv>
112
110
<refsect1 id="description">
113
111
<title>DESCRIPTION</title>
123
121
Any authenticated client is then given the stored pre-encrypted
124
122
password for that specific client.
129
126
<refsect1 id="purpose">
130
127
<title>PURPOSE</title>
133
129
The purpose of this is to enable <emphasis>remote and unattended
134
130
rebooting</emphasis> of client host computer with an
135
131
<emphasis>encrypted root file system</emphasis>. See <xref
136
132
linkend="overview"/> for details.
141
136
<refsect1 id="options">
142
137
<title>OPTIONS</title>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
140
<term><option>--help</option></term>
141
<term><option>-h</option></term>
149
144
Show a help message and exit
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
152
<term><option>-i</option>
153
<replaceable>NAME</replaceable></term>
158
155
<xi:include href="mandos-options.xml" xpointer="interface"/>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
166
165
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
174
175
<xi:include href="mandos-options.xml" xpointer="port"/>
179
<term><literal>--check</literal></term>
180
<term><option>--check</option></term>
182
183
Run the server’s self-tests. This includes any unit
189
<term><literal>--debug</literal></term>
190
<term><option>--debug</option></term>
191
192
<xi:include href="mandos-options.xml" xpointer="debug"/>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
199
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
207
208
<xi:include href="mandos-options.xml"
208
209
xpointer="servicename"/>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
217
218
Directory to search for configuration files. Default is
228
<term><literal>--version</literal></term>
229
<term><option>--version</option></term>
231
232
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"/>
238
256
<refsect1 id="overview">
239
257
<title>OVERVIEW</title>
240
258
<xi:include href="overview.xml"/>
242
260
This program is the server part. It is a normal server program
243
261
and will run in a normal system environment, not in an initial
244
RAM disk environment.
262
<acronym>RAM</acronym> disk environment.
248
266
<refsect1 id="protocol">
249
267
<title>NETWORK PROTOCOL</title>
303
321
</tbody></tgroup></table>
306
324
<refsect1 id="checking">
307
325
<title>CHECKING</title>
309
327
The server will, by default, continually check that the clients
310
328
are still up. If a client has not been confirmed as being up
311
329
for some time, the client is assumed to be compromised and is no
312
longer eligible to receive the encrypted password. The timeout,
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
313
332
checker program, and interval between checks can be configured
314
333
both globally and per client; see <citerefentry>
315
334
<refentrytitle>mandos-clients.conf</refentrytitle>
316
<manvolnum>5</manvolnum></citerefentry>.
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
341
<refsect1 id="approval">
342
<title>APPROVAL</title>
344
The server can be configured to require manual approval for a
345
client before it is sent its secret. The delay to wait for such
346
approval and the default action (approve or deny) can be
347
configured both globally and per client; see <citerefentry>
348
<refentrytitle>mandos-clients.conf</refentrytitle>
349
<manvolnum>5</manvolnum></citerefentry>. By default all clients
350
will be approved immediately without delay.
353
This can be used to deny a client its secret if not manually
354
approved within a specified time. It can also be used to make
355
the server delay before giving a client its secret, allowing
356
optional manual denying of this specific client.
320
361
<refsect1 id="logging">
321
362
<title>LOGGING</title>
326
367
and also show them on the console.
371
<refsect1 id="dbus_interface">
372
<title>D-BUS INTERFACE</title>
374
The server will by default provide a D-Bus system bus interface.
375
This interface will only be accessible by the root user or a
376
Mandos-specific user, if such a user exists. For documentation
377
of the D-Bus API, see the file <filename>DBUS-API</filename>.
330
381
<refsect1 id="exit_status">
331
382
<title>EXIT STATUS</title>
422
473
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.
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
436
481
There is no fine-grained control over logging and debug output.
481
530
</informalexample>
484
533
<refsect1 id="security">
485
534
<title>SECURITY</title>
486
<refsect2 id="SERVER">
535
<refsect2 id="server">
487
536
<title>SERVER</title>
489
538
Running this <command>&COMMANDNAME;</command> server program
490
539
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.
540
computer running it. The program switches to a non-root user
495
<refsect2 id="CLIENTS">
544
<refsect2 id="clients">
496
545
<title>CLIENTS</title>
498
547
The server only gives out its stored data to clients which
505
554
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
555
<manvolnum>5</manvolnum></citerefentry>)
507
556
<emphasis>must</emphasis> be made non-readable by anyone
508
except the user running the server.
557
except the user starting the server (usually root).
511
560
As detailed in <xref linkend="checking"/>, the status of all
516
565
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
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
574
image of the client host. What should be done in that case
575
(if restarting the server program really is necessary) is to
576
stop the server program, edit the configuration file to omit
577
any suspect clients, and restart the server program.
532
580
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
581
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
582
<manvolnum>8mandos</manvolnum></citerefentry>.
539
587
<refsect1 id="see_also">
540
588
<title>SEE ALSO</title>
544
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
593
<refentrytitle>mandos.conf</refentrytitle>
546
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>password-request</refentrytitle>
595
<refentrytitle>mandos-client</refentrytitle>
548
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>