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 "2011-08-08">
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
38
<holder>Teddy Hogeborn</holder>
35
39
<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/"/>.
41
<xi:include href="legalnotice.xml"/>
63
45
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
<manvolnum>8</manvolnum>
68
50
<refname><command>&COMMANDNAME;</command></refname>
70
Sends encrypted passwords to authenticated Mandos clients
52
Gives encrypted passwords to authenticated Mandos clients
76
58
<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>
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>
96
99
<command>&COMMANDNAME;</command>
97
100
<group choice="req">
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
101
<arg choice="plain"><option>--help</option></arg>
102
<arg choice="plain"><option>-h</option></arg>
103
106
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--version</arg>
107
<arg choice="plain"><option>--version</option></arg>
107
110
<command>&COMMANDNAME;</command>
108
<arg choice="plain">--check</arg>
111
<arg choice="plain"><option>--check</option></arg>
110
113
</refsynopsisdiv>
112
115
<refsect1 id="description">
113
116
<title>DESCRIPTION</title>
123
126
Any authenticated client is then given the stored pre-encrypted
124
127
password for that specific client.
129
131
<refsect1 id="purpose">
130
132
<title>PURPOSE</title>
133
134
The purpose of this is to enable <emphasis>remote and unattended
134
135
rebooting</emphasis> of client host computer with an
135
136
<emphasis>encrypted root file system</emphasis>. See <xref
136
137
linkend="overview"/> for details.
141
141
<refsect1 id="options">
142
142
<title>OPTIONS</title>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
145
<term><option>--help</option></term>
146
<term><option>-h</option></term>
149
149
Show a help message and exit
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
155
<term><option>--interface</option>
156
<replaceable>NAME</replaceable></term>
157
<term><option>-i</option>
158
<replaceable>NAME</replaceable></term>
158
160
<xi:include href="mandos-options.xml" xpointer="interface"/>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
165
<term><option>--address
166
<replaceable>ADDRESS</replaceable></option></term>
168
<replaceable>ADDRESS</replaceable></option></term>
166
170
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
176
<replaceable>PORT</replaceable></option></term>
178
<replaceable>PORT</replaceable></option></term>
174
180
<xi:include href="mandos-options.xml" xpointer="port"/>
179
<term><literal>--check</literal></term>
185
<term><option>--check</option></term>
182
188
Run the server’s self-tests. This includes any unit
189
<term><literal>--debug</literal></term>
195
<term><option>--debug</option></term>
191
197
<xi:include href="mandos-options.xml" xpointer="debug"/>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
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>
199
223
<xi:include href="mandos-options.xml" xpointer="priority"/>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
228
<term><option>--servicename
229
<replaceable>NAME</replaceable></option></term>
207
231
<xi:include href="mandos-options.xml"
208
232
xpointer="servicename"/>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
237
<term><option>--configdir
238
<replaceable>DIRECTORY</replaceable></option></term>
217
241
Directory to search for configuration files. Default is
228
<term><literal>--version</literal></term>
252
<term><option>--version</option></term>
231
255
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"/>
238
279
<refsect1 id="overview">
239
280
<title>OVERVIEW</title>
240
281
<xi:include href="overview.xml"/>
242
283
This program is the server part. It is a normal server program
243
284
and will run in a normal system environment, not in an initial
244
RAM disk environment.
285
<acronym>RAM</acronym> disk environment.
248
289
<refsect1 id="protocol">
249
290
<title>NETWORK PROTOCOL</title>
303
344
</tbody></tgroup></table>
306
347
<refsect1 id="checking">
307
348
<title>CHECKING</title>
309
350
The server will, by default, continually check that the clients
310
351
are still up. If a client has not been confirmed as being up
311
352
for some time, the client is assumed to be compromised and is no
312
longer eligible to receive the encrypted password. The timeout,
353
longer eligible to receive the encrypted password. (Manual
354
intervention is required to re-enable a client.) The timeout,
313
355
checker program, and interval between checks can be configured
314
356
both globally and per client; see <citerefentry>
315
357
<refentrytitle>mandos-clients.conf</refentrytitle>
316
<manvolnum>5</manvolnum></citerefentry>.
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.
320
384
<refsect1 id="logging">
321
385
<title>LOGGING</title>
326
390
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>.
330
404
<refsect1 id="exit_status">
331
405
<title>EXIT STATUS</title>
422
496
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.
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"/>.
436
504
There is no fine-grained control over logging and debug output.
516
588
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
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.
532
603
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
604
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
605
<manvolnum>8mandos</manvolnum></citerefentry>.
539
610
<refsect1 id="see_also">
540
611
<title>SEE ALSO</title>
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>
613
<citerefentry><refentrytitle>intro</refentrytitle>
614
<manvolnum>8mandos</manvolnum></citerefentry>,
615
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
616
<manvolnum>5</manvolnum></citerefentry>,
617
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
618
<manvolnum>5</manvolnum></citerefentry>,
619
<citerefentry><refentrytitle>mandos-client</refentrytitle>
620
<manvolnum>8mandos</manvolnum></citerefentry>,
621
<citerefentry><refentrytitle>sh</refentrytitle>
622
<manvolnum>1</manvolnum></citerefentry>