1
<?xml version="1.0" encoding="UTF-8"?>
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"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
5
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2019-02-09">
6
<!ENTITY % common SYSTEM "common.ent">
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>
12
<title>&COMMANDNAME;</title>
13
<!-- NWalsh's docbook scripts use this to generate the footer: -->
14
<productname>&COMMANDNAME;</productname>
15
<productnumber>&VERSION;</productnumber>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
45
34
<holder>Teddy Hogeborn</holder>
46
35
<holder>Björn Påhlsson</holder>
48
<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/"/>.
52
63
<refentrytitle>&COMMANDNAME;</refentrytitle>
53
64
<manvolnum>8</manvolnum>
57
68
<refname><command>&COMMANDNAME;</command></refname>
59
Gives encrypted passwords to authenticated Mandos clients
70
Sends encrypted passwords to authenticated Mandos clients
65
76
<command>&COMMANDNAME;</command>
67
<arg choice="plain"><option>--interface
68
<replaceable>NAME</replaceable></option></arg>
69
<arg choice="plain"><option>-i
70
<replaceable>NAME</replaceable></option></arg>
74
<arg choice="plain"><option>--address
75
<replaceable>ADDRESS</replaceable></option></arg>
76
<arg choice="plain"><option>-a
77
<replaceable>ADDRESS</replaceable></option></arg>
81
<arg choice="plain"><option>--port
82
<replaceable>PORT</replaceable></option></arg>
83
<arg choice="plain"><option>-p
84
<replaceable>PORT</replaceable></option></arg>
87
<arg><option>--priority
88
<replaceable>PRIORITY</replaceable></option></arg>
90
<arg><option>--servicename
91
<replaceable>NAME</replaceable></option></arg>
93
<arg><option>--configdir
94
<replaceable>DIRECTORY</replaceable></option></arg>
96
<arg><option>--debug</option></arg>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
101
<arg><option>--no-dbus</option></arg>
103
<arg><option>--no-ipv6</option></arg>
105
<arg><option>--no-restore</option></arg>
107
<arg><option>--statedir
108
<replaceable>DIRECTORY</replaceable></option></arg>
110
<arg><option>--socket
111
<replaceable>FD</replaceable></option></arg>
113
<arg><option>--foreground</option></arg>
115
<arg><option>--no-zeroconf</option></arg>
118
<command>&COMMANDNAME;</command>
120
<arg choice="plain"><option>--help</option></arg>
121
<arg choice="plain"><option>-h</option></arg>
125
<command>&COMMANDNAME;</command>
126
<arg choice="plain"><option>--version</option></arg>
129
<command>&COMMANDNAME;</command>
130
<arg choice="plain"><option>--check</option></arg>
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>
132
107
</refsynopsisdiv>
134
109
<refsect1 id="description">
135
110
<title>DESCRIPTION</title>
137
112
<command>&COMMANDNAME;</command> is a server daemon which
138
113
handles incoming request for passwords for a pre-defined list of
139
client host computers. For an introduction, see
140
<citerefentry><refentrytitle>intro</refentrytitle>
141
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
uses Zeroconf to announce itself on the local network, and uses
143
TLS to communicate securely with and to authenticate the
144
clients. The Mandos server uses IPv6 to allow Mandos clients to
145
use IPv6 link-local addresses, since the clients will probably
146
not have any other addresses configured (see <xref
147
linkend="overview"/>). Any authenticated client is then given
148
the stored pre-encrypted password for that specific client.
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.
152
125
<refsect1 id="purpose">
153
126
<title>PURPOSE</title>
155
129
The purpose of this is to enable <emphasis>remote and unattended
156
rebooting</emphasis> of client host computer with an
157
<emphasis>encrypted root file system</emphasis>. See <xref
158
linkend="overview"/> for details.
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
162
142
<refsect1 id="options">
163
143
<title>OPTIONS</title>
166
<term><option>--help</option></term>
167
<term><option>-h</option></term>
147
<term><literal>-h</literal>, <literal>--help</literal></term>
170
150
Show a help message and exit
176
<term><option>--interface</option>
177
<replaceable>NAME</replaceable></term>
178
<term><option>-i</option>
179
<replaceable>NAME</replaceable></term>
181
<xi:include href="mandos-options.xml" xpointer="interface"/>
186
<term><option>--address
187
<replaceable>ADDRESS</replaceable></option></term>
189
<replaceable>ADDRESS</replaceable></option></term>
191
<xi:include href="mandos-options.xml" xpointer="address"/>
197
<replaceable>PORT</replaceable></option></term>
199
<replaceable>PORT</replaceable></option></term>
201
<xi:include href="mandos-options.xml" xpointer="port"/>
206
<term><option>--check</option></term>
209
Run the server’s self-tests. This includes any unit
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
216
<term><option>--debug</option></term>
218
<xi:include href="mandos-options.xml" xpointer="debug"/>
223
<term><option>--debuglevel
224
<replaceable>LEVEL</replaceable></option></term>
227
Set the debugging log level.
228
<replaceable>LEVEL</replaceable> is a string, one of
229
<quote><literal>CRITICAL</literal></quote>,
230
<quote><literal>ERROR</literal></quote>,
231
<quote><literal>WARNING</literal></quote>,
232
<quote><literal>INFO</literal></quote>, or
233
<quote><literal>DEBUG</literal></quote>, in order of
234
increasing verbosity. The default level is
235
<quote><literal>WARNING</literal></quote>.
241
<term><option>--priority <replaceable>
242
PRIORITY</replaceable></option></term>
244
<xi:include href="mandos-options.xml" xpointer="priority"/>
249
<term><option>--servicename
250
<replaceable>NAME</replaceable></option></term>
252
<xi:include href="mandos-options.xml"
253
xpointer="servicename"/>
258
<term><option>--configdir
259
<replaceable>DIRECTORY</replaceable></option></term>
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>
262
258
Directory to search for configuration files. Default is
407
334
</tbody></tgroup></table>
410
337
<refsect1 id="checking">
411
338
<title>CHECKING</title>
413
340
The server will, by default, continually check that the clients
414
341
are still up. If a client has not been confirmed as being up
415
342
for some time, the client is assumed to be compromised and is no
416
longer eligible to receive the encrypted password. (Manual
417
intervention is required to re-enable a client.) The timeout,
418
extended timeout, checker program, and interval between checks
419
can be configured both globally and per client; see
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
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>
348
<refentrytitle>mandos-clients.conf</refentrytitle>
421
349
<manvolnum>5</manvolnum></citerefentry>.
425
<refsect1 id="approval">
426
<title>APPROVAL</title>
428
The server can be configured to require manual approval for a
429
client before it is sent its secret. The delay to wait for such
430
approval and the default action (approve or deny) can be
431
configured both globally and per client; see <citerefentry>
432
<refentrytitle>mandos-clients.conf</refentrytitle>
433
<manvolnum>5</manvolnum></citerefentry>. By default all clients
434
will be approved immediately without delay.
437
This can be used to deny a client its secret if not manually
438
approved within a specified time. It can also be used to make
439
the server delay before giving a client its secret, allowing
440
optional manual denying of this specific client.
445
353
<refsect1 id="logging">
446
354
<title>LOGGING</title>
448
The server will send log message with various severity levels to
449
<filename class="devicefile">/dev/log</filename>. With the
356
The server will send log messaged with various severity levels
357
to <filename>/dev/log</filename>. With the
450
358
<option>--debug</option> option, it will log even more messages,
451
359
and also show them on the console.
455
<refsect1 id="persistent_state">
456
<title>PERSISTENT STATE</title>
458
Client settings, initially read from
459
<filename>clients.conf</filename>, are persistent across
460
restarts, and run-time changes will override settings in
461
<filename>clients.conf</filename>. However, if a setting is
462
<emphasis>changed</emphasis> (or a client added, or removed) in
463
<filename>clients.conf</filename>, this will take precedence.
467
<refsect1 id="dbus_interface">
468
<title>D-BUS INTERFACE</title>
470
The server will by default provide a D-Bus system bus interface.
471
This interface will only be accessible by the root user or a
472
Mandos-specific user, if such a user exists. For documentation
473
of the D-Bus API, see the file <filename>DBUS-API</filename>.
477
363
<refsect1 id="exit_status">
478
364
<title>EXIT STATUS</title>
623
457
<!-- do not wrap this line -->
624
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
458
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
627
461
</informalexample>
630
464
<refsect1 id="security">
631
465
<title>SECURITY</title>
632
<refsect2 id="server">
633
467
<title>SERVER</title>
635
Running this <command>&COMMANDNAME;</command> server program
636
should not in itself present any security risk to the host
637
computer running it. The program switches to a non-root user
469
Running the server should not in itself present any security
470
risk to the host computer running it.
641
<refsect2 id="clients">
642
474
<title>CLIENTS</title>
644
476
The server only gives out its stored data to clients which
645
does have the correct key ID of the stored key ID. This is
646
guaranteed by the fact that the client sends its public key in
647
the TLS handshake; this ensures it to be genuine. The server
648
computes the key ID of the key itself and looks up the key ID
649
in its list of clients. The <filename>clients.conf</filename>
477
does have the OpenPGP key of the stored fingerprint. This is
478
guaranteed by the fact that the client sends its OpenPGP
479
public key in the TLS handshake; this ensures it to be
480
genuine. The server computes the fingerprint of the key
481
itself and looks up the fingerprint in its list of
482
clients. The <filename>clients.conf</filename> file (see
651
483
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
<manvolnum>5</manvolnum></citerefentry>)
653
<emphasis>must</emphasis> be made non-readable by anyone
654
except the user starting the server (usually root).
657
As detailed in <xref linkend="checking"/>, the status of all
658
client computers will continually be checked and be assumed
659
compromised if they are gone for too long.
484
<manvolnum>5</manvolnum></citerefentry>) must be non-readable
485
by anyone except the user running the server.
662
488
For more details on client-side security, see
663
<citerefentry><refentrytitle>mandos-client</refentrytitle>
489
<citerefentry><refentrytitle>password-request</refentrytitle>
664
490
<manvolnum>8mandos</manvolnum></citerefentry>.
669
495
<refsect1 id="see_also">
670
496
<title>SEE ALSO</title>
672
<citerefentry><refentrytitle>intro</refentrytitle>
673
<manvolnum>8mandos</manvolnum></citerefentry>,
674
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
675
<manvolnum>5</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-client</refentrytitle>
679
<manvolnum>8mandos</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>sh</refentrytitle>
681
<manvolnum>1</manvolnum></citerefentry>
686
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
690
Zeroconf is the network protocol standard used by clients
691
for finding this Mandos server on the local network.
697
<ulink url="http://www.avahi.org/">Avahi</ulink>
701
Avahi is the library this server calls to implement
702
Zeroconf service announcements.
708
<ulink url="https://gnutls.org/">GnuTLS</ulink>
712
GnuTLS is the library this server uses to implement TLS for
713
communicating securely with the client, and at the same time
714
confidently get the client’s public key.
720
RFC 4291: <citetitle>IP Version 6 Addressing
721
Architecture</citetitle>
726
<term>Section 2.2: <citetitle>Text Representation of
727
Addresses</citetitle></term>
728
<listitem><para/></listitem>
731
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
732
Address</citetitle></term>
733
<listitem><para/></listitem>
736
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
737
Addresses</citetitle></term>
740
The clients use IPv6 link-local addresses, which are
741
immediately usable since a link-local addresses is
742
automatically assigned to a network interfaces when it
752
RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
Protocol Version 1.2</citetitle>
757
TLS 1.2 is the protocol implemented by GnuTLS.
763
RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
767
The data sent to clients is binary encrypted OpenPGP data.
773
RFC 7250: <citetitle>Using Raw Public Keys in Transport
774
Layer Security (TLS) and Datagram Transport Layer Security
779
This is implemented by GnuTLS version 3.6.6 and is, if
780
present, used by this server so that raw public keys can be
787
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
Security (TLS) Authentication</citetitle>
792
This is implemented by GnuTLS before version 3.6.0 and is,
793
if present, used by this server so that OpenPGP keys can be
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>
801
<!-- Local Variables: -->
802
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
803
<!-- time-stamp-end: "[\"']>" -->
804
<!-- time-stamp-format: "%:y-%02m-%02d" -->