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 OVERVIEW SYSTEM "overview.xml">
6
<!ENTITY TIMESTAMP "2008-09-12">
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<title>&COMMANDNAME;</title>
11
<title>Mandos Manual</title>
12
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
<productname>&COMMANDNAME;</productname>
13
<productname>Mandos</productname>
14
14
<productnumber>&VERSION;</productnumber>
15
<date>&TIMESTAMP;</date>
17
18
<firstname>Björn</firstname>
33
34
<holder>Teddy Hogeborn</holder>
34
35
<holder>Björn Påhlsson</holder>
38
This manual page is free software: you can redistribute it
39
and/or modify it under the terms of the GNU General Public
40
License as published by the Free Software Foundation,
41
either version 3 of the License, or (at your option) any
46
This manual page is distributed in the hope that it will
47
be useful, but WITHOUT ANY WARRANTY; without even the
48
implied warranty of MERCHANTABILITY or FITNESS FOR A
49
PARTICULAR PURPOSE. See the GNU General Public License
54
You should have received a copy of the GNU General Public
55
License along with this program; If not, see
56
<ulink url="http://www.gnu.org/licenses/"/>.
37
<xi:include href="legalnotice.xml"/>
62
41
<refentrytitle>&COMMANDNAME;</refentrytitle>
63
42
<manvolnum>8</manvolnum>
67
46
<refname><command>&COMMANDNAME;</command></refname>
69
Sends encrypted passwords to authenticated Mandos clients
48
Gives encrypted passwords to authenticated Mandos clients
75
54
<command>&COMMANDNAME;</command>
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>
56
<arg choice="plain"><option>--interface
57
<replaceable>NAME</replaceable></option></arg>
58
<arg choice="plain"><option>-i
59
<replaceable>NAME</replaceable></option></arg>
63
<arg choice="plain"><option>--address
64
<replaceable>ADDRESS</replaceable></option></arg>
65
<arg choice="plain"><option>-a
66
<replaceable>ADDRESS</replaceable></option></arg>
70
<arg choice="plain"><option>--port
71
<replaceable>PORT</replaceable></option></arg>
72
<arg choice="plain"><option>-p
73
<replaceable>PORT</replaceable></option></arg>
76
<arg><option>--priority
77
<replaceable>PRIORITY</replaceable></option></arg>
79
<arg><option>--servicename
80
<replaceable>NAME</replaceable></option></arg>
82
<arg><option>--configdir
83
<replaceable>DIRECTORY</replaceable></option></arg>
85
<arg><option>--debug</option></arg>
88
<command>&COMMANDNAME;</command>
90
<arg choice="plain"><option>--help</option></arg>
91
<arg choice="plain"><option>-h</option></arg>
95
<command>&COMMANDNAME;</command>
96
<arg choice="plain"><option>--version</option></arg>
99
<command>&COMMANDNAME;</command>
100
<arg choice="plain"><option>--check</option></arg>
106
102
</refsynopsisdiv>
108
104
<refsect1 id="description">
109
105
<title>DESCRIPTION</title>
119
115
Any authenticated client is then given the stored pre-encrypted
120
116
password for that specific client.
125
120
<refsect1 id="purpose">
126
121
<title>PURPOSE</title>
129
123
The purpose of this is to enable <emphasis>remote and unattended
130
124
rebooting</emphasis> of client host computer with an
131
125
<emphasis>encrypted root file system</emphasis>. See <xref
132
126
linkend="overview"/> for details.
137
130
<refsect1 id="options">
138
131
<title>OPTIONS</title>
142
<term><literal>-h</literal>, <literal>--help</literal></term>
134
<term><option>--help</option></term>
135
<term><option>-h</option></term>
145
138
Show a help message and exit
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>
144
<term><option>--interface</option>
145
<replaceable>NAME</replaceable></term>
146
<term><option>-i</option>
147
<replaceable>NAME</replaceable></term>
149
<xi:include href="mandos-options.xml" xpointer="interface"/>
154
<term><option>--address
155
<replaceable>ADDRESS</replaceable></option></term>
157
<replaceable>ADDRESS</replaceable></option></term>
159
<xi:include href="mandos-options.xml" xpointer="address"/>
165
<replaceable>PORT</replaceable></option></term>
167
<replaceable>PORT</replaceable></option></term>
169
<xi:include href="mandos-options.xml" xpointer="port"/>
174
<term><option>--check</option></term>
195
177
Run the server’s self-tests. This includes any unit
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>
184
<term><option>--debug</option></term>
186
<xi:include href="mandos-options.xml" xpointer="debug"/>
191
<term><option>--priority <replaceable>
192
PRIORITY</replaceable></option></term>
194
<xi:include href="mandos-options.xml" xpointer="priority"/>
199
<term><option>--servicename
200
<replaceable>NAME</replaceable></option></term>
202
<xi:include href="mandos-options.xml"
203
xpointer="servicename"/>
208
<term><option>--configdir
209
<replaceable>DIRECTORY</replaceable></option></term>
252
212
Directory to search for configuration files. Default is
347
307
longer eligible to receive the encrypted password. The timeout,
348
308
checker program, and interval between checks can be configured
349
309
both globally and per client; see <citerefentry>
350
<refentrytitle>mandos.conf</refentrytitle>
351
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
352
310
<refentrytitle>mandos-clients.conf</refentrytitle>
353
311
<manvolnum>5</manvolnum></citerefentry>.
357
315
<refsect1 id="logging">
358
316
<title>LOGGING</title>
360
The server will send log messaged with various severity levels
361
to <filename>/dev/log</filename>. With the
318
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
362
320
<option>--debug</option> option, it will log even more messages,
363
321
and also show them on the console.
367
325
<refsect1 id="exit_status">
368
326
<title>EXIT STATUS</title>
371
329
critical error is encountered.
333
<refsect1 id="environment">
334
<title>ENVIRONMENT</title>
337
<term><envar>PATH</envar></term>
340
To start the configured checker (see <xref
341
linkend="checking"/>), the server uses
342
<filename>/bin/sh</filename>, which in turn uses
343
<varname>PATH</varname> to search for matching commands if
344
an absolute path is not given. See <citerefentry>
345
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
375
353
<refsect1 id="file">
376
354
<title>FILES</title>
400
<term><filename>/bin/sh</filename></term>
403
This is used to start the configured checker command for
404
each client. See <citerefentry>
405
<refentrytitle>mandos-clients.conf</refentrytitle>
406
<manvolnum>5</manvolnum></citerefentry> for details.
424
413
<refsect1 id="bugs">
425
414
<title>BUGS</title>
427
416
This server might, on especially fatal errors, emit a Python
428
417
backtrace. This could be considered a feature.
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
431
There is no fine-grained control over logging and debug output.
434
Debug mode is conflated with running in the foreground.
437
The console log messages does not show a time stamp.
440
This server does not check the expire time of clients’ OpenPGP
432
<refsect1 id="examples">
433
<title>EXAMPLES</title>
445
<refsect1 id="example">
446
<title>EXAMPLE</title>
434
447
<informalexample>
436
449
Normal invocation needs no options:
439
<userinput>mandos</userinput>
452
<userinput>&COMMANDNAME;</userinput>
441
454
</informalexample>
442
455
<informalexample>
463
476
<!-- do not wrap this line -->
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
477
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
467
480
</informalexample>
470
483
<refsect1 id="security">
471
484
<title>SECURITY</title>
485
<refsect2 id="SERVER">
473
486
<title>SERVER</title>
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.
488
Running this <command>&COMMANDNAME;</command> server program
489
should not in itself present any security risk to the host
490
computer running it. The program switches to a non-root user
494
<refsect2 id="CLIENTS">
482
495
<title>CLIENTS</title>
484
497
The server only gives out its stored data to clients which
499
512
compromised if they are gone for too long.
515
If a client is compromised, its downtime should be duly noted
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
502
531
For more details on client-side security, see
503
<citerefentry><refentrytitle>password-request</refentrytitle>
532
<citerefentry><refentrytitle>mandos-client</refentrytitle>
504
533
<manvolnum>8mandos</manvolnum></citerefentry>.
509
538
<refsect1 id="see_also">
510
539
<title>SEE ALSO</title>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<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.
530
554
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
565
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
566
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
567
Unicast Addresses</citation>
589
RFC 4291: <citetitle>IP Version 6 Addressing
590
Architecture</citetitle>
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
595
<term>Section 2.2: <citetitle>Text Representation of
596
Addresses</citetitle></term>
597
<listitem><para/></listitem>
600
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
601
Address</citetitle></term>
602
<listitem><para/></listitem>
605
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
606
Addresses</citetitle></term>
609
The clients use IPv6 link-local addresses, which are
610
immediately usable since a link-local addresses is
611
automatically assigned to a network interfaces when it
580
<citation>RFC 4346: <citetitle>The Transport Layer Security
581
(TLS) Protocol Version 1.1</citetitle></citation>
621
RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
Protocol Version 1.1</citetitle>