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">
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>
37
32
<holder>Teddy Hogeborn</holder>
38
33
<holder>Björn Påhlsson</holder>
40
<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/"/>.
44
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
62
<manvolnum>8</manvolnum>
49
66
<refname><command>&COMMANDNAME;</command></refname>
51
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
57
74
<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>
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>
98
94
<command>&COMMANDNAME;</command>
99
95
<group choice="req">
100
<arg choice="plain"><option>--help</option></arg>
101
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
105
101
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
109
105
<command>&COMMANDNAME;</command>
110
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
112
108
</refsynopsisdiv>
114
110
<refsect1 id="description">
115
111
<title>DESCRIPTION</title>
125
121
Any authenticated client is then given the stored pre-encrypted
126
122
password for that specific client.
130
127
<refsect1 id="purpose">
131
128
<title>PURPOSE</title>
133
131
The purpose of this is to enable <emphasis>remote and unattended
134
132
rebooting</emphasis> of client host computer with an
135
133
<emphasis>encrypted root file system</emphasis>. See <xref
136
134
linkend="overview"/> for details.
140
139
<refsect1 id="options">
141
140
<title>OPTIONS</title>
144
<term><option>--help</option></term>
145
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
148
147
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>
153
<term><literal>-i</literal>, <literal>--interface <replaceable
154
>NAME</replaceable></literal></term>
159
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
164
<term><option>--address
165
<replaceable>ADDRESS</replaceable></option></term>
167
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
169
164
<xi:include href="mandos-options.xml" xpointer="address"/>
175
<replaceable>PORT</replaceable></option></term>
177
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
179
172
<xi:include href="mandos-options.xml" xpointer="port"/>
184
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
187
180
Run the server’s self-tests. This includes any unit
194
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
196
189
<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>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
222
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
227
<term><option>--servicename
228
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
230
205
<xi:include href="mandos-options.xml"
231
206
xpointer="servicename"/>
236
<term><option>--configdir
237
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
240
215
Directory to search for configuration files. Default is
251
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
254
229
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
236
<refsect1 id="overview">
279
237
<title>OVERVIEW</title>
280
238
<xi:include href="overview.xml"/>
282
240
This program is the server part. It is a normal server program
283
241
and will run in a normal system environment, not in an initial
284
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
288
246
<refsect1 id="protocol">
289
247
<title>NETWORK PROTOCOL</title>
343
301
</tbody></tgroup></table>
346
304
<refsect1 id="checking">
347
305
<title>CHECKING</title>
349
307
The server will, by default, continually check that the clients
350
308
are still up. If a client has not been confirmed as being up
351
309
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,
310
longer eligible to receive the encrypted password. The timeout,
354
311
checker program, and interval between checks can be configured
355
312
both globally and per client; see <citerefentry>
356
313
<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.
314
<manvolnum>5</manvolnum></citerefentry>.
383
318
<refsect1 id="logging">
384
319
<title>LOGGING</title>
389
324
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
328
<refsect1 id="exit_status">
404
329
<title>EXIT STATUS</title>
495
420
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"/>.
423
Currently, if a client is declared <quote>invalid</quote> due to
424
having timed out, the server does not record this fact onto
425
permanent storage. This has some security implications, see
426
<xref linkend="CLIENTS"/>.
429
There is currently no way of querying the server of the current
430
status of clients, other than analyzing its <systemitem
431
class="service">syslog</systemitem> output.
503
434
There is no fine-grained control over logging and debug output.
548
475
<!-- do not wrap this line -->
549
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
552
479
</informalexample>
555
482
<refsect1 id="security">
556
483
<title>SECURITY</title>
557
<refsect2 id="server">
484
<refsect2 id="SERVER">
558
485
<title>SERVER</title>
560
487
Running this <command>&COMMANDNAME;</command> server program
561
488
should not in itself present any security risk to the host
562
computer running it. The program switches to a non-root user
489
computer running it. The program does not need any special
490
privileges to run, and is designed to run as a non-root user.
566
<refsect2 id="clients">
493
<refsect2 id="CLIENTS">
567
494
<title>CLIENTS</title>
569
496
The server only gives out its stored data to clients which
587
514
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>
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.
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
602
530
For more details on client-side security, see
603
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
604
532
<manvolnum>8mandos</manvolnum></citerefentry>.
609
537
<refsect1 id="see_also">
610
538
<title>SEE ALSO</title>
541
<refentrytitle>mandos.conf</refentrytitle>
542
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
613
543
<refentrytitle>mandos-clients.conf</refentrytitle>
614
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
<refentrytitle>mandos.conf</refentrytitle>
616
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
<refentrytitle>mandos-client</refentrytitle>
545
<refentrytitle>password-request</refentrytitle>
618
546
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
547
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
660
RFC 4291: <citetitle>IP Version 6 Addressing
661
Architecture</citetitle>
588
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
589
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
590
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
594
The clients use IPv6 link-local addresses, which are
595
immediately usable since a link-local addresses is
596
automatically assigned to a network interfaces when it is
692
RFC 4346: <citetitle>The Transport Layer Security (TLS)
693
Protocol Version 1.1</citetitle>
603
<citation>RFC 4346: <citetitle>The Transport Layer Security
604
(TLS) Protocol Version 1.1</citetitle></citation>