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-01-04">
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-dbus</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>. This only needs
241
to be changed this if it, for some reason, is necessary to
242
run more than one server on the same
243
<emphasis>host</emphasis>, which would not normally be
244
useful. If there are name collisions on the same
245
<emphasis>network</emphasis>, the newer server will
246
automatically rename itself to <quote><literal>Mandos
247
#2</literal></quote>, and so on; therefore, this option is
248
not needed in that case.
254
<term><literal>--configdir <replaceable>DIR</replaceable>
216
258
Directory to search for configuration files. Default is
227
<term><option>--version</option></term>
269
<term><literal>--version</literal></term>
230
272
Prints the program version and exit.
236
<term><option>--no-dbus</option></term>
238
<xi:include href="mandos-options.xml" xpointer="dbus"/>
240
See also <xref linkend="dbus_interface"/>.
247
279
<refsect1 id="overview">
248
280
<title>OVERVIEW</title>
249
<xi:include href="overview.xml"/>
251
283
This program is the server part. It is a normal server program
252
284
and will run in a normal system environment, not in an initial
253
<acronym>RAM</acronym> disk environment.
285
RAM disk environment.
257
289
<refsect1 id="protocol">
258
290
<title>NETWORK PROTOCOL</title>
321
353
longer eligible to receive the encrypted password. The timeout,
322
354
checker program, and interval between checks can be configured
323
355
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
324
358
<refentrytitle>mandos-clients.conf</refentrytitle>
325
359
<manvolnum>5</manvolnum></citerefentry>.
329
363
<refsect1 id="logging">
330
364
<title>LOGGING</title>
332
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
366
The server will send log messaged with various severity levels
367
to <filename>/dev/log</filename>. With the
334
368
<option>--debug</option> option, it will log even more messages,
335
369
and also show them on the console.
339
<refsect1 id="dbus_interface">
340
<title>D-BUS INTERFACE</title>
342
The server will by default provide a D-Bus system bus interface.
343
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
349
373
<refsect1 id="exit_status">
350
374
<title>EXIT STATUS</title>
444
468
Currently, if a client is declared <quote>invalid</quote> due to
445
469
having timed out, the server does not record this fact onto
446
470
permanent storage. This has some security implications, see
447
<xref linkend="clients"/>.
471
<xref linkend="CLIENTS"/>.
450
474
There is currently no way of querying the server of the current
500
520
<!-- do not wrap this line -->
501
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
521
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
504
524
</informalexample>
507
527
<refsect1 id="security">
508
528
<title>SECURITY</title>
509
<refsect2 id="server">
529
<refsect2 id="SERVER">
510
530
<title>SERVER</title>
512
532
Running this <command>&COMMANDNAME;</command> server program
513
533
should not in itself present any security risk to the host
514
computer running it. The program switches to a non-root user
534
computer running it. The program does not need any special
535
privileges to run, and is designed to run as a non-root user.
518
<refsect2 id="clients">
538
<refsect2 id="CLIENTS">
519
539
<title>CLIENTS</title>
521
541
The server only gives out its stored data to clients which
545
565
restarting servers if it is suspected that a client has, in
546
566
fact, been compromised by parties who may now be running a
547
567
fake Mandos client with the keys from the non-encrypted
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
568
initial RAM image of the client host. What should be done in
569
that case (if restarting the server program really is
570
necessary) is to stop the server program, edit the
551
571
configuration file to omit any suspect clients, and restart
552
572
the server program.
555
575
For more details on client-side security, see
556
<citerefentry><refentrytitle>mandos-client</refentrytitle>
576
<citerefentry><refentrytitle>password-request</refentrytitle>
557
577
<manvolnum>8mandos</manvolnum></citerefentry>.
562
582
<refsect1 id="see_also">
563
583
<title>SEE ALSO</title>
566
<refentrytitle>mandos-clients.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos.conf</refentrytitle>
569
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
588
<refentrytitle>password-request</refentrytitle>
589
<manvolnum>8mandos</manvolnum>
594
This is the actual program which talks to this server.
595
Note that it is normally not invoked directly, and is only
596
run in the initial RAM disk environment, and not on a
597
fully started system.
578
603
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
613
RFC 4291: <citetitle>IP Version 6 Addressing
614
Architecture</citetitle>
638
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
Unicast Addresses</citation>
619
<term>Section 2.2: <citetitle>Text Representation of
620
Addresses</citetitle></term>
621
<listitem><para/></listitem>
624
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
625
Address</citetitle></term>
626
<listitem><para/></listitem>
629
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
630
Addresses</citetitle></term>
633
The clients use IPv6 link-local addresses, which are
634
immediately usable since a link-local addresses is
635
automatically assigned to a network interfaces when it
644
The clients use IPv6 link-local addresses, which are
645
immediately usable since a link-local addresses is
646
automatically assigned to a network interfaces when it is
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>
653
<citation>RFC 4346: <citetitle>The Transport Layer Security
654
(TLS) Protocol Version 1.1</citetitle></citation>