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-11-26">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-29">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
11
<title>&COMMANDNAME;</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
13
<productname>&COMMANDNAME;</productname>
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>
98
<arg><option>--no-restore</option></arg>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></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>
104
96
<command>&COMMANDNAME;</command>
105
97
<group choice="req">
106
<arg choice="plain"><option>--help</option></arg>
107
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
111
103
<command>&COMMANDNAME;</command>
112
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
115
107
<command>&COMMANDNAME;</command>
116
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
118
110
</refsynopsisdiv>
120
112
<refsect1 id="description">
121
113
<title>DESCRIPTION</title>
123
115
<command>&COMMANDNAME;</command> is a server daemon which
124
116
handles incoming request for passwords for a pre-defined list of
125
client host computers. For an introduction, see
126
<citerefentry><refentrytitle>intro</refentrytitle>
127
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
uses Zeroconf to announce itself on the local network, and uses
129
TLS to communicate securely with and to authenticate the
130
clients. The Mandos server uses IPv6 to allow Mandos clients to
131
use IPv6 link-local addresses, since the clients will probably
132
not have any other addresses configured (see <xref
133
linkend="overview"/>). Any authenticated client is then given
134
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.
138
129
<refsect1 id="purpose">
139
130
<title>PURPOSE</title>
141
133
The purpose of this is to enable <emphasis>remote and unattended
142
134
rebooting</emphasis> of client host computer with an
143
135
<emphasis>encrypted root file system</emphasis>. See <xref
144
136
linkend="overview"/> for details.
148
141
<refsect1 id="options">
149
142
<title>OPTIONS</title>
152
<term><option>--help</option></term>
153
<term><option>-h</option></term>
146
<term><literal>-h</literal>, <literal>--help</literal></term>
156
149
Show a help message and exit
162
<term><option>--interface</option>
163
<replaceable>NAME</replaceable></term>
164
<term><option>-i</option>
165
<replaceable>NAME</replaceable></term>
155
<term><literal>-i</literal>, <literal>--interface <replaceable
156
>NAME</replaceable></literal></term>
167
158
<xi:include href="mandos-options.xml" xpointer="interface"/>
172
<term><option>--address
173
<replaceable>ADDRESS</replaceable></option></term>
175
<replaceable>ADDRESS</replaceable></option></term>
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
177
166
<xi:include href="mandos-options.xml" xpointer="address"/>
183
<replaceable>PORT</replaceable></option></term>
185
<replaceable>PORT</replaceable></option></term>
171
<term><literal>-p</literal>, <literal>--port <replaceable>
172
PORT</replaceable></literal></term>
187
174
<xi:include href="mandos-options.xml" xpointer="port"/>
192
<term><option>--check</option></term>
179
<term><literal>--check</literal></term>
195
182
Run the server’s self-tests. This includes any unit
202
<term><option>--debug</option></term>
189
<term><literal>--debug</literal></term>
204
191
<xi:include href="mandos-options.xml" xpointer="debug"/>
209
<term><option>--debuglevel
210
<replaceable>LEVEL</replaceable></option></term>
213
Set the debugging log level.
214
<replaceable>LEVEL</replaceable> is a string, one of
215
<quote><literal>CRITICAL</literal></quote>,
216
<quote><literal>ERROR</literal></quote>,
217
<quote><literal>WARNING</literal></quote>,
218
<quote><literal>INFO</literal></quote>, or
219
<quote><literal>DEBUG</literal></quote>, in order of
220
increasing verbosity. The default level is
221
<quote><literal>WARNING</literal></quote>.
227
<term><option>--priority <replaceable>
228
PRIORITY</replaceable></option></term>
196
<term><literal>--priority <replaceable>
197
PRIORITY</replaceable></literal></term>
230
199
<xi:include href="mandos-options.xml" xpointer="priority"/>
235
<term><option>--servicename
236
<replaceable>NAME</replaceable></option></term>
204
<term><literal>--servicename <replaceable>NAME</replaceable>
238
207
<xi:include href="mandos-options.xml"
239
208
xpointer="servicename"/>
244
<term><option>--configdir
245
<replaceable>DIRECTORY</replaceable></option></term>
213
<term><literal>--configdir <replaceable>DIR</replaceable>
248
217
Directory to search for configuration files. Default is
366
303
</tbody></tgroup></table>
369
306
<refsect1 id="checking">
370
307
<title>CHECKING</title>
372
309
The server will, by default, continually check that the clients
373
310
are still up. If a client has not been confirmed as being up
374
311
for some time, the client is assumed to be compromised and is no
375
longer eligible to receive the encrypted password. (Manual
376
intervention is required to re-enable a client.) The timeout,
377
extended timeout, checker program, and interval between checks
378
can be configured both globally and per client; see
379
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
<manvolnum>5</manvolnum></citerefentry>. A client successfully
381
receiving its password will also be treated as a successful
386
<refsect1 id="approval">
387
<title>APPROVAL</title>
389
The server can be configured to require manual approval for a
390
client before it is sent its secret. The delay to wait for such
391
approval and the default action (approve or deny) can be
392
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>
393
315
<refentrytitle>mandos-clients.conf</refentrytitle>
394
<manvolnum>5</manvolnum></citerefentry>. By default all clients
395
will be approved immediately without delay.
398
This can be used to deny a client its secret if not manually
399
approved within a specified time. It can also be used to make
400
the server delay before giving a client its secret, allowing
401
optional manual denying of this specific client.
316
<manvolnum>5</manvolnum></citerefentry>.
406
320
<refsect1 id="logging">
407
321
<title>LOGGING</title>
409
323
The server will send log message with various severity levels to
410
<filename class="devicefile">/dev/log</filename>. With the
324
<filename>/dev/log</filename>. With the
411
325
<option>--debug</option> option, it will log even more messages,
412
326
and also show them on the console.
416
<refsect1 id="dbus_interface">
417
<title>D-BUS INTERFACE</title>
419
The server will by default provide a D-Bus system bus interface.
420
This interface will only be accessible by the root user or a
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
426
330
<refsect1 id="exit_status">
427
331
<title>EXIT STATUS</title>
613
513
compromised if they are gone for too long.
516
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
616
532
For more details on client-side security, see
617
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
618
534
<manvolnum>8mandos</manvolnum></citerefentry>.
623
539
<refsect1 id="see_also">
624
540
<title>SEE ALSO</title>
626
<citerefentry><refentrytitle>intro</refentrytitle>
627
<manvolnum>8mandos</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
<manvolnum>5</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
<manvolnum>5</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>mandos-client</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>sh</refentrytitle>
635
<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>