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 24.1.172
- compare with another revision
- download diff
- download tarball
- view history from revision 24.1.172
- Committer: Björn Påhlsson
- Date: 2011-06-18 22:51:12 UTC
- mto: (237.7.33 trunk)
- mto: This revision was merged to the branch mainline in revision 284.
- Revision ID: belorn@fukt.bsnet.se-20110618225112-rnt2m4ek32758f80
using scandir instead of readdir
- files added:
- initramfs-tools-hook-conf
- files removed:
- bugs.xml
- debian/upstream
- network-hooks.d
- plugin-helpers
- 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 "2019-02-09">
5
<!ENTITY TIMESTAMP "2011-02-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@recompile.se</email>
22
<email>belorn@fukt.bsnet.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@recompile.se</email>
29
<email>teddy@fukt.bsnet.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>
45
38
<holder>Teddy Hogeborn</holder>
46
39
<holder>Björn Påhlsson</holder>
47
40
</copyright>
101
94
<arg><option>--no-dbus</option></arg>
102
95
<sbr/>
103
96
<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>
116
97
</cmdsynopsis>
117
98
<cmdsynopsis>
118
99
<command>&COMMANDNAME;</command>
136
117
<para>
137
118
<command>&COMMANDNAME;</command> is a server daemon which
138
119
handles incoming request for passwords for a pre-defined list of
139
client host computers. For an introduction, see
140
<citerefentry><refentrytitle>intro</refentrytitle>
141
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
uses Zeroconf to announce itself on the local network, and uses
143
TLS to communicate securely with and to authenticate the
144
clients. The Mandos server uses IPv6 to allow Mandos clients to
145
use IPv6 link-local addresses, since the clients will probably
146
not have any other addresses configured (see <xref
147
linkend="overview"/>). Any authenticated client is then given
148
the stored pre-encrypted password for that specific client.
120
client host computers. The Mandos server uses Zeroconf to
121
announce itself on the local network, and uses TLS to
122
communicate securely with and to authenticate the clients. The
123
Mandos server uses IPv6 to allow Mandos clients to use IPv6
124
link-local addresses, since the clients will probably not have
125
any other addresses configured (see <xref linkend="overview"/>).
126
Any authenticated client is then given the stored pre-encrypted
127
password for that specific client.
149
128
</para>
150
129
</refsect1>
151
130
294
273
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
274
</listitem>
296
275
</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
339
276
</variablelist>
340
277
</refsect1>
341
278
361
298
start a TLS protocol handshake with a slight quirk: the Mandos
362
299
server program acts as a TLS <quote>client</quote> while the
363
300
connecting Mandos client acts as a TLS <quote>server</quote>.
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.
301
The Mandos client must supply an OpenPGP certificate, and the
302
fingerprint of this certificate is used by the Mandos server to
303
look up (in a list read from <filename>clients.conf</filename>
304
at start time) which binary blob to give the client. No other
305
authentication or authorization is done by the server.
369
306
</para>
370
307
<table>
371
308
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
328
</emphasis></entry>
392
329
</row>
393
330
<row>
394
<entry>Public key (part of TLS handshake)</entry>
331
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
332
<entry>-><!-- → --></entry>
396
333
</row>
397
334
<row>
415
352
for some time, the client is assumed to be compromised and is no
416
353
longer eligible to receive the encrypted password. (Manual
417
354
intervention is required to re-enable a client.) The timeout,
418
extended timeout, checker program, and interval between checks
419
can be configured both globally and per client; see
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
<manvolnum>5</manvolnum></citerefentry>.
355
checker program, and interval between checks can be configured
356
both globally and per client; see <citerefentry>
357
<refentrytitle>mandos-clients.conf</refentrytitle>
358
<manvolnum>5</manvolnum></citerefentry>. A client successfully
359
receiving its password will also be treated as a successful
360
checker run.
422
361
</para>
423
362
</refsect1>
424
363
446
385
<title>LOGGING</title>
447
386
<para>
448
387
The server will send log message with various severity levels to
449
<filename class="devicefile">/dev/log</filename>. With the
388
<filename>/dev/log</filename>. With the
450
389
<option>--debug</option> option, it will log even more messages,
451
390
and also show them on the console.
452
391
</para>
453
392
</refsect1>
454
393
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
467
394
<refsect1 id="dbus_interface">
468
395
<title>D-BUS INTERFACE</title>
469
396
<para>
531
458
</listitem>
532
459
</varlistentry>
533
460
<varlistentry>
534
<term><filename>/run/mandos.pid</filename></term>
461
<term><filename>/var/run/mandos.pid</filename></term>
535
462
<listitem>
536
463
<para>
537
464
The file containing the process id of the
538
465
<command>&COMMANDNAME;</command> process started last.
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>
466
</para>
467
</listitem>
468
</varlistentry>
469
<varlistentry>
470
<term><filename>/dev/log</filename></term>
559
471
<listitem>
560
472
<para>
561
473
The Unix domain socket to where local syslog messages are
584
496
backtrace. This could be considered a feature.
585
497
</para>
586
498
<para>
499
Currently, if a client is disabled due to having timed out, the
500
server does not record this fact onto permanent storage. This
501
has some security implications, see <xref linkend="clients"/>.
502
</para>
503
<para>
587
504
There is no fine-grained control over logging and debug output.
588
505
</para>
589
<xi:include href="bugs.xml"/>
506
<para>
507
Debug mode is conflated with running in the foreground.
508
</para>
509
<para>
510
The console log messages do not show a time stamp.
511
</para>
512
<para>
513
This server does not check the expire time of clients’ OpenPGP
514
keys.
515
</para>
590
516
</refsect1>
591
517
592
518
<refsect1 id="example">
602
528
<informalexample>
603
529
<para>
604
530
Run the server in debug mode, read configuration files from
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:
531
the <filename>~/mandos</filename> directory, and use the
532
Zeroconf service name <quote>Test</quote> to not collide with
533
any other official Mandos server on this host:
608
534
</para>
609
535
<para>
610
536
642
568
<title>CLIENTS</title>
643
569
<para>
644
570
The server only gives out its stored data to clients which
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
571
does have the OpenPGP key of the stored fingerprint. This is
572
guaranteed by the fact that the client sends its OpenPGP
573
public key in the TLS handshake; this ensures it to be
574
genuine. The server computes the fingerprint of the key
575
itself and looks up the fingerprint in its list of
576
clients. The <filename>clients.conf</filename> file (see
651
577
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
578
<manvolnum>5</manvolnum></citerefentry>)
653
579
<emphasis>must</emphasis> be made non-readable by anyone
659
585
compromised if they are gone for too long.
660
586
</para>
661
587
<para>
588
If a client is compromised, its downtime should be duly noted
589
by the server which would therefore disable the client. But
590
if the server was ever restarted, it would re-read its client
591
list from its configuration file and again regard all clients
592
therein as enabled, and hence eligible to receive their
593
passwords. Therefore, be careful when restarting servers if
594
it is suspected that a client has, in fact, been compromised
595
by parties who may now be running a fake Mandos client with
596
the keys from the non-encrypted initial <acronym>RAM</acronym>
597
image of the client host. What should be done in that case
598
(if restarting the server program really is necessary) is to
599
stop the server program, edit the configuration file to omit
600
any suspect clients, and restart the server program.
601
</para>
602
<para>
662
603
For more details on client-side security, see
663
604
<citerefentry><refentrytitle>mandos-client</refentrytitle>
664
605
<manvolnum>8mandos</manvolnum></citerefentry>.
669
610
<refsect1 id="see_also">
670
611
<title>SEE ALSO</title>
671
612
<para>
672
<citerefentry><refentrytitle>intro</refentrytitle>
673
<manvolnum>8mandos</manvolnum></citerefentry>,
674
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
675
<manvolnum>5</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-client</refentrytitle>
679
<manvolnum>8mandos</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>sh</refentrytitle>
681
<manvolnum>1</manvolnum></citerefentry>
613
<citerefentry>
614
<refentrytitle>mandos-clients.conf</refentrytitle>
615
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
<refentrytitle>mandos.conf</refentrytitle>
617
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
<refentrytitle>mandos-client</refentrytitle>
619
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
</citerefentry>
682
622
</para>
683
623
<variablelist>
684
624
<varlistentry>
705
645
</varlistentry>
706
646
<varlistentry>
707
647
<term>
708
<ulink url="https://gnutls.org/">GnuTLS</ulink>
648
<ulink url="http://www.gnu.org/software/gnutls/"
649
>GnuTLS</ulink>
709
650
</term>
710
651
<listitem>
711
652
<para>
712
653
GnuTLS is the library this server uses to implement TLS for
713
654
communicating securely with the client, and at the same time
714
confidently get the client’s public key.
655
confidently get the client’s public OpenPGP key.
715
656
</para>
716
657
</listitem>
717
658
</varlistentry>
749
690
</varlistentry>
750
691
<varlistentry>
751
692
<term>
752
RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
Protocol Version 1.2</citetitle>
693
RFC 4346: <citetitle>The Transport Layer Security (TLS)
694
Protocol Version 1.1</citetitle>
754
695
</term>
755
696
<listitem>
756
697
<para>
757
TLS 1.2 is the protocol implemented by GnuTLS.
698
TLS 1.1 is the protocol implemented by GnuTLS.
758
699
</para>
759
700
</listitem>
760
701
</varlistentry>
770
711
</varlistentry>
771
712
<varlistentry>
772
713
<term>
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.
714
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
715
Security</citetitle>
716
</term>
717
<listitem>
718
<para>
719
This is implemented by GnuTLS and used by this server so
720
that OpenPGP keys can be used.
795
721
</para>
796
722
</listitem>
797
723
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0