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-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>
92
94
<command>&COMMANDNAME;</command>
93
95
<group choice="req">
94
<arg choice="plain"><option>--help</option></arg>
95
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
99
101
<command>&COMMANDNAME;</command>
100
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
103
105
<command>&COMMANDNAME;</command>
104
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
106
108
</refsynopsisdiv>
108
110
<refsect1 id="description">
109
111
<title>DESCRIPTION</title>
119
121
Any authenticated client is then given the stored pre-encrypted
120
122
password for that specific client.
124
127
<refsect1 id="purpose">
125
128
<title>PURPOSE</title>
127
131
The purpose of this is to enable <emphasis>remote and unattended
128
132
rebooting</emphasis> of client host computer with an
129
133
<emphasis>encrypted root file system</emphasis>. See <xref
130
134
linkend="overview"/> for details.
134
139
<refsect1 id="options">
135
140
<title>OPTIONS</title>
138
<term><option>--help</option></term>
139
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
142
147
Show a help message and exit
148
<term><option>--interface</option>
149
<replaceable>NAME</replaceable></term>
150
<term><option>-i</option>
151
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
153
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
158
<term><option>--address
159
<replaceable>ADDRESS</replaceable></option></term>
161
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
163
164
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<replaceable>PORT</replaceable></option></term>
171
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
173
172
<xi:include href="mandos-options.xml" xpointer="port"/>
178
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
181
180
Run the server’s self-tests. This includes any unit
188
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
190
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
195
<term><option>--priority <replaceable>
196
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
198
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
203
<term><option>--servicename
204
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
206
205
<xi:include href="mandos-options.xml"
207
206
xpointer="servicename"/>
212
<term><option>--configdir
213
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
216
215
Directory to search for configuration files. Default is
227
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
230
229
Prints the program version and exit.
236
<term><option>--no-ipv6</option></term>
238
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
244
236
<refsect1 id="overview">
245
237
<title>OVERVIEW</title>
246
238
<xi:include href="overview.xml"/>
248
240
This program is the server part. It is a normal server program
249
241
and will run in a normal system environment, not in an initial
250
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
254
246
<refsect1 id="protocol">
255
247
<title>NETWORK PROTOCOL</title>
318
310
longer eligible to receive the encrypted password. The timeout,
319
311
checker program, and interval between checks can be configured
320
312
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
321
315
<refentrytitle>mandos-clients.conf</refentrytitle>
322
316
<manvolnum>5</manvolnum></citerefentry>.
326
320
<refsect1 id="logging">
327
321
<title>LOGGING</title>
329
The server will send log message with various severity levels to
330
<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
331
325
<option>--debug</option> option, it will log even more messages,
332
326
and also show them on the console.
336
330
<refsect1 id="exit_status">
337
331
<title>EXIT STATUS</title>
431
425
Currently, if a client is declared <quote>invalid</quote> due to
432
426
having timed out, the server does not record this fact onto
433
427
permanent storage. This has some security implications, see
434
<xref linkend="clients"/>.
428
<xref linkend="CLIENTS"/>.
437
431
There is currently no way of querying the server of the current
487
477
<!-- do not wrap this line -->
488
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
491
481
</informalexample>
494
484
<refsect1 id="security">
495
485
<title>SECURITY</title>
496
<refsect2 id="server">
486
<refsect2 id="SERVER">
497
487
<title>SERVER</title>
499
489
Running this <command>&COMMANDNAME;</command> server program
500
490
should not in itself present any security risk to the host
501
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.
505
<refsect2 id="clients">
495
<refsect2 id="CLIENTS">
506
496
<title>CLIENTS</title>
508
498
The server only gives out its stored data to clients which
515
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
516
506
<manvolnum>5</manvolnum></citerefentry>)
517
507
<emphasis>must</emphasis> be made non-readable by anyone
518
except the user starting the server (usually root).
508
except the user running the server.
521
511
As detailed in <xref linkend="checking"/>, the status of all
532
522
restarting servers if it is suspected that a client has, in
533
523
fact, been compromised by parties who may now be running a
534
524
fake Mandos client with the keys from the non-encrypted
535
initial <acronym>RAM</acronym> image of the client host. What
536
should be done in that case (if restarting the server program
537
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
538
528
configuration file to omit any suspect clients, and restart
539
529
the server program.
542
532
For more details on client-side security, see
543
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
544
534
<manvolnum>8mandos</manvolnum></citerefentry>.
549
539
<refsect1 id="see_also">
550
540
<title>SEE ALSO</title>
553
<refentrytitle>mandos-clients.conf</refentrytitle>
554
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
<refentrytitle>mandos.conf</refentrytitle>
556
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
<refentrytitle>mandos-client</refentrytitle>
558
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
<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.
565
560
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
600
RFC 4291: <citetitle>IP Version 6 Addressing
601
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>
606
<term>Section 2.2: <citetitle>Text Representation of
607
Addresses</citetitle></term>
608
<listitem><para/></listitem>
611
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
612
Address</citetitle></term>
613
<listitem><para/></listitem>
616
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
617
Addresses</citetitle></term>
620
The clients use IPv6 link-local addresses, which are
621
immediately usable since a link-local addresses is
622
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
632
RFC 4346: <citetitle>The Transport Layer Security (TLS)
633
Protocol Version 1.1</citetitle>
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>