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>
35
33
<holder>Teddy Hogeborn</holder>
36
34
<holder>Björn Påhlsson</holder>
38
<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/"/>.
42
62
<refentrytitle>&COMMANDNAME;</refentrytitle>
43
63
<manvolnum>8</manvolnum>
47
67
<refname><command>&COMMANDNAME;</command></refname>
49
Gives encrypted passwords to authenticated Mandos clients
69
Sends encrypted passwords to authenticated Mandos clients
55
75
<command>&COMMANDNAME;</command>
57
<arg choice="plain"><option>--interface
58
<replaceable>NAME</replaceable></option></arg>
59
<arg choice="plain"><option>-i
60
<replaceable>NAME</replaceable></option></arg>
64
<arg choice="plain"><option>--address
65
<replaceable>ADDRESS</replaceable></option></arg>
66
<arg choice="plain"><option>-a
67
<replaceable>ADDRESS</replaceable></option></arg>
71
<arg choice="plain"><option>--port
72
<replaceable>PORT</replaceable></option></arg>
73
<arg choice="plain"><option>-p
74
<replaceable>PORT</replaceable></option></arg>
77
<arg><option>--priority
78
<replaceable>PRIORITY</replaceable></option></arg>
80
<arg><option>--servicename
81
<replaceable>NAME</replaceable></option></arg>
83
<arg><option>--configdir
84
<replaceable>DIRECTORY</replaceable></option></arg>
86
<arg><option>--debug</option></arg>
88
<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>
91
95
<command>&COMMANDNAME;</command>
92
96
<group choice="req">
93
<arg choice="plain"><option>--help</option></arg>
94
<arg choice="plain"><option>-h</option></arg>
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
98
102
<command>&COMMANDNAME;</command>
99
<arg choice="plain"><option>--version</option></arg>
103
<arg choice="plain">--version</arg>
102
106
<command>&COMMANDNAME;</command>
103
<arg choice="plain"><option>--check</option></arg>
107
<arg choice="plain">--check</arg>
105
109
</refsynopsisdiv>
107
111
<refsect1 id="description">
108
112
<title>DESCRIPTION</title>
118
122
Any authenticated client is then given the stored pre-encrypted
119
123
password for that specific client.
123
128
<refsect1 id="purpose">
124
129
<title>PURPOSE</title>
126
132
The purpose of this is to enable <emphasis>remote and unattended
127
133
rebooting</emphasis> of client host computer with an
128
134
<emphasis>encrypted root file system</emphasis>. See <xref
129
135
linkend="overview"/> for details.
133
140
<refsect1 id="options">
134
141
<title>OPTIONS</title>
137
<term><option>--help</option></term>
138
<term><option>-h</option></term>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
141
148
Show a help message and exit
147
<term><option>--interface</option>
148
<replaceable>NAME</replaceable></term>
149
<term><option>-i</option>
150
<replaceable>NAME</replaceable></term>
152
<xi:include href="mandos-options.xml" xpointer="interface"/>
157
<term><option>--address
158
<replaceable>ADDRESS</replaceable></option></term>
160
<replaceable>ADDRESS</replaceable></option></term>
162
<xi:include href="mandos-options.xml" xpointer="address"/>
168
<replaceable>PORT</replaceable></option></term>
170
<replaceable>PORT</replaceable></option></term>
172
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<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>
180
200
Run the server’s self-tests. This includes any unit
187
<term><option>--debug</option></term>
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><option>--priority <replaceable>
195
PRIORITY</replaceable></option></term>
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><option>--servicename
203
<replaceable>NAME</replaceable></option></term>
205
<xi:include href="mandos-options.xml"
206
xpointer="servicename"/>
211
<term><option>--configdir
212
<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>
215
258
Directory to search for configuration files. Default is
226
<term><option>--version</option></term>
269
<term><literal>--version</literal></term>
229
272
Prints the program version and exit.
235
<term><option>--no-dbus</option></term>
237
<xi:include href="mandos-options.xml" xpointer="dbus"/>
239
See also <xref linkend="dbus_interface"/>.
246
279
<refsect1 id="overview">
247
280
<title>OVERVIEW</title>
248
<xi:include href="overview.xml"/>
250
283
This program is the server part. It is a normal server program
251
284
and will run in a normal system environment, not in an initial
252
<acronym>RAM</acronym> disk environment.
285
RAM disk environment.
256
289
<refsect1 id="protocol">
257
290
<title>NETWORK PROTOCOL</title>
320
353
longer eligible to receive the encrypted password. The timeout,
321
354
checker program, and interval between checks can be configured
322
355
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
323
358
<refentrytitle>mandos-clients.conf</refentrytitle>
324
359
<manvolnum>5</manvolnum></citerefentry>.
328
363
<refsect1 id="logging">
329
364
<title>LOGGING</title>
331
The server will send log message with various severity levels to
332
<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
333
368
<option>--debug</option> option, it will log even more messages,
334
369
and also show them on the console.
338
<refsect1 id="dbus_interface">
339
<title>D-BUS INTERFACE</title>
341
The server will by default provide a D-Bus system bus interface.
342
This interface will only be accessible by the root user or a
343
Mandos-specific user, if such a user exists.
348
373
<refsect1 id="exit_status">
349
374
<title>EXIT STATUS</title>
443
468
Currently, if a client is declared <quote>invalid</quote> due to
444
469
having timed out, the server does not record this fact onto
445
470
permanent storage. This has some security implications, see
446
<xref linkend="clients"/>.
471
<xref linkend="CLIENTS"/>.
449
474
There is currently no way of querying the server of the current
499
520
<!-- do not wrap this line -->
500
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
521
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
503
524
</informalexample>
506
527
<refsect1 id="security">
507
528
<title>SECURITY</title>
508
<refsect2 id="server">
529
<refsect2 id="SERVER">
509
530
<title>SERVER</title>
511
532
Running this <command>&COMMANDNAME;</command> server program
512
533
should not in itself present any security risk to the host
513
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.
517
<refsect2 id="clients">
538
<refsect2 id="CLIENTS">
518
539
<title>CLIENTS</title>
520
541
The server only gives out its stored data to clients which
544
565
restarting servers if it is suspected that a client has, in
545
566
fact, been compromised by parties who may now be running a
546
567
fake Mandos client with the keys from the non-encrypted
547
initial <acronym>RAM</acronym> image of the client host. What
548
should be done in that case (if restarting the server program
549
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
550
571
configuration file to omit any suspect clients, and restart
551
572
the server program.
554
575
For more details on client-side security, see
555
<citerefentry><refentrytitle>mandos-client</refentrytitle>
576
<citerefentry><refentrytitle>password-request</refentrytitle>
556
577
<manvolnum>8mandos</manvolnum></citerefentry>.
561
582
<refsect1 id="see_also">
562
583
<title>SEE ALSO</title>
565
<refentrytitle>mandos-clients.conf</refentrytitle>
566
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
567
<refentrytitle>mandos.conf</refentrytitle>
568
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
569
<refentrytitle>mandos-client</refentrytitle>
570
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
571
<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.
577
603
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
612
RFC 4291: <citetitle>IP Version 6 Addressing
613
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>
618
<term>Section 2.2: <citetitle>Text Representation of
619
Addresses</citetitle></term>
620
<listitem><para/></listitem>
623
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
624
Address</citetitle></term>
625
<listitem><para/></listitem>
628
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
629
Addresses</citetitle></term>
632
The clients use IPv6 link-local addresses, which are
633
immediately usable since a link-local addresses is
634
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
644
RFC 4346: <citetitle>The Transport Layer Security (TLS)
645
Protocol Version 1.1</citetitle>
653
<citation>RFC 4346: <citetitle>The Transport Layer Security
654
(TLS) Protocol Version 1.1</citetitle></citation>