To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos.xml
- browse files at revision 963
- compare with another revision
- download diff
- download tarball
- view history from revision 963
- Committer: Teddy Hogeborn
- Date: 2019-02-09 23:31:44 UTC
- Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.
- files added:
- bugs.xml
- debian/upstream
- 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-08-08">
5
<!ENTITY TIMESTAMP "2019-02-09">
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>
38
45
<holder>Teddy Hogeborn</holder>
39
46
<holder>Björn Påhlsson</holder>
40
47
</copyright>
94
101
<arg><option>--no-dbus</option></arg>
95
102
<sbr/>
96
103
<arg><option>--no-ipv6</option></arg>
104
<sbr/>
105
<arg><option>--no-restore</option></arg>
106
<sbr/>
107
<arg><option>--statedir
108
<replaceable>DIRECTORY</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--socket
111
<replaceable>FD</replaceable></option></arg>
112
<sbr/>
113
<arg><option>--foreground</option></arg>
114
<sbr/>
115
<arg><option>--no-zeroconf</option></arg>
97
116
</cmdsynopsis>
98
117
<cmdsynopsis>
99
118
<command>&COMMANDNAME;</command>
275
294
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
276
295
</listitem>
277
296
</varlistentry>
297
298
<varlistentry>
299
<term><option>--no-restore</option></term>
300
<listitem>
301
<xi:include href="mandos-options.xml" xpointer="restore"/>
302
<para>
303
See also <xref linkend="persistent_state"/>.
304
</para>
305
</listitem>
306
</varlistentry>
307
308
<varlistentry>
309
<term><option>--statedir
310
<replaceable>DIRECTORY</replaceable></option></term>
311
<listitem>
312
<xi:include href="mandos-options.xml" xpointer="statedir"/>
313
</listitem>
314
</varlistentry>
315
316
<varlistentry>
317
<term><option>--socket
318
<replaceable>FD</replaceable></option></term>
319
<listitem>
320
<xi:include href="mandos-options.xml" xpointer="socket"/>
321
</listitem>
322
</varlistentry>
323
324
<varlistentry>
325
<term><option>--foreground</option></term>
326
<listitem>
327
<xi:include href="mandos-options.xml"
328
xpointer="foreground"/>
329
</listitem>
330
</varlistentry>
331
332
<varlistentry>
333
<term><option>--no-zeroconf</option></term>
334
<listitem>
335
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
</listitem>
337
</varlistentry>
338
278
339
</variablelist>
279
340
</refsect1>
280
341
300
361
start a TLS protocol handshake with a slight quirk: the Mandos
301
362
server program acts as a TLS <quote>client</quote> while the
302
363
connecting Mandos client acts as a TLS <quote>server</quote>.
303
The Mandos client must supply an OpenPGP certificate, and the
304
fingerprint of this certificate is used by the Mandos server to
305
look up (in a list read from <filename>clients.conf</filename>
306
at start time) which binary blob to give the client. No other
307
authentication or authorization is done by the server.
364
The Mandos client must supply a TLS public key, and the key ID
365
of this public key is used by the Mandos server to look up (in a
366
list read from <filename>clients.conf</filename> at start time)
367
which binary blob to give the client. No other authentication
368
or authorization is done by the server.
308
369
</para>
309
370
<table>
310
371
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
330
391
</emphasis></entry>
331
392
</row>
332
393
<row>
333
<entry>OpenPGP public key (part of TLS handshake)</entry>
394
<entry>Public key (part of TLS handshake)</entry>
334
395
<entry>-><!-- → --></entry>
335
396
</row>
336
397
<row>
357
418
extended timeout, checker program, and interval between checks
358
419
can be configured both globally and per client; see
359
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
360
<manvolnum>5</manvolnum></citerefentry>. A client successfully
361
receiving its password will also be treated as a successful
362
checker run.
421
<manvolnum>5</manvolnum></citerefentry>.
363
422
</para>
364
423
</refsect1>
365
424
387
446
<title>LOGGING</title>
388
447
<para>
389
448
The server will send log message with various severity levels to
390
<filename>/dev/log</filename>. With the
449
<filename class="devicefile">/dev/log</filename>. With the
391
450
<option>--debug</option> option, it will log even more messages,
392
451
and also show them on the console.
393
452
</para>
394
453
</refsect1>
395
454
455
<refsect1 id="persistent_state">
456
<title>PERSISTENT STATE</title>
457
<para>
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.
464
</para>
465
</refsect1>
466
396
467
<refsect1 id="dbus_interface">
397
468
<title>D-BUS INTERFACE</title>
398
469
<para>
460
531
</listitem>
461
532
</varlistentry>
462
533
<varlistentry>
463
<term><filename>/var/run/mandos.pid</filename></term>
534
<term><filename>/run/mandos.pid</filename></term>
464
535
<listitem>
465
536
<para>
466
537
The file containing the process id of the
467
538
<command>&COMMANDNAME;</command> process started last.
468
</para>
469
</listitem>
470
</varlistentry>
471
<varlistentry>
472
<term><filename>/dev/log</filename></term>
539
<emphasis >Note:</emphasis> If the <filename
540
class="directory">/run</filename> directory does not
541
exist, <filename>/var/run/mandos.pid</filename> will be
542
used instead.
543
</para>
544
</listitem>
545
</varlistentry>
546
<varlistentry>
547
<term><filename
548
class="directory">/var/lib/mandos</filename></term>
549
<listitem>
550
<para>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
554
</para>
555
</listitem>
556
</varlistentry>
557
<varlistentry>
558
<term><filename class="devicefile">/dev/log</filename></term>
473
559
<listitem>
474
560
<para>
475
561
The Unix domain socket to where local syslog messages are
498
584
backtrace. This could be considered a feature.
499
585
</para>
500
586
<para>
501
Currently, if a client is disabled due to having timed out, the
502
server does not record this fact onto permanent storage. This
503
has some security implications, see <xref linkend="clients"/>.
504
</para>
505
<para>
506
587
There is no fine-grained control over logging and debug output.
507
588
</para>
508
<para>
509
Debug mode is conflated with running in the foreground.
510
</para>
511
<para>
512
The console log messages do not show a time stamp.
513
</para>
514
<para>
515
This server does not check the expire time of clients’ OpenPGP
516
keys.
517
</para>
589
<xi:include href="bugs.xml"/>
518
590
</refsect1>
519
591
520
592
<refsect1 id="example">
530
602
<informalexample>
531
603
<para>
532
604
Run the server in debug mode, read configuration files from
533
the <filename>~/mandos</filename> directory, and use the
534
Zeroconf service name <quote>Test</quote> to not collide with
535
any other official Mandos server on this host:
605
the <filename class="directory">~/mandos</filename> directory,
606
and use the Zeroconf service name <quote>Test</quote> to not
607
collide with any other official Mandos server on this host:
536
608
</para>
537
609
<para>
538
610
570
642
<title>CLIENTS</title>
571
643
<para>
572
644
The server only gives out its stored data to clients which
573
does have the OpenPGP key of the stored fingerprint. This is
574
guaranteed by the fact that the client sends its OpenPGP
575
public key in the TLS handshake; this ensures it to be
576
genuine. The server computes the fingerprint of the key
577
itself and looks up the fingerprint in its list of
578
clients. The <filename>clients.conf</filename> file (see
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>
650
file (see
579
651
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
580
652
<manvolnum>5</manvolnum></citerefentry>)
581
653
<emphasis>must</emphasis> be made non-readable by anyone
587
659
compromised if they are gone for too long.
588
660
</para>
589
661
<para>
590
If a client is compromised, its downtime should be duly noted
591
by the server which would therefore disable the client. But
592
if the server was ever restarted, it would re-read its client
593
list from its configuration file and again regard all clients
594
therein as enabled, and hence eligible to receive their
595
passwords. Therefore, be careful when restarting servers if
596
it is suspected that a client has, in fact, been compromised
597
by parties who may now be running a fake Mandos client with
598
the keys from the non-encrypted initial <acronym>RAM</acronym>
599
image of the client host. What should be done in that case
600
(if restarting the server program really is necessary) is to
601
stop the server program, edit the configuration file to omit
602
any suspect clients, and restart the server program.
603
</para>
604
<para>
605
662
For more details on client-side security, see
606
663
<citerefentry><refentrytitle>mandos-client</refentrytitle>
607
664
<manvolnum>8mandos</manvolnum></citerefentry>.
648
705
</varlistentry>
649
706
<varlistentry>
650
707
<term>
651
<ulink url="http://www.gnu.org/software/gnutls/"
652
>GnuTLS</ulink>
708
<ulink url="https://gnutls.org/">GnuTLS</ulink>
653
709
</term>
654
710
<listitem>
655
711
<para>
656
712
GnuTLS is the library this server uses to implement TLS for
657
713
communicating securely with the client, and at the same time
658
confidently get the client’s public OpenPGP key.
714
confidently get the client’s public key.
659
715
</para>
660
716
</listitem>
661
717
</varlistentry>
693
749
</varlistentry>
694
750
<varlistentry>
695
751
<term>
696
RFC 4346: <citetitle>The Transport Layer Security (TLS)
697
Protocol Version 1.1</citetitle>
752
RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
Protocol Version 1.2</citetitle>
698
754
</term>
699
755
<listitem>
700
756
<para>
701
TLS 1.1 is the protocol implemented by GnuTLS.
757
TLS 1.2 is the protocol implemented by GnuTLS.
702
758
</para>
703
759
</listitem>
704
760
</varlistentry>
714
770
</varlistentry>
715
771
<varlistentry>
716
772
<term>
717
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
718
Security</citetitle>
719
</term>
720
<listitem>
721
<para>
722
This is implemented by GnuTLS and used by this server so
723
that OpenPGP keys can be used.
773
RFC 7250: <citetitle>Using Raw Public Keys in Transport
774
Layer Security (TLS) and Datagram Transport Layer Security
775
(DTLS)</citetitle>
776
</term>
777
<listitem>
778
<para>
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
781
used.
782
</para>
783
</listitem>
784
</varlistentry>
785
<varlistentry>
786
<term>
787
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
788
Security (TLS) Authentication</citetitle>
789
</term>
790
<listitem>
791
<para>
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
794
used.
724
795
</para>
725
796
</listitem>
726
797
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0