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 911
- compare with another revision
- download diff
- download tarball
- view history from revision 911
- Committer: Teddy Hogeborn
- Date: 2017-08-20 20:12:54 UTC
- mfrom: (237.4.92 release)
- Revision ID: teddy@recompile.se-20170820201254-5tbkyqovrbvo4fqi
Merge from release branch
- files added:
- 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 "2010-09-26">
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
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>
37
44
<holder>Teddy Hogeborn</holder>
38
45
<holder>Björn Påhlsson</holder>
39
46
</copyright>
87
94
<sbr/>
88
95
<arg><option>--debug</option></arg>
89
96
<sbr/>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
99
<sbr/>
90
100
<arg><option>--no-dbus</option></arg>
91
101
<sbr/>
92
102
<arg><option>--no-ipv6</option></arg>
103
<sbr/>
104
<arg><option>--no-restore</option></arg>
105
<sbr/>
106
<arg><option>--statedir
107
<replaceable>DIRECTORY</replaceable></option></arg>
108
<sbr/>
109
<arg><option>--socket
110
<replaceable>FD</replaceable></option></arg>
111
<sbr/>
112
<arg><option>--foreground</option></arg>
113
<sbr/>
114
<arg><option>--no-zeroconf</option></arg>
93
115
</cmdsynopsis>
94
116
<cmdsynopsis>
95
117
<command>&COMMANDNAME;</command>
113
135
<para>
114
136
<command>&COMMANDNAME;</command> is a server daemon which
115
137
handles incoming request for passwords for a pre-defined list of
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.
138
client host computers. For an introduction, see
139
<citerefentry><refentrytitle>intro</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
uses Zeroconf to announce itself on the local network, and uses
142
TLS to communicate securely with and to authenticate the
143
clients. The Mandos server uses IPv6 to allow Mandos clients to
144
use IPv6 link-local addresses, since the clients will probably
145
not have any other addresses configured (see <xref
146
linkend="overview"/>). Any authenticated client is then given
147
the stored pre-encrypted password for that specific client.
124
148
</para>
125
149
</refsect1>
126
150
195
219
</varlistentry>
196
220
197
221
<varlistentry>
222
<term><option>--debuglevel
223
<replaceable>LEVEL</replaceable></option></term>
224
<listitem>
225
<para>
226
Set the debugging log level.
227
<replaceable>LEVEL</replaceable> is a string, one of
228
<quote><literal>CRITICAL</literal></quote>,
229
<quote><literal>ERROR</literal></quote>,
230
<quote><literal>WARNING</literal></quote>,
231
<quote><literal>INFO</literal></quote>, or
232
<quote><literal>DEBUG</literal></quote>, in order of
233
increasing verbosity. The default level is
234
<quote><literal>WARNING</literal></quote>.
235
</para>
236
</listitem>
237
</varlistentry>
238
239
<varlistentry>
198
240
<term><option>--priority <replaceable>
199
241
PRIORITY</replaceable></option></term>
200
242
<listitem>
251
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
252
294
</listitem>
253
295
</varlistentry>
296
297
<varlistentry>
298
<term><option>--no-restore</option></term>
299
<listitem>
300
<xi:include href="mandos-options.xml" xpointer="restore"/>
301
<para>
302
See also <xref linkend="persistent_state"/>.
303
</para>
304
</listitem>
305
</varlistentry>
306
307
<varlistentry>
308
<term><option>--statedir
309
<replaceable>DIRECTORY</replaceable></option></term>
310
<listitem>
311
<xi:include href="mandos-options.xml" xpointer="statedir"/>
312
</listitem>
313
</varlistentry>
314
315
<varlistentry>
316
<term><option>--socket
317
<replaceable>FD</replaceable></option></term>
318
<listitem>
319
<xi:include href="mandos-options.xml" xpointer="socket"/>
320
</listitem>
321
</varlistentry>
322
323
<varlistentry>
324
<term><option>--foreground</option></term>
325
<listitem>
326
<xi:include href="mandos-options.xml"
327
xpointer="foreground"/>
328
</listitem>
329
</varlistentry>
330
331
<varlistentry>
332
<term><option>--no-zeroconf</option></term>
333
<listitem>
334
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
335
</listitem>
336
</varlistentry>
337
254
338
</variablelist>
255
339
</refsect1>
256
340
330
414
for some time, the client is assumed to be compromised and is no
331
415
longer eligible to receive the encrypted password. (Manual
332
416
intervention is required to re-enable a client.) The timeout,
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.
417
extended timeout, checker program, and interval between checks
418
can be configured both globally and per client; see
419
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
420
<manvolnum>5</manvolnum></citerefentry>.
339
421
</para>
340
422
</refsect1>
341
423
363
445
<title>LOGGING</title>
364
446
<para>
365
447
The server will send log message with various severity levels to
366
<filename>/dev/log</filename>. With the
448
<filename class="devicefile">/dev/log</filename>. With the
367
449
<option>--debug</option> option, it will log even more messages,
368
450
and also show them on the console.
369
451
</para>
370
452
</refsect1>
371
453
454
<refsect1 id="persistent_state">
455
<title>PERSISTENT STATE</title>
456
<para>
457
Client settings, initially read from
458
<filename>clients.conf</filename>, are persistent across
459
restarts, and run-time changes will override settings in
460
<filename>clients.conf</filename>. However, if a setting is
461
<emphasis>changed</emphasis> (or a client added, or removed) in
462
<filename>clients.conf</filename>, this will take precedence.
463
</para>
464
</refsect1>
465
372
466
<refsect1 id="dbus_interface">
373
467
<title>D-BUS INTERFACE</title>
374
468
<para>
436
530
</listitem>
437
531
</varlistentry>
438
532
<varlistentry>
439
<term><filename>/var/run/mandos.pid</filename></term>
533
<term><filename>/run/mandos.pid</filename></term>
440
534
<listitem>
441
535
<para>
442
536
The file containing the process id of the
443
537
<command>&COMMANDNAME;</command> process started last.
444
</para>
445
</listitem>
446
</varlistentry>
447
<varlistentry>
448
<term><filename>/dev/log</filename></term>
538
<emphasis >Note:</emphasis> If the <filename
539
class="directory">/run</filename> directory does not
540
exist, <filename>/var/run/mandos.pid</filename> will be
541
used instead.
542
</para>
543
</listitem>
544
</varlistentry>
545
<varlistentry>
546
<term><filename
547
class="directory">/var/lib/mandos</filename></term>
548
<listitem>
549
<para>
550
Directory where persistent state will be saved. Change
551
this with the <option>--statedir</option> option. See
552
also the <option>--no-restore</option> option.
553
</para>
554
</listitem>
555
</varlistentry>
556
<varlistentry>
557
<term><filename class="devicefile">/dev/log</filename></term>
449
558
<listitem>
450
559
<para>
451
560
The Unix domain socket to where local syslog messages are
474
583
backtrace. This could be considered a feature.
475
584
</para>
476
585
<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>
482
586
There is no fine-grained control over logging and debug output.
483
587
</para>
484
588
<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
589
This server does not check the expire time of clients’ OpenPGP
492
590
keys.
493
591
</para>
592
<xi:include href="bugs.xml"/>
494
593
</refsect1>
495
594
496
595
<refsect1 id="example">
506
605
<informalexample>
507
606
<para>
508
607
Run the server in debug mode, read configuration files from
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
the <filename class="directory">~/mandos</filename> directory,
609
and use the Zeroconf service name <quote>Test</quote> to not
610
collide with any other official Mandos server on this host:
512
611
</para>
513
612
<para>
514
613
563
662
compromised if they are gone for too long.
564
663
</para>
565
664
<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>
581
665
For more details on client-side security, see
582
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
583
667
<manvolnum>8mandos</manvolnum></citerefentry>.
588
672
<refsect1 id="see_also">
589
673
<title>SEE ALSO</title>
590
674
<para>
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>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>mandos-client</refentrytitle>
682
<manvolnum>8mandos</manvolnum></citerefentry>,
683
<citerefentry><refentrytitle>sh</refentrytitle>
684
<manvolnum>1</manvolnum></citerefentry>
600
685
</para>
601
686
<variablelist>
602
687
<varlistentry>
623
708
</varlistentry>
624
709
<varlistentry>
625
710
<term>
626
<ulink url="http://www.gnu.org/software/gnutls/"
627
>GnuTLS</ulink>
711
<ulink url="https://gnutls.org/">GnuTLS</ulink>
628
712
</term>
629
713
<listitem>
630
714
<para>
668
752
</varlistentry>
669
753
<varlistentry>
670
754
<term>
671
RFC 4346: <citetitle>The Transport Layer Security (TLS)
672
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
673
757
</term>
674
758
<listitem>
675
759
<para>
676
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
677
761
</para>
678
762
</listitem>
679
763
</varlistentry>
689
773
</varlistentry>
690
774
<varlistentry>
691
775
<term>
692
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
693
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
694
778
</term>
695
779
<listitem>
696
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0