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-10-03">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-29">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
38
34
<holder>Teddy Hogeborn</holder>
39
35
<holder>Björn Påhlsson</holder>
41
<xi:include href="legalnotice.xml"/>
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/"/>.
45
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
46
64
<manvolnum>8</manvolnum>
50
68
<refname><command>&COMMANDNAME;</command></refname>
52
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
58
76
<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>
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>
99
96
<command>&COMMANDNAME;</command>
100
97
<group choice="req">
101
<arg choice="plain"><option>--help</option></arg>
102
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
106
103
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
110
107
<command>&COMMANDNAME;</command>
111
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
113
110
</refsynopsisdiv>
115
112
<refsect1 id="description">
116
113
<title>DESCRIPTION</title>
118
115
<command>&COMMANDNAME;</command> is a server daemon which
119
116
handles incoming request for passwords for a pre-defined list of
120
client host computers. For an introduction, see
121
<citerefentry><refentrytitle>intro</refentrytitle>
122
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
123
uses Zeroconf to announce itself on the local network, and uses
124
TLS to communicate securely with and to authenticate the
125
clients. The Mandos server uses IPv6 to allow Mandos clients to
126
use IPv6 link-local addresses, since the clients will probably
127
not have any other addresses configured (see <xref
128
linkend="overview"/>). Any authenticated client is then given
129
the stored pre-encrypted password for that specific client.
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.
133
129
<refsect1 id="purpose">
134
130
<title>PURPOSE</title>
136
133
The purpose of this is to enable <emphasis>remote and unattended
137
134
rebooting</emphasis> of client host computer with an
138
135
<emphasis>encrypted root file system</emphasis>. See <xref
139
136
linkend="overview"/> for details.
143
141
<refsect1 id="options">
144
142
<title>OPTIONS</title>
147
<term><option>--help</option></term>
148
<term><option>-h</option></term>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
151
149
Show a help message and exit
157
<term><option>--interface</option>
158
<replaceable>NAME</replaceable></term>
159
<term><option>-i</option>
160
<replaceable>NAME</replaceable></term>
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
162
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
167
<term><option>--address
168
<replaceable>ADDRESS</replaceable></option></term>
170
<replaceable>ADDRESS</replaceable></option></term>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
172
166
<xi:include href="mandos-options.xml" xpointer="address"/>
178
<replaceable>PORT</replaceable></option></term>
180
<replaceable>PORT</replaceable></option></term>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
182
174
<xi:include href="mandos-options.xml" xpointer="port"/>
187
<term><option>--check</option></term>
179
<term><literal>--check</literal></term>
190
182
Run the server’s self-tests. This includes any unit
197
<term><option>--debug</option></term>
189
<term><literal>--debug</literal></term>
199
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
204
<term><option>--debuglevel
205
<replaceable>LEVEL</replaceable></option></term>
208
Set the debugging log level.
209
<replaceable>LEVEL</replaceable> is a string, one of
210
<quote><literal>CRITICAL</literal></quote>,
211
<quote><literal>ERROR</literal></quote>,
212
<quote><literal>WARNING</literal></quote>,
213
<quote><literal>INFO</literal></quote>, or
214
<quote><literal>DEBUG</literal></quote>, in order of
215
increasing verbosity. The default level is
216
<quote><literal>WARNING</literal></quote>.
222
<term><option>--priority <replaceable>
223
PRIORITY</replaceable></option></term>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
225
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
230
<term><option>--servicename
231
<replaceable>NAME</replaceable></option></term>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
233
207
<xi:include href="mandos-options.xml"
234
208
xpointer="servicename"/>
239
<term><option>--configdir
240
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
243
217
Directory to search for configuration files. Default is
346
303
</tbody></tgroup></table>
349
306
<refsect1 id="checking">
350
307
<title>CHECKING</title>
352
309
The server will, by default, continually check that the clients
353
310
are still up. If a client has not been confirmed as being up
354
311
for some time, the client is assumed to be compromised and is no
355
longer eligible to receive the encrypted password. (Manual
356
intervention is required to re-enable a client.) The timeout,
357
extended timeout, checker program, and interval between checks
358
can be configured both globally and per client; see
359
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
<manvolnum>5</manvolnum></citerefentry>. A client successfully
361
receiving its password will also be treated as a successful
366
<refsect1 id="approval">
367
<title>APPROVAL</title>
369
The server can be configured to require manual approval for a
370
client before it is sent its secret. The delay to wait for such
371
approval and the default action (approve or deny) can be
372
configured both globally and per client; see <citerefentry>
312
longer eligible to receive the encrypted password. The timeout,
313
checker program, and interval between checks can be configured
314
both globally and per client; see <citerefentry>
373
315
<refentrytitle>mandos-clients.conf</refentrytitle>
374
<manvolnum>5</manvolnum></citerefentry>. By default all clients
375
will be approved immediately without delay.
378
This can be used to deny a client its secret if not manually
379
approved within a specified time. It can also be used to make
380
the server delay before giving a client its secret, allowing
381
optional manual denying of this specific client.
316
<manvolnum>5</manvolnum></citerefentry>.
386
320
<refsect1 id="logging">
387
321
<title>LOGGING</title>
590
516
If a client is compromised, its downtime should be duly noted
591
by the server which would therefore disable the client. But
592
if the server was ever restarted, it would re-read its client
593
list from its configuration file and again regard all clients
594
therein as enabled, and hence eligible to receive their
595
passwords. Therefore, be careful when restarting servers if
596
it is suspected that a client has, in fact, been compromised
597
by parties who may now be running a fake Mandos client with
598
the keys from the non-encrypted initial <acronym>RAM</acronym>
599
image of the client host. What should be done in that case
600
(if restarting the server program really is necessary) is to
601
stop the server program, edit the configuration file to omit
602
any suspect clients, and restart the server program.
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
605
532
For more details on client-side security, see
606
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
607
534
<manvolnum>8mandos</manvolnum></citerefentry>.
612
539
<refsect1 id="see_also">
613
540
<title>SEE ALSO</title>
615
<citerefentry><refentrytitle>intro</refentrytitle>
616
<manvolnum>8mandos</manvolnum></citerefentry>,
617
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
618
<manvolnum>5</manvolnum></citerefentry>,
619
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
620
<manvolnum>5</manvolnum></citerefentry>,
621
<citerefentry><refentrytitle>mandos-client</refentrytitle>
622
<manvolnum>8mandos</manvolnum></citerefentry>,
623
<citerefentry><refentrytitle>sh</refentrytitle>
624
<manvolnum>1</manvolnum></citerefentry>
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>