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">
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>
37
33
<holder>Teddy Hogeborn</holder>
38
34
<holder>Björn Påhlsson</holder>
40
<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/"/>.
44
62
<refentrytitle>&COMMANDNAME;</refentrytitle>
45
63
<manvolnum>8</manvolnum>
49
67
<refname><command>&COMMANDNAME;</command></refname>
51
Gives encrypted passwords to authenticated Mandos clients
69
Sends encrypted passwords to authenticated Mandos clients
57
75
<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>--no-dbus</option></arg>
92
<arg><option>--no-ipv6</option></arg>
95
<command>&COMMANDNAME;</command>
97
<arg choice="plain"><option>--help</option></arg>
98
<arg choice="plain"><option>-h</option></arg>
102
<command>&COMMANDNAME;</command>
103
<arg choice="plain"><option>--version</option></arg>
106
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--check</option></arg>
76
<arg choice="opt">--interface<arg choice="plain">IF</arg></arg>
77
<arg choice="opt">--address<arg choice="plain">ADDRESS</arg></arg>
78
<arg choice="opt">--port<arg choice="plain">PORT</arg></arg>
79
<arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
80
<arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
81
<arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
<arg choice="opt">--debug</arg>
85
<command>&COMMANDNAME;</command>
86
<arg choice="opt">-i<arg choice="plain">IF</arg></arg>
87
<arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
88
<arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
89
<arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
90
<arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
91
<arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
<arg choice="opt">--debug</arg>
95
<command>&COMMANDNAME;</command>
96
<arg choice="plain">--help</arg>
99
<command>&COMMANDNAME;</command>
100
<arg choice="plain">--version</arg>
103
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--check</arg>
109
106
</refsynopsisdiv>
111
108
<refsect1 id="description">
112
109
<title>DESCRIPTION</title>
122
119
Any authenticated client is then given the stored pre-encrypted
123
120
password for that specific client.
127
125
<refsect1 id="purpose">
128
126
<title>PURPOSE</title>
130
129
The purpose of this is to enable <emphasis>remote and unattended
131
130
rebooting</emphasis> of client host computer with an
132
131
<emphasis>encrypted root file system</emphasis>. See <xref
133
132
linkend="overview"/> for details.
137
137
<refsect1 id="options">
138
138
<title>OPTIONS</title>
141
<term><option>--help</option></term>
142
<term><option>-h</option></term>
142
<term><literal>-h</literal>, <literal>--help</literal></term>
145
145
Show a help message and exit
151
<term><option>--interface</option>
152
<replaceable>NAME</replaceable></term>
153
<term><option>-i</option>
154
<replaceable>NAME</replaceable></term>
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><option>--address
162
<replaceable>ADDRESS</replaceable></option></term>
164
<replaceable>ADDRESS</replaceable></option></term>
166
<xi:include href="mandos-options.xml" xpointer="address"/>
172
<replaceable>PORT</replaceable></option></term>
174
<replaceable>PORT</replaceable></option></term>
176
<xi:include href="mandos-options.xml" xpointer="port"/>
181
<term><option>--check</option></term>
151
<term><literal>-i</literal>, <literal>--interface <replaceable>
152
IF</replaceable></literal></term>
155
Only announce the server and listen to requests on network
156
interface <replaceable>IF</replaceable>. Default is to
157
use all available interfaces.
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
167
If this option is used, the server will only listen to a
168
specific address. This must currently be an IPv6 address;
169
an IPv4 address can be specified using the
170
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
171
Also, if a link-local address is specified, an interface
172
should be set, since a link-local address is only valid on
173
a single interface. By default, the server will listen to
174
all available addresses.
180
<term><literal>-p</literal>, <literal>--port <replaceable>
181
PORT</replaceable></literal></term>
184
If this option is used, the server to bind to that
185
port. By default, the server will listen to an arbitrary
186
port given by the operating system.
192
<term><literal>--check</literal></term>
184
195
Run the server’s self-tests. This includes any unit
191
<term><option>--debug</option></term>
193
<xi:include href="mandos-options.xml" xpointer="debug"/>
198
<term><option>--priority <replaceable>
199
PRIORITY</replaceable></option></term>
201
<xi:include href="mandos-options.xml" xpointer="priority"/>
206
<term><option>--servicename
207
<replaceable>NAME</replaceable></option></term>
209
<xi:include href="mandos-options.xml"
210
xpointer="servicename"/>
215
<term><option>--configdir
216
<replaceable>DIRECTORY</replaceable></option></term>
202
<term><literal>--debug</literal></term>
205
If the server is run in debug mode, it will run in the
206
foreground and print a lot of debugging information. The
207
default is <emphasis>not</emphasis> to run in debug mode.
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
217
GnuTLS priority string for the TLS handshake with the
218
clients. The default is
219
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
220
See <citerefentry><refentrytitle>gnutls_priority_init
221
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
222
for the syntax. <emphasis>Warning</emphasis>: changing
223
this may make the TLS handshake fail, making communication
224
with clients impossible.
230
<term><literal>--servicename <replaceable>NAME</replaceable>
234
Zeroconf service name. The default is
235
<quote><literal>Mandos</literal></quote>. You only need
236
to change this if you for some reason want to run more
237
than one server on the same <emphasis>host</emphasis>,
238
which would not normally be useful. If there are name
239
collisions on the same <emphasis>network</emphasis>, the
240
newer server will automatically rename itself to
241
<quote><literal>Mandos #2</literal></quote>, and so on;
242
therefore, this option is not needed in that case.
248
<term><literal>--configdir <replaceable>DIR</replaceable>
219
252
Directory to search for configuration files. Default is
230
<term><option>--version</option></term>
263
<term><literal>--version</literal></term>
233
266
Prints the program version and exit.
239
<term><option>--no-dbus</option></term>
241
<xi:include href="mandos-options.xml" xpointer="dbus"/>
243
See also <xref linkend="dbus_interface"/>.
249
<term><option>--no-ipv6</option></term>
251
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
257
273
<refsect1 id="overview">
258
274
<title>OVERVIEW</title>
259
<xi:include href="overview.xml"/>
261
277
This program is the server part. It is a normal server program
262
278
and will run in a normal system environment, not in an initial
263
<acronym>RAM</acronym> disk environment.
279
RAM disk environment.
267
283
<refsect1 id="protocol">
268
284
<title>NETWORK PROTOCOL</title>
322
338
</tbody></tgroup></table>
325
341
<refsect1 id="checking">
326
342
<title>CHECKING</title>
328
344
The server will, by default, continually check that the clients
329
345
are still up. If a client has not been confirmed as being up
330
346
for some time, the client is assumed to be compromised and is no
331
longer eligible to receive the encrypted password. (Manual
332
intervention is required to re-enable a client.) The timeout,
347
longer eligible to receive the encrypted password. The timeout,
333
348
checker program, and interval between checks can be configured
334
349
both globally and per client; see <citerefentry>
335
<refentrytitle>mandos-clients.conf</refentrytitle>
336
<manvolnum>5</manvolnum></citerefentry>. A client successfully
337
receiving its password will also be treated as a successful
342
<refsect1 id="approval">
343
<title>APPROVAL</title>
345
The server can be configured to require manual approval for a
346
client before it is sent its secret. The delay to wait for such
347
approval and the default action (approve or deny) can be
348
configured both globally and per client; see <citerefentry>
349
<refentrytitle>mandos-clients.conf</refentrytitle>
350
<manvolnum>5</manvolnum></citerefentry>. By default all clients
351
will be approved immediately without delay.
354
This can be used to deny a client its secret if not manually
355
approved within a specified time. It can also be used to make
356
the server delay before giving a client its secret, allowing
357
optional manual denying of this specific client.
350
<refentrytitle>mandos.conf</refentrytitle>
351
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
352
<refentrytitle>mandos-clients.conf</refentrytitle>
353
<manvolnum>5</manvolnum></citerefentry>.
362
357
<refsect1 id="logging">
363
358
<title>LOGGING</title>
365
The server will send log message with various severity levels to
366
<filename>/dev/log</filename>. With the
360
The server will send log messaged with various severity levels
361
to <filename>/dev/log</filename>. With the
367
362
<option>--debug</option> option, it will log even more messages,
368
363
and also show them on the console.
372
<refsect1 id="dbus_interface">
373
<title>D-BUS INTERFACE</title>
375
The server will by default provide a D-Bus system bus interface.
376
This interface will only be accessible by the root user or a
377
Mandos-specific user, if such a user exists. For documentation
378
of the D-Bus API, see the file <filename>DBUS-API</filename>.
382
367
<refsect1 id="exit_status">
383
368
<title>EXIT STATUS</title>
386
371
critical error is encountered.
390
<refsect1 id="environment">
391
<title>ENVIRONMENT</title>
394
<term><envar>PATH</envar></term>
397
To start the configured checker (see <xref
398
linkend="checking"/>), the server uses
399
<filename>/bin/sh</filename>, which in turn uses
400
<varname>PATH</varname> to search for matching commands if
401
an absolute path is not given. See <citerefentry>
402
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
410
<refsect1 id="files">
411
376
<title>FILES</title>
413
378
Use the <option>--configdir</option> option to change where
457
<term><filename>/bin/sh</filename></term>
460
This is used to start the configured checker command for
461
each client. See <citerefentry>
462
<refentrytitle>mandos-clients.conf</refentrytitle>
463
<manvolnum>5</manvolnum></citerefentry> for details.
470
424
<refsect1 id="bugs">
471
425
<title>BUGS</title>
473
427
This server might, on especially fatal errors, emit a Python
474
428
backtrace. This could be considered a feature.
477
Currently, if a client is disabled due to having timed out, the
478
server does not record this fact onto permanent storage. This
479
has some security implications, see <xref linkend="clients"/>.
482
There is no fine-grained control over logging and debug output.
485
Debug mode is conflated with running in the foreground.
488
The console log messages do not show a time stamp.
491
This server does not check the expire time of clients’ OpenPGP
496
<refsect1 id="example">
497
<title>EXAMPLE</title>
432
<refsect1 id="examples">
433
<title>EXAMPLES</title>
498
434
<informalexample>
500
436
Normal invocation needs no options:
503
<userinput>&COMMANDNAME;</userinput>
439
<userinput>mandos</userinput>
505
441
</informalexample>
506
442
<informalexample>
527
463
<!-- do not wrap this line -->
528
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
531
467
</informalexample>
534
470
<refsect1 id="security">
535
471
<title>SECURITY</title>
536
<refsect2 id="server">
537
473
<title>SERVER</title>
539
Running this <command>&COMMANDNAME;</command> server program
540
should not in itself present any security risk to the host
541
computer running it. The program switches to a non-root user
475
Running this &COMMANDNAME; server program should not in itself
476
present any security risk to the host computer running it.
477
The program does not need any special privileges to run, and
478
is designed to run as a non-root user.
545
<refsect2 id="clients">
546
482
<title>CLIENTS</title>
548
484
The server only gives out its stored data to clients which
563
499
compromised if they are gone for too long.
566
If a client is compromised, its downtime should be duly noted
567
by the server which would therefore disable the client. But
568
if the server was ever restarted, it would re-read its client
569
list from its configuration file and again regard all clients
570
therein as enabled, and hence eligible to receive their
571
passwords. Therefore, be careful when restarting servers if
572
it is suspected that a client has, in fact, been compromised
573
by parties who may now be running a fake Mandos client with
574
the keys from the non-encrypted initial <acronym>RAM</acronym>
575
image of the client host. What should be done in that case
576
(if restarting the server program really is necessary) is to
577
stop the server program, edit the configuration file to omit
578
any suspect clients, and restart the server program.
581
502
For more details on client-side security, see
582
<citerefentry><refentrytitle>mandos-client</refentrytitle>
503
<citerefentry><refentrytitle>password-request</refentrytitle>
583
504
<manvolnum>8mandos</manvolnum></citerefentry>.
588
509
<refsect1 id="see_also">
589
510
<title>SEE ALSO</title>
592
<refentrytitle>mandos-clients.conf</refentrytitle>
593
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
594
<refentrytitle>mandos.conf</refentrytitle>
595
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
596
<refentrytitle>mandos-client</refentrytitle>
597
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
598
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
515
<refentrytitle>password-request</refentrytitle>
516
<manvolnum>8mandos</manvolnum>
521
This is the actual program which talks to this server.
522
Note that it is normally not invoked directly, and is only
523
run in the initial RAM disk environment, and not on a
524
fully started system.
604
530
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
639
RFC 4291: <citetitle>IP Version 6 Addressing
640
Architecture</citetitle>
565
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
Unicast Addresses</citation>
645
<term>Section 2.2: <citetitle>Text Representation of
646
Addresses</citetitle></term>
647
<listitem><para/></listitem>
650
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
651
Address</citetitle></term>
652
<listitem><para/></listitem>
655
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
656
Addresses</citetitle></term>
659
The clients use IPv6 link-local addresses, which are
660
immediately usable since a link-local addresses is
661
automatically assigned to a network interfaces when it
571
The clients use IPv6 link-local addresses, which are
572
immediately usable since a link-local addresses is
573
automatically assigned to a network interfaces when it is
671
RFC 4346: <citetitle>The Transport Layer Security (TLS)
672
Protocol Version 1.1</citetitle>
580
<citation>RFC 4346: <citetitle>The Transport Layer Security
581
(TLS) Protocol Version 1.1</citetitle></citation>