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 "2008-10-03">
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
35
<holder>Teddy Hogeborn</holder>
33
36
<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/"/>.
38
<xi:include href="legalnotice.xml"/>
61
42
<refentrytitle>&COMMANDNAME;</refentrytitle>
62
43
<manvolnum>8</manvolnum>
66
47
<refname><command>&COMMANDNAME;</command></refname>
68
Sends encrypted passwords to authenticated Mandos clients
49
Gives encrypted passwords to authenticated Mandos clients
74
55
<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>
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>
94
89
<command>&COMMANDNAME;</command>
95
90
<group choice="req">
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
91
<arg choice="plain"><option>--help</option></arg>
92
<arg choice="plain"><option>-h</option></arg>
101
96
<command>&COMMANDNAME;</command>
102
<arg choice="plain">--version</arg>
97
<arg choice="plain"><option>--version</option></arg>
105
100
<command>&COMMANDNAME;</command>
106
<arg choice="plain">--check</arg>
101
<arg choice="plain"><option>--check</option></arg>
108
103
</refsynopsisdiv>
110
105
<refsect1 id="description">
111
106
<title>DESCRIPTION</title>
121
116
Any authenticated client is then given the stored pre-encrypted
122
117
password for that specific client.
127
121
<refsect1 id="purpose">
128
122
<title>PURPOSE</title>
131
124
The purpose of this is to enable <emphasis>remote and unattended
132
125
rebooting</emphasis> of client host computer with an
133
126
<emphasis>encrypted root file system</emphasis>. See <xref
134
127
linkend="overview"/> for details.
139
131
<refsect1 id="options">
140
132
<title>OPTIONS</title>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
135
<term><option>--help</option></term>
136
<term><option>-h</option></term>
147
139
Show a help message and exit
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
145
<term><option>--interface</option>
146
<replaceable>NAME</replaceable></term>
147
<term><option>-i</option>
148
<replaceable>NAME</replaceable></term>
156
150
<xi:include href="mandos-options.xml" xpointer="interface"/>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
155
<term><option>--address
156
<replaceable>ADDRESS</replaceable></option></term>
158
<replaceable>ADDRESS</replaceable></option></term>
164
160
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
166
<replaceable>PORT</replaceable></option></term>
168
<replaceable>PORT</replaceable></option></term>
172
170
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><literal>--check</literal></term>
175
<term><option>--check</option></term>
180
178
Run the server’s self-tests. This includes any unit
187
<term><literal>--debug</literal></term>
185
<term><option>--debug</option></term>
189
187
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
192
<term><option>--priority <replaceable>
193
PRIORITY</replaceable></option></term>
197
195
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
200
<term><option>--servicename
201
<replaceable>NAME</replaceable></option></term>
205
203
<xi:include href="mandos-options.xml"
206
204
xpointer="servicename"/>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
209
<term><option>--configdir
210
<replaceable>DIRECTORY</replaceable></option></term>
215
213
Directory to search for configuration files. Default is
310
308
longer eligible to receive the encrypted password. The timeout,
311
309
checker program, and interval between checks can be configured
312
310
both globally and per client; see <citerefentry>
313
<refentrytitle>mandos.conf</refentrytitle>
314
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
311
<refentrytitle>mandos-clients.conf</refentrytitle>
316
312
<manvolnum>5</manvolnum></citerefentry>.
320
316
<refsect1 id="logging">
321
317
<title>LOGGING</title>
323
The server will send log messaged with various severity levels
324
to <filename>/dev/log</filename>. With the
319
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
325
321
<option>--debug</option> option, it will log even more messages,
326
322
and also show them on the console.
330
326
<refsect1 id="exit_status">
331
327
<title>EXIT STATUS</title>
425
421
Currently, if a client is declared <quote>invalid</quote> due to
426
422
having timed out, the server does not record this fact onto
427
423
permanent storage. This has some security implications, see
428
<xref linkend="CLIENTS"/>.
424
<xref linkend="clients"/>.
431
427
There is currently no way of querying the server of the current
477
477
<!-- do not wrap this line -->
478
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
478
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
481
481
</informalexample>
484
484
<refsect1 id="security">
485
485
<title>SECURITY</title>
486
<refsect2 id="SERVER">
486
<refsect2 id="server">
487
487
<title>SERVER</title>
489
489
Running this <command>&COMMANDNAME;</command> server program
490
490
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.
491
computer running it. The program switches to a non-root user
495
<refsect2 id="CLIENTS">
495
<refsect2 id="clients">
496
496
<title>CLIENTS</title>
498
498
The server only gives out its stored data to clients which
505
505
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
506
506
<manvolnum>5</manvolnum></citerefentry>)
507
507
<emphasis>must</emphasis> be made non-readable by anyone
508
except the user running the server.
508
except the user starting the server (usually root).
511
511
As detailed in <xref linkend="checking"/>, the status of all
522
522
restarting servers if it is suspected that a client has, in
523
523
fact, been compromised by parties who may now be running a
524
524
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
525
initial <acronym>RAM</acronym> image of the client host. What
526
should be done in that case (if restarting the server program
527
really is necessary) is to stop the server program, edit the
528
528
configuration file to omit any suspect clients, and restart
529
529
the server program.
532
532
For more details on client-side security, see
533
<citerefentry><refentrytitle>password-request</refentrytitle>
533
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
534
<manvolnum>8mandos</manvolnum></citerefentry>.
539
539
<refsect1 id="see_also">
540
540
<title>SEE ALSO</title>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>mandos-client</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<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
555
<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>
590
RFC 4291: <citetitle>IP Version 6 Addressing
591
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
596
<term>Section 2.2: <citetitle>Text Representation of
597
Addresses</citetitle></term>
598
<listitem><para/></listitem>
601
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
602
Address</citetitle></term>
603
<listitem><para/></listitem>
606
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
607
Addresses</citetitle></term>
610
The clients use IPv6 link-local addresses, which are
611
immediately usable since a link-local addresses is
612
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>
622
RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
Protocol Version 1.1</citetitle>