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 445
- compare with another revision
- download diff
- download tarball
- view history from revision 445
- Committer: Teddy Hogeborn
- Date: 2010-09-26 21:27:28 UTC
- Revision ID: teddy@fukt.bsnet.se-20100926212728-ej205k5037nfhz2g
Update copyright year to "2010" wherever appropriate.
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -
- files added:
- initramfs-tools-hook-conf
- files removed:
- bugs.xml
- debian/source
- 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>
95
87
<sbr/>
96
88
<arg><option>--debug</option></arg>
97
89
<sbr/>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
100
<sbr/>
101
90
<arg><option>--no-dbus</option></arg>
102
91
<sbr/>
103
92
<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
93
</cmdsynopsis>
117
94
<cmdsynopsis>
118
95
<command>&COMMANDNAME;</command>
136
113
<para>
137
114
<command>&COMMANDNAME;</command> is a server daemon which
138
115
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.
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.
149
124
</para>
150
125
</refsect1>
151
126
220
195
</varlistentry>
221
196
222
197
<varlistentry>
223
<term><option>--debuglevel
224
<replaceable>LEVEL</replaceable></option></term>
225
<listitem>
226
<para>
227
Set the debugging log level.
228
<replaceable>LEVEL</replaceable> is a string, one of
229
<quote><literal>CRITICAL</literal></quote>,
230
<quote><literal>ERROR</literal></quote>,
231
<quote><literal>WARNING</literal></quote>,
232
<quote><literal>INFO</literal></quote>, or
233
<quote><literal>DEBUG</literal></quote>, in order of
234
increasing verbosity. The default level is
235
<quote><literal>WARNING</literal></quote>.
236
</para>
237
</listitem>
238
</varlistentry>
239
240
<varlistentry>
241
198
<term><option>--priority <replaceable>
242
199
PRIORITY</replaceable></option></term>
243
200
<listitem>
294
251
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
252
</listitem>
296
253
</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
254
</variablelist>
340
255
</refsect1>
341
256
361
276
start a TLS protocol handshake with a slight quirk: the Mandos
362
277
server program acts as a TLS <quote>client</quote> while the
363
278
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.
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.
369
284
</para>
370
285
<table>
371
286
<title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
391
306
</emphasis></entry>
392
307
</row>
393
308
<row>
394
<entry>Public key (part of TLS handshake)</entry>
309
<entry>OpenPGP public key (part of TLS handshake)</entry>
395
310
<entry>-><!-- → --></entry>
396
311
</row>
397
312
<row>
415
330
for some time, the client is assumed to be compromised and is no
416
331
longer eligible to receive the encrypted password. (Manual
417
332
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>.
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.
422
339
</para>
423
340
</refsect1>
424
341
446
363
<title>LOGGING</title>
447
364
<para>
448
365
The server will send log message with various severity levels to
449
<filename class="devicefile">/dev/log</filename>. With the
366
<filename>/dev/log</filename>. With the
450
367
<option>--debug</option> option, it will log even more messages,
451
368
and also show them on the console.
452
369
</para>
453
370
</refsect1>
454
371
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
372
<refsect1 id="dbus_interface">
468
373
<title>D-BUS INTERFACE</title>
469
374
<para>
531
436
</listitem>
532
437
</varlistentry>
533
438
<varlistentry>
534
<term><filename>/run/mandos.pid</filename></term>
439
<term><filename>/var/run/mandos.pid</filename></term>
535
440
<listitem>
536
441
<para>
537
442
The file containing the process id of the
538
443
<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>
444
</para>
445
</listitem>
446
</varlistentry>
447
<varlistentry>
448
<term><filename>/dev/log</filename></term>
559
449
<listitem>
560
450
<para>
561
451
The Unix domain socket to where local syslog messages are
584
474
backtrace. This could be considered a feature.
585
475
</para>
586
476
<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>
587
482
There is no fine-grained control over logging and debug output.
588
483
</para>
589
<xi:include href="bugs.xml"/>
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
494
</refsect1>
591
495
592
496
<refsect1 id="example">
602
506
<informalexample>
603
507
<para>
604
508
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:
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:
608
512
</para>
609
513
<para>
610
514
642
546
<title>CLIENTS</title>
643
547
<para>
644
548
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
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
651
555
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
652
556
<manvolnum>5</manvolnum></citerefentry>)
653
557
<emphasis>must</emphasis> be made non-readable by anyone
659
563
compromised if they are gone for too long.
660
564
</para>
661
565
<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>
662
581
For more details on client-side security, see
663
582
<citerefentry><refentrytitle>mandos-client</refentrytitle>
664
583
<manvolnum>8mandos</manvolnum></citerefentry>.
669
588
<refsect1 id="see_also">
670
589
<title>SEE ALSO</title>
671
590
<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>
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>
682
600
</para>
683
601
<variablelist>
684
602
<varlistentry>
705
623
</varlistentry>
706
624
<varlistentry>
707
625
<term>
708
<ulink url="https://gnutls.org/">GnuTLS</ulink>
626
<ulink url="http://www.gnu.org/software/gnutls/"
627
>GnuTLS</ulink>
709
628
</term>
710
629
<listitem>
711
630
<para>
712
631
GnuTLS is the library this server uses to implement TLS for
713
632
communicating securely with the client, and at the same time
714
confidently get the client’s public key.
633
confidently get the client’s public OpenPGP key.
715
634
</para>
716
635
</listitem>
717
636
</varlistentry>
749
668
</varlistentry>
750
669
<varlistentry>
751
670
<term>
752
RFC 5246: <citetitle>The Transport Layer Security (TLS)
753
Protocol Version 1.2</citetitle>
671
RFC 4346: <citetitle>The Transport Layer Security (TLS)
672
Protocol Version 1.1</citetitle>
754
673
</term>
755
674
<listitem>
756
675
<para>
757
TLS 1.2 is the protocol implemented by GnuTLS.
676
TLS 1.1 is the protocol implemented by GnuTLS.
758
677
</para>
759
678
</listitem>
760
679
</varlistentry>
770
689
</varlistentry>
771
690
<varlistentry>
772
691
<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.
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.
795
699
</para>
796
700
</listitem>
797
701
</varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0