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