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">
5
<!ENTITY TIMESTAMP "2009-01-04">
6
<!ENTITY % common SYSTEM "common.ent">
8
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<title>&COMMANDNAME;</title>
12
<title>Mandos Manual</title>
11
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
16
19
<firstname>Björn</firstname>
32
36
<holder>Teddy Hogeborn</holder>
33
37
<holder>Björn Påhlsson</holder>
37
This manual page is free software: you can redistribute it
38
and/or modify it under the terms of the GNU General Public
39
License as published by the Free Software Foundation,
40
either version 3 of the License, or (at your option) any
45
This manual page is distributed in the hope that it will
46
be useful, but WITHOUT ANY WARRANTY; without even the
47
implied warranty of MERCHANTABILITY or FITNESS FOR A
48
PARTICULAR PURPOSE. See the GNU General Public License
53
You should have received a copy of the GNU General Public
54
License along with this program; If not, see
55
<ulink url="http://www.gnu.org/licenses/"/>.
39
<xi:include href="legalnotice.xml"/>
61
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
44
<manvolnum>8</manvolnum>
66
48
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
50
Gives encrypted passwords to authenticated Mandos clients
74
56
<command>&COMMANDNAME;</command>
75
<arg>--interface<arg choice="plain">IF</arg></arg>
76
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
<arg>--port<arg choice="plain">PORT</arg></arg>
78
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
<arg>--servicename<arg choice="plain">NAME</arg></arg>
80
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
84
<command>&COMMANDNAME;</command>
85
<arg>-i<arg choice="plain">IF</arg></arg>
86
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
<arg>-p<arg choice="plain">PORT</arg></arg>
88
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
<arg>--servicename<arg choice="plain">NAME</arg></arg>
90
<arg>--configdir<arg choice="plain">DIRECTORY</arg></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-dbus</option></arg>
94
92
<command>&COMMANDNAME;</command>
95
93
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
94
<arg choice="plain"><option>--help</option></arg>
95
<arg choice="plain"><option>-h</option></arg>
101
99
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
100
<arg choice="plain"><option>--version</option></arg>
105
103
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
104
<arg choice="plain"><option>--check</option></arg>
108
106
</refsynopsisdiv>
110
108
<refsect1 id="description">
111
109
<title>DESCRIPTION</title>
121
119
Any authenticated client is then given the stored pre-encrypted
122
120
password for that specific client.
127
124
<refsect1 id="purpose">
128
125
<title>PURPOSE</title>
131
127
The purpose of this is to enable <emphasis>remote and unattended
132
128
rebooting</emphasis> of client host computer with an
133
129
<emphasis>encrypted root file system</emphasis>. See <xref
134
130
linkend="overview"/> for details.
139
134
<refsect1 id="options">
140
135
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
138
<term><option>--help</option></term>
139
<term><option>-h</option></term>
147
142
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
148
<term><option>--interface</option>
149
<replaceable>NAME</replaceable></term>
150
<term><option>-i</option>
151
<replaceable>NAME</replaceable></term>
156
153
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
158
<term><option>--address
159
<replaceable>ADDRESS</replaceable></option></term>
161
<replaceable>ADDRESS</replaceable></option></term>
164
163
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
169
<replaceable>PORT</replaceable></option></term>
171
<replaceable>PORT</replaceable></option></term>
172
173
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
178
<term><option>--check</option></term>
180
181
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
188
<term><option>--debug</option></term>
189
190
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
195
<term><option>--priority <replaceable>
196
PRIORITY</replaceable></option></term>
197
198
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
203
<term><option>--servicename
204
<replaceable>NAME</replaceable></option></term>
205
206
<xi:include href="mandos-options.xml"
206
207
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
212
<term><option>--configdir
213
<replaceable>DIRECTORY</replaceable></option></term>
215
216
Directory to search for configuration files. Default is
226
<term><literal>--version</literal></term>
227
<term><option>--version</option></term>
229
230
Prints the program version and exit.
236
<term><option>--no-dbus</option></term>
238
<xi:include href="mandos-options.xml" xpointer="dbus"/>
240
See also <xref linkend="dbus_interface"/>.
236
247
<refsect1 id="overview">
237
248
<title>OVERVIEW</title>
238
249
<xi:include href="overview.xml"/>
240
251
This program is the server part. It is a normal server program
241
252
and will run in a normal system environment, not in an initial
242
RAM disk environment.
253
<acronym>RAM</acronym> disk environment.
246
257
<refsect1 id="protocol">
247
258
<title>NETWORK PROTOCOL</title>
310
321
longer eligible to receive the encrypted password. The timeout,
311
322
checker program, and interval between checks can be configured
312
323
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
324
<refentrytitle>mandos-clients.conf</refentrytitle>
316
325
<manvolnum>5</manvolnum></citerefentry>.
320
329
<refsect1 id="logging">
321
330
<title>LOGGING</title>
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
332
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
325
334
<option>--debug</option> option, it will log even more messages,
326
335
and also show them on the console.
339
<refsect1 id="dbus_interface">
340
<title>D-BUS INTERFACE</title>
342
The server will by default provide a D-Bus system bus interface.
343
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
330
349
<refsect1 id="exit_status">
331
350
<title>EXIT STATUS</title>
425
444
Currently, if a client is declared <quote>invalid</quote> due to
426
445
having timed out, the server does not record this fact onto
427
446
permanent storage. This has some security implications, see
428
<xref linkend="CLIENTS"/>.
447
<xref linkend="clients"/>.
431
450
There is currently no way of querying the server of the current
477
500
<!-- do not wrap this line -->
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
501
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
481
504
</informalexample>
484
507
<refsect1 id="security">
485
508
<title>SECURITY</title>
486
<refsect2 id="SERVER">
509
<refsect2 id="server">
487
510
<title>SERVER</title>
489
512
Running this <command>&COMMANDNAME;</command> server program
490
513
should not in itself present any security risk to the host
491
computer running it. The program does not need any special
492
privileges to run, and is designed to run as a non-root user.
514
computer running it. The program switches to a non-root user
495
<refsect2 id="CLIENTS">
518
<refsect2 id="clients">
496
519
<title>CLIENTS</title>
498
521
The server only gives out its stored data to clients which
505
528
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
529
<manvolnum>5</manvolnum></citerefentry>)
507
530
<emphasis>must</emphasis> be made non-readable by anyone
508
except the user running the server.
531
except the user starting the server (usually root).
511
534
As detailed in <xref linkend="checking"/>, the status of all
522
545
restarting servers if it is suspected that a client has, in
523
546
fact, been compromised by parties who may now be running a
524
547
fake Mandos client with the keys from the non-encrypted
525
initial RAM image of the client host. What should be done in
526
that case (if restarting the server program really is
527
necessary) is to stop the server program, edit the
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
528
551
configuration file to omit any suspect clients, and restart
529
552
the server program.
532
555
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
556
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
557
<manvolnum>8mandos</manvolnum></citerefentry>.
539
562
<refsect1 id="see_also">
540
563
<title>SEE ALSO</title>
566
<refentrytitle>mandos-clients.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos.conf</refentrytitle>
569
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
545
<refentrytitle>password-request</refentrytitle>
546
<manvolnum>8mandos</manvolnum>
551
This is the actual program which talks to this server.
552
Note that it is normally not invoked directly, and is only
553
run in the initial RAM disk environment, and not on a
554
fully started system.
560
578
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
595
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
Unicast Addresses</citation>
613
RFC 4291: <citetitle>IP Version 6 Addressing
614
Architecture</citetitle>
601
The clients use IPv6 link-local addresses, which are
602
immediately usable since a link-local addresses is
603
automatically assigned to a network interfaces when it is
619
<term>Section 2.2: <citetitle>Text Representation of
620
Addresses</citetitle></term>
621
<listitem><para/></listitem>
624
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
625
Address</citetitle></term>
626
<listitem><para/></listitem>
629
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
630
Addresses</citetitle></term>
633
The clients use IPv6 link-local addresses, which are
634
immediately usable since a link-local addresses is
635
automatically assigned to a network interfaces when it
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>