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 981
- compare with another revision
- download diff
- download tarball
- view history from revision 981
- Committer: Teddy Hogeborn
- Date: 2019-02-11 11:59:08 UTC
- mfrom: (237.4.110 release)
- Revision ID: teddy@recompile.se-20190211115908-xu166gaay21j3coa
Merge from release branch
- files added:
- bugs.xml
- debian/source
- 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 "2010-09-25">
5
<!ENTITY TIMESTAMP "2019-02-10">
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>
90
103
<sbr/>
91
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>
92
117
</cmdsynopsis>
93
118
<cmdsynopsis>
94
119
<command>&COMMANDNAME;</command>
112
137
<para>
113
138
<command>&COMMANDNAME;</command> is a server daemon which
114
139
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
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.
123
150
</para>
124
151
</refsect1>
125
152
194
221
</varlistentry>
195
222
196
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>
197
242
<term><option>--priority <replaceable>
198
243
PRIORITY</replaceable></option></term>
199
244
<listitem>
250
295
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
296
</listitem>
252
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
253
340
</variablelist>
254
341
</refsect1>
255
342
275
362
start a TLS protocol handshake with a slight quirk: the Mandos
276
363
server program acts as a TLS <quote>client</quote> while the
277
364
connecting Mandos client acts as a TLS <quote>server</quote>.
278
The Mandos client must supply an OpenPGP certificate, and the
279
fingerprint of this certificate is used by the Mandos server to
280
look up (in a list read from <filename>clients.conf</filename>
281
at start time) which binary blob to give the client. No other
282
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.
283
370
</para>
284
371
<table>
285
372
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
305
392
</emphasis></entry>
306
393
</row>
307
394
<row>
308
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
<entry>Public key (part of TLS handshake)</entry>
309
396
<entry>-><!-- → --></entry>
310
397
</row>
311
398
<row>
329
416
for some time, the client is assumed to be compromised and is no
330
417
longer eligible to receive the encrypted password. (Manual
331
418
intervention is required to re-enable a client.) The timeout,
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
334
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
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>.
338
423
</para>
339
424
</refsect1>
340
425
362
447
<title>LOGGING</title>
363
448
<para>
364
449
The server will send log message with various severity levels to
365
<filename>/dev/log</filename>. With the
450
<filename class="devicefile">/dev/log</filename>. With the
366
451
<option>--debug</option> option, it will log even more messages,
367
452
and also show them on the console.
368
453
</para>
369
454
</refsect1>
370
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
371
468
<refsect1 id="dbus_interface">
372
469
<title>D-BUS INTERFACE</title>
373
470
<para>
435
532
</listitem>
436
533
</varlistentry>
437
534
<varlistentry>
438
<term><filename>/var/run/mandos.pid</filename></term>
535
<term><filename>/run/mandos.pid</filename></term>
439
536
<listitem>
440
537
<para>
441
538
The file containing the process id of the
442
539
<command>&COMMANDNAME;</command> process started last.
443
</para>
444
</listitem>
445
</varlistentry>
446
<varlistentry>
447
<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>
448
560
<listitem>
449
561
<para>
450
562
The Unix domain socket to where local syslog messages are
473
585
backtrace. This could be considered a feature.
474
586
</para>
475
587
<para>
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
479
</para>
480
<para>
481
588
There is no fine-grained control over logging and debug output.
482
589
</para>
483
<para>
484
Debug mode is conflated with running in the foreground.
485
</para>
486
<para>
487
The console log messages do not show a time stamp.
488
</para>
489
<para>
490
This server does not check the expire time of clients’ OpenPGP
491
keys.
492
</para>
590
<xi:include href="bugs.xml"/>
493
591
</refsect1>
494
592
495
593
<refsect1 id="example">
505
603
<informalexample>
506
604
<para>
507
605
Run the server in debug mode, read configuration files from
508
the <filename>~/mandos</filename> directory, and use the
509
Zeroconf service name <quote>Test</quote> to not collide with
510
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:
511
609
</para>
512
610
<para>
513
611
545
643
<title>CLIENTS</title>
546
644
<para>
547
645
The server only gives out its stored data to clients which
548
does have the OpenPGP key of the stored fingerprint. This is
549
guaranteed by the fact that the client sends its OpenPGP
550
public key in the TLS handshake; this ensures it to be
551
genuine. The server computes the fingerprint of the key
552
itself and looks up the fingerprint in its list of
553
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
554
652
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
555
653
<manvolnum>5</manvolnum></citerefentry>)
556
654
<emphasis>must</emphasis> be made non-readable by anyone
562
660
compromised if they are gone for too long.
563
661
</para>
564
662
<para>
565
If a client is compromised, its downtime should be duly noted
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
574
image of the client host. What should be done in that case
575
(if restarting the server program really is necessary) is to
576
stop the server program, edit the configuration file to omit
577
any suspect clients, and restart the server program.
578
</para>
579
<para>
580
663
For more details on client-side security, see
581
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
582
665
<manvolnum>8mandos</manvolnum></citerefentry>.
587
670
<refsect1 id="see_also">
588
671
<title>SEE ALSO</title>
589
672
<para>
590
<citerefentry>
591
<refentrytitle>mandos-clients.conf</refentrytitle>
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
593
<refentrytitle>mandos.conf</refentrytitle>
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
595
<refentrytitle>mandos-client</refentrytitle>
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
598
</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>
599
683
</para>
600
684
<variablelist>
601
685
<varlistentry>
622
706
</varlistentry>
623
707
<varlistentry>
624
708
<term>
625
<ulink url="http://www.gnu.org/software/gnutls/"
626
>GnuTLS</ulink>
709
<ulink url="https://gnutls.org/">GnuTLS</ulink>
627
710
</term>
628
711
<listitem>
629
712
<para>
630
713
GnuTLS is the library this server uses to implement TLS for
631
714
communicating securely with the client, and at the same time
632
confidently get the client’s public OpenPGP key.
715
confidently get the client’s public key.
633
716
</para>
634
717
</listitem>
635
718
</varlistentry>
667
750
</varlistentry>
668
751
<varlistentry>
669
752
<term>
670
RFC 4346: <citetitle>The Transport Layer Security (TLS)
671
Protocol Version 1.1</citetitle>
753
RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
Protocol Version 1.2</citetitle>
672
755
</term>
673
756
<listitem>
674
757
<para>
675
TLS 1.1 is the protocol implemented by GnuTLS.
758
TLS 1.2 is the protocol implemented by GnuTLS.
676
759
</para>
677
760
</listitem>
678
761
</varlistentry>
688
771
</varlistentry>
689
772
<varlistentry>
690
773
<term>
691
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
692
Security</citetitle>
693
</term>
694
<listitem>
695
<para>
696
This is implemented by GnuTLS and used by this server so
697
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.
698
796
</para>
699
797
</listitem>
700
798
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0