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">
6
<!ENTITY TIMESTAMP "2008-08-29">
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
36
34
<holder>Teddy Hogeborn</holder>
37
35
<holder>Björn Påhlsson</holder>
39
<xi:include href="legalnotice.xml"/>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
43
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
<manvolnum>8</manvolnum>
48
68
<refname><command>&COMMANDNAME;</command></refname>
50
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
56
76
<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>
77
<arg>--interface<arg choice="plain">NAME</arg></arg>
78
<arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
<arg>--port<arg choice="plain">PORT</arg></arg>
80
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
<arg>--servicename<arg choice="plain">NAME</arg></arg>
82
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
86
<command>&COMMANDNAME;</command>
87
<arg>-i<arg choice="plain">NAME</arg></arg>
88
<arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
<arg>-p<arg choice="plain">PORT</arg></arg>
90
<arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
<arg>--servicename<arg choice="plain">NAME</arg></arg>
92
<arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
96
<command>&COMMANDNAME;</command>
93
97
<group choice="req">
94
<arg choice="plain"><option>--help</option></arg>
95
<arg choice="plain"><option>-h</option></arg>
98
<arg choice="plain">-h</arg>
99
<arg choice="plain">--help</arg>
99
103
<command>&COMMANDNAME;</command>
100
<arg choice="plain"><option>--version</option></arg>
104
<arg choice="plain">--version</arg>
103
107
<command>&COMMANDNAME;</command>
104
<arg choice="plain"><option>--check</option></arg>
108
<arg choice="plain">--check</arg>
106
110
</refsynopsisdiv>
108
112
<refsect1 id="description">
109
113
<title>DESCRIPTION</title>
119
123
Any authenticated client is then given the stored pre-encrypted
120
124
password for that specific client.
124
129
<refsect1 id="purpose">
125
130
<title>PURPOSE</title>
127
133
The purpose of this is to enable <emphasis>remote and unattended
128
134
rebooting</emphasis> of client host computer with an
129
135
<emphasis>encrypted root file system</emphasis>. See <xref
130
136
linkend="overview"/> for details.
134
141
<refsect1 id="options">
135
142
<title>OPTIONS</title>
146
<term><option>-h</option></term>
138
147
<term><option>--help</option></term>
139
<term><option>-h</option></term>
142
150
Show a help message and exit
156
<term><option>-i</option>
157
<replaceable>NAME</replaceable></term>
148
158
<term><option>--interface</option>
149
159
<replaceable>NAME</replaceable></term>
150
<term><option>-i</option>
151
<replaceable>NAME</replaceable></term>
153
161
<xi:include href="mandos-options.xml" xpointer="interface"/>
158
<term><option>--address
159
<replaceable>ADDRESS</replaceable></option></term>
161
<replaceable>ADDRESS</replaceable></option></term>
166
<term><literal>-a</literal>, <literal>--address <replaceable>
167
ADDRESS</replaceable></literal></term>
163
169
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<replaceable>PORT</replaceable></option></term>
171
<replaceable>PORT</replaceable></option></term>
174
<term><literal>-p</literal>, <literal>--port <replaceable>
175
PORT</replaceable></literal></term>
173
177
<xi:include href="mandos-options.xml" xpointer="port"/>
178
<term><option>--check</option></term>
182
<term><literal>--check</literal></term>
181
185
Run the server’s self-tests. This includes any unit
188
<term><option>--debug</option></term>
192
<term><literal>--debug</literal></term>
190
194
<xi:include href="mandos-options.xml" xpointer="debug"/>
195
<term><option>--priority <replaceable>
196
PRIORITY</replaceable></option></term>
199
<term><literal>--priority <replaceable>
200
PRIORITY</replaceable></literal></term>
198
202
<xi:include href="mandos-options.xml" xpointer="priority"/>
203
<term><option>--servicename
204
<replaceable>NAME</replaceable></option></term>
207
<term><literal>--servicename <replaceable>NAME</replaceable>
206
210
<xi:include href="mandos-options.xml"
207
211
xpointer="servicename"/>
212
<term><option>--configdir
213
<replaceable>DIRECTORY</replaceable></option></term>
216
<term><literal>--configdir <replaceable>DIR</replaceable>
216
220
Directory to search for configuration files. Default is
227
<term><option>--version</option></term>
231
<term><literal>--version</literal></term>
230
234
Prints the program version and exit.
236
<term><option>--no-dbus</option></term>
238
<xi:include href="mandos-options.xml" xpointer="dbus"/>
240
See also <xref linkend="dbus_interface"/>.
247
241
<refsect1 id="overview">
248
242
<title>OVERVIEW</title>
249
243
<xi:include href="overview.xml"/>
251
245
This program is the server part. It is a normal server program
252
246
and will run in a normal system environment, not in an initial
253
<acronym>RAM</acronym> disk environment.
247
RAM disk environment.
257
251
<refsect1 id="protocol">
258
252
<title>NETWORK PROTOCOL</title>
335
329
and also show them on the console.
339
<refsect1 id="dbus_interface">
340
<title>D-BUS INTERFACE</title>
342
The server will by default provide a D-Bus system bus interface.
343
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
349
333
<refsect1 id="exit_status">
350
334
<title>EXIT STATUS</title>
444
428
Currently, if a client is declared <quote>invalid</quote> due to
445
429
having timed out, the server does not record this fact onto
446
430
permanent storage. This has some security implications, see
447
<xref linkend="clients"/>.
431
<xref linkend="CLIENTS"/>.
450
434
There is currently no way of querying the server of the current
504
484
</informalexample>
507
487
<refsect1 id="security">
508
488
<title>SECURITY</title>
509
<refsect2 id="server">
489
<refsect2 id="SERVER">
510
490
<title>SERVER</title>
512
492
Running this <command>&COMMANDNAME;</command> server program
513
493
should not in itself present any security risk to the host
514
computer running it. The program switches to a non-root user
494
computer running it. The program does not need any special
495
privileges to run, and is designed to run as a non-root user.
518
<refsect2 id="clients">
498
<refsect2 id="CLIENTS">
519
499
<title>CLIENTS</title>
521
501
The server only gives out its stored data to clients which
528
508
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
509
<manvolnum>5</manvolnum></citerefentry>)
530
510
<emphasis>must</emphasis> be made non-readable by anyone
531
except the user starting the server (usually root).
511
except the user running the server.
534
514
As detailed in <xref linkend="checking"/>, the status of all
545
525
restarting servers if it is suspected that a client has, in
546
526
fact, been compromised by parties who may now be running a
547
527
fake Mandos client with the keys from the non-encrypted
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
528
initial RAM image of the client host. What should be done in
529
that case (if restarting the server program really is
530
necessary) is to stop the server program, edit the
551
531
configuration file to omit any suspect clients, and restart
552
532
the server program.
555
535
For more details on client-side security, see
556
<citerefentry><refentrytitle>mandos-client</refentrytitle>
536
<citerefentry><refentrytitle>password-request</refentrytitle>
557
537
<manvolnum>8mandos</manvolnum></citerefentry>.
562
542
<refsect1 id="see_also">
563
543
<title>SEE ALSO</title>
567
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
548
<refentrytitle>mandos.conf</refentrytitle>
569
549
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
550
<refentrytitle>password-request</refentrytitle>
571
551
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
552
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>