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-02-13">
6
<!ENTITY % common SYSTEM "common.ent">
6
<!ENTITY TIMESTAMP "2008-08-31">
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>
119
137
Any authenticated client is then given the stored pre-encrypted
120
138
password for that specific client.
124
143
<refsect1 id="purpose">
125
144
<title>PURPOSE</title>
127
147
The purpose of this is to enable <emphasis>remote and unattended
128
148
rebooting</emphasis> of client host computer with an
129
149
<emphasis>encrypted root file system</emphasis>. See <xref
130
150
linkend="overview"/> for details.
134
155
<refsect1 id="options">
135
156
<title>OPTIONS</title>
160
<term><option>-h</option></term>
138
161
<term><option>--help</option></term>
139
<term><option>-h</option></term>
142
164
Show a help message and exit
170
<term><option>-i</option>
171
<replaceable>NAME</replaceable></term>
148
172
<term><option>--interface</option>
149
173
<replaceable>NAME</replaceable></term>
150
<term><option>-i</option>
151
<replaceable>NAME</replaceable></term>
153
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
158
<term><option>--address
159
<replaceable>ADDRESS</replaceable></option></term>
161
<replaceable>ADDRESS</replaceable></option></term>
180
<term><literal>-a</literal>, <literal>--address <replaceable>
181
ADDRESS</replaceable></literal></term>
163
183
<xi:include href="mandos-options.xml" xpointer="address"/>
169
<replaceable>PORT</replaceable></option></term>
171
<replaceable>PORT</replaceable></option></term>
188
<term><literal>-p</literal>, <literal>--port <replaceable>
189
PORT</replaceable></literal></term>
173
191
<xi:include href="mandos-options.xml" xpointer="port"/>
178
<term><option>--check</option></term>
196
<term><literal>--check</literal></term>
181
199
Run the server’s self-tests. This includes any unit
188
<term><option>--debug</option></term>
206
<term><literal>--debug</literal></term>
190
208
<xi:include href="mandos-options.xml" xpointer="debug"/>
195
<term><option>--priority <replaceable>
196
PRIORITY</replaceable></option></term>
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
198
216
<xi:include href="mandos-options.xml" xpointer="priority"/>
203
<term><option>--servicename
204
<replaceable>NAME</replaceable></option></term>
221
<term><literal>--servicename <replaceable>NAME</replaceable>
206
224
<xi:include href="mandos-options.xml"
207
225
xpointer="servicename"/>
212
<term><option>--configdir
213
<replaceable>DIRECTORY</replaceable></option></term>
230
<term><literal>--configdir <replaceable>DIR</replaceable>
216
234
Directory to search for configuration files. Default is
227
<term><option>--version</option></term>
245
<term><literal>--version</literal></term>
230
248
Prints the program version and exit.
236
<term><option>--no-ipv6</option></term>
238
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
244
255
<refsect1 id="overview">
245
256
<title>OVERVIEW</title>
246
257
<xi:include href="overview.xml"/>
248
259
This program is the server part. It is a normal server program
249
260
and will run in a normal system environment, not in an initial
250
<acronym>RAM</acronym> disk environment.
261
RAM disk environment.
254
265
<refsect1 id="protocol">
255
266
<title>NETWORK PROTOCOL</title>
431
442
Currently, if a client is declared <quote>invalid</quote> due to
432
443
having timed out, the server does not record this fact onto
433
444
permanent storage. This has some security implications, see
434
<xref linkend="clients"/>.
445
<xref linkend="CLIENTS"/>.
437
448
There is currently no way of querying the server of the current
445
456
Debug mode is conflated with running in the foreground.
448
The console log messages does not show a time stamp.
451
This server does not check the expire time of clients’ OpenPGP
459
The console log messages does not show a timestamp.
491
498
</informalexample>
494
501
<refsect1 id="security">
495
502
<title>SECURITY</title>
496
<refsect2 id="server">
503
<refsect2 id="SERVER">
497
504
<title>SERVER</title>
499
506
Running this <command>&COMMANDNAME;</command> server program
500
507
should not in itself present any security risk to the host
501
computer running it. The program switches to a non-root user
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.
505
<refsect2 id="clients">
512
<refsect2 id="CLIENTS">
506
513
<title>CLIENTS</title>
508
515
The server only gives out its stored data to clients which
515
522
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
516
523
<manvolnum>5</manvolnum></citerefentry>)
517
524
<emphasis>must</emphasis> be made non-readable by anyone
518
except the user starting the server (usually root).
525
except the user running the server.
521
528
As detailed in <xref linkend="checking"/>, the status of all
532
539
restarting servers if it is suspected that a client has, in
533
540
fact, been compromised by parties who may now be running a
534
541
fake Mandos client with the keys from the non-encrypted
535
initial <acronym>RAM</acronym> image of the client host. What
536
should be done in that case (if restarting the server program
537
really is necessary) is to stop the server program, edit the
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
538
545
configuration file to omit any suspect clients, and restart
539
546
the server program.
542
549
For more details on client-side security, see
543
<citerefentry><refentrytitle>mandos-client</refentrytitle>
550
<citerefentry><refentrytitle>password-request</refentrytitle>
544
551
<manvolnum>8mandos</manvolnum></citerefentry>.
549
556
<refsect1 id="see_also">
550
557
<title>SEE ALSO</title>
554
561
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
562
<refentrytitle>mandos.conf</refentrytitle>
556
563
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
<refentrytitle>mandos-client</refentrytitle>
564
<refentrytitle>password-request</refentrytitle>
558
565
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
566
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>