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 "2009-09-17">
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>
36
33
<holder>Teddy Hogeborn</holder>
37
34
<holder>Björn Påhlsson</holder>
39
<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/"/>.
43
62
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
63
<manvolnum>8</manvolnum>
48
67
<refname><command>&COMMANDNAME;</command></refname>
50
Gives encrypted passwords to authenticated Mandos clients
69
Sends encrypted passwords to authenticated Mandos clients
56
75
<command>&COMMANDNAME;</command>
58
<arg choice="plain"><option>--interface
59
<replaceable>NAME</replaceable></option></arg>
60
<arg choice="plain"><option>-i
61
<replaceable>NAME</replaceable></option></arg>
65
<arg choice="plain"><option>--address
66
<replaceable>ADDRESS</replaceable></option></arg>
67
<arg choice="plain"><option>-a
68
<replaceable>ADDRESS</replaceable></option></arg>
72
<arg choice="plain"><option>--port
73
<replaceable>PORT</replaceable></option></arg>
74
<arg choice="plain"><option>-p
75
<replaceable>PORT</replaceable></option></arg>
78
<arg><option>--priority
79
<replaceable>PRIORITY</replaceable></option></arg>
81
<arg><option>--servicename
82
<replaceable>NAME</replaceable></option></arg>
84
<arg><option>--configdir
85
<replaceable>DIRECTORY</replaceable></option></arg>
87
<arg><option>--debug</option></arg>
89
<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>
92
95
<command>&COMMANDNAME;</command>
93
96
<group choice="req">
94
<arg choice="plain"><option>--help</option></arg>
95
<arg choice="plain"><option>-h</option></arg>
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
99
102
<command>&COMMANDNAME;</command>
100
<arg choice="plain"><option>--version</option></arg>
103
<arg choice="plain">--version</arg>
103
106
<command>&COMMANDNAME;</command>
104
<arg choice="plain"><option>--check</option></arg>
107
<arg choice="plain">--check</arg>
106
109
</refsynopsisdiv>
108
111
<refsect1 id="description">
109
112
<title>DESCRIPTION</title>
119
122
Any authenticated client is then given the stored pre-encrypted
120
123
password for that specific client.
124
128
<refsect1 id="purpose">
125
129
<title>PURPOSE</title>
127
132
The purpose of this is to enable <emphasis>remote and unattended
128
133
rebooting</emphasis> of client host computer with an
129
134
<emphasis>encrypted root file system</emphasis>. See <xref
130
135
linkend="overview"/> for details.
134
140
<refsect1 id="options">
135
141
<title>OPTIONS</title>
138
<term><option>--help</option></term>
139
<term><option>-h</option></term>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
142
148
Show a help message and exit
148
<term><option>--interface</option>
149
<replaceable>NAME</replaceable></term>
150
<term><option>-i</option>
151
<replaceable>NAME</replaceable></term>
153
<xi:include href="mandos-options.xml" xpointer="interface"/>
158
<term><option>--address
159
<replaceable>ADDRESS</replaceable></option></term>
161
<replaceable>ADDRESS</replaceable></option></term>
163
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<replaceable>PORT</replaceable></option></term>
171
<replaceable>PORT</replaceable></option></term>
173
<xi:include href="mandos-options.xml" xpointer="port"/>
178
<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>
181
200
Run the server’s self-tests. This includes any unit
188
<term><option>--debug</option></term>
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
195
<term><option>--priority <replaceable>
196
PRIORITY</replaceable></option></term>
198
<xi:include href="mandos-options.xml" xpointer="priority"/>
203
<term><option>--servicename
204
<replaceable>NAME</replaceable></option></term>
206
<xi:include href="mandos-options.xml"
207
xpointer="servicename"/>
212
<term><option>--configdir
213
<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>
216
257
Directory to search for configuration files. Default is
227
<term><option>--version</option></term>
268
<term><literal>--version</literal></term>
230
271
Prints the program version and exit.
236
<term><option>--no-ipv6</option></term>
238
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
244
278
<refsect1 id="overview">
245
279
<title>OVERVIEW</title>
246
<xi:include href="overview.xml"/>
248
282
This program is the server part. It is a normal server program
249
283
and will run in a normal system environment, not in an initial
250
<acronym>RAM</acronym> disk environment.
284
RAM disk environment.
254
288
<refsect1 id="protocol">
255
289
<title>NETWORK PROTOCOL</title>
309
343
</tbody></tgroup></table>
312
346
<refsect1 id="checking">
313
347
<title>CHECKING</title>
315
349
The server will, by default, continually check that the clients
316
350
are still up. If a client has not been confirmed as being up
317
351
for some time, the client is assumed to be compromised and is no
318
longer eligible to receive the encrypted password. (Manual
319
intervention is required to re-enable a client.) The timeout,
352
longer eligible to receive the encrypted password. The timeout,
320
353
checker program, and interval between checks can be configured
321
354
both globally and per client; see <citerefentry>
355
<refentrytitle>mandos.conf</refentrytitle>
356
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
322
357
<refentrytitle>mandos-clients.conf</refentrytitle>
323
<manvolnum>5</manvolnum></citerefentry>. A client successfully
324
receiving its password will also be treated as a successful
358
<manvolnum>5</manvolnum></citerefentry>.
329
362
<refsect1 id="logging">
330
363
<title>LOGGING</title>
332
The server will send log message with various severity levels to
333
<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
334
367
<option>--debug</option> option, it will log even more messages,
335
368
and also show them on the console.
339
372
<refsect1 id="exit_status">
340
373
<title>EXIT STATUS</title>
434
467
Currently, if a client is declared <quote>invalid</quote> due to
435
468
having timed out, the server does not record this fact onto
436
469
permanent storage. This has some security implications, see
437
<xref linkend="clients"/>.
470
<xref linkend="CLIENTS"/>.
440
473
There is currently no way of querying the server of the current
490
519
<!-- do not wrap this line -->
491
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
494
523
</informalexample>
497
526
<refsect1 id="security">
498
527
<title>SECURITY</title>
499
<refsect2 id="server">
528
<refsect2 id="SERVER">
500
529
<title>SERVER</title>
502
531
Running this <command>&COMMANDNAME;</command> server program
503
532
should not in itself present any security risk to the host
504
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.
508
<refsect2 id="clients">
537
<refsect2 id="CLIENTS">
509
538
<title>CLIENTS</title>
511
540
The server only gives out its stored data to clients which
532
561
re-read its client list from its configuration file and again
533
562
regard all clients therein as valid, and hence eligible to
534
563
receive their passwords. Therefore, be careful when
535
restarting servers if it is suspected that a client has, in
536
fact, been compromised by parties who may now be running a
537
fake Mandos client with the keys from the non-encrypted
538
initial <acronym>RAM</acronym> image of the client host. What
539
should be done in that case (if restarting the server program
540
really is necessary) is to stop the server program, edit the
541
configuration file to omit any suspect clients, and restart
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
567
image of the client host. What should be done in that case
568
(if restarting the server program really is necessary) is to
569
stop the server program, edit the configuration file to omit
570
any suspect clients, and restart the server program.
545
573
For more details on client-side security, see
546
<citerefentry><refentrytitle>mandos-client</refentrytitle>
574
<citerefentry><refentrytitle>password-request</refentrytitle>
547
575
<manvolnum>8mandos</manvolnum></citerefentry>.
552
580
<refsect1 id="see_also">
553
581
<title>SEE ALSO</title>
556
<refentrytitle>mandos-clients.conf</refentrytitle>
557
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
558
<refentrytitle>mandos.conf</refentrytitle>
559
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
560
<refentrytitle>mandos-client</refentrytitle>
561
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
562
<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.
568
601
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
603
RFC 4291: <citetitle>IP Version 6 Addressing
604
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>
609
<term>Section 2.2: <citetitle>Text Representation of
610
Addresses</citetitle></term>
611
<listitem><para/></listitem>
614
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
615
Address</citetitle></term>
616
<listitem><para/></listitem>
619
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
620
Addresses</citetitle></term>
623
The clients use IPv6 link-local addresses, which are
624
immediately usable since a link-local addresses is
625
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
635
RFC 4346: <citetitle>The Transport Layer Security (TLS)
636
Protocol Version 1.1</citetitle>
651
<citation>RFC 4346: <citetitle>The Transport Layer Security
652
(TLS) Protocol Version 1.1</citetitle></citation>