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">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
5
<!ENTITY TIMESTAMP "2011-02-27">
6
<!ENTITY % common SYSTEM "common.ent">
11
<title>&COMMANDNAME;</title>
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&COMMANDNAME;</productname>
14
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
17
19
<firstname>Björn</firstname>
33
38
<holder>Teddy Hogeborn</holder>
34
39
<holder>Björn Påhlsson</holder>
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/"/>.
41
<xi:include href="legalnotice.xml"/>
62
45
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
46
<manvolnum>8</manvolnum>
67
50
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
52
Gives encrypted passwords to authenticated Mandos clients
75
58
<command>&COMMANDNAME;</command>
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>
60
<arg choice="plain"><option>--interface
61
<replaceable>NAME</replaceable></option></arg>
62
<arg choice="plain"><option>-i
63
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>--address
68
<replaceable>ADDRESS</replaceable></option></arg>
69
<arg choice="plain"><option>-a
70
<replaceable>ADDRESS</replaceable></option></arg>
74
<arg choice="plain"><option>--port
75
<replaceable>PORT</replaceable></option></arg>
76
<arg choice="plain"><option>-p
77
<replaceable>PORT</replaceable></option></arg>
80
<arg><option>--priority
81
<replaceable>PRIORITY</replaceable></option></arg>
83
<arg><option>--servicename
84
<replaceable>NAME</replaceable></option></arg>
86
<arg><option>--configdir
87
<replaceable>DIRECTORY</replaceable></option></arg>
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
99
<command>&COMMANDNAME;</command>
101
<arg choice="plain"><option>--help</option></arg>
102
<arg choice="plain"><option>-h</option></arg>
106
<command>&COMMANDNAME;</command>
107
<arg choice="plain"><option>--version</option></arg>
110
<command>&COMMANDNAME;</command>
111
<arg choice="plain"><option>--check</option></arg>
106
113
</refsynopsisdiv>
108
115
<refsect1 id="description">
109
116
<title>DESCRIPTION</title>
119
126
Any authenticated client is then given the stored pre-encrypted
120
127
password for that specific client.
125
131
<refsect1 id="purpose">
126
132
<title>PURPOSE</title>
129
134
The purpose of this is to enable <emphasis>remote and unattended
130
135
rebooting</emphasis> of client host computer with an
131
136
<emphasis>encrypted root file system</emphasis>. See <xref
132
137
linkend="overview"/> for details.
137
141
<refsect1 id="options">
138
142
<title>OPTIONS</title>
142
<term><literal>-h</literal>, <literal>--help</literal></term>
145
<term><option>--help</option></term>
146
<term><option>-h</option></term>
145
149
Show a help message and exit
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>
155
<term><option>--interface</option>
156
<replaceable>NAME</replaceable></term>
157
<term><option>-i</option>
158
<replaceable>NAME</replaceable></term>
160
<xi:include href="mandos-options.xml" xpointer="interface"/>
165
<term><option>--address
166
<replaceable>ADDRESS</replaceable></option></term>
168
<replaceable>ADDRESS</replaceable></option></term>
170
<xi:include href="mandos-options.xml" xpointer="address"/>
176
<replaceable>PORT</replaceable></option></term>
178
<replaceable>PORT</replaceable></option></term>
180
<xi:include href="mandos-options.xml" xpointer="port"/>
185
<term><option>--check</option></term>
195
188
Run the server’s self-tests. This includes any unit
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>
195
<term><option>--debug</option></term>
197
<xi:include href="mandos-options.xml" xpointer="debug"/>
202
<term><option>--debuglevel
203
<replaceable>LEVEL</replaceable></option></term>
206
Set the debugging log level.
207
<replaceable>LEVEL</replaceable> is a string, one of
208
<quote><literal>CRITICAL</literal></quote>,
209
<quote><literal>ERROR</literal></quote>,
210
<quote><literal>WARNING</literal></quote>,
211
<quote><literal>INFO</literal></quote>, or
212
<quote><literal>DEBUG</literal></quote>, in order of
213
increasing verbosity. The default level is
214
<quote><literal>WARNING</literal></quote>.
220
<term><option>--priority <replaceable>
221
PRIORITY</replaceable></option></term>
223
<xi:include href="mandos-options.xml" xpointer="priority"/>
228
<term><option>--servicename
229
<replaceable>NAME</replaceable></option></term>
231
<xi:include href="mandos-options.xml"
232
xpointer="servicename"/>
237
<term><option>--configdir
238
<replaceable>DIRECTORY</replaceable></option></term>
252
241
Directory to search for configuration files. Default is
263
<term><literal>--version</literal></term>
252
<term><option>--version</option></term>
266
255
Prints the program version and exit.
261
<term><option>--no-dbus</option></term>
263
<xi:include href="mandos-options.xml" xpointer="dbus"/>
265
See also <xref linkend="dbus_interface"/>.
271
<term><option>--no-ipv6</option></term>
273
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
279
<refsect1 id="overview">
274
280
<title>OVERVIEW</title>
281
<xi:include href="overview.xml"/>
277
283
This program is the server part. It is a normal server program
278
284
and will run in a normal system environment, not in an initial
279
RAM disk environment.
285
<acronym>RAM</acronym> disk environment.
283
289
<refsect1 id="protocol">
284
290
<title>NETWORK PROTOCOL</title>
338
344
</tbody></tgroup></table>
341
347
<refsect1 id="checking">
342
348
<title>CHECKING</title>
344
350
The server will, by default, continually check that the clients
345
351
are still up. If a client has not been confirmed as being up
346
352
for some time, the client is assumed to be compromised and is no
347
longer eligible to receive the encrypted password. The timeout,
353
longer eligible to receive the encrypted password. (Manual
354
intervention is required to re-enable a client.) The timeout,
348
355
checker program, and interval between checks can be configured
349
356
both globally and per client; see <citerefentry>
350
<refentrytitle>mandos.conf</refentrytitle>
351
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
352
<refentrytitle>mandos-clients.conf</refentrytitle>
353
<manvolnum>5</manvolnum></citerefentry>.
357
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>. A client successfully
359
receiving its password will also be treated as a successful
364
<refsect1 id="approval">
365
<title>APPROVAL</title>
367
The server can be configured to require manual approval for a
368
client before it is sent its secret. The delay to wait for such
369
approval and the default action (approve or deny) can be
370
configured both globally and per client; see <citerefentry>
371
<refentrytitle>mandos-clients.conf</refentrytitle>
372
<manvolnum>5</manvolnum></citerefentry>. By default all clients
373
will be approved immediately without delay.
376
This can be used to deny a client its secret if not manually
377
approved within a specified time. It can also be used to make
378
the server delay before giving a client its secret, allowing
379
optional manual denying of this specific client.
357
384
<refsect1 id="logging">
358
385
<title>LOGGING</title>
360
The server will send log messaged with various severity levels
361
to <filename>/dev/log</filename>. With the
387
The server will send log message with various severity levels to
388
<filename>/dev/log</filename>. With the
362
389
<option>--debug</option> option, it will log even more messages,
363
390
and also show them on the console.
394
<refsect1 id="dbus_interface">
395
<title>D-BUS INTERFACE</title>
397
The server will by default provide a D-Bus system bus interface.
398
This interface will only be accessible by the root user or a
399
Mandos-specific user, if such a user exists. For documentation
400
of the D-Bus API, see the file <filename>DBUS-API</filename>.
367
404
<refsect1 id="exit_status">
368
405
<title>EXIT STATUS</title>
371
408
critical error is encountered.
412
<refsect1 id="environment">
413
<title>ENVIRONMENT</title>
416
<term><envar>PATH</envar></term>
419
To start the configured checker (see <xref
420
linkend="checking"/>), the server uses
421
<filename>/bin/sh</filename>, which in turn uses
422
<varname>PATH</varname> to search for matching commands if
423
an absolute path is not given. See <citerefentry>
424
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
432
<refsect1 id="files">
376
433
<title>FILES</title>
378
435
Use the <option>--configdir</option> option to change where
479
<term><filename>/bin/sh</filename></term>
482
This is used to start the configured checker command for
483
each client. See <citerefentry>
484
<refentrytitle>mandos-clients.conf</refentrytitle>
485
<manvolnum>5</manvolnum></citerefentry> for details.
424
492
<refsect1 id="bugs">
425
493
<title>BUGS</title>
427
495
This server might, on especially fatal errors, emit a Python
428
496
backtrace. This could be considered a feature.
499
Currently, if a client is disabled due to having timed out, the
500
server does not record this fact onto permanent storage. This
501
has some security implications, see <xref linkend="clients"/>.
504
There is no fine-grained control over logging and debug output.
507
Debug mode is conflated with running in the foreground.
510
The console log messages do not show a time stamp.
513
This server does not check the expire time of clients’ OpenPGP
432
<refsect1 id="examples">
433
<title>EXAMPLES</title>
518
<refsect1 id="example">
519
<title>EXAMPLE</title>
434
520
<informalexample>
436
522
Normal invocation needs no options:
439
<userinput>mandos</userinput>
525
<userinput>&COMMANDNAME;</userinput>
441
527
</informalexample>
442
528
<informalexample>
463
549
<!-- do not wrap this line -->
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
550
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
467
553
</informalexample>
470
556
<refsect1 id="security">
471
557
<title>SECURITY</title>
558
<refsect2 id="server">
473
559
<title>SERVER</title>
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.
561
Running this <command>&COMMANDNAME;</command> server program
562
should not in itself present any security risk to the host
563
computer running it. The program switches to a non-root user
567
<refsect2 id="clients">
482
568
<title>CLIENTS</title>
484
570
The server only gives out its stored data to clients which
499
585
compromised if they are gone for too long.
588
If a client is compromised, its downtime should be duly noted
589
by the server which would therefore disable the client. But
590
if the server was ever restarted, it would re-read its client
591
list from its configuration file and again regard all clients
592
therein as enabled, and hence eligible to receive their
593
passwords. Therefore, be careful when restarting servers if
594
it is suspected that a client has, in fact, been compromised
595
by parties who may now be running a fake Mandos client with
596
the keys from the non-encrypted initial <acronym>RAM</acronym>
597
image of the client host. What should be done in that case
598
(if restarting the server program really is necessary) is to
599
stop the server program, edit the configuration file to omit
600
any suspect clients, and restart the server program.
502
603
For more details on client-side security, see
503
<citerefentry><refentrytitle>password-request</refentrytitle>
604
<citerefentry><refentrytitle>mandos-client</refentrytitle>
504
605
<manvolnum>8mandos</manvolnum></citerefentry>.
509
610
<refsect1 id="see_also">
510
611
<title>SEE ALSO</title>
614
<refentrytitle>mandos-clients.conf</refentrytitle>
615
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
<refentrytitle>mandos.conf</refentrytitle>
617
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
<refentrytitle>mandos-client</refentrytitle>
619
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
<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.
530
626
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
565
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
Unicast Addresses</citation>
661
RFC 4291: <citetitle>IP Version 6 Addressing
662
Architecture</citetitle>
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
667
<term>Section 2.2: <citetitle>Text Representation of
668
Addresses</citetitle></term>
669
<listitem><para/></listitem>
672
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
673
Address</citetitle></term>
674
<listitem><para/></listitem>
677
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
678
Addresses</citetitle></term>
681
The clients use IPv6 link-local addresses, which are
682
immediately usable since a link-local addresses is
683
automatically assigned to a network interfaces when it
580
<citation>RFC 4346: <citetitle>The Transport Layer Security
581
(TLS) Protocol Version 1.1</citetitle></citation>
693
RFC 4346: <citetitle>The Transport Layer Security (TLS)
694
Protocol Version 1.1</citetitle>