To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos.xml
- browse files at revision 386
- compare with another revision
- download diff
- download tarball
- view history from revision 386
- Committer: Teddy Hogeborn
- Date: 2019-08-03 12:40:59 UTC
- mfrom: (237.7.692 trunk)
- Revision ID: teddy@recompile.se-20190803124059-z12hb7q97uc74ydk
Merge from trunk
- files added:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files modified:
- .bzrignore
added
removed
mandos.xml
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
4
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2009-01-04">
5
<!ENTITY TIMESTAMP "2019-07-24">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
<firstname>Björn</firstname>
20
20
<surname>Påhlsson</surname>
21
21
<address>
22
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
23
23
</address>
24
24
</author>
25
25
<author>
26
26
<firstname>Teddy</firstname>
27
27
<surname>Hogeborn</surname>
28
28
<address>
29
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
30
30
</address>
31
31
</author>
32
32
</authorgroup>
33
33
<copyright>
34
34
<year>2008</year>
35
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
38
<year>2012</year>
39
<year>2013</year>
40
<year>2014</year>
41
<year>2015</year>
42
<year>2016</year>
43
<year>2017</year>
44
<year>2018</year>
45
<year>2019</year>
36
46
<holder>Teddy Hogeborn</holder>
37
47
<holder>Björn Påhlsson</holder>
38
48
</copyright>
86
96
<sbr/>
87
97
<arg><option>--debug</option></arg>
88
98
<sbr/>
99
<arg><option>--debuglevel
100
<replaceable>LEVEL</replaceable></option></arg>
101
<sbr/>
89
102
<arg><option>--no-dbus</option></arg>
103
<sbr/>
104
<arg><option>--no-ipv6</option></arg>
105
<sbr/>
106
<arg><option>--no-restore</option></arg>
107
<sbr/>
108
<arg><option>--statedir
109
<replaceable>DIRECTORY</replaceable></option></arg>
110
<sbr/>
111
<arg><option>--socket
112
<replaceable>FD</replaceable></option></arg>
113
<sbr/>
114
<arg><option>--foreground</option></arg>
115
<sbr/>
116
<arg><option>--no-zeroconf</option></arg>
90
117
</cmdsynopsis>
91
118
<cmdsynopsis>
92
119
<command>&COMMANDNAME;</command>
110
137
<para>
111
138
<command>&COMMANDNAME;</command> is a server daemon which
112
139
handles incoming request for passwords for a pre-defined list of
113
client host computers. The Mandos server uses Zeroconf to
114
announce itself on the local network, and uses TLS to
115
communicate securely with and to authenticate the clients. The
116
Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
link-local addresses, since the clients will probably not have
118
any other addresses configured (see <xref linkend="overview"/>).
119
Any authenticated client is then given the stored pre-encrypted
120
password for that specific client.
140
client host computers. For an introduction, see
141
<citerefentry><refentrytitle>intro</refentrytitle>
142
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
143
uses Zeroconf to announce itself on the local network, and uses
144
TLS to communicate securely with and to authenticate the
145
clients. The Mandos server uses IPv6 to allow Mandos clients to
146
use IPv6 link-local addresses, since the clients will probably
147
not have any other addresses configured (see <xref
148
linkend="overview"/>). Any authenticated client is then given
149
the stored pre-encrypted password for that specific client.
121
150
</para>
122
151
</refsect1>
123
152
192
221
</varlistentry>
193
222
194
223
<varlistentry>
224
<term><option>--debuglevel
225
<replaceable>LEVEL</replaceable></option></term>
226
<listitem>
227
<para>
228
Set the debugging log level.
229
<replaceable>LEVEL</replaceable> is a string, one of
230
<quote><literal>CRITICAL</literal></quote>,
231
<quote><literal>ERROR</literal></quote>,
232
<quote><literal>WARNING</literal></quote>,
233
<quote><literal>INFO</literal></quote>, or
234
<quote><literal>DEBUG</literal></quote>, in order of
235
increasing verbosity. The default level is
236
<quote><literal>WARNING</literal></quote>.
237
</para>
238
</listitem>
239
</varlistentry>
240
241
<varlistentry>
195
242
<term><option>--priority <replaceable>
196
243
PRIORITY</replaceable></option></term>
197
244
<listitem>
241
288
</para>
242
289
</listitem>
243
290
</varlistentry>
291
292
<varlistentry>
293
<term><option>--no-ipv6</option></term>
294
<listitem>
295
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
</listitem>
297
</varlistentry>
298
299
<varlistentry>
300
<term><option>--no-restore</option></term>
301
<listitem>
302
<xi:include href="mandos-options.xml" xpointer="restore"/>
303
<para>
304
See also <xref linkend="persistent_state"/>.
305
</para>
306
</listitem>
307
</varlistentry>
308
309
<varlistentry>
310
<term><option>--statedir
311
<replaceable>DIRECTORY</replaceable></option></term>
312
<listitem>
313
<xi:include href="mandos-options.xml" xpointer="statedir"/>
314
</listitem>
315
</varlistentry>
316
317
<varlistentry>
318
<term><option>--socket
319
<replaceable>FD</replaceable></option></term>
320
<listitem>
321
<xi:include href="mandos-options.xml" xpointer="socket"/>
322
</listitem>
323
</varlistentry>
324
325
<varlistentry>
326
<term><option>--foreground</option></term>
327
<listitem>
328
<xi:include href="mandos-options.xml"
329
xpointer="foreground"/>
330
</listitem>
331
</varlistentry>
332
333
<varlistentry>
334
<term><option>--no-zeroconf</option></term>
335
<listitem>
336
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
337
</listitem>
338
</varlistentry>
339
244
340
</variablelist>
245
341
</refsect1>
246
342
266
362
start a TLS protocol handshake with a slight quirk: the Mandos
267
363
server program acts as a TLS <quote>client</quote> while the
268
364
connecting Mandos client acts as a TLS <quote>server</quote>.
269
The Mandos client must supply an OpenPGP certificate, and the
270
fingerprint of this certificate is used by the Mandos server to
271
look up (in a list read from <filename>clients.conf</filename>
272
at start time) which binary blob to give the client. No other
273
authentication or authorization is done by the server.
365
The Mandos client must supply a TLS public key, and the key ID
366
of this public key is used by the Mandos server to look up (in a
367
list read from <filename>clients.conf</filename> at start time)
368
which binary blob to give the client. No other authentication
369
or authorization is done by the server.
274
370
</para>
275
371
<table>
276
372
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
296
392
</emphasis></entry>
297
393
</row>
298
394
<row>
299
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
<entry>Public key (part of TLS handshake)</entry>
300
396
<entry>-><!-- → --></entry>
301
397
</row>
302
398
<row>
318
414
The server will, by default, continually check that the clients
319
415
are still up. If a client has not been confirmed as being up
320
416
for some time, the client is assumed to be compromised and is no
321
longer eligible to receive the encrypted password. The timeout,
322
checker program, and interval between checks can be configured
323
both globally and per client; see <citerefentry>
417
longer eligible to receive the encrypted password. (Manual
418
intervention is required to re-enable a client.) The timeout,
419
extended timeout, checker program, and interval between checks
420
can be configured both globally and per client; see
421
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
422
<manvolnum>5</manvolnum></citerefentry>.
423
</para>
424
</refsect1>
425
426
<refsect1 id="approval">
427
<title>APPROVAL</title>
428
<para>
429
The server can be configured to require manual approval for a
430
client before it is sent its secret. The delay to wait for such
431
approval and the default action (approve or deny) can be
432
configured both globally and per client; see <citerefentry>
324
433
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
434
<manvolnum>5</manvolnum></citerefentry>. By default all clients
435
will be approved immediately without delay.
436
</para>
437
<para>
438
This can be used to deny a client its secret if not manually
439
approved within a specified time. It can also be used to make
440
the server delay before giving a client its secret, allowing
441
optional manual denying of this specific client.
442
</para>
443
327
444
</refsect1>
328
445
329
446
<refsect1 id="logging">
330
447
<title>LOGGING</title>
331
448
<para>
332
449
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
450
<filename class="devicefile">/dev/log</filename>. With the
334
451
<option>--debug</option> option, it will log even more messages,
335
452
and also show them on the console.
336
453
</para>
337
454
</refsect1>
338
455
456
<refsect1 id="persistent_state">
457
<title>PERSISTENT STATE</title>
458
<para>
459
Client settings, initially read from
460
<filename>clients.conf</filename>, are persistent across
461
restarts, and run-time changes will override settings in
462
<filename>clients.conf</filename>. However, if a setting is
463
<emphasis>changed</emphasis> (or a client added, or removed) in
464
<filename>clients.conf</filename>, this will take precedence.
465
</para>
466
</refsect1>
467
339
468
<refsect1 id="dbus_interface">
340
469
<title>D-BUS INTERFACE</title>
341
470
<para>
342
471
The server will by default provide a D-Bus system bus interface.
343
472
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
473
Mandos-specific user, if such a user exists. For documentation
474
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
475
</para>
347
476
</refsect1>
348
477
349
478
<refsect1 id="exit_status">
350
479
<title>EXIT STATUS</title>
351
480
<para>
403
532
</listitem>
404
533
</varlistentry>
405
534
<varlistentry>
406
<term><filename>/var/run/mandos.pid</filename></term>
407
<listitem>
408
<para>
409
The file containing the process id of
410
<command>&COMMANDNAME;</command>.
411
</para>
412
</listitem>
413
</varlistentry>
414
<varlistentry>
415
<term><filename>/dev/log</filename></term>
535
<term><filename>/run/mandos.pid</filename></term>
536
<listitem>
537
<para>
538
The file containing the process id of the
539
<command>&COMMANDNAME;</command> process started last.
540
<emphasis >Note:</emphasis> If the <filename
541
class="directory">/run</filename> directory does not
542
exist, <filename>/var/run/mandos.pid</filename> will be
543
used instead.
544
</para>
545
</listitem>
546
</varlistentry>
547
<varlistentry>
548
<term><filename
549
class="directory">/var/lib/mandos</filename></term>
550
<listitem>
551
<para>
552
Directory where persistent state will be saved. Change
553
this with the <option>--statedir</option> option. See
554
also the <option>--no-restore</option> option.
555
</para>
556
</listitem>
557
</varlistentry>
558
<varlistentry>
559
<term><filename class="devicefile">/dev/log</filename></term>
416
560
<listitem>
417
561
<para>
418
562
The Unix domain socket to where local syslog messages are
441
585
backtrace. This could be considered a feature.
442
586
</para>
443
587
<para>
444
Currently, if a client is declared <quote>invalid</quote> due to
445
having timed out, the server does not record this fact onto
446
permanent storage. This has some security implications, see
447
<xref linkend="clients"/>.
448
</para>
449
<para>
450
There is currently no way of querying the server of the current
451
status of clients, other than analyzing its <systemitem
452
class="service">syslog</systemitem> output.
453
</para>
454
<para>
455
588
There is no fine-grained control over logging and debug output.
456
589
</para>
457
<para>
458
Debug mode is conflated with running in the foreground.
459
</para>
460
<para>
461
The console log messages does not show a time stamp.
462
</para>
463
<para>
464
This server does not check the expire time of clients’ OpenPGP
465
keys.
466
</para>
590
<xi:include href="bugs.xml"/>
467
591
</refsect1>
468
592
469
593
<refsect1 id="example">
479
603
<informalexample>
480
604
<para>
481
605
Run the server in debug mode, read configuration files from
482
the <filename>~/mandos</filename> directory, and use the
483
Zeroconf service name <quote>Test</quote> to not collide with
484
any other official Mandos server on this host:
606
the <filename class="directory">~/mandos</filename> directory,
607
and use the Zeroconf service name <quote>Test</quote> to not
608
collide with any other official Mandos server on this host:
485
609
</para>
486
610
<para>
487
611
519
643
<title>CLIENTS</title>
520
644
<para>
521
645
The server only gives out its stored data to clients which
522
does have the OpenPGP key of the stored fingerprint. This is
523
guaranteed by the fact that the client sends its OpenPGP
524
public key in the TLS handshake; this ensures it to be
525
genuine. The server computes the fingerprint of the key
526
itself and looks up the fingerprint in its list of
527
clients. The <filename>clients.conf</filename> file (see
646
does have the correct key ID of the stored key ID. This is
647
guaranteed by the fact that the client sends its public key in
648
the TLS handshake; this ensures it to be genuine. The server
649
computes the key ID of the key itself and looks up the key ID
650
in its list of clients. The <filename>clients.conf</filename>
651
file (see
528
652
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
653
<manvolnum>5</manvolnum></citerefentry>)
530
654
<emphasis>must</emphasis> be made non-readable by anyone
536
660
compromised if they are gone for too long.
537
661
</para>
538
662
<para>
539
If a client is compromised, its downtime should be duly noted
540
by the server which would therefore declare the client
541
invalid. But if the server was ever restarted, it would
542
re-read its client list from its configuration file and again
543
regard all clients therein as valid, and hence eligible to
544
receive their passwords. Therefore, be careful when
545
restarting servers if it is suspected that a client has, in
546
fact, been compromised by parties who may now be running a
547
fake Mandos client with the keys from the non-encrypted
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
551
configuration file to omit any suspect clients, and restart
552
the server program.
553
</para>
554
<para>
555
663
For more details on client-side security, see
556
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
665
<manvolnum>8mandos</manvolnum></citerefentry>.
562
670
<refsect1 id="see_also">
563
671
<title>SEE ALSO</title>
564
672
<para>
565
<citerefentry>
566
<refentrytitle>mandos-clients.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos.conf</refentrytitle>
569
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
</citerefentry>
673
<citerefentry><refentrytitle>intro</refentrytitle>
674
<manvolnum>8mandos</manvolnum></citerefentry>,
675
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
<manvolnum>5</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos-client</refentrytitle>
680
<manvolnum>8mandos</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>sh</refentrytitle>
682
<manvolnum>1</manvolnum></citerefentry>
574
683
</para>
575
684
<variablelist>
576
685
<varlistentry>
586
695
</varlistentry>
587
696
<varlistentry>
588
697
<term>
589
<ulink url="http://www.avahi.org/">Avahi</ulink>
698
<ulink url="https://www.avahi.org/">Avahi</ulink>
590
699
</term>
591
700
<listitem>
592
701
<para>
597
706
</varlistentry>
598
707
<varlistentry>
599
708
<term>
600
<ulink url="http://www.gnu.org/software/gnutls/"
601
>GnuTLS</ulink>
709
<ulink url="https://gnutls.org/">GnuTLS</ulink>
602
710
</term>
603
711
<listitem>
604
712
<para>
605
713
GnuTLS is the library this server uses to implement TLS for
606
714
communicating securely with the client, and at the same time
607
confidently get the client’s public OpenPGP key.
715
confidently get the client’s public key.
608
716
</para>
609
717
</listitem>
610
718
</varlistentry>
642
750
</varlistentry>
643
751
<varlistentry>
644
752
<term>
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>
753
RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
Protocol Version 1.2</citetitle>
647
755
</term>
648
756
<listitem>
649
757
<para>
650
TLS 1.1 is the protocol implemented by GnuTLS.
758
TLS 1.2 is the protocol implemented by GnuTLS.
651
759
</para>
652
760
</listitem>
653
761
</varlistentry>
663
771
</varlistentry>
664
772
<varlistentry>
665
773
<term>
666
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
667
Security</citetitle>
668
</term>
669
<listitem>
670
<para>
671
This is implemented by GnuTLS and used by this server so
672
that OpenPGP keys can be used.
774
RFC 7250: <citetitle>Using Raw Public Keys in Transport
775
Layer Security (TLS) and Datagram Transport Layer Security
776
(DTLS)</citetitle>
777
</term>
778
<listitem>
779
<para>
780
This is implemented by GnuTLS version 3.6.6 and is, if
781
present, used by this server so that raw public keys can be
782
used.
783
</para>
784
</listitem>
785
</varlistentry>
786
<varlistentry>
787
<term>
788
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
789
Security (TLS) Authentication</citetitle>
790
</term>
791
<listitem>
792
<para>
793
This is implemented by GnuTLS before version 3.6.0 and is,
794
if present, used by this server so that OpenPGP keys can be
795
used.
673
796
</para>
674
797
</listitem>
675
798
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0