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 "2008-09-30">
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>
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>
89
95
<command>&COMMANDNAME;</command>
90
96
<group choice="req">
91
<arg choice="plain"><option>--help</option></arg>
92
<arg choice="plain"><option>-h</option></arg>
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
96
102
<command>&COMMANDNAME;</command>
97
<arg choice="plain"><option>--version</option></arg>
103
<arg choice="plain">--version</arg>
100
106
<command>&COMMANDNAME;</command>
101
<arg choice="plain"><option>--check</option></arg>
107
<arg choice="plain">--check</arg>
103
109
</refsynopsisdiv>
105
111
<refsect1 id="description">
106
112
<title>DESCRIPTION</title>
116
122
Any authenticated client is then given the stored pre-encrypted
117
123
password for that specific client.
121
128
<refsect1 id="purpose">
122
129
<title>PURPOSE</title>
124
132
The purpose of this is to enable <emphasis>remote and unattended
125
133
rebooting</emphasis> of client host computer with an
126
134
<emphasis>encrypted root file system</emphasis>. See <xref
127
135
linkend="overview"/> for details.
131
140
<refsect1 id="options">
132
141
<title>OPTIONS</title>
135
<term><option>--help</option></term>
136
<term><option>-h</option></term>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
139
148
Show a help message and exit
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>
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>
178
200
Run the server’s self-tests. This includes any unit
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>
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>
213
258
Directory to search for configuration files. Default is
308
353
longer eligible to receive the encrypted password. The timeout,
309
354
checker program, and interval between checks can be configured
310
355
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
311
358
<refentrytitle>mandos-clients.conf</refentrytitle>
312
359
<manvolnum>5</manvolnum></citerefentry>.
316
363
<refsect1 id="logging">
317
364
<title>LOGGING</title>
319
The server will send log message with various severity levels to
320
<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
321
368
<option>--debug</option> option, it will log even more messages,
322
369
and also show them on the console.
326
373
<refsect1 id="exit_status">
327
374
<title>EXIT STATUS</title>
522
565
restarting servers if it is suspected that a client has, in
523
566
fact, been compromised by parties who may now be running a
524
567
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
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
528
571
configuration file to omit any suspect clients, and restart
529
572
the server program.
532
575
For more details on client-side security, see
533
<citerefentry><refentrytitle>mandos-client</refentrytitle>
576
<citerefentry><refentrytitle>password-request</refentrytitle>
534
577
<manvolnum>8mandos</manvolnum></citerefentry>.
539
582
<refsect1 id="see_also">
540
583
<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>
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.
555
603
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
590
RFC 4291: <citetitle>IP Version 6 Addressing
591
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>
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
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
622
RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
Protocol Version 1.1</citetitle>
653
<citation>RFC 4346: <citetitle>The Transport Layer Security
654
(TLS) Protocol Version 1.1</citetitle></citation>