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 "2010-09-26">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
10
<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>
16
<date>&TIMESTAMP;</date>
13
<productname>&COMMANDNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
19
17
<firstname>Björn</firstname>
37
33
<holder>Teddy Hogeborn</holder>
38
34
<holder>Björn Påhlsson</holder>
40
<xi:include href="legalnotice.xml"/>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
44
62
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
63
<manvolnum>8</manvolnum>
49
67
<refname><command>&COMMANDNAME;</command></refname>
51
Gives encrypted passwords to authenticated Mandos clients
69
Sends encrypted passwords to authenticated Mandos clients
57
75
<command>&COMMANDNAME;</command>
59
<arg choice="plain"><option>--interface
60
<replaceable>NAME</replaceable></option></arg>
61
<arg choice="plain"><option>-i
62
<replaceable>NAME</replaceable></option></arg>
66
<arg choice="plain"><option>--address
67
<replaceable>ADDRESS</replaceable></option></arg>
68
<arg choice="plain"><option>-a
69
<replaceable>ADDRESS</replaceable></option></arg>
73
<arg choice="plain"><option>--port
74
<replaceable>PORT</replaceable></option></arg>
75
<arg choice="plain"><option>-p
76
<replaceable>PORT</replaceable></option></arg>
79
<arg><option>--priority
80
<replaceable>PRIORITY</replaceable></option></arg>
82
<arg><option>--servicename
83
<replaceable>NAME</replaceable></option></arg>
85
<arg><option>--configdir
86
<replaceable>DIRECTORY</replaceable></option></arg>
88
<arg><option>--debug</option></arg>
90
<arg><option>--debuglevel
91
<replaceable>LEVEL</replaceable></option></arg>
93
<arg><option>--no-dbus</option></arg>
95
<arg><option>--no-ipv6</option></arg>
76
<arg>--interface<arg choice="plain">IF</arg></arg>
77
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
<arg>--port<arg choice="plain">PORT</arg></arg>
79
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
80
<arg>--servicename<arg choice="plain">NAME</arg></arg>
81
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
85
<command>&COMMANDNAME;</command>
86
<arg>-i<arg choice="plain">IF</arg></arg>
87
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
<arg>-p<arg choice="plain">PORT</arg></arg>
89
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
90
<arg>--servicename<arg choice="plain">NAME</arg></arg>
91
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
98
95
<command>&COMMANDNAME;</command>
99
96
<group choice="req">
100
<arg choice="plain"><option>--help</option></arg>
101
<arg choice="plain"><option>-h</option></arg>
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
105
102
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--version</option></arg>
103
<arg choice="plain">--version</arg>
109
106
<command>&COMMANDNAME;</command>
110
<arg choice="plain"><option>--check</option></arg>
107
<arg choice="plain">--check</arg>
112
109
</refsynopsisdiv>
114
111
<refsect1 id="description">
115
112
<title>DESCRIPTION</title>
125
122
Any authenticated client is then given the stored pre-encrypted
126
123
password for that specific client.
130
128
<refsect1 id="purpose">
131
129
<title>PURPOSE</title>
133
132
The purpose of this is to enable <emphasis>remote and unattended
134
133
rebooting</emphasis> of client host computer with an
135
134
<emphasis>encrypted root file system</emphasis>. See <xref
136
135
linkend="overview"/> for details.
140
140
<refsect1 id="options">
141
141
<title>OPTIONS</title>
144
<term><option>--help</option></term>
145
<term><option>-h</option></term>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
148
148
Show a help message and exit
154
<term><option>--interface</option>
155
<replaceable>NAME</replaceable></term>
156
<term><option>-i</option>
157
<replaceable>NAME</replaceable></term>
159
<xi:include href="mandos-options.xml" xpointer="interface"/>
164
<term><option>--address
165
<replaceable>ADDRESS</replaceable></option></term>
167
<replaceable>ADDRESS</replaceable></option></term>
169
<xi:include href="mandos-options.xml" xpointer="address"/>
175
<replaceable>PORT</replaceable></option></term>
177
<replaceable>PORT</replaceable></option></term>
179
<xi:include href="mandos-options.xml" xpointer="port"/>
184
<term><option>--check</option></term>
154
<term><literal>-i</literal>, <literal>--interface <replaceable>
155
IF</replaceable></literal></term>
158
Only announce the server and listen to requests on network
159
interface <replaceable>IF</replaceable>. Default is to
160
use all available interfaces. <emphasis>Note:</emphasis>
161
a failure to bind to the specified interface is not
162
considered critical, and the server does not exit.
168
<term><literal>-a</literal>, <literal>--address <replaceable>
169
ADDRESS</replaceable></literal></term>
172
If this option is used, the server will only listen to a
173
specific address. This must currently be an IPv6 address;
174
an IPv4 address can be specified using the
175
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
Also, if a link-local address is specified, an interface
177
should be set, since a link-local address is only valid on
178
a single interface. By default, the server will listen to
179
all available addresses.
185
<term><literal>-p</literal>, <literal>--port <replaceable>
186
PORT</replaceable></literal></term>
189
If this option is used, the server to bind to that
190
port. By default, the server will listen to an arbitrary
191
port given by the operating system.
197
<term><literal>--check</literal></term>
187
200
Run the server’s self-tests. This includes any unit
194
<term><option>--debug</option></term>
196
<xi:include href="mandos-options.xml" xpointer="debug"/>
201
<term><option>--debuglevel
202
<replaceable>LEVEL</replaceable></option></term>
205
Set the debugging log level.
206
<replaceable>LEVEL</replaceable> is a string, one of
207
<quote><literal>CRITICAL</literal></quote>,
208
<quote><literal>ERROR</literal></quote>,
209
<quote><literal>WARNING</literal></quote>,
210
<quote><literal>INFO</literal></quote>, or
211
<quote><literal>DEBUG</literal></quote>, in order of
212
increasing verbosity. The default level is
213
<quote><literal>WARNING</literal></quote>.
219
<term><option>--priority <replaceable>
220
PRIORITY</replaceable></option></term>
222
<xi:include href="mandos-options.xml" xpointer="priority"/>
227
<term><option>--servicename
228
<replaceable>NAME</replaceable></option></term>
230
<xi:include href="mandos-options.xml"
231
xpointer="servicename"/>
236
<term><option>--configdir
237
<replaceable>DIRECTORY</replaceable></option></term>
207
<term><literal>--debug</literal></term>
210
If the server is run in debug mode, it will run in the
211
foreground and print a lot of debugging information. The
212
default is <emphasis>not</emphasis> to run in debug mode.
218
<term><literal>--priority <replaceable>
219
PRIORITY</replaceable></literal></term>
222
GnuTLS priority string for the TLS handshake with the
223
clients. The default is
224
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
See <citerefentry><refentrytitle>gnutls_priority_init
226
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
for the syntax. <emphasis>Warning</emphasis>: changing
228
this may make the TLS handshake fail, making communication
229
with clients impossible.
235
<term><literal>--servicename <replaceable>NAME</replaceable>
239
Zeroconf service name. The default is
240
<quote><literal>Mandos</literal></quote>. You only need
241
to change this if you for some reason want to run more
242
than one server on the same <emphasis>host</emphasis>,
243
which would not normally be useful. If there are name
244
collisions on the same <emphasis>network</emphasis>, the
245
newer server will automatically rename itself to
246
<quote><literal>Mandos #2</literal></quote>, and so on;
247
therefore, this option is not needed in that case.
253
<term><literal>--configdir <replaceable>DIR</replaceable>
240
257
Directory to search for configuration files. Default is
251
<term><option>--version</option></term>
268
<term><literal>--version</literal></term>
254
271
Prints the program version and exit.
260
<term><option>--no-dbus</option></term>
262
<xi:include href="mandos-options.xml" xpointer="dbus"/>
264
See also <xref linkend="dbus_interface"/>.
270
<term><option>--no-ipv6</option></term>
272
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
278
278
<refsect1 id="overview">
279
279
<title>OVERVIEW</title>
280
<xi:include href="overview.xml"/>
282
282
This program is the server part. It is a normal server program
283
283
and will run in a normal system environment, not in an initial
284
<acronym>RAM</acronym> disk environment.
284
RAM disk environment.
288
288
<refsect1 id="protocol">
289
289
<title>NETWORK PROTOCOL</title>
343
343
</tbody></tgroup></table>
346
346
<refsect1 id="checking">
347
347
<title>CHECKING</title>
349
349
The server will, by default, continually check that the clients
350
350
are still up. If a client has not been confirmed as being up
351
351
for some time, the client is assumed to be compromised and is no
352
longer eligible to receive the encrypted password. (Manual
353
intervention is required to re-enable a client.) The timeout,
352
longer eligible to receive the encrypted password. The timeout,
354
353
checker program, and interval between checks can be configured
355
354
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos-clients.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry>. A client successfully
358
receiving its password will also be treated as a successful
363
<refsect1 id="approval">
364
<title>APPROVAL</title>
366
The server can be configured to require manual approval for a
367
client before it is sent its secret. The delay to wait for such
368
approval and the default action (approve or deny) can be
369
configured both globally and per client; see <citerefentry>
370
<refentrytitle>mandos-clients.conf</refentrytitle>
371
<manvolnum>5</manvolnum></citerefentry>. By default all clients
372
will be approved immediately without delay.
375
This can be used to deny a client its secret if not manually
376
approved within a specified time. It can also be used to make
377
the server delay before giving a client its secret, allowing
378
optional manual denying of this specific client.
355
<refentrytitle>mandos.conf</refentrytitle>
356
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
357
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>.
383
362
<refsect1 id="logging">
384
363
<title>LOGGING</title>
386
The server will send log message with various severity levels to
387
<filename>/dev/log</filename>. With the
365
The server will send log messaged with various severity levels
366
to <filename>/dev/log</filename>. With the
388
367
<option>--debug</option> option, it will log even more messages,
389
368
and also show them on the console.
393
<refsect1 id="dbus_interface">
394
<title>D-BUS INTERFACE</title>
396
The server will by default provide a D-Bus system bus interface.
397
This interface will only be accessible by the root user or a
398
Mandos-specific user, if such a user exists. For documentation
399
of the D-Bus API, see the file <filename>DBUS-API</filename>.
403
372
<refsect1 id="exit_status">
404
373
<title>EXIT STATUS</title>
495
464
backtrace. This could be considered a feature.
498
Currently, if a client is disabled due to having timed out, the
499
server does not record this fact onto permanent storage. This
500
has some security implications, see <xref linkend="clients"/>.
467
Currently, if a client is declared <quote>invalid</quote> due to
468
having timed out, the server does not record this fact onto
469
permanent storage. This has some security implications, see
470
<xref linkend="CLIENTS"/>.
473
There is currently no way of querying the server of the current
474
status of clients, other than analyzing its <systemitem
475
class="service">syslog</systemitem> output.
503
478
There is no fine-grained control over logging and debug output.
548
519
<!-- do not wrap this line -->
549
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
552
523
</informalexample>
555
526
<refsect1 id="security">
556
527
<title>SECURITY</title>
557
<refsect2 id="server">
528
<refsect2 id="SERVER">
558
529
<title>SERVER</title>
560
531
Running this <command>&COMMANDNAME;</command> server program
561
532
should not in itself present any security risk to the host
562
computer running it. The program switches to a non-root user
533
computer running it. The program does not need any special
534
privileges to run, and is designed to run as a non-root user.
566
<refsect2 id="clients">
537
<refsect2 id="CLIENTS">
567
538
<title>CLIENTS</title>
569
540
The server only gives out its stored data to clients which
587
558
If a client is compromised, its downtime should be duly noted
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>
559
by the server which would therefore declare the client
560
invalid. But if the server was ever restarted, it would
561
re-read its client list from its configuration file and again
562
regard all clients therein as valid, and hence eligible to
563
receive their passwords. Therefore, be careful when
564
restarting servers if you suspect that a client has, in fact,
565
been compromised by parties who may now be running a fake
566
Mandos client with the keys from the non-encrypted initial RAM
596
567
image of the client host. What should be done in that case
597
568
(if restarting the server program really is necessary) is to
598
569
stop the server program, edit the configuration file to omit
602
573
For more details on client-side security, see
603
<citerefentry><refentrytitle>mandos-client</refentrytitle>
574
<citerefentry><refentrytitle>password-request</refentrytitle>
604
575
<manvolnum>8mandos</manvolnum></citerefentry>.
609
580
<refsect1 id="see_also">
610
581
<title>SEE ALSO</title>
613
<refentrytitle>mandos-clients.conf</refentrytitle>
614
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
<refentrytitle>mandos.conf</refentrytitle>
616
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
<refentrytitle>mandos-client</refentrytitle>
618
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
586
<refentrytitle>password-request</refentrytitle>
587
<manvolnum>8mandos</manvolnum>
592
This is the actual program which talks to this server.
593
Note that it is normally not invoked directly, and is only
594
run in the initial RAM disk environment, and not on a
595
fully started system.
625
601
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
660
RFC 4291: <citetitle>IP Version 6 Addressing
661
Architecture</citetitle>
636
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
Unicast Addresses</citation>
666
<term>Section 2.2: <citetitle>Text Representation of
667
Addresses</citetitle></term>
668
<listitem><para/></listitem>
671
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
672
Address</citetitle></term>
673
<listitem><para/></listitem>
676
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
677
Addresses</citetitle></term>
680
The clients use IPv6 link-local addresses, which are
681
immediately usable since a link-local addresses is
682
automatically assigned to a network interfaces when it
642
The clients use IPv6 link-local addresses, which are
643
immediately usable since a link-local addresses is
644
automatically assigned to a network interfaces when it is
692
RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
Protocol Version 1.1</citetitle>
651
<citation>RFC 4346: <citetitle>The Transport Layer Security
652
(TLS) Protocol Version 1.1</citetitle></citation>