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">
5
<!ENTITY TIMESTAMP "2011-11-26">
6
<!ENTITY % common SYSTEM "common.ent">
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<title>&COMMANDNAME;</title>
12
<title>Mandos Manual</title>
11
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
16
19
<firstname>Björn</firstname>
17
20
<surname>Påhlsson</surname>
19
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
23
26
<firstname>Teddy</firstname>
24
27
<surname>Hogeborn</surname>
26
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
32
38
<holder>Teddy Hogeborn</holder>
33
39
<holder>Björn Påhlsson</holder>
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/"/>.
41
<xi:include href="legalnotice.xml"/>
61
45
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
46
<manvolnum>8</manvolnum>
66
50
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
52
Gives encrypted passwords to authenticated Mandos clients
74
58
<command>&COMMANDNAME;</command>
75
<arg>--interface<arg choice="plain">IF</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">IF</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>
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>
94
104
<command>&COMMANDNAME;</command>
95
105
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
106
<arg choice="plain"><option>--help</option></arg>
107
<arg choice="plain"><option>-h</option></arg>
101
111
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
112
<arg choice="plain"><option>--version</option></arg>
105
115
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
116
<arg choice="plain"><option>--check</option></arg>
108
118
</refsynopsisdiv>
110
120
<refsect1 id="description">
111
121
<title>DESCRIPTION</title>
113
123
<command>&COMMANDNAME;</command> is a server daemon which
114
124
handles incoming request for passwords for a pre-defined list of
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.
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.
127
138
<refsect1 id="purpose">
128
139
<title>PURPOSE</title>
131
141
The purpose of this is to enable <emphasis>remote and unattended
132
142
rebooting</emphasis> of client host computer with an
133
143
<emphasis>encrypted root file system</emphasis>. See <xref
134
144
linkend="overview"/> for details.
139
148
<refsect1 id="options">
140
149
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
152
<term><option>--help</option></term>
153
<term><option>-h</option></term>
147
156
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
162
<term><option>--interface</option>
163
<replaceable>NAME</replaceable></term>
164
<term><option>-i</option>
165
<replaceable>NAME</replaceable></term>
156
167
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
172
<term><option>--address
173
<replaceable>ADDRESS</replaceable></option></term>
175
<replaceable>ADDRESS</replaceable></option></term>
164
177
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
183
<replaceable>PORT</replaceable></option></term>
185
<replaceable>PORT</replaceable></option></term>
172
187
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
192
<term><option>--check</option></term>
180
195
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
202
<term><option>--debug</option></term>
189
204
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
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>
197
230
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
235
<term><option>--servicename
236
<replaceable>NAME</replaceable></option></term>
205
238
<xi:include href="mandos-options.xml"
206
239
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
244
<term><option>--configdir
245
<replaceable>DIRECTORY</replaceable></option></term>
215
248
Directory to search for configuration files. Default is
301
366
</tbody></tgroup></table>
304
369
<refsect1 id="checking">
305
370
<title>CHECKING</title>
307
372
The server will, by default, continually check that the clients
308
373
are still up. If a client has not been confirmed as being up
309
374
for some time, the client is assumed to be compromised and is no
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>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
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>
315
393
<refentrytitle>mandos-clients.conf</refentrytitle>
316
<manvolnum>5</manvolnum></citerefentry>.
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.
320
406
<refsect1 id="logging">
321
407
<title>LOGGING</title>
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
409
The server will send log message with various severity levels to
410
<filename>/dev/log</filename>. With the
325
411
<option>--debug</option> option, it will log even more messages,
326
412
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>.
330
426
<refsect1 id="exit_status">
331
427
<title>EXIT STATUS</title>
513
610
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
532
613
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
614
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
615
<manvolnum>8mandos</manvolnum></citerefentry>.
539
620
<refsect1 id="see_also">
540
621
<title>SEE ALSO</title>
623
<citerefentry><refentrytitle>intro</refentrytitle>
624
<manvolnum>8mandos</manvolnum></citerefentry>,
625
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
626
<manvolnum>5</manvolnum></citerefentry>,
627
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
628
<manvolnum>5</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>mandos-client</refentrytitle>
630
<manvolnum>8mandos</manvolnum></citerefentry>,
631
<citerefentry><refentrytitle>sh</refentrytitle>
632
<manvolnum>1</manvolnum></citerefentry>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum>
551
This is the actual program which talks to this server.
552
Note that it is normally not invoked directly, and is only
553
run in the initial RAM disk environment, and not on a
554
fully started system.
560
637
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
595
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
Unicast Addresses</citation>
672
RFC 4291: <citetitle>IP Version 6 Addressing
673
Architecture</citetitle>
601
The clients use IPv6 link-local addresses, which are
602
immediately usable since a link-local addresses is
603
automatically assigned to a network interfaces when it is
678
<term>Section 2.2: <citetitle>Text Representation of
679
Addresses</citetitle></term>
680
<listitem><para/></listitem>
683
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
684
Address</citetitle></term>
685
<listitem><para/></listitem>
688
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
689
Addresses</citetitle></term>
692
The clients use IPv6 link-local addresses, which are
693
immediately usable since a link-local addresses is
694
automatically assigned to a network interfaces when it
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>
704
RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
Protocol Version 1.1</citetitle>