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 "2011-02-27">
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>
38
32
<holder>Teddy Hogeborn</holder>
39
33
<holder>Björn Påhlsson</holder>
41
<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/"/>.
45
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
46
62
<manvolnum>8</manvolnum>
50
66
<refname><command>&COMMANDNAME;</command></refname>
52
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
58
74
<command>&COMMANDNAME;</command>
60
<arg choice="plain"><option>--interface
61
<replaceable>NAME</replaceable></option></arg>
62
<arg choice="plain"><option>-i
63
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>--address
68
<replaceable>ADDRESS</replaceable></option></arg>
69
<arg choice="plain"><option>-a
70
<replaceable>ADDRESS</replaceable></option></arg>
74
<arg choice="plain"><option>--port
75
<replaceable>PORT</replaceable></option></arg>
76
<arg choice="plain"><option>-p
77
<replaceable>PORT</replaceable></option></arg>
80
<arg><option>--priority
81
<replaceable>PRIORITY</replaceable></option></arg>
83
<arg><option>--servicename
84
<replaceable>NAME</replaceable></option></arg>
86
<arg><option>--configdir
87
<replaceable>DIRECTORY</replaceable></option></arg>
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<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>
99
94
<command>&COMMANDNAME;</command>
100
95
<group choice="req">
101
<arg choice="plain"><option>--help</option></arg>
102
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
106
101
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
110
105
<command>&COMMANDNAME;</command>
111
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
113
108
</refsynopsisdiv>
115
110
<refsect1 id="description">
116
111
<title>DESCRIPTION</title>
126
121
Any authenticated client is then given the stored pre-encrypted
127
122
password for that specific client.
131
127
<refsect1 id="purpose">
132
128
<title>PURPOSE</title>
134
131
The purpose of this is to enable <emphasis>remote and unattended
135
132
rebooting</emphasis> of client host computer with an
136
133
<emphasis>encrypted root file system</emphasis>. See <xref
137
134
linkend="overview"/> for details.
141
139
<refsect1 id="options">
142
140
<title>OPTIONS</title>
145
<term><option>--help</option></term>
146
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
149
147
Show a help message and exit
155
<term><option>--interface</option>
156
<replaceable>NAME</replaceable></term>
157
<term><option>-i</option>
158
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
160
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
165
<term><option>--address
166
<replaceable>ADDRESS</replaceable></option></term>
168
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
170
164
<xi:include href="mandos-options.xml" xpointer="address"/>
176
<replaceable>PORT</replaceable></option></term>
178
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
180
172
<xi:include href="mandos-options.xml" xpointer="port"/>
185
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
188
180
Run the server’s self-tests. This includes any unit
195
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
197
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
202
<term><option>--debuglevel
203
<replaceable>LEVEL</replaceable></option></term>
206
Set the debugging log level.
207
<replaceable>LEVEL</replaceable> is a string, one of
208
<quote><literal>CRITICAL</literal></quote>,
209
<quote><literal>ERROR</literal></quote>,
210
<quote><literal>WARNING</literal></quote>,
211
<quote><literal>INFO</literal></quote>, or
212
<quote><literal>DEBUG</literal></quote>, in order of
213
increasing verbosity. The default level is
214
<quote><literal>WARNING</literal></quote>.
220
<term><option>--priority <replaceable>
221
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
223
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
228
<term><option>--servicename
229
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
231
205
<xi:include href="mandos-options.xml"
232
206
xpointer="servicename"/>
237
<term><option>--configdir
238
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
241
215
Directory to search for configuration files. Default is
252
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
255
229
Prints the program version and exit.
261
<term><option>--no-dbus</option></term>
263
<xi:include href="mandos-options.xml" xpointer="dbus"/>
265
See also <xref linkend="dbus_interface"/>.
271
<term><option>--no-ipv6</option></term>
273
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
279
236
<refsect1 id="overview">
280
237
<title>OVERVIEW</title>
281
238
<xi:include href="overview.xml"/>
283
240
This program is the server part. It is a normal server program
284
241
and will run in a normal system environment, not in an initial
285
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
289
246
<refsect1 id="protocol">
290
247
<title>NETWORK PROTOCOL</title>
344
301
</tbody></tgroup></table>
347
304
<refsect1 id="checking">
348
305
<title>CHECKING</title>
350
307
The server will, by default, continually check that the clients
351
308
are still up. If a client has not been confirmed as being up
352
309
for some time, the client is assumed to be compromised and is no
353
longer eligible to receive the encrypted password. (Manual
354
intervention is required to re-enable a client.) The timeout,
310
longer eligible to receive the encrypted password. The timeout,
355
311
checker program, and interval between checks can be configured
356
312
both globally and per client; see <citerefentry>
357
313
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>. A client successfully
359
receiving its password will also be treated as a successful
364
<refsect1 id="approval">
365
<title>APPROVAL</title>
367
The server can be configured to require manual approval for a
368
client before it is sent its secret. The delay to wait for such
369
approval and the default action (approve or deny) can be
370
configured both globally and per client; see <citerefentry>
371
<refentrytitle>mandos-clients.conf</refentrytitle>
372
<manvolnum>5</manvolnum></citerefentry>. By default all clients
373
will be approved immediately without delay.
376
This can be used to deny a client its secret if not manually
377
approved within a specified time. It can also be used to make
378
the server delay before giving a client its secret, allowing
379
optional manual denying of this specific client.
314
<manvolnum>5</manvolnum></citerefentry>.
384
318
<refsect1 id="logging">
385
319
<title>LOGGING</title>
390
324
and also show them on the console.
394
<refsect1 id="dbus_interface">
395
<title>D-BUS INTERFACE</title>
397
The server will by default provide a D-Bus system bus interface.
398
This interface will only be accessible by the root user or a
399
Mandos-specific user, if such a user exists. For documentation
400
of the D-Bus API, see the file <filename>DBUS-API</filename>.
404
328
<refsect1 id="exit_status">
405
329
<title>EXIT STATUS</title>
496
420
backtrace. This could be considered a feature.
499
Currently, if a client is disabled due to having timed out, the
500
server does not record this fact onto permanent storage. This
501
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.
504
434
There is no fine-grained control over logging and debug output.
549
475
<!-- do not wrap this line -->
550
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
553
479
</informalexample>
556
482
<refsect1 id="security">
557
483
<title>SECURITY</title>
558
<refsect2 id="server">
484
<refsect2 id="SERVER">
559
485
<title>SERVER</title>
561
487
Running this <command>&COMMANDNAME;</command> server program
562
488
should not in itself present any security risk to the host
563
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.
567
<refsect2 id="clients">
493
<refsect2 id="CLIENTS">
568
494
<title>CLIENTS</title>
570
496
The server only gives out its stored data to clients which
588
514
If a client is compromised, its downtime should be duly noted
589
by the server which would therefore disable the client. But
590
if the server was ever restarted, it would re-read its client
591
list from its configuration file and again regard all clients
592
therein as enabled, and hence eligible to receive their
593
passwords. Therefore, be careful when restarting servers if
594
it is suspected that a client has, in fact, been compromised
595
by parties who may now be running a fake Mandos client with
596
the keys from the non-encrypted initial <acronym>RAM</acronym>
597
image of the client host. What should be done in that case
598
(if restarting the server program really is necessary) is to
599
stop the server program, edit the configuration file to omit
600
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
603
530
For more details on client-side security, see
604
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
605
532
<manvolnum>8mandos</manvolnum></citerefentry>.
610
537
<refsect1 id="see_also">
611
538
<title>SEE ALSO</title>
541
<refentrytitle>mandos.conf</refentrytitle>
542
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
614
543
<refentrytitle>mandos-clients.conf</refentrytitle>
615
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
<refentrytitle>mandos.conf</refentrytitle>
617
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
<refentrytitle>mandos-client</refentrytitle>
545
<refentrytitle>password-request</refentrytitle>
619
546
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
547
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>