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