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 237.4.75
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.75
- Committer: Teddy Hogeborn
- Date: 2016-06-21 19:47:30 UTC
- mfrom: (854 trunk)
- mto: This revision was merged to the branch mainline in revision 855.
- Revision ID: teddy@recompile.se-20160621194730-sb4zcfg961tvuic2
Merge from trunk
- 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-25">
5
<!ENTITY TIMESTAMP "2016-03-05">
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>
33
33
<copyright>
34
34
<year>2008</year>
35
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>
36
43
<holder>Teddy Hogeborn</holder>
37
44
<holder>Björn Påhlsson</holder>
38
45
</copyright>
86
93
<sbr/>
87
94
<arg><option>--debug</option></arg>
88
95
<sbr/>
96
<arg><option>--debuglevel
97
<replaceable>LEVEL</replaceable></option></arg>
98
<sbr/>
89
99
<arg><option>--no-dbus</option></arg>
90
100
<sbr/>
91
101
<arg><option>--no-ipv6</option></arg>
102
<sbr/>
103
<arg><option>--no-restore</option></arg>
104
<sbr/>
105
<arg><option>--statedir
106
<replaceable>DIRECTORY</replaceable></option></arg>
107
<sbr/>
108
<arg><option>--socket
109
<replaceable>FD</replaceable></option></arg>
110
<sbr/>
111
<arg><option>--foreground</option></arg>
112
<sbr/>
113
<arg><option>--no-zeroconf</option></arg>
92
114
</cmdsynopsis>
93
115
<cmdsynopsis>
94
116
<command>&COMMANDNAME;</command>
112
134
<para>
113
135
<command>&COMMANDNAME;</command> is a server daemon which
114
136
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
password for that specific client.
137
client host computers. For an introduction, see
138
<citerefentry><refentrytitle>intro</refentrytitle>
139
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
uses Zeroconf to announce itself on the local network, and uses
141
TLS to communicate securely with and to authenticate the
142
clients. The Mandos server uses IPv6 to allow Mandos clients to
143
use IPv6 link-local addresses, since the clients will probably
144
not have any other addresses configured (see <xref
145
linkend="overview"/>). Any authenticated client is then given
146
the stored pre-encrypted password for that specific client.
123
147
</para>
124
148
</refsect1>
125
149
194
218
</varlistentry>
195
219
196
220
<varlistentry>
221
<term><option>--debuglevel
222
<replaceable>LEVEL</replaceable></option></term>
223
<listitem>
224
<para>
225
Set the debugging log level.
226
<replaceable>LEVEL</replaceable> is a string, one of
227
<quote><literal>CRITICAL</literal></quote>,
228
<quote><literal>ERROR</literal></quote>,
229
<quote><literal>WARNING</literal></quote>,
230
<quote><literal>INFO</literal></quote>, or
231
<quote><literal>DEBUG</literal></quote>, in order of
232
increasing verbosity. The default level is
233
<quote><literal>WARNING</literal></quote>.
234
</para>
235
</listitem>
236
</varlistentry>
237
238
<varlistentry>
197
239
<term><option>--priority <replaceable>
198
240
PRIORITY</replaceable></option></term>
199
241
<listitem>
250
292
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
293
</listitem>
252
294
</varlistentry>
295
296
<varlistentry>
297
<term><option>--no-restore</option></term>
298
<listitem>
299
<xi:include href="mandos-options.xml" xpointer="restore"/>
300
<para>
301
See also <xref linkend="persistent_state"/>.
302
</para>
303
</listitem>
304
</varlistentry>
305
306
<varlistentry>
307
<term><option>--statedir
308
<replaceable>DIRECTORY</replaceable></option></term>
309
<listitem>
310
<xi:include href="mandos-options.xml" xpointer="statedir"/>
311
</listitem>
312
</varlistentry>
313
314
<varlistentry>
315
<term><option>--socket
316
<replaceable>FD</replaceable></option></term>
317
<listitem>
318
<xi:include href="mandos-options.xml" xpointer="socket"/>
319
</listitem>
320
</varlistentry>
321
322
<varlistentry>
323
<term><option>--foreground</option></term>
324
<listitem>
325
<xi:include href="mandos-options.xml"
326
xpointer="foreground"/>
327
</listitem>
328
</varlistentry>
329
330
<varlistentry>
331
<term><option>--no-zeroconf</option></term>
332
<listitem>
333
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
</listitem>
335
</varlistentry>
336
253
337
</variablelist>
254
338
</refsect1>
255
339
329
413
for some time, the client is assumed to be compromised and is no
330
414
longer eligible to receive the encrypted password. (Manual
331
415
intervention is required to re-enable a client.) The timeout,
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
334
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
checker run.
416
extended timeout, checker program, and interval between checks
417
can be configured both globally and per client; see
418
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
<manvolnum>5</manvolnum></citerefentry>.
338
420
</para>
339
421
</refsect1>
340
422
362
444
<title>LOGGING</title>
363
445
<para>
364
446
The server will send log message with various severity levels to
365
<filename>/dev/log</filename>. With the
447
<filename class="devicefile">/dev/log</filename>. With the
366
448
<option>--debug</option> option, it will log even more messages,
367
449
and also show them on the console.
368
450
</para>
369
451
</refsect1>
370
452
453
<refsect1 id="persistent_state">
454
<title>PERSISTENT STATE</title>
455
<para>
456
Client settings, initially read from
457
<filename>clients.conf</filename>, are persistent across
458
restarts, and run-time changes will override settings in
459
<filename>clients.conf</filename>. However, if a setting is
460
<emphasis>changed</emphasis> (or a client added, or removed) in
461
<filename>clients.conf</filename>, this will take precedence.
462
</para>
463
</refsect1>
464
371
465
<refsect1 id="dbus_interface">
372
466
<title>D-BUS INTERFACE</title>
373
467
<para>
435
529
</listitem>
436
530
</varlistentry>
437
531
<varlistentry>
438
<term><filename>/var/run/mandos.pid</filename></term>
532
<term><filename>/run/mandos.pid</filename></term>
439
533
<listitem>
440
534
<para>
441
535
The file containing the process id of the
442
536
<command>&COMMANDNAME;</command> process started last.
443
</para>
444
</listitem>
445
</varlistentry>
446
<varlistentry>
447
<term><filename>/dev/log</filename></term>
537
<emphasis >Note:</emphasis> If the <filename
538
class="directory">/run</filename> directory does not
539
exist, <filename>/var/run/mandos.pid</filename> will be
540
used instead.
541
</para>
542
</listitem>
543
</varlistentry>
544
<varlistentry>
545
<term><filename
546
class="directory">/var/lib/mandos</filename></term>
547
<listitem>
548
<para>
549
Directory where persistent state will be saved. Change
550
this with the <option>--statedir</option> option. See
551
also the <option>--no-restore</option> option.
552
</para>
553
</listitem>
554
</varlistentry>
555
<varlistentry>
556
<term><filename class="devicefile">/dev/log</filename></term>
448
557
<listitem>
449
558
<para>
450
559
The Unix domain socket to where local syslog messages are
473
582
backtrace. This could be considered a feature.
474
583
</para>
475
584
<para>
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
479
</para>
480
<para>
481
585
There is no fine-grained control over logging and debug output.
482
586
</para>
483
587
<para>
484
Debug mode is conflated with running in the foreground.
485
</para>
486
<para>
487
The console log messages do not show a time stamp.
488
</para>
489
<para>
490
588
This server does not check the expire time of clients’ OpenPGP
491
589
keys.
492
590
</para>
591
<xi:include href="bugs.xml"/>
493
592
</refsect1>
494
593
495
594
<refsect1 id="example">
505
604
<informalexample>
506
605
<para>
507
606
Run the server in debug mode, read configuration files from
508
the <filename>~/mandos</filename> directory, and use the
509
Zeroconf service name <quote>Test</quote> to not collide with
510
any other official Mandos server on this host:
607
the <filename class="directory">~/mandos</filename> directory,
608
and use the Zeroconf service name <quote>Test</quote> to not
609
collide with any other official Mandos server on this host:
511
610
</para>
512
611
<para>
513
612
562
661
compromised if they are gone for too long.
563
662
</para>
564
663
<para>
565
If a client is compromised, its downtime should be duly noted
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
574
image of the client host. What should be done in that case
575
(if restarting the server program really is necessary) is to
576
stop the server program, edit the configuration file to omit
577
any suspect clients, and restart the server program.
578
</para>
579
<para>
580
664
For more details on client-side security, see
581
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
582
666
<manvolnum>8mandos</manvolnum></citerefentry>.
587
671
<refsect1 id="see_also">
588
672
<title>SEE ALSO</title>
589
673
<para>
590
<citerefentry>
591
<refentrytitle>mandos-clients.conf</refentrytitle>
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
593
<refentrytitle>mandos.conf</refentrytitle>
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
595
<refentrytitle>mandos-client</refentrytitle>
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
598
</citerefentry>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<manvolnum>1</manvolnum></citerefentry>
599
684
</para>
600
685
<variablelist>
601
686
<varlistentry>
622
707
</varlistentry>
623
708
<varlistentry>
624
709
<term>
625
<ulink url="http://www.gnu.org/software/gnutls/"
626
>GnuTLS</ulink>
710
<ulink url="http://gnutls.org/">GnuTLS</ulink>
627
711
</term>
628
712
<listitem>
629
713
<para>
667
751
</varlistentry>
668
752
<varlistentry>
669
753
<term>
670
RFC 4346: <citetitle>The Transport Layer Security (TLS)
671
Protocol Version 1.1</citetitle>
754
RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
Protocol Version 1.2</citetitle>
672
756
</term>
673
757
<listitem>
674
758
<para>
675
TLS 1.1 is the protocol implemented by GnuTLS.
759
TLS 1.2 is the protocol implemented by GnuTLS.
676
760
</para>
677
761
</listitem>
678
762
</varlistentry>
688
772
</varlistentry>
689
773
<varlistentry>
690
774
<term>
691
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
692
Security</citetitle>
775
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
Security (TLS) Authentication</citetitle>
693
777
</term>
694
778
<listitem>
695
779
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0