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-26">
6
<!ENTITY % common SYSTEM "common.ent">
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
10
<title>&COMMANDNAME;</title>
13
11
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
19
16
<firstname>Björn</firstname>
37
32
<holder>Teddy Hogeborn</holder>
38
33
<holder>Björn Påhlsson</holder>
40
<xi:include href="legalnotice.xml"/>
37
This manual page is free software: you can redistribute it
38
and/or modify it under the terms of the GNU General Public
39
License as published by the Free Software Foundation,
40
either version 3 of the License, or (at your option) any
45
This manual page is distributed in the hope that it will
46
be useful, but WITHOUT ANY WARRANTY; without even the
47
implied warranty of MERCHANTABILITY or FITNESS FOR A
48
PARTICULAR PURPOSE. See the GNU General Public License
53
You should have received a copy of the GNU General Public
54
License along with this program; If not, see
55
<ulink url="http://www.gnu.org/licenses/"/>.
44
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
62
<manvolnum>8</manvolnum>
49
66
<refname><command>&COMMANDNAME;</command></refname>
51
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
57
74
<command>&COMMANDNAME;</command>
59
<arg choice="plain"><option>--interface
60
<replaceable>NAME</replaceable></option></arg>
61
<arg choice="plain"><option>-i
62
<replaceable>NAME</replaceable></option></arg>
66
<arg choice="plain"><option>--address
67
<replaceable>ADDRESS</replaceable></option></arg>
68
<arg choice="plain"><option>-a
69
<replaceable>ADDRESS</replaceable></option></arg>
73
<arg choice="plain"><option>--port
74
<replaceable>PORT</replaceable></option></arg>
75
<arg choice="plain"><option>-p
76
<replaceable>PORT</replaceable></option></arg>
79
<arg><option>--priority
80
<replaceable>PRIORITY</replaceable></option></arg>
82
<arg><option>--servicename
83
<replaceable>NAME</replaceable></option></arg>
85
<arg><option>--configdir
86
<replaceable>DIRECTORY</replaceable></option></arg>
88
<arg><option>--debug</option></arg>
90
<arg><option>--no-dbus</option></arg>
92
<arg><option>--no-ipv6</option></arg>
75
<arg>--interface<arg choice="plain">NAME</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">NAME</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
95
94
<command>&COMMANDNAME;</command>
96
95
<group choice="req">
97
<arg choice="plain"><option>--help</option></arg>
98
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
102
101
<command>&COMMANDNAME;</command>
103
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
106
105
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
109
108
</refsynopsisdiv>
111
110
<refsect1 id="description">
112
111
<title>DESCRIPTION</title>
122
121
Any authenticated client is then given the stored pre-encrypted
123
122
password for that specific client.
127
127
<refsect1 id="purpose">
128
128
<title>PURPOSE</title>
130
131
The purpose of this is to enable <emphasis>remote and unattended
131
132
rebooting</emphasis> of client host computer with an
132
133
<emphasis>encrypted root file system</emphasis>. See <xref
133
134
linkend="overview"/> for details.
137
139
<refsect1 id="options">
138
140
<title>OPTIONS</title>
141
<term><option>--help</option></term>
142
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
145
147
Show a help message and exit
151
<term><option>--interface</option>
152
<replaceable>NAME</replaceable></term>
153
<term><option>-i</option>
154
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
156
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><option>--address
162
<replaceable>ADDRESS</replaceable></option></term>
164
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
166
164
<xi:include href="mandos-options.xml" xpointer="address"/>
172
<replaceable>PORT</replaceable></option></term>
174
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
176
172
<xi:include href="mandos-options.xml" xpointer="port"/>
181
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
184
180
Run the server’s self-tests. This includes any unit
191
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
193
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
198
<term><option>--priority <replaceable>
199
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
201
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
206
<term><option>--servicename
207
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
209
205
<xi:include href="mandos-options.xml"
210
206
xpointer="servicename"/>
215
<term><option>--configdir
216
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
219
215
Directory to search for configuration files. Default is
230
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
233
229
Prints the program version and exit.
239
<term><option>--no-dbus</option></term>
241
<xi:include href="mandos-options.xml" xpointer="dbus"/>
243
See also <xref linkend="dbus_interface"/>.
249
<term><option>--no-ipv6</option></term>
251
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
257
236
<refsect1 id="overview">
258
237
<title>OVERVIEW</title>
259
238
<xi:include href="overview.xml"/>
261
240
This program is the server part. It is a normal server program
262
241
and will run in a normal system environment, not in an initial
263
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
267
246
<refsect1 id="protocol">
268
247
<title>NETWORK PROTOCOL</title>
322
301
</tbody></tgroup></table>
325
304
<refsect1 id="checking">
326
305
<title>CHECKING</title>
328
307
The server will, by default, continually check that the clients
329
308
are still up. If a client has not been confirmed as being up
330
309
for some time, the client is assumed to be compromised and is no
331
longer eligible to receive the encrypted password. (Manual
332
intervention is required to re-enable a client.) The timeout,
310
longer eligible to receive the encrypted password. The timeout,
333
311
checker program, and interval between checks can be configured
334
312
both globally and per client; see <citerefentry>
335
313
<refentrytitle>mandos-clients.conf</refentrytitle>
336
<manvolnum>5</manvolnum></citerefentry>. A client successfully
337
receiving its password will also be treated as a successful
342
<refsect1 id="approval">
343
<title>APPROVAL</title>
345
The server can be configured to require manual approval for a
346
client before it is sent its secret. The delay to wait for such
347
approval and the default action (approve or deny) can be
348
configured both globally and per client; see <citerefentry>
349
<refentrytitle>mandos-clients.conf</refentrytitle>
350
<manvolnum>5</manvolnum></citerefentry>. By default all clients
351
will be approved immediately without delay.
354
This can be used to deny a client its secret if not manually
355
approved within a specified time. It can also be used to make
356
the server delay before giving a client its secret, allowing
357
optional manual denying of this specific client.
314
<manvolnum>5</manvolnum></citerefentry>.
362
318
<refsect1 id="logging">
363
319
<title>LOGGING</title>
368
324
and also show them on the console.
372
<refsect1 id="dbus_interface">
373
<title>D-BUS INTERFACE</title>
375
The server will by default provide a D-Bus system bus interface.
376
This interface will only be accessible by the root user or a
377
Mandos-specific user, if such a user exists. For documentation
378
of the D-Bus API, see the file <filename>DBUS-API</filename>.
382
328
<refsect1 id="exit_status">
383
329
<title>EXIT STATUS</title>
474
420
backtrace. This could be considered a feature.
477
Currently, if a client is disabled due to having timed out, the
478
server does not record this fact onto permanent storage. This
479
has some security implications, see <xref linkend="clients"/>.
423
Currently, if a client is declared <quote>invalid</quote> due to
424
having timed out, the server does not record this fact onto
425
permanent storage. This has some security implications, see
426
<xref linkend="CLIENTS"/>.
429
There is currently no way of querying the server of the current
430
status of clients, other than analyzing its <systemitem
431
class="service">syslog</systemitem> output.
482
434
There is no fine-grained control over logging and debug output.
527
475
<!-- do not wrap this line -->
528
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
531
479
</informalexample>
534
482
<refsect1 id="security">
535
483
<title>SECURITY</title>
536
<refsect2 id="server">
484
<refsect2 id="SERVER">
537
485
<title>SERVER</title>
539
487
Running this <command>&COMMANDNAME;</command> server program
540
488
should not in itself present any security risk to the host
541
computer running it. The program switches to a non-root user
489
computer running it. The program does not need any special
490
privileges to run, and is designed to run as a non-root user.
545
<refsect2 id="clients">
493
<refsect2 id="CLIENTS">
546
494
<title>CLIENTS</title>
548
496
The server only gives out its stored data to clients which
555
503
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
556
504
<manvolnum>5</manvolnum></citerefentry>)
557
505
<emphasis>must</emphasis> be made non-readable by anyone
558
except the user starting the server (usually root).
506
except the user running the server.
561
509
As detailed in <xref linkend="checking"/>, the status of all
566
514
If a client is compromised, its downtime should be duly noted
567
by the server which would therefore disable the client. But
568
if the server was ever restarted, it would re-read its client
569
list from its configuration file and again regard all clients
570
therein as enabled, and hence eligible to receive their
571
passwords. Therefore, be careful when restarting servers if
572
it is suspected that a client has, in fact, been compromised
573
by parties who may now be running a fake Mandos client with
574
the keys from the non-encrypted initial <acronym>RAM</acronym>
575
image of the client host. What should be done in that case
576
(if restarting the server program really is necessary) is to
577
stop the server program, edit the configuration file to omit
578
any suspect clients, and restart the server program.
515
by the server which would therefore declare the client
516
invalid. But if the server was ever restarted, it would
517
re-read its client list from its configuration file and again
518
regard all clients therein as valid, and hence eligible to
519
receive their passwords. Therefore, be careful when
520
restarting servers if it is suspected that a client has, in
521
fact, been compromised by parties who may now be running a
522
fake Mandos client with the keys from the non-encrypted
523
initial RAM image of the client host. What should be done in
524
that case (if restarting the server program really is
525
necessary) is to stop the server program, edit the
526
configuration file to omit any suspect clients, and restart
581
530
For more details on client-side security, see
582
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
583
532
<manvolnum>8mandos</manvolnum></citerefentry>.
588
537
<refsect1 id="see_also">
589
538
<title>SEE ALSO</title>
541
<refentrytitle>mandos.conf</refentrytitle>
542
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
592
543
<refentrytitle>mandos-clients.conf</refentrytitle>
593
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
594
<refentrytitle>mandos.conf</refentrytitle>
595
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
596
<refentrytitle>mandos-client</refentrytitle>
545
<refentrytitle>password-request</refentrytitle>
597
546
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
598
547
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>