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:
- bugs.xml
- 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 "2011-02-27">
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>
35
35
<year>2009</year>
36
36
<year>2010</year>
37
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>
38
46
<holder>Teddy Hogeborn</holder>
39
47
<holder>Björn Påhlsson</holder>
40
48
</copyright>
94
102
<arg><option>--no-dbus</option></arg>
95
103
<sbr/>
96
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>
97
117
</cmdsynopsis>
98
118
<cmdsynopsis>
99
119
<command>&COMMANDNAME;</command>
117
137
<para>
118
138
<command>&COMMANDNAME;</command> is a server daemon which
119
139
handles incoming request for passwords for a pre-defined list of
120
client host computers. The Mandos server uses Zeroconf to
121
announce itself on the local network, and uses TLS to
122
communicate securely with and to authenticate the clients. The
123
Mandos server uses IPv6 to allow Mandos clients to use IPv6
124
link-local addresses, since the clients will probably not have
125
any other addresses configured (see <xref linkend="overview"/>).
126
Any authenticated client is then given the stored pre-encrypted
127
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.
128
150
</para>
129
151
</refsect1>
130
152
273
295
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
296
</listitem>
275
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
276
340
</variablelist>
277
341
</refsect1>
278
342
298
362
start a TLS protocol handshake with a slight quirk: the Mandos
299
363
server program acts as a TLS <quote>client</quote> while the
300
364
connecting Mandos client acts as a TLS <quote>server</quote>.
301
The Mandos client must supply an OpenPGP certificate, and the
302
fingerprint of this certificate is used by the Mandos server to
303
look up (in a list read from <filename>clients.conf</filename>
304
at start time) which binary blob to give the client. No other
305
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.
306
370
</para>
307
371
<table>
308
372
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
328
392
</emphasis></entry>
329
393
</row>
330
394
<row>
331
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
<entry>Public key (part of TLS handshake)</entry>
332
396
<entry>-><!-- → --></entry>
333
397
</row>
334
398
<row>
352
416
for some time, the client is assumed to be compromised and is no
353
417
longer eligible to receive the encrypted password. (Manual
354
418
intervention is required to re-enable a client.) The timeout,
355
checker program, and interval between checks can be configured
356
both globally and per client; see <citerefentry>
357
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>. A client successfully
359
receiving its password will also be treated as a successful
360
checker run.
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>.
361
423
</para>
362
424
</refsect1>
363
425
385
447
<title>LOGGING</title>
386
448
<para>
387
449
The server will send log message with various severity levels to
388
<filename>/dev/log</filename>. With the
450
<filename class="devicefile">/dev/log</filename>. With the
389
451
<option>--debug</option> option, it will log even more messages,
390
452
and also show them on the console.
391
453
</para>
392
454
</refsect1>
393
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
394
468
<refsect1 id="dbus_interface">
395
469
<title>D-BUS INTERFACE</title>
396
470
<para>
458
532
</listitem>
459
533
</varlistentry>
460
534
<varlistentry>
461
<term><filename>/var/run/mandos.pid</filename></term>
535
<term><filename>/run/mandos.pid</filename></term>
462
536
<listitem>
463
537
<para>
464
538
The file containing the process id of the
465
539
<command>&COMMANDNAME;</command> process started last.
466
</para>
467
</listitem>
468
</varlistentry>
469
<varlistentry>
470
<term><filename>/dev/log</filename></term>
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>
471
560
<listitem>
472
561
<para>
473
562
The Unix domain socket to where local syslog messages are
496
585
backtrace. This could be considered a feature.
497
586
</para>
498
587
<para>
499
Currently, if a client is disabled due to having timed out, the
500
server does not record this fact onto permanent storage. This
501
has some security implications, see <xref linkend="clients"/>.
502
</para>
503
<para>
504
588
There is no fine-grained control over logging and debug output.
505
589
</para>
506
<para>
507
Debug mode is conflated with running in the foreground.
508
</para>
509
<para>
510
The console log messages do not show a time stamp.
511
</para>
512
<para>
513
This server does not check the expire time of clients’ OpenPGP
514
keys.
515
</para>
590
<xi:include href="bugs.xml"/>
516
591
</refsect1>
517
592
518
593
<refsect1 id="example">
528
603
<informalexample>
529
604
<para>
530
605
Run the server in debug mode, read configuration files from
531
the <filename>~/mandos</filename> directory, and use the
532
Zeroconf service name <quote>Test</quote> to not collide with
533
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:
534
609
</para>
535
610
<para>
536
611
568
643
<title>CLIENTS</title>
569
644
<para>
570
645
The server only gives out its stored data to clients which
571
does have the OpenPGP key of the stored fingerprint. This is
572
guaranteed by the fact that the client sends its OpenPGP
573
public key in the TLS handshake; this ensures it to be
574
genuine. The server computes the fingerprint of the key
575
itself and looks up the fingerprint in its list of
576
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
577
652
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
578
653
<manvolnum>5</manvolnum></citerefentry>)
579
654
<emphasis>must</emphasis> be made non-readable by anyone
585
660
compromised if they are gone for too long.
586
661
</para>
587
662
<para>
588
If a client is compromised, its downtime should be duly noted
589
by the server which would therefore disable the client. But
590
if the server was ever restarted, it would re-read its client
591
list from its configuration file and again regard all clients
592
therein as enabled, and hence eligible to receive their
593
passwords. Therefore, be careful when restarting servers if
594
it is suspected that a client has, in fact, been compromised
595
by parties who may now be running a fake Mandos client with
596
the keys from the non-encrypted initial <acronym>RAM</acronym>
597
image of the client host. What should be done in that case
598
(if restarting the server program really is necessary) is to
599
stop the server program, edit the configuration file to omit
600
any suspect clients, and restart the server program.
601
</para>
602
<para>
603
663
For more details on client-side security, see
604
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
605
665
<manvolnum>8mandos</manvolnum></citerefentry>.
610
670
<refsect1 id="see_also">
611
671
<title>SEE ALSO</title>
612
672
<para>
613
<citerefentry>
614
<refentrytitle>mandos-clients.conf</refentrytitle>
615
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
<refentrytitle>mandos.conf</refentrytitle>
617
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
<refentrytitle>mandos-client</refentrytitle>
619
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
</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>
622
683
</para>
623
684
<variablelist>
624
685
<varlistentry>
634
695
</varlistentry>
635
696
<varlistentry>
636
697
<term>
637
<ulink url="http://www.avahi.org/">Avahi</ulink>
698
<ulink url="https://www.avahi.org/">Avahi</ulink>
638
699
</term>
639
700
<listitem>
640
701
<para>
645
706
</varlistentry>
646
707
<varlistentry>
647
708
<term>
648
<ulink url="http://www.gnu.org/software/gnutls/"
649
>GnuTLS</ulink>
709
<ulink url="https://gnutls.org/">GnuTLS</ulink>
650
710
</term>
651
711
<listitem>
652
712
<para>
653
713
GnuTLS is the library this server uses to implement TLS for
654
714
communicating securely with the client, and at the same time
655
confidently get the client’s public OpenPGP key.
715
confidently get the client’s public key.
656
716
</para>
657
717
</listitem>
658
718
</varlistentry>
690
750
</varlistentry>
691
751
<varlistentry>
692
752
<term>
693
RFC 4346: <citetitle>The Transport Layer Security (TLS)
694
Protocol Version 1.1</citetitle>
753
RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
Protocol Version 1.2</citetitle>
695
755
</term>
696
756
<listitem>
697
757
<para>
698
TLS 1.1 is the protocol implemented by GnuTLS.
758
TLS 1.2 is the protocol implemented by GnuTLS.
699
759
</para>
700
760
</listitem>
701
761
</varlistentry>
711
771
</varlistentry>
712
772
<varlistentry>
713
773
<term>
714
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
715
Security</citetitle>
716
</term>
717
<listitem>
718
<para>
719
This is implemented by GnuTLS and used by this server so
720
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.
721
796
</para>
722
797
</listitem>
723
798
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0