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 "2008-12-28">
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>
35
32
<holder>Teddy Hogeborn</holder>
36
33
<holder>Björn Påhlsson</holder>
38
<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/"/>.
42
61
<refentrytitle>&COMMANDNAME;</refentrytitle>
43
62
<manvolnum>8</manvolnum>
47
66
<refname><command>&COMMANDNAME;</command></refname>
49
Gives encrypted passwords to authenticated Mandos clients
68
Sends encrypted passwords to authenticated Mandos clients
55
74
<command>&COMMANDNAME;</command>
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>
88
<arg><option>--no-dbus</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>
91
94
<command>&COMMANDNAME;</command>
92
95
<group choice="req">
93
<arg choice="plain"><option>--help</option></arg>
94
<arg choice="plain"><option>-h</option></arg>
96
<arg choice="plain">-h</arg>
97
<arg choice="plain">--help</arg>
98
101
<command>&COMMANDNAME;</command>
99
<arg choice="plain"><option>--version</option></arg>
102
<arg choice="plain">--version</arg>
102
105
<command>&COMMANDNAME;</command>
103
<arg choice="plain"><option>--check</option></arg>
106
<arg choice="plain">--check</arg>
105
108
</refsynopsisdiv>
107
110
<refsect1 id="description">
108
111
<title>DESCRIPTION</title>
118
121
Any authenticated client is then given the stored pre-encrypted
119
122
password for that specific client.
123
127
<refsect1 id="purpose">
124
128
<title>PURPOSE</title>
126
131
The purpose of this is to enable <emphasis>remote and unattended
127
132
rebooting</emphasis> of client host computer with an
128
133
<emphasis>encrypted root file system</emphasis>. See <xref
129
134
linkend="overview"/> for details.
133
139
<refsect1 id="options">
134
140
<title>OPTIONS</title>
137
<term><option>--help</option></term>
138
<term><option>-h</option></term>
144
<term><literal>-h</literal>, <literal>--help</literal></term>
141
147
Show a help message and exit
147
<term><option>--interface</option>
148
<replaceable>NAME</replaceable></term>
149
<term><option>-i</option>
150
<replaceable>NAME</replaceable></term>
153
<term><literal>-i</literal>, <literal>--interface <replaceable>
154
IF</replaceable></literal></term>
152
156
<xi:include href="mandos-options.xml" xpointer="interface"/>
157
<term><option>--address
158
<replaceable>ADDRESS</replaceable></option></term>
160
<replaceable>ADDRESS</replaceable></option></term>
161
<term><literal>-a</literal>, <literal>--address <replaceable>
162
ADDRESS</replaceable></literal></term>
162
164
<xi:include href="mandos-options.xml" xpointer="address"/>
168
<replaceable>PORT</replaceable></option></term>
170
<replaceable>PORT</replaceable></option></term>
169
<term><literal>-p</literal>, <literal>--port <replaceable>
170
PORT</replaceable></literal></term>
172
172
<xi:include href="mandos-options.xml" xpointer="port"/>
177
<term><option>--check</option></term>
177
<term><literal>--check</literal></term>
180
180
Run the server’s self-tests. This includes any unit
187
<term><option>--debug</option></term>
187
<term><literal>--debug</literal></term>
189
189
<xi:include href="mandos-options.xml" xpointer="debug"/>
194
<term><option>--priority <replaceable>
195
PRIORITY</replaceable></option></term>
194
<term><literal>--priority <replaceable>
195
PRIORITY</replaceable></literal></term>
197
197
<xi:include href="mandos-options.xml" xpointer="priority"/>
202
<term><option>--servicename
203
<replaceable>NAME</replaceable></option></term>
202
<term><literal>--servicename <replaceable>NAME</replaceable>
205
205
<xi:include href="mandos-options.xml"
206
206
xpointer="servicename"/>
211
<term><option>--configdir
212
<replaceable>DIRECTORY</replaceable></option></term>
211
<term><literal>--configdir <replaceable>DIR</replaceable>
215
215
Directory to search for configuration files. Default is
226
<term><option>--version</option></term>
226
<term><literal>--version</literal></term>
229
229
Prints the program version and exit.
235
<term><option>--no-dbus</option></term>
237
<xi:include href="mandos-options.xml" xpointer="dbus"/>
239
See also <xref linkend="dbus"/>.
245
236
<refsect1 id="overview">
246
237
<title>OVERVIEW</title>
247
238
<xi:include href="overview.xml"/>
249
240
This program is the server part. It is a normal server program
250
241
and will run in a normal system environment, not in an initial
251
<acronym>RAM</acronym> disk environment.
242
RAM disk environment.
255
246
<refsect1 id="protocol">
256
247
<title>NETWORK PROTOCOL</title>
333
324
and also show them on the console.
338
<title>D-BUS INTERFACE</title>
340
The server will by default provide a D-Bus system bus interface.
341
This interface will only be accessible by the root user or a
342
Mandos-specific user, if such a user exists.
347
328
<refsect1 id="exit_status">
348
329
<title>EXIT STATUS</title>
442
423
Currently, if a client is declared <quote>invalid</quote> due to
443
424
having timed out, the server does not record this fact onto
444
425
permanent storage. This has some security implications, see
445
<xref linkend="clients"/>.
426
<xref linkend="CLIENTS"/>.
448
429
There is currently no way of querying the server of the current
498
475
<!-- do not wrap this line -->
499
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
476
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
502
479
</informalexample>
505
482
<refsect1 id="security">
506
483
<title>SECURITY</title>
507
<refsect2 id="server">
484
<refsect2 id="SERVER">
508
485
<title>SERVER</title>
510
487
Running this <command>&COMMANDNAME;</command> server program
511
488
should not in itself present any security risk to the host
512
computer running it. The program switches to a non-root user
489
computer running it. The program does not need any special
490
privileges to run, and is designed to run as a non-root user.
516
<refsect2 id="clients">
493
<refsect2 id="CLIENTS">
517
494
<title>CLIENTS</title>
519
496
The server only gives out its stored data to clients which
526
503
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
527
504
<manvolnum>5</manvolnum></citerefentry>)
528
505
<emphasis>must</emphasis> be made non-readable by anyone
529
except the user starting the server (usually root).
506
except the user running the server.
532
509
As detailed in <xref linkend="checking"/>, the status of all
543
520
restarting servers if it is suspected that a client has, in
544
521
fact, been compromised by parties who may now be running a
545
522
fake Mandos client with the keys from the non-encrypted
546
initial <acronym>RAM</acronym> image of the client host. What
547
should be done in that case (if restarting the server program
548
really is necessary) is to stop the server program, edit the
523
initial RAM image of the client host. What should be done in
524
that case (if restarting the server program really is
525
necessary) is to stop the server program, edit the
549
526
configuration file to omit any suspect clients, and restart
550
527
the server program.
553
530
For more details on client-side security, see
554
<citerefentry><refentrytitle>mandos-client</refentrytitle>
531
<citerefentry><refentrytitle>password-request</refentrytitle>
555
532
<manvolnum>8mandos</manvolnum></citerefentry>.
560
537
<refsect1 id="see_also">
561
538
<title>SEE ALSO</title>
564
<refentrytitle>mandos-clients.conf</refentrytitle>
565
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
566
<refentrytitle>mandos.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos-client</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
543
<refentrytitle>password-request</refentrytitle>
544
<manvolnum>8mandos</manvolnum>
549
This is the actual program which talks to this server.
550
Note that it is normally not invoked directly, and is only
551
run in the initial RAM disk environment, and not on a
552
fully started system.
576
558
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
611
RFC 4291: <citetitle>IP Version 6 Addressing
612
Architecture</citetitle>
593
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
594
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
595
Unicast Addresses</citation>
617
<term>Section 2.2: <citetitle>Text Representation of
618
Addresses</citetitle></term>
619
<listitem><para/></listitem>
622
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
623
Address</citetitle></term>
624
<listitem><para/></listitem>
627
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
628
Addresses</citetitle></term>
631
The clients use IPv6 link-local addresses, which are
632
immediately usable since a link-local addresses is
633
automatically assigned to a network interfaces when it
599
The clients use IPv6 link-local addresses, which are
600
immediately usable since a link-local addresses is
601
automatically assigned to a network interfaces when it is
643
RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
Protocol Version 1.1</citetitle>
608
<citation>RFC 4346: <citetitle>The Transport Layer Security
609
(TLS) Protocol Version 1.1</citetitle></citation>