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-01-04">
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>
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>
90
94
<command>&COMMANDNAME;</command>
91
95
<group choice="req">
92
<arg choice="plain"><option>--help</option></arg>
93
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
97
101
<command>&COMMANDNAME;</command>
98
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
101
105
<command>&COMMANDNAME;</command>
102
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
104
108
</refsynopsisdiv>
106
110
<refsect1 id="description">
107
111
<title>DESCRIPTION</title>
117
121
Any authenticated client is then given the stored pre-encrypted
118
122
password for that specific client.
122
127
<refsect1 id="purpose">
123
128
<title>PURPOSE</title>
125
131
The purpose of this is to enable <emphasis>remote and unattended
126
132
rebooting</emphasis> of client host computer with an
127
133
<emphasis>encrypted root file system</emphasis>. See <xref
128
134
linkend="overview"/> for details.
132
139
<refsect1 id="options">
133
140
<title>OPTIONS</title>
136
<term><option>--help</option></term>
137
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
140
147
Show a help message and exit
146
<term><option>--interface</option>
147
<replaceable>NAME</replaceable></term>
148
<term><option>-i</option>
149
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
151
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
156
<term><option>--address
157
<replaceable>ADDRESS</replaceable></option></term>
159
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
161
164
<xi:include href="mandos-options.xml" xpointer="address"/>
167
<replaceable>PORT</replaceable></option></term>
169
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
171
172
<xi:include href="mandos-options.xml" xpointer="port"/>
176
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
179
180
Run the server’s self-tests. This includes any unit
186
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
188
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
193
<term><option>--priority <replaceable>
194
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
196
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
201
<term><option>--servicename
202
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
204
205
<xi:include href="mandos-options.xml"
205
206
xpointer="servicename"/>
210
<term><option>--configdir
211
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
214
215
Directory to search for configuration files. Default is
309
310
longer eligible to receive the encrypted password. The timeout,
310
311
checker program, and interval between checks can be configured
311
312
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
312
315
<refentrytitle>mandos-clients.conf</refentrytitle>
313
316
<manvolnum>5</manvolnum></citerefentry>.
317
320
<refsect1 id="logging">
318
321
<title>LOGGING</title>
320
The server will send log message with various severity levels to
321
<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
322
325
<option>--debug</option> option, it will log even more messages,
323
326
and also show them on the console.
327
330
<refsect1 id="exit_status">
328
331
<title>EXIT STATUS</title>
422
425
Currently, if a client is declared <quote>invalid</quote> due to
423
426
having timed out, the server does not record this fact onto
424
427
permanent storage. This has some security implications, see
425
<xref linkend="clients"/>.
428
<xref linkend="CLIENTS"/>.
428
431
There is currently no way of querying the server of the current
478
477
<!-- do not wrap this line -->
479
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
482
481
</informalexample>
485
484
<refsect1 id="security">
486
485
<title>SECURITY</title>
487
<refsect2 id="server">
486
<refsect2 id="SERVER">
488
487
<title>SERVER</title>
490
489
Running this <command>&COMMANDNAME;</command> server program
491
490
should not in itself present any security risk to the host
492
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.
496
<refsect2 id="clients">
495
<refsect2 id="CLIENTS">
497
496
<title>CLIENTS</title>
499
498
The server only gives out its stored data to clients which
506
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
507
506
<manvolnum>5</manvolnum></citerefentry>)
508
507
<emphasis>must</emphasis> be made non-readable by anyone
509
except the user starting the server (usually root).
508
except the user running the server.
512
511
As detailed in <xref linkend="checking"/>, the status of all
523
522
restarting servers if it is suspected that a client has, in
524
523
fact, been compromised by parties who may now be running a
525
524
fake Mandos client with the keys from the non-encrypted
526
initial <acronym>RAM</acronym> image of the client host. What
527
should be done in that case (if restarting the server program
528
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
529
528
configuration file to omit any suspect clients, and restart
530
529
the server program.
533
532
For more details on client-side security, see
534
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
<citerefentry><refentrytitle>password-request</refentrytitle>
535
534
<manvolnum>8mandos</manvolnum></citerefentry>.
540
539
<refsect1 id="see_also">
541
540
<title>SEE ALSO</title>
544
<refentrytitle>mandos-clients.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>mandos-client</refentrytitle>
549
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
550
<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.
556
560
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
591
RFC 4291: <citetitle>IP Version 6 Addressing
592
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>
597
<term>Section 2.2: <citetitle>Text Representation of
598
Addresses</citetitle></term>
599
<listitem><para/></listitem>
602
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
603
Address</citetitle></term>
604
<listitem><para/></listitem>
607
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
608
Addresses</citetitle></term>
611
The clients use IPv6 link-local addresses, which are
612
immediately usable since a link-local addresses is
613
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
623
RFC 4346: <citetitle>The Transport Layer Security (TLS)
624
Protocol Version 1.1</citetitle>
610
<citation>RFC 4346: <citetitle>The Transport Layer Security
611
(TLS) Protocol Version 1.1</citetitle></citation>