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 414
- compare with another revision
- download diff
- download tarball
- view history from revision 414
- Committer: Teddy Hogeborn
- Date: 2025-06-27 19:57:27 UTC
- mfrom: (237.7.868 trunk)
- Revision ID: teddy@recompile.se-20250627195727-wmn5jvu20sor29ts
Merge from trunk
- files added:
- DBUS-API
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- debian/mandos-client.config
- files renamed:
- mandos-list => mandos-ctl
- 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 "2025-06-27">
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>
46
<year>2020</year>
47
<year>2021</year>
48
<year>2022</year>
36
49
<holder>Teddy Hogeborn</holder>
37
50
<holder>Björn Påhlsson</holder>
38
51
</copyright>
86
99
<sbr/>
87
100
<arg><option>--debug</option></arg>
88
101
<sbr/>
102
<arg><option>--debuglevel
103
<replaceable>LEVEL</replaceable></option></arg>
104
<sbr/>
89
105
<arg><option>--no-dbus</option></arg>
106
<sbr/>
107
<arg><option>--no-ipv6</option></arg>
108
<sbr/>
109
<arg><option>--no-restore</option></arg>
110
<sbr/>
111
<arg><option>--statedir
112
<replaceable>DIRECTORY</replaceable></option></arg>
113
<sbr/>
114
<arg><option>--socket
115
<replaceable>FD</replaceable></option></arg>
116
<sbr/>
117
<arg><option>--foreground</option></arg>
118
<sbr/>
119
<arg><option>--no-zeroconf</option></arg>
90
120
</cmdsynopsis>
91
121
<cmdsynopsis>
92
122
<command>&COMMANDNAME;</command>
109
139
<title>DESCRIPTION</title>
110
140
<para>
111
141
<command>&COMMANDNAME;</command> is a server daemon which
112
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.
142
handles incoming requests for passwords for a pre-defined list
143
of client host computers. For an introduction, see
144
<citerefentry><refentrytitle>intro</refentrytitle>
145
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
146
uses Zeroconf to announce itself on the local network, and uses
147
TLS to communicate securely with and to authenticate the
148
clients. The Mandos server uses IPv6 to allow Mandos clients to
149
use IPv6 link-local addresses, since the clients will probably
150
not have any other addresses configured (see <xref
151
linkend="overview"/>). Any authenticated client is then given
152
the stored pre-encrypted password for that specific client.
121
153
</para>
122
154
</refsect1>
123
155
192
224
</varlistentry>
193
225
194
226
<varlistentry>
227
<term><option>--debuglevel
228
<replaceable>LEVEL</replaceable></option></term>
229
<listitem>
230
<para>
231
Set the debugging log level.
232
<replaceable>LEVEL</replaceable> is a string, one of
233
<quote><literal>CRITICAL</literal></quote>,
234
<quote><literal>ERROR</literal></quote>,
235
<quote><literal>WARNING</literal></quote>,
236
<quote><literal>INFO</literal></quote>, or
237
<quote><literal>DEBUG</literal></quote>, in order of
238
increasing verbosity. The default level is
239
<quote><literal>WARNING</literal></quote>.
240
</para>
241
</listitem>
242
</varlistentry>
243
244
<varlistentry>
195
245
<term><option>--priority <replaceable>
196
246
PRIORITY</replaceable></option></term>
197
247
<listitem>
241
291
</para>
242
292
</listitem>
243
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--no-ipv6</option></term>
297
<listitem>
298
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
299
</listitem>
300
</varlistentry>
301
302
<varlistentry>
303
<term><option>--no-restore</option></term>
304
<listitem>
305
<xi:include href="mandos-options.xml" xpointer="restore"/>
306
<para>
307
See also <xref linkend="persistent_state"/>.
308
</para>
309
</listitem>
310
</varlistentry>
311
312
<varlistentry>
313
<term><option>--statedir
314
<replaceable>DIRECTORY</replaceable></option></term>
315
<listitem>
316
<xi:include href="mandos-options.xml" xpointer="statedir"/>
317
</listitem>
318
</varlistentry>
319
320
<varlistentry>
321
<term><option>--socket
322
<replaceable>FD</replaceable></option></term>
323
<listitem>
324
<xi:include href="mandos-options.xml" xpointer="socket"/>
325
</listitem>
326
</varlistentry>
327
328
<varlistentry>
329
<term><option>--foreground</option></term>
330
<listitem>
331
<xi:include href="mandos-options.xml"
332
xpointer="foreground"/>
333
</listitem>
334
</varlistentry>
335
336
<varlistentry>
337
<term><option>--no-zeroconf</option></term>
338
<listitem>
339
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
340
</listitem>
341
</varlistentry>
342
244
343
</variablelist>
245
344
</refsect1>
246
345
266
365
start a TLS protocol handshake with a slight quirk: the Mandos
267
366
server program acts as a TLS <quote>client</quote> while the
268
367
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.
368
The Mandos client must supply a TLS public key, and the key ID
369
of this public key is used by the Mandos server to look up (in a
370
list read from <filename>clients.conf</filename> at start time)
371
which binary blob to give the client. No other authentication
372
or authorization is done by the server.
274
373
</para>
275
374
<table>
276
375
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
296
395
</emphasis></entry>
297
396
</row>
298
397
<row>
299
<entry>OpenPGP public key (part of TLS handshake)</entry>
398
<entry>Public key (part of TLS handshake)</entry>
300
399
<entry>-><!-- → --></entry>
301
400
</row>
302
401
<row>
318
417
The server will, by default, continually check that the clients
319
418
are still up. If a client has not been confirmed as being up
320
419
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>
420
longer eligible to receive the encrypted password. (Manual
421
intervention is required to re-enable a client.) The timeout,
422
extended timeout, checker program, and interval between checks
423
can be configured both globally and per client; see
424
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
425
<manvolnum>5</manvolnum></citerefentry>.
426
</para>
427
</refsect1>
428
429
<refsect1 id="approval">
430
<title>APPROVAL</title>
431
<para>
432
The server can be configured to require manual approval for a
433
client before it is sent its secret. The delay to wait for such
434
approval and the default action (approve or deny) can be
435
configured both globally and per client; see <citerefentry>
324
436
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
437
<manvolnum>5</manvolnum></citerefentry>. By default all clients
438
will be approved immediately without delay.
439
</para>
440
<para>
441
This can be used to deny a client its secret if not manually
442
approved within a specified time. It can also be used to make
443
the server delay before giving a client its secret, allowing
444
optional manual denying of this specific client.
445
</para>
446
327
447
</refsect1>
328
448
329
449
<refsect1 id="logging">
330
450
<title>LOGGING</title>
331
451
<para>
332
452
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
453
<filename class="devicefile">/dev/log</filename>. With the
334
454
<option>--debug</option> option, it will log even more messages,
335
455
and also show them on the console.
336
456
</para>
337
457
</refsect1>
338
458
459
<refsect1 id="persistent_state">
460
<title>PERSISTENT STATE</title>
461
<para>
462
Client settings, initially read from
463
<filename>clients.conf</filename>, are persistent across
464
restarts, and run-time changes will override settings in
465
<filename>clients.conf</filename>. However, if a setting is
466
<emphasis>changed</emphasis> (or a client added, or removed) in
467
<filename>clients.conf</filename>, this will take precedence.
468
</para>
469
</refsect1>
470
339
471
<refsect1 id="dbus_interface">
340
472
<title>D-BUS INTERFACE</title>
341
473
<para>
342
474
The server will by default provide a D-Bus system bus interface.
343
475
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
476
Mandos-specific user, if such a user exists. For documentation
477
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
478
</para>
347
479
</refsect1>
348
480
349
481
<refsect1 id="exit_status">
350
482
<title>EXIT STATUS</title>
351
483
<para>
403
535
</listitem>
404
536
</varlistentry>
405
537
<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>
538
<term><filename>/run/mandos.pid</filename></term>
539
<listitem>
540
<para>
541
The file containing the process id of the
542
<command>&COMMANDNAME;</command> process started last.
543
<emphasis >Note:</emphasis> If the <filename
544
class="directory">/run</filename> directory does not
545
exist, <filename>/var/run/mandos.pid</filename> will be
546
used instead.
547
</para>
548
</listitem>
549
</varlistentry>
550
<varlistentry>
551
<term><filename
552
class="directory">/var/lib/mandos</filename></term>
553
<listitem>
554
<para>
555
Directory where persistent state will be saved. Change
556
this with the <option>--statedir</option> option. See
557
also the <option>--no-restore</option> option.
558
</para>
559
</listitem>
560
</varlistentry>
561
<varlistentry>
562
<term><filename class="devicefile">/dev/log</filename></term>
416
563
<listitem>
417
564
<para>
418
565
The Unix domain socket to where local syslog messages are
441
588
backtrace. This could be considered a feature.
442
589
</para>
443
590
<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
591
There is no fine-grained control over logging and debug output.
456
592
</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>
593
<xi:include href="bugs.xml"/>
467
594
</refsect1>
468
595
469
596
<refsect1 id="example">
479
606
<informalexample>
480
607
<para>
481
608
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:
609
the <filename class="directory">~/mandos</filename> directory,
610
and use the Zeroconf service name <quote>Test</quote> to not
611
collide with any other official Mandos server on this host:
485
612
</para>
486
613
<para>
487
614
519
646
<title>CLIENTS</title>
520
647
<para>
521
648
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
649
does have the correct key ID of the stored key ID. This is
650
guaranteed by the fact that the client sends its public key in
651
the TLS handshake; this ensures it to be genuine. The server
652
computes the key ID of the key itself and looks up the key ID
653
in its list of clients. The <filename>clients.conf</filename>
654
file (see
528
655
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
656
<manvolnum>5</manvolnum></citerefentry>)
530
657
<emphasis>must</emphasis> be made non-readable by anyone
536
663
compromised if they are gone for too long.
537
664
</para>
538
665
<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
666
For more details on client-side security, see
556
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
668
<manvolnum>8mandos</manvolnum></citerefentry>.
562
673
<refsect1 id="see_also">
563
674
<title>SEE ALSO</title>
564
675
<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>
676
<citerefentry><refentrytitle>intro</refentrytitle>
677
<manvolnum>8mandos</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
<manvolnum>5</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>mandos-client</refentrytitle>
683
<manvolnum>8mandos</manvolnum></citerefentry>,
684
<citerefentry><refentrytitle>sh</refentrytitle>
685
<manvolnum>1</manvolnum></citerefentry>
574
686
</para>
575
687
<variablelist>
576
688
<varlistentry>
586
698
</varlistentry>
587
699
<varlistentry>
588
700
<term>
589
<ulink url="http://www.avahi.org/">Avahi</ulink>
701
<ulink url="https://www.avahi.org/">Avahi</ulink>
590
702
</term>
591
703
<listitem>
592
704
<para>
597
709
</varlistentry>
598
710
<varlistentry>
599
711
<term>
600
<ulink url="http://www.gnu.org/software/gnutls/"
601
>GnuTLS</ulink>
712
<ulink url="https://gnutls.org/">GnuTLS</ulink>
602
713
</term>
603
714
<listitem>
604
715
<para>
605
716
GnuTLS is the library this server uses to implement TLS for
606
717
communicating securely with the client, and at the same time
607
confidently get the client’s public OpenPGP key.
718
confidently get the client’s public key.
608
719
</para>
609
720
</listitem>
610
721
</varlistentry>
631
742
<listitem>
632
743
<para>
633
744
The clients use IPv6 link-local addresses, which are
634
immediately usable since a link-local addresses is
745
immediately usable since a link-local address is
635
746
automatically assigned to a network interfaces when it
636
747
is brought up.
637
748
</para>
642
753
</varlistentry>
643
754
<varlistentry>
644
755
<term>
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>
756
RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
Protocol Version 1.2</citetitle>
647
758
</term>
648
759
<listitem>
649
760
<para>
650
TLS 1.1 is the protocol implemented by GnuTLS.
761
TLS 1.2 is the protocol implemented by GnuTLS.
651
762
</para>
652
763
</listitem>
653
764
</varlistentry>
663
774
</varlistentry>
664
775
<varlistentry>
665
776
<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.
777
RFC 7250: <citetitle>Using Raw Public Keys in Transport
778
Layer Security (TLS) and Datagram Transport Layer Security
779
(DTLS)</citetitle>
780
</term>
781
<listitem>
782
<para>
783
This is implemented by GnuTLS version 3.6.6 and is, if
784
present, used by this server so that raw public keys can be
785
used.
786
</para>
787
</listitem>
788
</varlistentry>
789
<varlistentry>
790
<term>
791
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
792
Security (TLS) Authentication</citetitle>
793
</term>
794
<listitem>
795
<para>
796
This is implemented by GnuTLS before version 3.6.0 and is,
797
if present, used by this server so that OpenPGP keys can be
798
used.
673
799
</para>
674
800
</listitem>
675
801
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.3