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-12-28">
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>
88
<arg><option>--no-dbus</option></arg>
95
91
<command>&COMMANDNAME;</command>
96
92
<group choice="req">
97
<arg choice="plain">-h</arg>
98
<arg choice="plain">--help</arg>
93
<arg choice="plain"><option>--help</option></arg>
94
<arg choice="plain"><option>-h</option></arg>
102
98
<command>&COMMANDNAME;</command>
103
<arg choice="plain">--version</arg>
99
<arg choice="plain"><option>--version</option></arg>
106
102
<command>&COMMANDNAME;</command>
107
<arg choice="plain">--check</arg>
103
<arg choice="plain"><option>--check</option></arg>
109
105
</refsynopsisdiv>
111
107
<refsect1 id="description">
112
108
<title>DESCRIPTION</title>
122
118
Any authenticated client is then given the stored pre-encrypted
123
119
password for that specific client.
128
123
<refsect1 id="purpose">
129
124
<title>PURPOSE</title>
132
126
The purpose of this is to enable <emphasis>remote and unattended
133
127
rebooting</emphasis> of client host computer with an
134
128
<emphasis>encrypted root file system</emphasis>. See <xref
135
129
linkend="overview"/> for details.
140
133
<refsect1 id="options">
141
134
<title>OPTIONS</title>
145
<term><literal>-h</literal>, <literal>--help</literal></term>
137
<term><option>--help</option></term>
138
<term><option>-h</option></term>
148
141
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>
147
<term><option>--interface</option>
148
<replaceable>NAME</replaceable></term>
149
<term><option>-i</option>
150
<replaceable>NAME</replaceable></term>
152
<xi:include href="mandos-options.xml" xpointer="interface"/>
157
<term><option>--address
158
<replaceable>ADDRESS</replaceable></option></term>
160
<replaceable>ADDRESS</replaceable></option></term>
162
<xi:include href="mandos-options.xml" xpointer="address"/>
168
<replaceable>PORT</replaceable></option></term>
170
<replaceable>PORT</replaceable></option></term>
172
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><option>--check</option></term>
200
180
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>. 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>
187
<term><option>--debug</option></term>
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><option>--priority <replaceable>
195
PRIORITY</replaceable></option></term>
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><option>--servicename
203
<replaceable>NAME</replaceable></option></term>
205
<xi:include href="mandos-options.xml"
206
xpointer="servicename"/>
211
<term><option>--configdir
212
<replaceable>DIRECTORY</replaceable></option></term>
258
215
Directory to search for configuration files. Default is
269
<term><literal>--version</literal></term>
226
<term><option>--version</option></term>
272
229
Prints the program version and exit.
235
<term><option>--no-dbus</option></term>
237
<xi:include href="mandos-options.xml" xpointer="dbus"/>
239
See also <xref linkend="dbus"/>.
279
245
<refsect1 id="overview">
280
246
<title>OVERVIEW</title>
247
<xi:include href="overview.xml"/>
283
249
This program is the server part. It is a normal server program
284
250
and will run in a normal system environment, not in an initial
285
RAM disk environment.
251
<acronym>RAM</acronym> disk environment.
289
255
<refsect1 id="protocol">
290
256
<title>NETWORK PROTOCOL</title>
353
319
longer eligible to receive the encrypted password. The timeout,
354
320
checker program, and interval between checks can be configured
355
321
both globally and per client; see <citerefentry>
356
<refentrytitle>mandos.conf</refentrytitle>
357
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
358
322
<refentrytitle>mandos-clients.conf</refentrytitle>
359
323
<manvolnum>5</manvolnum></citerefentry>.
363
327
<refsect1 id="logging">
364
328
<title>LOGGING</title>
366
The server will send log messaged with various severity levels
367
to <filename>/dev/log</filename>. With the
330
The server will send log message with various severity levels to
331
<filename>/dev/log</filename>. With the
368
332
<option>--debug</option> option, it will log even more messages,
369
333
and also show them on the console.
338
<title>D-BUS INTERFACE</title>
340
The server will by default provide a D-Bus system bus interface.
341
This interface will only be accessible by the root user or a
342
Mandos-specific user, if such a user exists.
373
347
<refsect1 id="exit_status">
374
348
<title>EXIT STATUS</title>
468
442
Currently, if a client is declared <quote>invalid</quote> due to
469
443
having timed out, the server does not record this fact onto
470
444
permanent storage. This has some security implications, see
471
<xref linkend="CLIENTS"/>.
445
<xref linkend="clients"/>.
474
448
There is currently no way of querying the server of the current
520
498
<!-- do not wrap this line -->
521
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
499
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
524
502
</informalexample>
527
505
<refsect1 id="security">
528
506
<title>SECURITY</title>
529
<refsect2 id="SERVER">
507
<refsect2 id="server">
530
508
<title>SERVER</title>
532
510
Running this <command>&COMMANDNAME;</command> server program
533
511
should not in itself present any security risk to the host
534
computer running it. The program does not need any special
535
privileges to run, and is designed to run as a non-root user.
512
computer running it. The program switches to a non-root user
538
<refsect2 id="CLIENTS">
516
<refsect2 id="clients">
539
517
<title>CLIENTS</title>
541
519
The server only gives out its stored data to clients which
565
543
restarting servers if it is suspected that a client has, in
566
544
fact, been compromised by parties who may now be running a
567
545
fake Mandos client with the keys from the non-encrypted
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
546
initial <acronym>RAM</acronym> image of the client host. What
547
should be done in that case (if restarting the server program
548
really is necessary) is to stop the server program, edit the
571
549
configuration file to omit any suspect clients, and restart
572
550
the server program.
575
553
For more details on client-side security, see
576
<citerefentry><refentrytitle>password-request</refentrytitle>
554
<citerefentry><refentrytitle>mandos-client</refentrytitle>
577
555
<manvolnum>8mandos</manvolnum></citerefentry>.
582
560
<refsect1 id="see_also">
583
561
<title>SEE ALSO</title>
564
<refentrytitle>mandos-clients.conf</refentrytitle>
565
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>mandos.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos-client</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
<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.
603
576
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
638
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
639
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
640
Unicast Addresses</citation>
611
RFC 4291: <citetitle>IP Version 6 Addressing
612
Architecture</citetitle>
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
617
<term>Section 2.2: <citetitle>Text Representation of
618
Addresses</citetitle></term>
619
<listitem><para/></listitem>
622
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
Address</citetitle></term>
624
<listitem><para/></listitem>
627
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
Addresses</citetitle></term>
631
The clients use IPv6 link-local addresses, which are
632
immediately usable since a link-local addresses is
633
automatically assigned to a network interfaces when it
653
<citation>RFC 4346: <citetitle>The Transport Layer Security
654
(TLS) Protocol Version 1.1</citetitle></citation>
643
RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
Protocol Version 1.1</citetitle>