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-30">
5
<!ENTITY TIMESTAMP "2011-10-22">
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>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
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>
70
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>
98
<arg><option>--no-restore</option></arg>
96
101
<command>&COMMANDNAME;</command>
97
102
<group choice="req">
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
103
<arg choice="plain"><option>--help</option></arg>
104
<arg choice="plain"><option>-h</option></arg>
103
108
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--version</arg>
109
<arg choice="plain"><option>--version</option></arg>
107
112
<command>&COMMANDNAME;</command>
108
<arg choice="plain">--check</arg>
113
<arg choice="plain"><option>--check</option></arg>
110
115
</refsynopsisdiv>
112
117
<refsect1 id="description">
113
118
<title>DESCRIPTION</title>
115
120
<command>&COMMANDNAME;</command> is a server daemon which
116
121
handles incoming request for passwords for a pre-defined list of
117
client host computers. The Mandos server uses Zeroconf to
118
announce itself on the local network, and uses TLS to
119
communicate securely with and to authenticate the clients. The
120
Mandos server uses IPv6 to allow Mandos clients to use IPv6
121
link-local addresses, since the clients will probably not have
122
any other addresses configured (see <xref linkend="overview"/>).
123
Any authenticated client is then given the stored pre-encrypted
124
password for that specific client.
122
client host computers. For an introduction, see
123
<citerefentry><refentrytitle>intro</refentrytitle>
124
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
125
uses Zeroconf to announce itself on the local network, and uses
126
TLS to communicate securely with and to authenticate the
127
clients. The Mandos server uses IPv6 to allow Mandos clients to
128
use IPv6 link-local addresses, since the clients will probably
129
not have any other addresses configured (see <xref
130
linkend="overview"/>). Any authenticated client is then given
131
the stored pre-encrypted password for that specific client.
129
135
<refsect1 id="purpose">
130
136
<title>PURPOSE</title>
133
138
The purpose of this is to enable <emphasis>remote and unattended
134
139
rebooting</emphasis> of client host computer with an
135
140
<emphasis>encrypted root file system</emphasis>. See <xref
136
141
linkend="overview"/> for details.
141
145
<refsect1 id="options">
142
146
<title>OPTIONS</title>
149
<term><option>--help</option></term>
146
150
<term><option>-h</option></term>
147
<term><option>--help</option></term>
150
153
Show a help message and exit
159
<term><option>--interface</option>
160
<replaceable>NAME</replaceable></term>
156
161
<term><option>-i</option>
157
162
<replaceable>NAME</replaceable></term>
158
<term><option>--interface</option>
159
<replaceable>NAME</replaceable></term>
161
164
<xi:include href="mandos-options.xml" xpointer="interface"/>
166
<term><literal>-a</literal>, <literal>--address <replaceable>
167
ADDRESS</replaceable></literal></term>
169
<term><option>--address
170
<replaceable>ADDRESS</replaceable></option></term>
172
<replaceable>ADDRESS</replaceable></option></term>
169
174
<xi:include href="mandos-options.xml" xpointer="address"/>
174
<term><literal>-p</literal>, <literal>--port <replaceable>
175
PORT</replaceable></literal></term>
180
<replaceable>PORT</replaceable></option></term>
182
<replaceable>PORT</replaceable></option></term>
177
184
<xi:include href="mandos-options.xml" xpointer="port"/>
182
<term><literal>--check</literal></term>
189
<term><option>--check</option></term>
185
192
Run the server’s self-tests. This includes any unit
192
<term><literal>--debug</literal></term>
199
<term><option>--debug</option></term>
194
201
<xi:include href="mandos-options.xml" xpointer="debug"/>
199
<term><literal>--priority <replaceable>
200
PRIORITY</replaceable></literal></term>
206
<term><option>--debuglevel
207
<replaceable>LEVEL</replaceable></option></term>
210
Set the debugging log level.
211
<replaceable>LEVEL</replaceable> is a string, one of
212
<quote><literal>CRITICAL</literal></quote>,
213
<quote><literal>ERROR</literal></quote>,
214
<quote><literal>WARNING</literal></quote>,
215
<quote><literal>INFO</literal></quote>, or
216
<quote><literal>DEBUG</literal></quote>, in order of
217
increasing verbosity. The default level is
218
<quote><literal>WARNING</literal></quote>.
224
<term><option>--priority <replaceable>
225
PRIORITY</replaceable></option></term>
202
227
<xi:include href="mandos-options.xml" xpointer="priority"/>
207
<term><literal>--servicename <replaceable>NAME</replaceable>
232
<term><option>--servicename
233
<replaceable>NAME</replaceable></option></term>
210
235
<xi:include href="mandos-options.xml"
211
236
xpointer="servicename"/>
216
<term><literal>--configdir <replaceable>DIR</replaceable>
241
<term><option>--configdir
242
<replaceable>DIRECTORY</replaceable></option></term>
220
245
Directory to search for configuration files. Default is
306
355
</tbody></tgroup></table>
309
358
<refsect1 id="checking">
310
359
<title>CHECKING</title>
312
361
The server will, by default, continually check that the clients
313
362
are still up. If a client has not been confirmed as being up
314
363
for some time, the client is assumed to be compromised and is no
315
longer eligible to receive the encrypted password. The timeout,
316
checker program, and interval between checks can be configured
317
both globally and per client; see <citerefentry>
364
longer eligible to receive the encrypted password. (Manual
365
intervention is required to re-enable a client.) The timeout,
366
extended timeout, checker program, and interval between checks
367
can be configured both globally and per client; see
368
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
369
<manvolnum>5</manvolnum></citerefentry>. A client successfully
370
receiving its password will also be treated as a successful
375
<refsect1 id="approval">
376
<title>APPROVAL</title>
378
The server can be configured to require manual approval for a
379
client before it is sent its secret. The delay to wait for such
380
approval and the default action (approve or deny) can be
381
configured both globally and per client; see <citerefentry>
318
382
<refentrytitle>mandos-clients.conf</refentrytitle>
319
<manvolnum>5</manvolnum></citerefentry>.
383
<manvolnum>5</manvolnum></citerefentry>. By default all clients
384
will be approved immediately without delay.
387
This can be used to deny a client its secret if not manually
388
approved within a specified time. It can also be used to make
389
the server delay before giving a client its secret, allowing
390
optional manual denying of this specific client.
323
395
<refsect1 id="logging">
324
396
<title>LOGGING</title>
326
398
The server will send log message with various severity levels to
327
<filename>/dev/log</filename>. With the
399
<filename class="devicefile">/dev/log</filename>. With the
328
400
<option>--debug</option> option, it will log even more messages,
329
401
and also show them on the console.
405
<refsect1 id="dbus_interface">
406
<title>D-BUS INTERFACE</title>
408
The server will by default provide a D-Bus system bus interface.
409
This interface will only be accessible by the root user or a
410
Mandos-specific user, if such a user exists. For documentation
411
of the D-Bus API, see the file <filename>DBUS-API</filename>.
333
415
<refsect1 id="exit_status">
334
416
<title>EXIT STATUS</title>
519
596
If a client is compromised, its downtime should be duly noted
520
by the server which would therefore declare the client
521
invalid. But if the server was ever restarted, it would
522
re-read its client list from its configuration file and again
523
regard all clients therein as valid, and hence eligible to
524
receive their passwords. Therefore, be careful when
525
restarting servers if it is suspected that a client has, in
526
fact, been compromised by parties who may now be running a
527
fake Mandos client with the keys from the non-encrypted
528
initial RAM image of the client host. What should be done in
529
that case (if restarting the server program really is
530
necessary) is to stop the server program, edit the
531
configuration file to omit any suspect clients, and restart
597
by the server which would therefore disable the client. But
598
if the server was ever restarted, it would re-read its client
599
list from its configuration file and again regard all clients
600
therein as enabled, and hence eligible to receive their
601
passwords. Therefore, be careful when restarting servers if
602
it is suspected that a client has, in fact, been compromised
603
by parties who may now be running a fake Mandos client with
604
the keys from the non-encrypted initial <acronym>RAM</acronym>
605
image of the client host. What should be done in that case
606
(if restarting the server program really is necessary) is to
607
stop the server program, edit the configuration file to omit
608
any suspect clients, and restart the server program.
535
611
For more details on client-side security, see
536
<citerefentry><refentrytitle>password-request</refentrytitle>
612
<citerefentry><refentrytitle>mandos-client</refentrytitle>
537
613
<manvolnum>8mandos</manvolnum></citerefentry>.
542
618
<refsect1 id="see_also">
543
619
<title>SEE ALSO</title>
546
<refentrytitle>mandos-clients.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>mandos.conf</refentrytitle>
549
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
<refentrytitle>password-request</refentrytitle>
551
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
<citerefentry><refentrytitle>intro</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
624
<manvolnum>5</manvolnum></citerefentry>,
625
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
626
<manvolnum>5</manvolnum></citerefentry>,
627
<citerefentry><refentrytitle>mandos-client</refentrytitle>
628
<manvolnum>8mandos</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>sh</refentrytitle>
630
<manvolnum>1</manvolnum></citerefentry>