3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-08-31">
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<title>Mandos Manual</title>
11
<title>&COMMANDNAME;</title>
12
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>Mandos</productname>
13
<productname>&COMMANDNAME;</productname>
14
14
<productnumber>&VERSION;</productnumber>
15
<date>&TIMESTAMP;</date>
18
17
<firstname>Björn</firstname>
68
67
<refname><command>&COMMANDNAME;</command></refname>
70
Gives encrypted passwords to authenticated Mandos clients
69
Sends encrypted passwords to authenticated Mandos clients
76
75
<command>&COMMANDNAME;</command>
78
<arg choice="plain"><option>--interface
79
<replaceable>NAME</replaceable></option></arg>
80
<arg choice="plain"><option>-i
81
<replaceable>NAME</replaceable></option></arg>
85
<arg choice="plain"><option>--address
86
<replaceable>ADDRESS</replaceable></option></arg>
87
<arg choice="plain"><option>-a
88
<replaceable>ADDRESS</replaceable></option></arg>
92
<arg choice="plain"><option>--port
93
<replaceable>PORT</replaceable></option></arg>
94
<arg choice="plain"><option>-p
95
<replaceable>PORT</replaceable></option></arg>
98
<arg><option>--priority
99
<replaceable>PRIORITY</replaceable></option></arg>
101
<arg><option>--servicename
102
<replaceable>NAME</replaceable></option></arg>
104
<arg><option>--configdir
105
<replaceable>DIRECTORY</replaceable></option></arg>
107
<arg><option>--debug</option></arg>
110
<command>&COMMANDNAME;</command>
112
<arg choice="plain"><option>--help</option></arg>
113
<arg choice="plain"><option>-h</option></arg>
117
<command>&COMMANDNAME;</command>
118
<arg choice="plain"><option>--version</option></arg>
121
<command>&COMMANDNAME;</command>
122
<arg choice="plain"><option>--check</option></arg>
76
<arg choice="opt">--interface<arg choice="plain">IF</arg></arg>
77
<arg choice="opt">--address<arg choice="plain">ADDRESS</arg></arg>
78
<arg choice="opt">--port<arg choice="plain">PORT</arg></arg>
79
<arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
80
<arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
81
<arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
82
<arg choice="opt">--debug</arg>
85
<command>&COMMANDNAME;</command>
86
<arg choice="opt">-i<arg choice="plain">IF</arg></arg>
87
<arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
88
<arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
89
<arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
90
<arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
91
<arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
92
<arg choice="opt">--debug</arg>
95
<command>&COMMANDNAME;</command>
96
<arg choice="plain">--help</arg>
99
<command>&COMMANDNAME;</command>
100
<arg choice="plain">--version</arg>
103
<command>&COMMANDNAME;</command>
104
<arg choice="plain">--check</arg>
124
106
</refsynopsisdiv>
149
131
<emphasis>encrypted root file system</emphasis>. See <xref
150
132
linkend="overview"/> for details.
155
137
<refsect1 id="options">
156
138
<title>OPTIONS</title>
160
<term><option>--help</option></term>
161
<term><option>-h</option></term>
142
<term><literal>-h</literal>, <literal>--help</literal></term>
164
145
Show a help message and exit
170
<term><option>--interface</option>
171
<replaceable>NAME</replaceable></term>
172
<term><option>-i</option>
173
<replaceable>NAME</replaceable></term>
175
<xi:include href="mandos-options.xml" xpointer="interface"/>
180
<term><option>--address
181
<replaceable>ADDRESS</replaceable></option></term>
183
<replaceable>ADDRESS</replaceable></option></term>
185
<xi:include href="mandos-options.xml" xpointer="address"/>
191
<replaceable>PORT</replaceable></option></term>
193
<replaceable>PORT</replaceable></option></term>
195
<xi:include href="mandos-options.xml" xpointer="port"/>
200
<term><option>--check</option></term>
151
<term><literal>-i</literal>, <literal>--interface <replaceable>
152
IF</replaceable></literal></term>
155
Only announce the server and listen to requests on network
156
interface <replaceable>IF</replaceable>. Default is to
157
use all available interfaces.
163
<term><literal>-a</literal>, <literal>--address <replaceable>
164
ADDRESS</replaceable></literal></term>
167
If this option is used, the server will only listen to a
168
specific address. This must currently be an IPv6 address;
169
an IPv4 address can be specified using the
170
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
171
Also, if a link-local address is specified, an interface
172
should be set, since a link-local address is only valid on
173
a single interface. By default, the server will listen to
174
all available addresses.
180
<term><literal>-p</literal>, <literal>--port <replaceable>
181
PORT</replaceable></literal></term>
184
If this option is used, the server to bind to that
185
port. By default, the server will listen to an arbitrary
186
port given by the operating system.
192
<term><literal>--check</literal></term>
203
195
Run the server’s self-tests. This includes any unit
210
<term><option>--debug</option></term>
212
<xi:include href="mandos-options.xml" xpointer="debug"/>
217
<term><option>--priority <replaceable>
218
PRIORITY</replaceable></option></term>
220
<xi:include href="mandos-options.xml" xpointer="priority"/>
225
<term><option>--servicename
226
<replaceable>NAME</replaceable></option></term>
228
<xi:include href="mandos-options.xml"
229
xpointer="servicename"/>
234
<term><option>--configdir
235
<replaceable>DIRECTORY</replaceable></option></term>
202
<term><literal>--debug</literal></term>
205
If the server is run in debug mode, it will run in the
206
foreground and print a lot of debugging information. The
207
default is <emphasis>not</emphasis> to run in debug mode.
213
<term><literal>--priority <replaceable>
214
PRIORITY</replaceable></literal></term>
217
GnuTLS priority string for the TLS handshake with the
218
clients. The default is
219
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
220
See <citerefentry><refentrytitle>gnutls_priority_init
221
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
222
for the syntax. <emphasis>Warning</emphasis>: changing
223
this may make the TLS handshake fail, making communication
224
with clients impossible.
230
<term><literal>--servicename <replaceable>NAME</replaceable>
234
Zeroconf service name. The default is
235
<quote><literal>Mandos</literal></quote>. You only need
236
to change this if you for some reason want to run more
237
than one server on the same <emphasis>host</emphasis>,
238
which would not normally be useful. If there are name
239
collisions on the same <emphasis>network</emphasis>, the
240
newer server will automatically rename itself to
241
<quote><literal>Mandos #2</literal></quote>, and so on;
242
therefore, this option is not needed in that case.
248
<term><literal>--configdir <replaceable>DIR</replaceable>
238
252
Directory to search for configuration files. Default is
333
347
longer eligible to receive the encrypted password. The timeout,
334
348
checker program, and interval between checks can be configured
335
349
both globally and per client; see <citerefentry>
350
<refentrytitle>mandos.conf</refentrytitle>
351
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
336
352
<refentrytitle>mandos-clients.conf</refentrytitle>
337
353
<manvolnum>5</manvolnum></citerefentry>.
341
357
<refsect1 id="logging">
342
358
<title>LOGGING</title>
344
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
360
The server will send log messaged with various severity levels
361
to <filename>/dev/log</filename>. With the
346
362
<option>--debug</option> option, it will log even more messages,
347
363
and also show them on the console.
359
<refsect1 id="environment">
360
<title>ENVIRONMENT</title>
363
<term><envar>PATH</envar></term>
366
To start the configured checker (see <xref
367
linkend="checking"/>), the server uses
368
<filename>/bin/sh</filename>, which in turn uses
369
<varname>PATH</varname> to search for matching commands if
370
an absolute path is not given. See <citerefentry>
371
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
379
375
<refsect1 id="file">
380
376
<title>FILES</title>
426
<term><filename>/bin/sh</filename></term>
429
This is used to start the configured checker command for
430
each client. See <citerefentry>
431
<refentrytitle>mandos-clients.conf</refentrytitle>
432
<manvolnum>5</manvolnum></citerefentry> for details.
439
424
<refsect1 id="bugs">
440
425
<title>BUGS</title>
442
427
This server might, on especially fatal errors, emit a Python
443
428
backtrace. This could be considered a feature.
446
Currently, if a client is declared <quote>invalid</quote> due to
447
having timed out, the server does not record this fact onto
448
permanent storage. This has some security implications, see
449
<xref linkend="CLIENTS"/>.
452
There is currently no way of querying the server of the current
453
status of clients, other than analyzing its <systemitem
454
class="service">syslog</systemitem> output.
457
There is no fine-grained control over logging and debug output.
460
Debug mode is conflated with running in the foreground.
463
The console log messages does not show a timestamp.
467
<refsect1 id="example">
468
<title>EXAMPLE</title>
432
<refsect1 id="examples">
433
<title>EXAMPLES</title>
469
434
<informalexample>
471
436
Normal invocation needs no options:
474
<userinput>&COMMANDNAME;</userinput>
439
<userinput>mandos</userinput>
476
441
</informalexample>
477
442
<informalexample>
505
470
<refsect1 id="security">
506
471
<title>SECURITY</title>
507
<refsect2 id="SERVER">
508
473
<title>SERVER</title>
510
Running this <command>&COMMANDNAME;</command> server program
511
should not in itself present any security risk to the host
512
computer running it. The program does not need any special
513
privileges to run, and is designed to run as a non-root user.
475
Running this &COMMANDNAME; server program should not in itself
476
present any security risk to the host computer running it.
477
The program does not need any special privileges to run, and
478
is designed to run as a non-root user.
516
<refsect2 id="CLIENTS">
517
482
<title>CLIENTS</title>
519
484
The server only gives out its stored data to clients which
534
499
compromised if they are gone for too long.
537
If a client is compromised, its downtime should be duly noted
538
by the server which would therefore declare the client
539
invalid. But if the server was ever restarted, it would
540
re-read its client list from its configuration file and again
541
regard all clients therein as valid, and hence eligible to
542
receive their passwords. Therefore, be careful when
543
restarting servers if it is suspected that a client has, in
544
fact, been compromised by parties who may now be running a
545
fake Mandos client with the keys from the non-encrypted
546
initial RAM image of the client host. What should be done in
547
that case (if restarting the server program really is
548
necessary) is to stop the server program, edit the
549
configuration file to omit any suspect clients, and restart
553
502
For more details on client-side security, see
554
503
<citerefentry><refentrytitle>password-request</refentrytitle>
555
504
<manvolnum>8mandos</manvolnum></citerefentry>.
560
509
<refsect1 id="see_also">
561
510
<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>password-request</refentrytitle>
569
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
515
<refentrytitle>password-request</refentrytitle>
516
<manvolnum>8mandos</manvolnum>
521
This is the actual program which talks to this server.
522
Note that it is normally not invoked directly, and is only
523
run in the initial RAM disk environment, and not on a
524
fully started system.
576
530
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
611
RFC 4291: <citetitle>IP Version 6 Addressing
612
Architecture</citetitle>
565
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
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
571
The clients use IPv6 link-local addresses, which are
572
immediately usable since a link-local addresses is
573
automatically assigned to a network interfaces when it is
643
RFC 4346: <citetitle>The Transport Layer Security (TLS)
644
Protocol Version 1.1</citetitle>
580
<citation>RFC 4346: <citetitle>The Transport Layer Security
581
(TLS) Protocol Version 1.1</citetitle></citation>