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:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files renamed:
- mandos-list => mandos-ctl
- 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 "2009-01-04">
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>
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>
43
<year>2017</year>
36
44
<holder>Teddy Hogeborn</holder>
37
45
<holder>Björn Påhlsson</holder>
38
46
</copyright>
86
94
<sbr/>
87
95
<arg><option>--debug</option></arg>
88
96
<sbr/>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
99
<sbr/>
89
100
<arg><option>--no-dbus</option></arg>
101
<sbr/>
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>
90
115
</cmdsynopsis>
91
116
<cmdsynopsis>
92
117
<command>&COMMANDNAME;</command>
110
135
<para>
111
136
<command>&COMMANDNAME;</command> is a server daemon which
112
137
handles incoming request for passwords for a pre-defined list of
113
client host computers. The Mandos server uses Zeroconf to
114
announce itself on the local network, and uses TLS to
115
communicate securely with and to authenticate the clients. The
116
Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
link-local addresses, since the clients will probably not have
118
any other addresses configured (see <xref linkend="overview"/>).
119
Any authenticated client is then given the stored pre-encrypted
120
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.
121
148
</para>
122
149
</refsect1>
123
150
192
219
</varlistentry>
193
220
194
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>
195
240
<term><option>--priority <replaceable>
196
241
PRIORITY</replaceable></option></term>
197
242
<listitem>
241
286
</para>
242
287
</listitem>
243
288
</varlistentry>
289
290
<varlistentry>
291
<term><option>--no-ipv6</option></term>
292
<listitem>
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
</listitem>
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
244
338
</variablelist>
245
339
</refsect1>
246
340
318
412
The server will, by default, continually check that the clients
319
413
are still up. If a client has not been confirmed as being up
320
414
for some time, the client is assumed to be compromised and is no
321
longer eligible to receive the encrypted password. The timeout,
322
checker program, and interval between checks can be configured
323
both globally and per client; see <citerefentry>
415
longer eligible to receive the encrypted password. (Manual
416
intervention is required to re-enable a client.) The timeout,
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>.
421
</para>
422
</refsect1>
423
424
<refsect1 id="approval">
425
<title>APPROVAL</title>
426
<para>
427
The server can be configured to require manual approval for a
428
client before it is sent its secret. The delay to wait for such
429
approval and the default action (approve or deny) can be
430
configured both globally and per client; see <citerefentry>
324
431
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
432
<manvolnum>5</manvolnum></citerefentry>. By default all clients
433
will be approved immediately without delay.
434
</para>
435
<para>
436
This can be used to deny a client its secret if not manually
437
approved within a specified time. It can also be used to make
438
the server delay before giving a client its secret, allowing
439
optional manual denying of this specific client.
440
</para>
441
327
442
</refsect1>
328
443
329
444
<refsect1 id="logging">
330
445
<title>LOGGING</title>
331
446
<para>
332
447
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
448
<filename class="devicefile">/dev/log</filename>. With the
334
449
<option>--debug</option> option, it will log even more messages,
335
450
and also show them on the console.
336
451
</para>
337
452
</refsect1>
338
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
339
466
<refsect1 id="dbus_interface">
340
467
<title>D-BUS INTERFACE</title>
341
468
<para>
342
469
The server will by default provide a D-Bus system bus interface.
343
470
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
471
Mandos-specific user, if such a user exists. For documentation
472
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
473
</para>
347
474
</refsect1>
348
475
349
476
<refsect1 id="exit_status">
350
477
<title>EXIT STATUS</title>
351
478
<para>
403
530
</listitem>
404
531
</varlistentry>
405
532
<varlistentry>
406
<term><filename>/var/run/mandos.pid</filename></term>
407
<listitem>
408
<para>
409
The file containing the process id of
410
<command>&COMMANDNAME;</command>.
411
</para>
412
</listitem>
413
</varlistentry>
414
<varlistentry>
415
<term><filename>/dev/log</filename></term>
533
<term><filename>/run/mandos.pid</filename></term>
534
<listitem>
535
<para>
536
The file containing the process id of the
537
<command>&COMMANDNAME;</command> process started last.
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>
416
558
<listitem>
417
559
<para>
418
560
The Unix domain socket to where local syslog messages are
441
583
backtrace. This could be considered a feature.
442
584
</para>
443
585
<para>
444
Currently, if a client is declared <quote>invalid</quote> due to
445
having timed out, the server does not record this fact onto
446
permanent storage. This has some security implications, see
447
<xref linkend="clients"/>.
448
</para>
449
<para>
450
There is currently no way of querying the server of the current
451
status of clients, other than analyzing its <systemitem
452
class="service">syslog</systemitem> output.
453
</para>
454
<para>
455
586
There is no fine-grained control over logging and debug output.
456
587
</para>
457
588
<para>
458
Debug mode is conflated with running in the foreground.
459
</para>
460
<para>
461
The console log messages does not show a time stamp.
462
</para>
463
<para>
464
589
This server does not check the expire time of clients’ OpenPGP
465
590
keys.
466
591
</para>
592
<xi:include href="bugs.xml"/>
467
593
</refsect1>
468
594
469
595
<refsect1 id="example">
479
605
<informalexample>
480
606
<para>
481
607
Run the server in debug mode, read configuration files from
482
the <filename>~/mandos</filename> directory, and use the
483
Zeroconf service name <quote>Test</quote> to not collide with
484
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:
485
611
</para>
486
612
<para>
487
613
536
662
compromised if they are gone for too long.
537
663
</para>
538
664
<para>
539
If a client is compromised, its downtime should be duly noted
540
by the server which would therefore declare the client
541
invalid. But if the server was ever restarted, it would
542
re-read its client list from its configuration file and again
543
regard all clients therein as valid, and hence eligible to
544
receive their passwords. Therefore, be careful when
545
restarting servers if it is suspected that a client has, in
546
fact, been compromised by parties who may now be running a
547
fake Mandos client with the keys from the non-encrypted
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
551
configuration file to omit any suspect clients, and restart
552
the server program.
553
</para>
554
<para>
555
665
For more details on client-side security, see
556
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
667
<manvolnum>8mandos</manvolnum></citerefentry>.
562
672
<refsect1 id="see_also">
563
673
<title>SEE ALSO</title>
564
674
<para>
565
<citerefentry>
566
<refentrytitle>mandos-clients.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos.conf</refentrytitle>
569
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
</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>
574
685
</para>
575
686
<variablelist>
576
687
<varlistentry>
597
708
</varlistentry>
598
709
<varlistentry>
599
710
<term>
600
<ulink url="http://www.gnu.org/software/gnutls/"
601
>GnuTLS</ulink>
711
<ulink url="https://gnutls.org/">GnuTLS</ulink>
602
712
</term>
603
713
<listitem>
604
714
<para>
642
752
</varlistentry>
643
753
<varlistentry>
644
754
<term>
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
647
757
</term>
648
758
<listitem>
649
759
<para>
650
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
651
761
</para>
652
762
</listitem>
653
763
</varlistentry>
663
773
</varlistentry>
664
774
<varlistentry>
665
775
<term>
666
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
667
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
668
778
</term>
669
779
<listitem>
670
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0