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">
6
<!ENTITY TIMESTAMP "2008-08-31">
5
<!ENTITY TIMESTAMP "2009-12-09">
6
<!ENTITY % common SYSTEM "common.ent">
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
34
36
<holder>Teddy Hogeborn</holder>
35
37
<holder>Björn Påhlsson</holder>
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/"/>.
39
<xi:include href="legalnotice.xml"/>
63
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
<manvolnum>8</manvolnum>
105
85
<replaceable>DIRECTORY</replaceable></option></arg>
107
87
<arg><option>--debug</option></arg>
89
<arg><option>--no-dbus</option></arg>
91
<arg><option>--no-ipv6</option></arg>
110
94
<command>&COMMANDNAME;</command>
137
121
Any authenticated client is then given the stored pre-encrypted
138
122
password for that specific client.
143
126
<refsect1 id="purpose">
144
127
<title>PURPOSE</title>
147
129
The purpose of this is to enable <emphasis>remote and unattended
148
130
rebooting</emphasis> of client host computer with an
149
131
<emphasis>encrypted root file system</emphasis>. See <xref
150
132
linkend="overview"/> for details.
155
136
<refsect1 id="options">
156
137
<title>OPTIONS</title>
140
<term><option>--help</option></term>
160
141
<term><option>-h</option></term>
161
<term><option>--help</option></term>
164
144
Show a help message and exit
150
<term><option>--interface</option>
151
<replaceable>NAME</replaceable></term>
170
152
<term><option>-i</option>
171
153
<replaceable>NAME</replaceable></term>
172
<term><option>--interface</option>
173
<replaceable>NAME</replaceable></term>
175
155
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
160
<term><option>--address
161
<replaceable>ADDRESS</replaceable></option></term>
163
<replaceable>ADDRESS</replaceable></option></term>
183
165
<xi:include href="mandos-options.xml" xpointer="address"/>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
171
<replaceable>PORT</replaceable></option></term>
173
<replaceable>PORT</replaceable></option></term>
191
175
<xi:include href="mandos-options.xml" xpointer="port"/>
196
<term><literal>--check</literal></term>
180
<term><option>--check</option></term>
199
183
Run the server’s self-tests. This includes any unit
206
<term><literal>--debug</literal></term>
190
<term><option>--debug</option></term>
208
192
<xi:include href="mandos-options.xml" xpointer="debug"/>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
197
<term><option>--priority <replaceable>
198
PRIORITY</replaceable></option></term>
216
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
205
<term><option>--servicename
206
<replaceable>NAME</replaceable></option></term>
224
208
<xi:include href="mandos-options.xml"
225
209
xpointer="servicename"/>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
214
<term><option>--configdir
215
<replaceable>DIRECTORY</replaceable></option></term>
234
218
Directory to search for configuration files. Default is
245
<term><literal>--version</literal></term>
229
<term><option>--version</option></term>
248
232
Prints the program version and exit.
238
<term><option>--no-dbus</option></term>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
242
See also <xref linkend="dbus_interface"/>.
248
<term><option>--no-ipv6</option></term>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
255
256
<refsect1 id="overview">
256
257
<title>OVERVIEW</title>
257
258
<xi:include href="overview.xml"/>
259
260
This program is the server part. It is a normal server program
260
261
and will run in a normal system environment, not in an initial
261
RAM disk environment.
262
<acronym>RAM</acronym> disk environment.
265
266
<refsect1 id="protocol">
266
267
<title>NETWORK PROTOCOL</title>
320
321
</tbody></tgroup></table>
323
324
<refsect1 id="checking">
324
325
<title>CHECKING</title>
326
327
The server will, by default, continually check that the clients
327
328
are still up. If a client has not been confirmed as being up
328
329
for some time, the client is assumed to be compromised and is no
329
longer eligible to receive the encrypted password. The timeout,
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
330
332
checker program, and interval between checks can be configured
331
333
both globally and per client; see <citerefentry>
332
334
<refentrytitle>mandos-clients.conf</refentrytitle>
333
<manvolnum>5</manvolnum></citerefentry>.
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
341
<refsect1 id="logging">
338
342
<title>LOGGING</title>
343
347
and also show them on the console.
351
<refsect1 id="dbus_interface">
352
<title>D-BUS INTERFACE</title>
354
The server will by default provide a D-Bus system bus interface.
355
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists.
347
361
<refsect1 id="exit_status">
348
362
<title>EXIT STATUS</title>
439
453
backtrace. This could be considered a feature.
442
Currently, if a client is declared <quote>invalid</quote> due to
443
having timed out, the server does not record this fact onto
444
permanent storage. This has some security implications, see
445
<xref linkend="CLIENTS"/>.
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
has some security implications, see <xref linkend="clients"/>.
448
461
There is currently no way of querying the server of the current
456
469
Debug mode is conflated with running in the foreground.
459
The console log messages does not show a timestamp.
472
The console log messages do not show a time stamp.
475
This server does not check the expire time of clients’ OpenPGP
498
515
</informalexample>
501
518
<refsect1 id="security">
502
519
<title>SECURITY</title>
503
<refsect2 id="SERVER">
520
<refsect2 id="server">
504
521
<title>SERVER</title>
506
523
Running this <command>&COMMANDNAME;</command> server program
507
524
should not in itself present any security risk to the host
508
computer running it. The program does not need any special
509
privileges to run, and is designed to run as a non-root user.
525
computer running it. The program switches to a non-root user
512
<refsect2 id="CLIENTS">
529
<refsect2 id="clients">
513
530
<title>CLIENTS</title>
515
532
The server only gives out its stored data to clients which
522
539
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
523
540
<manvolnum>5</manvolnum></citerefentry>)
524
541
<emphasis>must</emphasis> be made non-readable by anyone
525
except the user running the server.
542
except the user starting the server (usually root).
528
545
As detailed in <xref linkend="checking"/>, the status of all
533
550
If a client is compromised, its downtime should be duly noted
534
by the server which would therefore declare the client
535
invalid. But if the server was ever restarted, it would
536
re-read its client list from its configuration file and again
537
regard all clients therein as valid, and hence eligible to
538
receive their passwords. Therefore, be careful when
539
restarting servers if it is suspected that a client has, in
540
fact, been compromised by parties who may now be running a
541
fake Mandos client with the keys from the non-encrypted
542
initial RAM image of the client host. What should be done in
543
that case (if restarting the server program really is
544
necessary) is to stop the server program, edit the
545
configuration file to omit any suspect clients, and restart
551
by the server which would therefore disable the client. But
552
if the server was ever restarted, it would re-read its client
553
list from its configuration file and again regard all clients
554
therein as enabled, and hence eligible to receive their
555
passwords. Therefore, be careful when restarting servers if
556
it is suspected that a client has, in fact, been compromised
557
by parties who may now be running a fake Mandos client with
558
the keys from the non-encrypted initial <acronym>RAM</acronym>
559
image of the client host. What should be done in that case
560
(if restarting the server program really is necessary) is to
561
stop the server program, edit the configuration file to omit
562
any suspect clients, and restart the server program.
549
565
For more details on client-side security, see
550
<citerefentry><refentrytitle>password-request</refentrytitle>
566
<citerefentry><refentrytitle>mandos-client</refentrytitle>
551
567
<manvolnum>8mandos</manvolnum></citerefentry>.
556
572
<refsect1 id="see_also">
557
573
<title>SEE ALSO</title>
561
577
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
578
<refentrytitle>mandos.conf</refentrytitle>
563
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
<refentrytitle>password-request</refentrytitle>
580
<refentrytitle>mandos-client</refentrytitle>
565
581
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
582
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>