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 "2009-02-13">
6
<!ENTITY % common SYSTEM "common.ent">
10
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
10
<title>&COMMANDNAME;</title>
13
11
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
12
<productname>&COMMANDNAME;</productname>
13
<productnumber>&VERSION;</productnumber>
19
16
<firstname>Björn</firstname>
36
32
<holder>Teddy Hogeborn</holder>
37
33
<holder>Björn Påhlsson</holder>
39
<xi:include href="legalnotice.xml"/>
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/"/>.
43
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
62
<manvolnum>8</manvolnum>
48
66
<refname><command>&COMMANDNAME;</command></refname>
50
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
56
74
<command>&COMMANDNAME;</command>
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>
91
<arg><option>--no-ipv6</option></arg>
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>
94
94
<command>&COMMANDNAME;</command>
95
95
<group choice="req">
96
<arg choice="plain"><option>--help</option></arg>
97
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
101
101
<command>&COMMANDNAME;</command>
102
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
105
105
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
108
108
</refsynopsisdiv>
110
110
<refsect1 id="description">
111
111
<title>DESCRIPTION</title>
121
121
Any authenticated client is then given the stored pre-encrypted
122
122
password for that specific client.
126
127
<refsect1 id="purpose">
127
128
<title>PURPOSE</title>
129
131
The purpose of this is to enable <emphasis>remote and unattended
130
132
rebooting</emphasis> of client host computer with an
131
133
<emphasis>encrypted root file system</emphasis>. See <xref
132
134
linkend="overview"/> for details.
136
139
<refsect1 id="options">
137
140
<title>OPTIONS</title>
140
<term><option>--help</option></term>
141
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
144
147
Show a help message and exit
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
152
<term><option>-i</option>
153
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
155
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
165
164
<xi:include href="mandos-options.xml" xpointer="address"/>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
175
172
<xi:include href="mandos-options.xml" xpointer="port"/>
180
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
183
180
Run the server’s self-tests. This includes any unit
190
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
192
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
200
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
208
205
<xi:include href="mandos-options.xml"
209
206
xpointer="servicename"/>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
218
215
Directory to search for configuration files. Default is
229
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
232
229
Prints the program version and exit.
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
256
236
<refsect1 id="overview">
257
237
<title>OVERVIEW</title>
258
238
<xi:include href="overview.xml"/>
260
240
This program is the server part. It is a normal server program
261
241
and will run in a normal system environment, not in an initial
262
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
266
246
<refsect1 id="protocol">
267
247
<title>NETWORK PROTOCOL</title>
330
310
longer eligible to receive the encrypted password. The timeout,
331
311
checker program, and interval between checks can be configured
332
312
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
333
315
<refentrytitle>mandos-clients.conf</refentrytitle>
334
316
<manvolnum>5</manvolnum></citerefentry>.
338
320
<refsect1 id="logging">
339
321
<title>LOGGING</title>
341
The server will send log message with various severity levels to
342
<filename>/dev/log</filename>. With the
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
343
325
<option>--debug</option> option, it will log even more messages,
344
326
and also show them on the console.
348
<refsect1 id="dbus_interface">
349
<title>D-BUS INTERFACE</title>
351
The server will by default provide a D-Bus system bus interface.
352
This interface will only be accessible by the root user or a
353
Mandos-specific user, if such a user exists.
358
330
<refsect1 id="exit_status">
359
331
<title>EXIT STATUS</title>
453
425
Currently, if a client is declared <quote>invalid</quote> due to
454
426
having timed out, the server does not record this fact onto
455
427
permanent storage. This has some security implications, see
456
<xref linkend="clients"/>.
428
<xref linkend="CLIENTS"/>.
459
431
There is currently no way of querying the server of the current
509
477
<!-- do not wrap this line -->
510
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
513
481
</informalexample>
516
484
<refsect1 id="security">
517
485
<title>SECURITY</title>
518
<refsect2 id="server">
486
<refsect2 id="SERVER">
519
487
<title>SERVER</title>
521
489
Running this <command>&COMMANDNAME;</command> server program
522
490
should not in itself present any security risk to the host
523
computer running it. The program switches to a non-root user
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.
527
<refsect2 id="clients">
495
<refsect2 id="CLIENTS">
528
496
<title>CLIENTS</title>
530
498
The server only gives out its stored data to clients which
537
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
538
506
<manvolnum>5</manvolnum></citerefentry>)
539
507
<emphasis>must</emphasis> be made non-readable by anyone
540
except the user starting the server (usually root).
508
except the user running the server.
543
511
As detailed in <xref linkend="checking"/>, the status of all
554
522
restarting servers if it is suspected that a client has, in
555
523
fact, been compromised by parties who may now be running a
556
524
fake Mandos client with the keys from the non-encrypted
557
initial <acronym>RAM</acronym> image of the client host. What
558
should be done in that case (if restarting the server program
559
really is necessary) is to stop the server program, edit the
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
560
528
configuration file to omit any suspect clients, and restart
561
529
the server program.
564
532
For more details on client-side security, see
565
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
566
534
<manvolnum>8mandos</manvolnum></citerefentry>.
571
539
<refsect1 id="see_also">
572
540
<title>SEE ALSO</title>
575
<refentrytitle>mandos-clients.conf</refentrytitle>
576
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
<refentrytitle>mandos.conf</refentrytitle>
578
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
<refentrytitle>mandos-client</refentrytitle>
580
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
<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.
587
560
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
622
RFC 4291: <citetitle>IP Version 6 Addressing
623
Architecture</citetitle>
595
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
596
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
597
Unicast Addresses</citation>
628
<term>Section 2.2: <citetitle>Text Representation of
629
Addresses</citetitle></term>
630
<listitem><para/></listitem>
633
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
634
Address</citetitle></term>
635
<listitem><para/></listitem>
638
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
639
Addresses</citetitle></term>
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
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
654
RFC 4346: <citetitle>The Transport Layer Security (TLS)
655
Protocol Version 1.1</citetitle>
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>