1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
7
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2011-11-26">
6
<!ENTITY % common SYSTEM "common.ent">
12
<title>&COMMANDNAME;</title>
13
<!-- NWalsh's docbook scripts use this to generate the footer: -->
14
<productname>&COMMANDNAME;</productname>
15
<productnumber>&VERSION;</productnumber>
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
16
<date>&TIMESTAMP;</date>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
34
38
<holder>Teddy Hogeborn</holder>
35
39
<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/"/>.
41
<xi:include href="legalnotice.xml"/>
63
45
<refentrytitle>&COMMANDNAME;</refentrytitle>
64
46
<manvolnum>8</manvolnum>
68
50
<refname><command>&COMMANDNAME;</command></refname>
70
Sends encrypted passwords to authenticated Mandos clients
52
Gives encrypted passwords to authenticated Mandos clients
76
58
<command>&COMMANDNAME;</command>
77
<arg choice='opt'>--interface<arg choice='plain'>IF</arg></arg>
78
<arg choice='opt'>--address<arg choice='plain'>ADDRESS</arg></arg>
79
<arg choice='opt'>--port<arg choice='plain'>PORT</arg></arg>
80
<arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
81
<arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
82
<arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
83
<arg choice='opt'>--debug</arg>
86
<command>&COMMANDNAME;</command>
87
<arg choice='opt'>-i<arg choice='plain'>IF</arg></arg>
88
<arg choice='opt'>-a<arg choice='plain'>ADDRESS</arg></arg>
89
<arg choice='opt'>-p<arg choice='plain'>PORT</arg></arg>
90
<arg choice='opt'>--priority<arg choice='plain'>PRIORITY</arg></arg>
91
<arg choice='opt'>--servicename<arg choice='plain'>NAME</arg></arg>
92
<arg choice='opt'>--configdir<arg choice='plain'>DIRECTORY</arg></arg>
93
<arg choice='opt'>--debug</arg>
96
<command>&COMMANDNAME;</command>
97
<arg choice='plain'>--help</arg>
100
<command>&COMMANDNAME;</command>
101
<arg choice='plain'>--version</arg>
104
<command>&COMMANDNAME;</command>
105
<arg choice='plain'>--check</arg>
60
<arg choice="plain"><option>--interface
61
<replaceable>NAME</replaceable></option></arg>
62
<arg choice="plain"><option>-i
63
<replaceable>NAME</replaceable></option></arg>
67
<arg choice="plain"><option>--address
68
<replaceable>ADDRESS</replaceable></option></arg>
69
<arg choice="plain"><option>-a
70
<replaceable>ADDRESS</replaceable></option></arg>
74
<arg choice="plain"><option>--port
75
<replaceable>PORT</replaceable></option></arg>
76
<arg choice="plain"><option>-p
77
<replaceable>PORT</replaceable></option></arg>
80
<arg><option>--priority
81
<replaceable>PRIORITY</replaceable></option></arg>
83
<arg><option>--servicename
84
<replaceable>NAME</replaceable></option></arg>
86
<arg><option>--configdir
87
<replaceable>DIRECTORY</replaceable></option></arg>
89
<arg><option>--debug</option></arg>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
94
<arg><option>--no-dbus</option></arg>
96
<arg><option>--no-ipv6</option></arg>
98
<arg><option>--no-restore</option></arg>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></option></arg>
104
<command>&COMMANDNAME;</command>
106
<arg choice="plain"><option>--help</option></arg>
107
<arg choice="plain"><option>-h</option></arg>
111
<command>&COMMANDNAME;</command>
112
<arg choice="plain"><option>--version</option></arg>
115
<command>&COMMANDNAME;</command>
116
<arg choice="plain"><option>--check</option></arg>
107
118
</refsynopsisdiv>
109
120
<refsect1 id="description">
110
121
<title>DESCRIPTION</title>
112
123
<command>&COMMANDNAME;</command> is a server daemon which
113
124
handles incoming request for passwords for a pre-defined list of
114
client host computers. The Mandos server uses Zeroconf to
115
announce itself on the local network, and uses GnuTLS to
116
communicate securely with and to authenticate the clients.
117
Mandos uses IPv6 link-local addresses, since the clients are
118
assumed to not have any other addresses configured. Any
119
authenticated client is then given the pre-encrypted password
120
for that specific client.
125
client host computers. For an introduction, see
126
<citerefentry><refentrytitle>intro</refentrytitle>
127
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
uses Zeroconf to announce itself on the local network, and uses
129
TLS to communicate securely with and to authenticate the
130
clients. The Mandos server uses IPv6 to allow Mandos clients to
131
use IPv6 link-local addresses, since the clients will probably
132
not have any other addresses configured (see <xref
133
linkend="overview"/>). Any authenticated client is then given
134
the stored pre-encrypted password for that specific client.
125
138
<refsect1 id="purpose">
126
139
<title>PURPOSE</title>
129
141
The purpose of this is to enable <emphasis>remote and unattended
130
rebooting</emphasis> of any client host computer with an
131
<emphasis>encrypted root file system</emphasis>. The client
132
host computer should start a Mandos client in the initial RAM
133
disk environment, the Mandos client program communicates with
134
this server program to get an encrypted password, which is then
135
decrypted and used to unlock the encrypted root file system.
136
The client host computer can then continue its boot sequence
142
rebooting</emphasis> of client host computer with an
143
<emphasis>encrypted root file system</emphasis>. See <xref
144
linkend="overview"/> for details.
142
148
<refsect1 id="options">
143
149
<title>OPTIONS</title>
147
<term><literal>-h</literal>, <literal>--help</literal></term>
152
<term><option>--help</option></term>
153
<term><option>-h</option></term>
150
156
Show a help message and exit
156
<term><literal>-i</literal>, <literal>--interface <replaceable>
157
IF</replaceable></literal></term>
160
Only announce the server and listen to requests on network
161
interface <replaceable>IF</replaceable>. Default is to
162
use all available interfaces.
168
<term><literal>-a</literal>, <literal>--address <replaceable>
169
ADDRESS</replaceable></literal></term>
172
If this option is used, the server will only listen to a
173
specific address. This must currently be an IPv6 address;
174
an IPv4 address can be specified using the
175
<quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
Also, if a link-local address is specified, an interface
177
should be set, since a link-local address is only valid on
178
a single interface. By default, the server will listen to
179
all available addresses.
185
<term><literal>-p</literal>, <literal>--port <replaceable>
186
PORT</replaceable></literal></term>
189
If this option is used, the server to bind to that
190
port. By default, the server will listen to an arbitrary
191
port given by the operating system.
197
<term><literal>--check</literal></term>
200
Run the server's self-tests. This includes any unit
162
<term><option>--interface</option>
163
<replaceable>NAME</replaceable></term>
164
<term><option>-i</option>
165
<replaceable>NAME</replaceable></term>
167
<xi:include href="mandos-options.xml" xpointer="interface"/>
172
<term><option>--address
173
<replaceable>ADDRESS</replaceable></option></term>
175
<replaceable>ADDRESS</replaceable></option></term>
177
<xi:include href="mandos-options.xml" xpointer="address"/>
183
<replaceable>PORT</replaceable></option></term>
185
<replaceable>PORT</replaceable></option></term>
187
<xi:include href="mandos-options.xml" xpointer="port"/>
192
<term><option>--check</option></term>
195
Run the server’s self-tests. This includes any unit
207
<term><literal>--debug</literal></term>
210
If the server is run in debug mode, it will run in the
211
foreground and print a lot of debugging information. The
212
default is <emphasis>not</emphasis> to run in debug mode.
218
<term><literal>--priority <replaceable>
219
PRIORITY</replaceable></literal></term>
222
GnuTLS priority string for the TLS handshake with the
224
<citerefentry><refentrytitle>gnutls_priority_init
225
</refentrytitle><manvolnum>3</manvolnum></citerefentry>
226
for the syntax. The default is
227
<quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
228
<emphasis>Warning</emphasis>: changing this may make the
229
TLS handshake fail, making communication with clients
236
<term><literal>--servicename <replaceable>NAME</replaceable>
240
Zeroconf service name. The default is
241
<quote><literal>Mandos</literal></quote>. You only need
242
to change this if you for some reason want to run more
243
than one server on the same <emphasis>host</emphasis>,
244
which would not normally be useful. If there are name
245
collisions on the same <emphasis>network</emphasis>, the
246
newer server will automatically rename itself to
247
<quote><literal>Mandos #2</literal></quote>, and so on,
248
therefore this option is not needed in that case.
254
<term><literal>--configdir <replaceable>DIR</replaceable>
202
<term><option>--debug</option></term>
204
<xi:include href="mandos-options.xml" xpointer="debug"/>
209
<term><option>--debuglevel
210
<replaceable>LEVEL</replaceable></option></term>
213
Set the debugging log level.
214
<replaceable>LEVEL</replaceable> is a string, one of
215
<quote><literal>CRITICAL</literal></quote>,
216
<quote><literal>ERROR</literal></quote>,
217
<quote><literal>WARNING</literal></quote>,
218
<quote><literal>INFO</literal></quote>, or
219
<quote><literal>DEBUG</literal></quote>, in order of
220
increasing verbosity. The default level is
221
<quote><literal>WARNING</literal></quote>.
227
<term><option>--priority <replaceable>
228
PRIORITY</replaceable></option></term>
230
<xi:include href="mandos-options.xml" xpointer="priority"/>
235
<term><option>--servicename
236
<replaceable>NAME</replaceable></option></term>
238
<xi:include href="mandos-options.xml"
239
xpointer="servicename"/>
244
<term><option>--configdir
245
<replaceable>DIRECTORY</replaceable></option></term>
258
248
Directory to search for configuration files. Default is
334
366
</tbody></tgroup></table>
337
369
<refsect1 id="checking">
338
370
<title>CHECKING</title>
340
372
The server will, by default, continually check that the clients
341
373
are still up. If a client has not been confirmed as being up
342
374
for some time, the client is assumed to be compromised and is no
343
longer eligible to receive the encrypted password. The timeout,
344
checker program and interval between checks can be configured
345
both globally and per client; see <citerefentry>
346
<refentrytitle>mandos.conf</refentrytitle>
347
<manvolnum>5</manvolnum></citerefentry> and <citerefentry>
375
longer eligible to receive the encrypted password. (Manual
376
intervention is required to re-enable a client.) The timeout,
377
extended timeout, checker program, and interval between checks
378
can be configured both globally and per client; see
379
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
<manvolnum>5</manvolnum></citerefentry>. A client successfully
381
receiving its password will also be treated as a successful
386
<refsect1 id="approval">
387
<title>APPROVAL</title>
389
The server can be configured to require manual approval for a
390
client before it is sent its secret. The delay to wait for such
391
approval and the default action (approve or deny) can be
392
configured both globally and per client; see <citerefentry>
348
393
<refentrytitle>mandos-clients.conf</refentrytitle>
349
<manvolnum>5</manvolnum></citerefentry>.
394
<manvolnum>5</manvolnum></citerefentry>. By default all clients
395
will be approved immediately without delay.
398
This can be used to deny a client its secret if not manually
399
approved within a specified time. It can also be used to make
400
the server delay before giving a client its secret, allowing
401
optional manual denying of this specific client.
353
406
<refsect1 id="logging">
354
407
<title>LOGGING</title>
356
The server will send log messaged with various severity levels
357
to <filename>/dev/log</filename>. With the
409
The server will send log message with various severity levels to
410
<filename class="devicefile">/dev/log</filename>. With the
358
411
<option>--debug</option> option, it will log even more messages,
359
412
and also show them on the console.
416
<refsect1 id="dbus_interface">
417
<title>D-BUS INTERFACE</title>
419
The server will by default provide a D-Bus system bus interface.
420
This interface will only be accessible by the root user or a
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
363
426
<refsect1 id="exit_status">
364
427
<title>EXIT STATUS</title>
481
603
itself and looks up the fingerprint in its list of
482
604
clients. The <filename>clients.conf</filename> file (see
483
605
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
484
<manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
by anyone except the user running the server.
606
<manvolnum>5</manvolnum></citerefentry>)
607
<emphasis>must</emphasis> be made non-readable by anyone
608
except the user starting the server (usually root).
611
As detailed in <xref linkend="checking"/>, the status of all
612
client computers will continually be checked and be assumed
613
compromised if they are gone for too long.
488
616
For more details on client-side security, see
489
<citerefentry><refentrytitle>password-request</refentrytitle>
617
<citerefentry><refentrytitle>mandos-client</refentrytitle>
490
618
<manvolnum>8mandos</manvolnum></citerefentry>.
495
623
<refsect1 id="see_also">
496
624
<title>SEE ALSO</title>
497
<itemizedlist spacing="compact">
499
<citerefentry><refentrytitle>password-request</refentrytitle>
500
<manvolnum>8mandos</manvolnum></citerefentry>
504
<citerefentry><refentrytitle>plugin-runner</refentrytitle>
505
<manvolnum>8mandos</manvolnum></citerefentry>
509
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
513
<ulink url="http://www.avahi.org/">Avahi</ulink>
518
url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
522
<citation>RFC 4880: <citetitle>OpenPGP Message
523
Format</citetitle></citation>
527
<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
528
Transport Layer Security</citetitle></citation>
532
<citation>RFC 4291: <citetitle>IP Version 6 Addressing
533
Architecture</citetitle>, section 2.5.6, Link-Local IPv6
534
Unicast Addresses</citation>
626
<citerefentry><refentrytitle>intro</refentrytitle>
627
<manvolnum>8mandos</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
<manvolnum>5</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
<manvolnum>5</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>mandos-client</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>sh</refentrytitle>
635
<manvolnum>1</manvolnum></citerefentry>
640
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
644
Zeroconf is the network protocol standard used by clients
645
for finding this Mandos server on the local network.
651
<ulink url="http://www.avahi.org/">Avahi</ulink>
655
Avahi is the library this server calls to implement
656
Zeroconf service announcements.
662
<ulink url="http://www.gnu.org/software/gnutls/"
667
GnuTLS is the library this server uses to implement TLS for
668
communicating securely with the client, and at the same time
669
confidently get the client’s public OpenPGP key.
675
RFC 4291: <citetitle>IP Version 6 Addressing
676
Architecture</citetitle>
681
<term>Section 2.2: <citetitle>Text Representation of
682
Addresses</citetitle></term>
683
<listitem><para/></listitem>
686
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
687
Address</citetitle></term>
688
<listitem><para/></listitem>
691
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
692
Addresses</citetitle></term>
695
The clients use IPv6 link-local addresses, which are
696
immediately usable since a link-local addresses is
697
automatically assigned to a network interfaces when it
707
RFC 4346: <citetitle>The Transport Layer Security (TLS)
708
Protocol Version 1.1</citetitle>
712
TLS 1.1 is the protocol implemented by GnuTLS.
718
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
722
The data sent to clients is binary encrypted OpenPGP data.
728
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
733
This is implemented by GnuTLS and used by this server so
734
that OpenPGP keys can be used.
741
<!-- Local Variables: -->
742
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
743
<!-- time-stamp-end: "[\"']>" -->
744
<!-- time-stamp-format: "%:y-%02m-%02d" -->