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-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>
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>
115
118
<command>&COMMANDNAME;</command> is a server daemon which
116
119
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.
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.
129
133
<refsect1 id="purpose">
130
134
<title>PURPOSE</title>
133
136
The purpose of this is to enable <emphasis>remote and unattended
134
137
rebooting</emphasis> of client host computer with an
135
138
<emphasis>encrypted root file system</emphasis>. See <xref
136
139
linkend="overview"/> for details.
141
143
<refsect1 id="options">
142
144
<title>OPTIONS</title>
147
<term><option>--help</option></term>
146
148
<term><option>-h</option></term>
147
<term><option>--help</option></term>
150
151
Show a help message and exit
157
<term><option>--interface</option>
158
<replaceable>NAME</replaceable></term>
156
159
<term><option>-i</option>
157
160
<replaceable>NAME</replaceable></term>
158
<term><option>--interface</option>
159
<replaceable>NAME</replaceable></term>
161
162
<xi:include href="mandos-options.xml" xpointer="interface"/>
166
<term><literal>-a</literal>, <literal>--address <replaceable>
167
ADDRESS</replaceable></literal></term>
167
<term><option>--address
168
<replaceable>ADDRESS</replaceable></option></term>
170
<replaceable>ADDRESS</replaceable></option></term>
169
172
<xi:include href="mandos-options.xml" xpointer="address"/>
174
<term><literal>-p</literal>, <literal>--port <replaceable>
175
PORT</replaceable></literal></term>
178
<replaceable>PORT</replaceable></option></term>
180
<replaceable>PORT</replaceable></option></term>
177
182
<xi:include href="mandos-options.xml" xpointer="port"/>
182
<term><literal>--check</literal></term>
187
<term><option>--check</option></term>
185
190
Run the server’s self-tests. This includes any unit
192
<term><literal>--debug</literal></term>
197
<term><option>--debug</option></term>
194
199
<xi:include href="mandos-options.xml" xpointer="debug"/>
199
<term><literal>--priority <replaceable>
200
PRIORITY</replaceable></literal></term>
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>
202
225
<xi:include href="mandos-options.xml" xpointer="priority"/>
207
<term><literal>--servicename <replaceable>NAME</replaceable>
230
<term><option>--servicename
231
<replaceable>NAME</replaceable></option></term>
210
233
<xi:include href="mandos-options.xml"
211
234
xpointer="servicename"/>
216
<term><literal>--configdir <replaceable>DIR</replaceable>
239
<term><option>--configdir
240
<replaceable>DIRECTORY</replaceable></option></term>
220
243
Directory to search for configuration files. Default is
306
346
</tbody></tgroup></table>
309
349
<refsect1 id="checking">
310
350
<title>CHECKING</title>
312
352
The server will, by default, continually check that the clients
313
353
are still up. If a client has not been confirmed as being up
314
354
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>
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>
318
373
<refentrytitle>mandos-clients.conf</refentrytitle>
319
<manvolnum>5</manvolnum></citerefentry>.
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.
323
386
<refsect1 id="logging">
324
387
<title>LOGGING</title>
519
587
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
588
by the server which would therefore disable the client. But
589
if the server was ever restarted, it would re-read its client
590
list from its configuration file and again regard all clients
591
therein as enabled, and hence eligible to receive their
592
passwords. Therefore, be careful when restarting servers if
593
it is suspected that a client has, in fact, been compromised
594
by parties who may now be running a fake Mandos client with
595
the keys from the non-encrypted initial <acronym>RAM</acronym>
596
image of the client host. What should be done in that case
597
(if restarting the server program really is necessary) is to
598
stop the server program, edit the configuration file to omit
599
any suspect clients, and restart the server program.
535
602
For more details on client-side security, see
536
<citerefentry><refentrytitle>password-request</refentrytitle>
603
<citerefentry><refentrytitle>mandos-client</refentrytitle>
537
604
<manvolnum>8mandos</manvolnum></citerefentry>.
542
609
<refsect1 id="see_also">
543
610
<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>
612
<citerefentry><refentrytitle>intro</refentrytitle>
613
<manvolnum>8mandos</manvolnum></citerefentry>,
614
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
615
<manvolnum>5</manvolnum></citerefentry>,
616
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
617
<manvolnum>5</manvolnum></citerefentry>,
618
<citerefentry><refentrytitle>mandos-client</refentrytitle>
619
<manvolnum>8mandos</manvolnum></citerefentry>,
620
<citerefentry><refentrytitle>sh</refentrytitle>
621
<manvolnum>1</manvolnum></citerefentry>