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-22">
6
<!ENTITY % common SYSTEM "common.ent">
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
10
<title>&COMMANDNAME;</title>
13
11
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
19
16
<firstname>Björn</firstname>
20
17
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
19
<email>belorn@fukt.bsnet.se</email>
26
23
<firstname>Teddy</firstname>
27
24
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
26
<email>teddy@fukt.bsnet.se</email>
38
32
<holder>Teddy Hogeborn</holder>
39
33
<holder>Björn Påhlsson</holder>
41
<xi:include href="legalnotice.xml"/>
37
This manual page is free software: you can redistribute it
38
and/or modify it under the terms of the GNU General Public
39
License as published by the Free Software Foundation,
40
either version 3 of the License, or (at your option) any
45
This manual page is distributed in the hope that it will
46
be useful, but WITHOUT ANY WARRANTY; without even the
47
implied warranty of MERCHANTABILITY or FITNESS FOR A
48
PARTICULAR PURPOSE. See the GNU General Public License
53
You should have received a copy of the GNU General Public
54
License along with this program; If not, see
55
<ulink url="http://www.gnu.org/licenses/"/>.
45
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
46
62
<manvolnum>8</manvolnum>
50
66
<refname><command>&COMMANDNAME;</command></refname>
52
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
58
74
<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>
75
<arg>--interface<arg choice="plain">NAME</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">NAME</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
101
94
<command>&COMMANDNAME;</command>
102
95
<group choice="req">
103
<arg choice="plain"><option>--help</option></arg>
104
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
108
101
<command>&COMMANDNAME;</command>
109
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
112
105
<command>&COMMANDNAME;</command>
113
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
115
108
</refsynopsisdiv>
117
110
<refsect1 id="description">
118
111
<title>DESCRIPTION</title>
120
113
<command>&COMMANDNAME;</command> is a server daemon which
121
114
handles incoming request for passwords for a pre-defined list of
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.
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
password for that specific client.
135
127
<refsect1 id="purpose">
136
128
<title>PURPOSE</title>
138
131
The purpose of this is to enable <emphasis>remote and unattended
139
132
rebooting</emphasis> of client host computer with an
140
133
<emphasis>encrypted root file system</emphasis>. See <xref
141
134
linkend="overview"/> for details.
145
139
<refsect1 id="options">
146
140
<title>OPTIONS</title>
149
<term><option>--help</option></term>
150
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
153
147
Show a help message and exit
159
<term><option>--interface</option>
160
<replaceable>NAME</replaceable></term>
161
<term><option>-i</option>
162
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
164
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
169
<term><option>--address
170
<replaceable>ADDRESS</replaceable></option></term>
172
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
174
164
<xi:include href="mandos-options.xml" xpointer="address"/>
180
<replaceable>PORT</replaceable></option></term>
182
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
184
172
<xi:include href="mandos-options.xml" xpointer="port"/>
189
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
192
180
Run the server’s self-tests. This includes any unit
199
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
201
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
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>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
227
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
232
<term><option>--servicename
233
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
235
205
<xi:include href="mandos-options.xml"
236
206
xpointer="servicename"/>
241
<term><option>--configdir
242
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
245
215
Directory to search for configuration files. Default is
355
301
</tbody></tgroup></table>
358
304
<refsect1 id="checking">
359
305
<title>CHECKING</title>
361
307
The server will, by default, continually check that the clients
362
308
are still up. If a client has not been confirmed as being up
363
309
for some time, the client is assumed to be compromised and is no
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>
310
longer eligible to receive the encrypted password. The timeout,
311
checker program, and interval between checks can be configured
312
both globally and per client; see <citerefentry>
382
313
<refentrytitle>mandos-clients.conf</refentrytitle>
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.
314
<manvolnum>5</manvolnum></citerefentry>.
395
318
<refsect1 id="logging">
396
319
<title>LOGGING</title>
398
321
The server will send log message with various severity levels to
399
<filename class="devicefile">/dev/log</filename>. With the
322
<filename>/dev/log</filename>. With the
400
323
<option>--debug</option> option, it will log even more messages,
401
324
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>.
415
328
<refsect1 id="exit_status">
416
329
<title>EXIT STATUS</title>
596
514
If a client is compromised, its downtime should be duly noted
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.
515
by the server which would therefore declare the client
516
invalid. But if the server was ever restarted, it would
517
re-read its client list from its configuration file and again
518
regard all clients therein as valid, and hence eligible to
519
receive their passwords. Therefore, be careful when
520
restarting servers if it is suspected that a client has, in
521
fact, been compromised by parties who may now be running a
522
fake Mandos client with the keys from the non-encrypted
523
initial RAM image of the client host. What should be done in
524
that case (if restarting the server program really is
525
necessary) is to stop the server program, edit the
526
configuration file to omit any suspect clients, and restart
611
530
For more details on client-side security, see
612
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
613
532
<manvolnum>8mandos</manvolnum></citerefentry>.
618
537
<refsect1 id="see_also">
619
538
<title>SEE ALSO</title>
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>
541
<refentrytitle>mandos.conf</refentrytitle>
542
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>