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 "2009-02-24">
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
36
<holder>Teddy Hogeborn</holder>
34
37
<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/"/>.
39
<xi:include href="legalnotice.xml"/>
62
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
44
<manvolnum>8</manvolnum>
67
48
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
50
Gives encrypted passwords to authenticated Mandos clients
75
56
<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>
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>
92
<command>&COMMANDNAME;</command>
94
<arg choice="plain"><option>--help</option></arg>
95
<arg choice="plain"><option>-h</option></arg>
99
<command>&COMMANDNAME;</command>
100
<arg choice="plain"><option>--version</option></arg>
103
<command>&COMMANDNAME;</command>
104
<arg choice="plain"><option>--check</option></arg>
106
106
</refsynopsisdiv>
108
108
<refsect1 id="description">
109
109
<title>DESCRIPTION</title>
119
119
Any authenticated client is then given the stored pre-encrypted
120
120
password for that specific client.
125
124
<refsect1 id="purpose">
126
125
<title>PURPOSE</title>
129
127
The purpose of this is to enable <emphasis>remote and unattended
130
128
rebooting</emphasis> of client host computer with an
131
129
<emphasis>encrypted root file system</emphasis>. See <xref
132
130
linkend="overview"/> for details.
137
134
<refsect1 id="options">
138
135
<title>OPTIONS</title>
142
<term><literal>-h</literal>, <literal>--help</literal></term>
138
<term><option>--help</option></term>
139
<term><option>-h</option></term>
145
142
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>
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>
195
181
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>
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>
252
216
Directory to search for configuration files. Default is
263
<term><literal>--version</literal></term>
227
<term><option>--version</option></term>
266
230
Prints the program version and exit.
236
<term><option>--no-ipv6</option></term>
238
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
273
244
<refsect1 id="overview">
274
245
<title>OVERVIEW</title>
246
<xi:include href="overview.xml"/>
277
248
This program is the server part. It is a normal server program
278
249
and will run in a normal system environment, not in an initial
279
RAM disk environment.
250
<acronym>RAM</acronym> disk environment.
283
254
<refsect1 id="protocol">
284
255
<title>NETWORK PROTOCOL</title>
347
318
longer eligible to receive the encrypted password. The timeout,
348
319
checker program, and interval between checks can be configured
349
320
both globally and per client; see <citerefentry>
350
<refentrytitle>mandos.conf</refentrytitle>
351
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
352
321
<refentrytitle>mandos-clients.conf</refentrytitle>
353
322
<manvolnum>5</manvolnum></citerefentry>.
357
326
<refsect1 id="logging">
358
327
<title>LOGGING</title>
360
The server will send log messaged with various severity levels
361
to <filename>/dev/log</filename>. With the
329
The server will send log message with various severity levels to
330
<filename>/dev/log</filename>. With the
362
331
<option>--debug</option> option, it will log even more messages,
363
332
and also show them on the console.
367
336
<refsect1 id="exit_status">
368
337
<title>EXIT STATUS</title>
371
340
critical error is encountered.
344
<refsect1 id="environment">
345
<title>ENVIRONMENT</title>
348
<term><envar>PATH</envar></term>
351
To start the configured checker (see <xref
352
linkend="checking"/>), the server uses
353
<filename>/bin/sh</filename>, which in turn uses
354
<varname>PATH</varname> to search for matching commands if
355
an absolute path is not given. See <citerefentry>
356
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
364
<refsect1 id="files">
376
365
<title>FILES</title>
378
367
Use the <option>--configdir</option> option to change where
411
<term><filename>/bin/sh</filename></term>
414
This is used to start the configured checker command for
415
each client. See <citerefentry>
416
<refentrytitle>mandos-clients.conf</refentrytitle>
417
<manvolnum>5</manvolnum></citerefentry> for details.
424
424
<refsect1 id="bugs">
425
425
<title>BUGS</title>
427
427
This server might, on especially fatal errors, emit a Python
428
428
backtrace. This could be considered a feature.
431
Currently, if a client is declared <quote>invalid</quote> due to
432
having timed out, the server does not record this fact onto
433
permanent storage. This has some security implications, see
434
<xref linkend="clients"/>.
437
There is currently no way of querying the server of the current
438
status of clients, other than analyzing its <systemitem
439
class="service">syslog</systemitem> output.
442
There is no fine-grained control over logging and debug output.
445
Debug mode is conflated with running in the foreground.
448
The console log messages do not show a time stamp.
451
This server does not check the expire time of clients’ OpenPGP
432
<refsect1 id="examples">
433
<title>EXAMPLES</title>
456
<refsect1 id="example">
457
<title>EXAMPLE</title>
434
458
<informalexample>
436
460
Normal invocation needs no options:
439
<userinput>mandos</userinput>
463
<userinput>&COMMANDNAME;</userinput>
441
465
</informalexample>
442
466
<informalexample>
463
487
<!-- do not wrap this line -->
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
488
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
467
491
</informalexample>
470
494
<refsect1 id="security">
471
495
<title>SECURITY</title>
496
<refsect2 id="server">
473
497
<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.
499
Running this <command>&COMMANDNAME;</command> server program
500
should not in itself present any security risk to the host
501
computer running it. The program switches to a non-root user
505
<refsect2 id="clients">
482
506
<title>CLIENTS</title>
484
508
The server only gives out its stored data to clients which
499
523
compromised if they are gone for too long.
526
If a client is compromised, its downtime should be duly noted
527
by the server which would therefore declare the client
528
invalid. But if the server was ever restarted, it would
529
re-read its client list from its configuration file and again
530
regard all clients therein as valid, and hence eligible to
531
receive their passwords. Therefore, be careful when
532
restarting servers if it is suspected that a client has, in
533
fact, been compromised by parties who may now be running a
534
fake Mandos client with the keys from the non-encrypted
535
initial <acronym>RAM</acronym> image of the client host. What
536
should be done in that case (if restarting the server program
537
really is necessary) is to stop the server program, edit the
538
configuration file to omit any suspect clients, and restart
502
542
For more details on client-side security, see
503
<citerefentry><refentrytitle>password-request</refentrytitle>
543
<citerefentry><refentrytitle>mandos-client</refentrytitle>
504
544
<manvolnum>8mandos</manvolnum></citerefentry>.
509
549
<refsect1 id="see_also">
510
550
<title>SEE ALSO</title>
553
<refentrytitle>mandos-clients.conf</refentrytitle>
554
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
<refentrytitle>mandos.conf</refentrytitle>
556
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
<refentrytitle>mandos-client</refentrytitle>
558
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
<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
565
<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>
600
RFC 4291: <citetitle>IP Version 6 Addressing
601
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
606
<term>Section 2.2: <citetitle>Text Representation of
607
Addresses</citetitle></term>
608
<listitem><para/></listitem>
611
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
612
Address</citetitle></term>
613
<listitem><para/></listitem>
616
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
617
Addresses</citetitle></term>
620
The clients use IPv6 link-local addresses, which are
621
immediately usable since a link-local addresses is
622
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>
632
RFC 4346: <citetitle>The Transport Layer Security (TLS)
633
Protocol Version 1.1</citetitle>