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 "2010-09-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>
32
37
<holder>Teddy Hogeborn</holder>
33
38
<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/"/>.
40
<xi:include href="legalnotice.xml"/>
61
44
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
45
<manvolnum>8</manvolnum>
66
49
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
51
Gives encrypted passwords to authenticated Mandos clients
74
57
<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>
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>
94
98
<command>&COMMANDNAME;</command>
95
99
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
100
<arg choice="plain"><option>--help</option></arg>
101
<arg choice="plain"><option>-h</option></arg>
101
105
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
106
<arg choice="plain"><option>--version</option></arg>
105
109
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
110
<arg choice="plain"><option>--check</option></arg>
108
112
</refsynopsisdiv>
110
114
<refsect1 id="description">
111
115
<title>DESCRIPTION</title>
121
125
Any authenticated client is then given the stored pre-encrypted
122
126
password for that specific client.
127
130
<refsect1 id="purpose">
128
131
<title>PURPOSE</title>
131
133
The purpose of this is to enable <emphasis>remote and unattended
132
134
rebooting</emphasis> of client host computer with an
133
135
<emphasis>encrypted root file system</emphasis>. See <xref
134
136
linkend="overview"/> for details.
139
140
<refsect1 id="options">
140
141
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
144
<term><option>--help</option></term>
145
<term><option>-h</option></term>
147
148
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
154
<term><option>--interface</option>
155
<replaceable>NAME</replaceable></term>
156
<term><option>-i</option>
157
<replaceable>NAME</replaceable></term>
156
159
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
164
<term><option>--address
165
<replaceable>ADDRESS</replaceable></option></term>
167
<replaceable>ADDRESS</replaceable></option></term>
164
169
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
175
<replaceable>PORT</replaceable></option></term>
177
<replaceable>PORT</replaceable></option></term>
172
179
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
184
<term><option>--check</option></term>
180
187
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
194
<term><option>--debug</option></term>
189
196
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
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>
197
222
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
227
<term><option>--servicename
228
<replaceable>NAME</replaceable></option></term>
205
230
<xi:include href="mandos-options.xml"
206
231
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
236
<term><option>--configdir
237
<replaceable>DIRECTORY</replaceable></option></term>
215
240
Directory to search for configuration files. Default is
226
<term><literal>--version</literal></term>
251
<term><option>--version</option></term>
229
254
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"/>
236
278
<refsect1 id="overview">
237
279
<title>OVERVIEW</title>
238
280
<xi:include href="overview.xml"/>
240
282
This program is the server part. It is a normal server program
241
283
and will run in a normal system environment, not in an initial
242
RAM disk environment.
284
<acronym>RAM</acronym> disk environment.
246
288
<refsect1 id="protocol">
247
289
<title>NETWORK PROTOCOL</title>
301
343
</tbody></tgroup></table>
304
346
<refsect1 id="checking">
305
347
<title>CHECKING</title>
307
349
The server will, by default, continually check that the clients
308
350
are still up. If a client has not been confirmed as being up
309
351
for some time, the client is assumed to be compromised and is no
310
longer eligible to receive the encrypted password. The timeout,
352
longer eligible to receive the encrypted password. (Manual
353
intervention is required to re-enable a client.) The timeout,
311
354
checker program, and interval between checks can be configured
312
355
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
<refentrytitle>mandos-clients.conf</refentrytitle>
316
<manvolnum>5</manvolnum></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.
320
383
<refsect1 id="logging">
321
384
<title>LOGGING</title>
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
386
The server will send log message with various severity levels to
387
<filename>/dev/log</filename>. With the
325
388
<option>--debug</option> option, it will log even more messages,
326
389
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>.
330
403
<refsect1 id="exit_status">
331
404
<title>EXIT STATUS</title>
422
495
backtrace. This could be considered a feature.
425
Currently, if a client is declared <quote>invalid</quote> due to
426
having timed out, the server does not record this fact onto
427
permanent storage. This has some security implications, see
428
<xref linkend="CLIENTS"/>.
431
There is currently no way of querying the server of the current
432
status of clients, other than analyzing its <systemitem
433
class="service">syslog</systemitem> output.
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"/>.
436
503
There is no fine-grained control over logging and debug output.
477
548
<!-- do not wrap this line -->
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
549
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
481
552
</informalexample>
484
555
<refsect1 id="security">
485
556
<title>SECURITY</title>
486
<refsect2 id="SERVER">
557
<refsect2 id="server">
487
558
<title>SERVER</title>
489
560
Running this <command>&COMMANDNAME;</command> server program
490
561
should not in itself present any security risk to the host
491
computer running it. The program does not need any special
492
privileges to run, and is designed to run as a non-root user.
562
computer running it. The program switches to a non-root user
495
<refsect2 id="CLIENTS">
566
<refsect2 id="clients">
496
567
<title>CLIENTS</title>
498
569
The server only gives out its stored data to clients which
516
587
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
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.
532
602
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
603
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
604
<manvolnum>8mandos</manvolnum></citerefentry>.
539
609
<refsect1 id="see_also">
540
610
<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>
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
625
<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>
660
RFC 4291: <citetitle>IP Version 6 Addressing
661
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
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
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>
692
RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
Protocol Version 1.1</citetitle>