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 "2008-10-03">
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
35
<holder>Teddy Hogeborn</holder>
34
36
<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/"/>.
38
<xi:include href="legalnotice.xml"/>
62
42
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
43
<manvolnum>8</manvolnum>
67
47
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
49
Gives encrypted passwords to authenticated Mandos clients
75
55
<command>&COMMANDNAME;</command>
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>
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>
95
89
<command>&COMMANDNAME;</command>
96
90
<group choice="req">
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
91
<arg choice="plain"><option>--help</option></arg>
92
<arg choice="plain"><option>-h</option></arg>
102
96
<command>&COMMANDNAME;</command>
103
<arg choice="plain">--version</arg>
97
<arg choice="plain"><option>--version</option></arg>
106
100
<command>&COMMANDNAME;</command>
107
<arg choice="plain">--check</arg>
101
<arg choice="plain"><option>--check</option></arg>
109
103
</refsynopsisdiv>
111
105
<refsect1 id="description">
112
106
<title>DESCRIPTION</title>
122
116
Any authenticated client is then given the stored pre-encrypted
123
117
password for that specific client.
128
121
<refsect1 id="purpose">
129
122
<title>PURPOSE</title>
132
124
The purpose of this is to enable <emphasis>remote and unattended
133
125
rebooting</emphasis> of client host computer with an
134
126
<emphasis>encrypted root file system</emphasis>. See <xref
135
127
linkend="overview"/> for details.
140
131
<refsect1 id="options">
141
132
<title>OPTIONS</title>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
135
<term><option>--help</option></term>
136
<term><option>-h</option></term>
148
139
Show a help message and exit
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>
145
<term><option>--interface</option>
146
<replaceable>NAME</replaceable></term>
147
<term><option>-i</option>
148
<replaceable>NAME</replaceable></term>
150
<xi:include href="mandos-options.xml" xpointer="interface"/>
155
<term><option>--address
156
<replaceable>ADDRESS</replaceable></option></term>
158
<replaceable>ADDRESS</replaceable></option></term>
160
<xi:include href="mandos-options.xml" xpointer="address"/>
166
<replaceable>PORT</replaceable></option></term>
168
<replaceable>PORT</replaceable></option></term>
170
<xi:include href="mandos-options.xml" xpointer="port"/>
175
<term><option>--check</option></term>
200
178
Run the server’s self-tests. This includes any unit
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>. You only need
241
to change this if you for some reason want to run more
242
than one server on the same <emphasis>host</emphasis>,
243
which would not normally be useful. If there are name
244
collisions on the same <emphasis>network</emphasis>, the
245
newer server will automatically rename itself to
246
<quote><literal>Mandos #2</literal></quote>, and so on;
247
therefore, this option is not needed in that case.
253
<term><literal>--configdir <replaceable>DIR</replaceable>
185
<term><option>--debug</option></term>
187
<xi:include href="mandos-options.xml" xpointer="debug"/>
192
<term><option>--priority <replaceable>
193
PRIORITY</replaceable></option></term>
195
<xi:include href="mandos-options.xml" xpointer="priority"/>
200
<term><option>--servicename
201
<replaceable>NAME</replaceable></option></term>
203
<xi:include href="mandos-options.xml"
204
xpointer="servicename"/>
209
<term><option>--configdir
210
<replaceable>DIRECTORY</replaceable></option></term>
257
213
Directory to search for configuration files. Default is
352
308
longer eligible to receive the encrypted password. The timeout,
353
309
checker program, and interval between checks can be configured
354
310
both globally and per client; see <citerefentry>
355
<refentrytitle>mandos.conf</refentrytitle>
356
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
357
311
<refentrytitle>mandos-clients.conf</refentrytitle>
358
312
<manvolnum>5</manvolnum></citerefentry>.
362
316
<refsect1 id="logging">
363
317
<title>LOGGING</title>
365
The server will send log messaged with various severity levels
366
to <filename>/dev/log</filename>. With the
319
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
367
321
<option>--debug</option> option, it will log even more messages,
368
322
and also show them on the console.
372
326
<refsect1 id="exit_status">
373
327
<title>EXIT STATUS</title>
467
421
Currently, if a client is declared <quote>invalid</quote> due to
468
422
having timed out, the server does not record this fact onto
469
423
permanent storage. This has some security implications, see
470
<xref linkend="CLIENTS"/>.
424
<xref linkend="clients"/>.
473
427
There is currently no way of querying the server of the current
519
477
<!-- do not wrap this line -->
520
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
523
481
</informalexample>
526
484
<refsect1 id="security">
527
485
<title>SECURITY</title>
528
<refsect2 id="SERVER">
486
<refsect2 id="server">
529
487
<title>SERVER</title>
531
489
Running this <command>&COMMANDNAME;</command> server program
532
490
should not in itself present any security risk to the host
533
computer running it. The program does not need any special
534
privileges to run, and is designed to run as a non-root user.
491
computer running it. The program switches to a non-root user
537
<refsect2 id="CLIENTS">
495
<refsect2 id="clients">
538
496
<title>CLIENTS</title>
540
498
The server only gives out its stored data to clients which
561
519
re-read its client list from its configuration file and again
562
520
regard all clients therein as valid, and hence eligible to
563
521
receive their passwords. Therefore, be careful when
564
restarting servers if you suspect that a client has, in fact,
565
been compromised by parties who may now be running a fake
566
Mandos client with the keys from the non-encrypted initial RAM
567
image of the client host. What should be done in that case
568
(if restarting the server program really is necessary) is to
569
stop the server program, edit the configuration file to omit
570
any suspect clients, and restart the server program.
522
restarting servers if it is suspected that a client has, in
523
fact, been compromised by parties who may now be running a
524
fake Mandos client with the keys from the non-encrypted
525
initial <acronym>RAM</acronym> image of the client host. What
526
should be done in that case (if restarting the server program
527
really is necessary) is to stop the server program, edit the
528
configuration file to omit any suspect clients, and restart
573
532
For more details on client-side security, see
574
<citerefentry><refentrytitle>password-request</refentrytitle>
533
<citerefentry><refentrytitle>mandos-client</refentrytitle>
575
534
<manvolnum>8mandos</manvolnum></citerefentry>.
580
539
<refsect1 id="see_also">
581
540
<title>SEE ALSO</title>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>mandos-client</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
586
<refentrytitle>password-request</refentrytitle>
587
<manvolnum>8mandos</manvolnum>
592
This is the actual program which talks to this server.
593
Note that it is normally not invoked directly, and is only
594
run in the initial RAM disk environment, and not on a
595
fully started system.
601
555
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
636
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
Unicast Addresses</citation>
590
RFC 4291: <citetitle>IP Version 6 Addressing
591
Architecture</citetitle>
642
The clients use IPv6 link-local addresses, which are
643
immediately usable since a link-local addresses is
644
automatically assigned to a network interfaces when it is
596
<term>Section 2.2: <citetitle>Text Representation of
597
Addresses</citetitle></term>
598
<listitem><para/></listitem>
601
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
602
Address</citetitle></term>
603
<listitem><para/></listitem>
606
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
607
Addresses</citetitle></term>
610
The clients use IPv6 link-local addresses, which are
611
immediately usable since a link-local addresses is
612
automatically assigned to a network interfaces when it
651
<citation>RFC 4346: <citetitle>The Transport Layer Security
652
(TLS) Protocol Version 1.1</citetitle></citation>
622
RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
Protocol Version 1.1</citetitle>