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 1278
- compare with another revision
- download diff
- download tarball
- view history from revision 1278
- Committer: Teddy Hogeborn
- Date: 2024-09-08 00:11:24 UTC
- Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements
* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.
* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/tests
- debian/upstream
- dracut-module
- network-hooks.d
- plugin-helpers
- files removed:
- initramfs-tools-hook-conf
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- files modified:
- .bzrignore
added
removed
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-09-04">
5
<!ENTITY TIMESTAMP "2022-04-24">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<refentryinfo>
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
16
17
<authorgroup>
17
18
<author>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
20
21
<address>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
22
23
</address>
23
24
</author>
24
25
<author>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
27
28
<address>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
29
30
</address>
30
31
</author>
31
32
</authorgroup>
32
33
<copyright>
33
34
<year>2008</year>
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>
34
46
<holder>Teddy Hogeborn</holder>
35
47
<holder>Björn Påhlsson</holder>
36
48
</copyright>
37
49
<xi:include href="legalnotice.xml"/>
38
50
</refentryinfo>
39
51
40
52
<refmeta>
41
53
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
54
<manvolnum>8</manvolnum>
48
60
Gives encrypted passwords to authenticated Mandos clients
49
61
</refpurpose>
50
62
</refnamediv>
51
63
52
64
<refsynopsisdiv>
53
65
<cmdsynopsis>
54
66
<command>&COMMANDNAME;</command>
83
95
<replaceable>DIRECTORY</replaceable></option></arg>
84
96
<sbr/>
85
97
<arg><option>--debug</option></arg>
98
<sbr/>
99
<arg><option>--debuglevel
100
<replaceable>LEVEL</replaceable></option></arg>
101
<sbr/>
102
<arg><option>--no-dbus</option></arg>
103
<sbr/>
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>
86
117
</cmdsynopsis>
87
118
<cmdsynopsis>
88
119
<command>&COMMANDNAME;</command>
100
131
<arg choice="plain"><option>--check</option></arg>
101
132
</cmdsynopsis>
102
133
</refsynopsisdiv>
103
134
104
135
<refsect1 id="description">
105
136
<title>DESCRIPTION</title>
106
137
<para>
107
138
<command>&COMMANDNAME;</command> is a server daemon which
108
handles incoming request for passwords for a pre-defined list of
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
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.
117
150
</para>
118
151
</refsect1>
119
152
186
219
<xi:include href="mandos-options.xml" xpointer="debug"/>
187
220
</listitem>
188
221
</varlistentry>
189
222
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
190
241
<varlistentry>
191
242
<term><option>--priority <replaceable>
192
243
PRIORITY</replaceable></option></term>
194
245
<xi:include href="mandos-options.xml" xpointer="priority"/>
195
246
</listitem>
196
247
</varlistentry>
197
248
198
249
<varlistentry>
199
250
<term><option>--servicename
200
251
<replaceable>NAME</replaceable></option></term>
203
254
xpointer="servicename"/>
204
255
</listitem>
205
256
</varlistentry>
206
257
207
258
<varlistentry>
208
259
<term><option>--configdir
209
260
<replaceable>DIRECTORY</replaceable></option></term>
218
269
</para>
219
270
</listitem>
220
271
</varlistentry>
221
272
222
273
<varlistentry>
223
274
<term><option>--version</option></term>
224
275
<listitem>
227
278
</para>
228
279
</listitem>
229
280
</varlistentry>
281
282
<varlistentry>
283
<term><option>--no-dbus</option></term>
284
<listitem>
285
<xi:include href="mandos-options.xml" xpointer="dbus"/>
286
<para>
287
See also <xref linkend="dbus_interface"/>.
288
</para>
289
</listitem>
290
</varlistentry>
291
292
<varlistentry>
293
<term><option>--no-ipv6</option></term>
294
<listitem>
295
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
296
</listitem>
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
230
340
</variablelist>
231
341
</refsect1>
232
342
233
343
<refsect1 id="overview">
234
344
<title>OVERVIEW</title>
235
345
<xi:include href="overview.xml"/>
239
349
<acronym>RAM</acronym> disk environment.
240
350
</para>
241
351
</refsect1>
242
352
243
353
<refsect1 id="protocol">
244
354
<title>NETWORK PROTOCOL</title>
245
355
<para>
252
362
start a TLS protocol handshake with a slight quirk: the Mandos
253
363
server program acts as a TLS <quote>client</quote> while the
254
364
connecting Mandos client acts as a TLS <quote>server</quote>.
255
The Mandos client must supply an OpenPGP certificate, and the
256
fingerprint of this certificate is used by the Mandos server to
257
look up (in a list read from <filename>clients.conf</filename>
258
at start time) which binary blob to give the client. No other
259
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.
260
370
</para>
261
371
<table>
262
372
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
282
392
</emphasis></entry>
283
393
</row>
284
394
<row>
285
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
<entry>Public key (part of TLS handshake)</entry>
286
396
<entry>-><!-- → --></entry>
287
397
</row>
288
398
<row>
297
407
</row>
298
408
</tbody></tgroup></table>
299
409
</refsect1>
300
410
301
411
<refsect1 id="checking">
302
412
<title>CHECKING</title>
303
413
<para>
304
414
The server will, by default, continually check that the clients
305
415
are still up. If a client has not been confirmed as being up
306
416
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
417
longer eligible to receive the encrypted password. (Manual
418
intervention is required to re-enable a client.) The timeout,
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>.
423
</para>
424
</refsect1>
425
426
<refsect1 id="approval">
427
<title>APPROVAL</title>
428
<para>
429
The server can be configured to require manual approval for a
430
client before it is sent its secret. The delay to wait for such
431
approval and the default action (approve or deny) can be
432
configured both globally and per client; see <citerefentry>
310
433
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</para>
434
<manvolnum>5</manvolnum></citerefentry>. By default all clients
435
will be approved immediately without delay.
436
</para>
437
<para>
438
This can be used to deny a client its secret if not manually
439
approved within a specified time. It can also be used to make
440
the server delay before giving a client its secret, allowing
441
optional manual denying of this specific client.
442
</para>
443
313
444
</refsect1>
314
445
315
446
<refsect1 id="logging">
316
447
<title>LOGGING</title>
317
448
<para>
318
449
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
450
<filename class="devicefile">/dev/log</filename>. With the
320
451
<option>--debug</option> option, it will log even more messages,
321
452
and also show them on the console.
322
453
</para>
323
454
</refsect1>
324
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
468
<refsect1 id="dbus_interface">
469
<title>D-BUS INTERFACE</title>
470
<para>
471
The server will by default provide a D-Bus system bus interface.
472
This interface will only be accessible by the root user or a
473
Mandos-specific user, if such a user exists. For documentation
474
of the D-Bus API, see the file <filename>DBUS-API</filename>.
475
</para>
476
</refsect1>
477
325
478
<refsect1 id="exit_status">
326
479
<title>EXIT STATUS</title>
327
480
<para>
329
482
critical error is encountered.
330
483
</para>
331
484
</refsect1>
332
485
333
486
<refsect1 id="environment">
334
487
<title>ENVIRONMENT</title>
335
488
<variablelist>
349
502
</varlistentry>
350
503
</variablelist>
351
504
</refsect1>
352
353
<refsect1 id="file">
505
506
<refsect1 id="files">
354
507
<title>FILES</title>
355
508
<para>
356
509
Use the <option>--configdir</option> option to change where
379
532
</listitem>
380
533
</varlistentry>
381
534
<varlistentry>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
383
<listitem>
384
<para>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
387
</para>
388
</listitem>
389
</varlistentry>
390
<varlistentry>
391
<term><filename>/dev/log</filename></term>
535
<term><filename>/run/mandos.pid</filename></term>
536
<listitem>
537
<para>
538
The file containing the process id of the
539
<command>&COMMANDNAME;</command> process started last.
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>
392
560
<listitem>
393
561
<para>
394
562
The Unix domain socket to where local syslog messages are
417
585
backtrace. This could be considered a feature.
418
586
</para>
419
587
<para>
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
424
</para>
425
<para>
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
429
</para>
430
<para>
431
588
There is no fine-grained control over logging and debug output.
432
589
</para>
433
<para>
434
Debug mode is conflated with running in the foreground.
435
</para>
436
<para>
437
The console log messages does not show a time stamp.
438
</para>
439
<para>
440
This server does not check the expire time of clients’ OpenPGP
441
keys.
442
</para>
590
<xi:include href="bugs.xml"/>
443
591
</refsect1>
444
592
445
593
<refsect1 id="example">
455
603
<informalexample>
456
604
<para>
457
605
Run the server in debug mode, read configuration files from
458
the <filename>~/mandos</filename> directory, and use the
459
Zeroconf service name <quote>Test</quote> to not collide with
460
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:
461
609
</para>
462
610
<para>
463
611
479
627
</para>
480
628
</informalexample>
481
629
</refsect1>
482
630
483
631
<refsect1 id="security">
484
632
<title>SECURITY</title>
485
<refsect2 id="SERVER">
633
<refsect2 id="server">
486
634
<title>SERVER</title>
487
635
<para>
488
636
Running this <command>&COMMANDNAME;</command> server program
489
637
should not in itself present any security risk to the host
490
computer running it. The program does not need any special
491
privileges to run, and is designed to run as a non-root user.
638
computer running it. The program switches to a non-root user
639
soon after startup.
492
640
</para>
493
641
</refsect2>
494
<refsect2 id="CLIENTS">
642
<refsect2 id="clients">
495
643
<title>CLIENTS</title>
496
644
<para>
497
645
The server only gives out its stored data to clients which
498
does have the OpenPGP key of the stored fingerprint. This is
499
guaranteed by the fact that the client sends its OpenPGP
500
public key in the TLS handshake; this ensures it to be
501
genuine. The server computes the fingerprint of the key
502
itself and looks up the fingerprint in its list of
503
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
504
652
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
653
<manvolnum>5</manvolnum></citerefentry>)
506
654
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
655
except the user starting the server (usually root).
508
656
</para>
509
657
<para>
510
658
As detailed in <xref linkend="checking"/>, the status of all
512
660
compromised if they are gone for too long.
513
661
</para>
514
662
<para>
515
If a client is compromised, its downtime should be duly noted
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
528
the server program.
529
</para>
530
<para>
531
663
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
665
<manvolnum>8mandos</manvolnum></citerefentry>.
534
666
</para>
535
667
</refsect2>
536
668
</refsect1>
537
669
538
670
<refsect1 id="see_also">
539
671
<title>SEE ALSO</title>
540
672
<para>
541
<citerefentry>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
</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>
550
683
</para>
551
684
<variablelist>
552
685
<varlistentry>
562
695
</varlistentry>
563
696
<varlistentry>
564
697
<term>
565
<ulink url="http://www.avahi.org/">Avahi</ulink>
698
<ulink url="https://www.avahi.org/">Avahi</ulink>
566
699
</term>
567
700
<listitem>
568
701
<para>
573
706
</varlistentry>
574
707
<varlistentry>
575
708
<term>
576
<ulink url="http://www.gnu.org/software/gnutls/"
577
>GnuTLS</ulink>
709
<ulink url="https://gnutls.org/">GnuTLS</ulink>
578
710
</term>
579
711
<listitem>
580
712
<para>
581
713
GnuTLS is the library this server uses to implement TLS for
582
714
communicating securely with the client, and at the same time
583
confidently get the client’s public OpenPGP key.
715
confidently get the client’s public key.
584
716
</para>
585
717
</listitem>
586
718
</varlistentry>
607
739
<listitem>
608
740
<para>
609
741
The clients use IPv6 link-local addresses, which are
610
immediately usable since a link-local addresses is
742
immediately usable since a link-local address is
611
743
automatically assigned to a network interfaces when it
612
744
is brought up.
613
745
</para>
618
750
</varlistentry>
619
751
<varlistentry>
620
752
<term>
621
RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
Protocol Version 1.1</citetitle>
753
RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
Protocol Version 1.2</citetitle>
623
755
</term>
624
756
<listitem>
625
757
<para>
626
TLS 1.1 is the protocol implemented by GnuTLS.
758
TLS 1.2 is the protocol implemented by GnuTLS.
627
759
</para>
628
760
</listitem>
629
761
</varlistentry>
639
771
</varlistentry>
640
772
<varlistentry>
641
773
<term>
642
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
Security</citetitle>
644
</term>
645
<listitem>
646
<para>
647
This is implemented by GnuTLS and used by this server so
648
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.
649
796
</para>
650
797
</listitem>
651
798
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0