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 873
- compare with another revision
- download diff
- download tarball
- view history from revision 873
- Committer: Teddy Hogeborn
- Date: 2016-08-25 17:06:42 UTC
- Revision ID: teddy@recompile.se-20160825170642-n4ough8ql1145zak
PEP8 compliance: mandos-monitor
* mandos-monitor: Add PEP8 compliance (as per the "pycodestyle" tool).
* mandos-monitor: Add PEP8 compliance (as per the "pycodestyle" tool).
- files added:
- DBUS-API
- 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 "2009-09-10">
5
<!ENTITY TIMESTAMP "2016-07-03">
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>
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>.
420
</para>
421
</refsect1>
422
423
<refsect1 id="approval">
424
<title>APPROVAL</title>
425
<para>
426
The server can be configured to require manual approval for a
427
client before it is sent its secret. The delay to wait for such
428
approval and the default action (approve or deny) can be
429
configured both globally and per client; see <citerefentry>
334
430
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>.
336
</para>
431
<manvolnum>5</manvolnum></citerefentry>. By default all clients
432
will be approved immediately without delay.
433
</para>
434
<para>
435
This can be used to deny a client its secret if not manually
436
approved within a specified time. It can also be used to make
437
the server delay before giving a client its secret, allowing
438
optional manual denying of this specific client.
439
</para>
440
337
441
</refsect1>
338
442
339
443
<refsect1 id="logging">
340
444
<title>LOGGING</title>
341
445
<para>
342
446
The server will send log message with various severity levels to
343
<filename>/dev/log</filename>. With the
447
<filename class="devicefile">/dev/log</filename>. With the
344
448
<option>--debug</option> option, it will log even more messages,
345
449
and also show them on the console.
346
450
</para>
347
451
</refsect1>
348
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
349
465
<refsect1 id="dbus_interface">
350
466
<title>D-BUS INTERFACE</title>
351
467
<para>
352
468
The server will by default provide a D-Bus system bus interface.
353
469
This interface will only be accessible by the root user or a
354
Mandos-specific user, if such a user exists.
355
<!-- XXX -->
470
Mandos-specific user, if such a user exists. For documentation
471
of the D-Bus API, see the file <filename>DBUS-API</filename>.
356
472
</para>
357
473
</refsect1>
358
474
413
529
</listitem>
414
530
</varlistentry>
415
531
<varlistentry>
416
<term><filename>/var/run/mandos.pid</filename></term>
417
<listitem>
418
<para>
419
The file containing the process id of
420
<command>&COMMANDNAME;</command>.
421
</para>
422
</listitem>
423
</varlistentry>
424
<varlistentry>
425
<term><filename>/dev/log</filename></term>
532
<term><filename>/run/mandos.pid</filename></term>
533
<listitem>
534
<para>
535
The file containing the process id of the
536
<command>&COMMANDNAME;</command> process started last.
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>
426
557
<listitem>
427
558
<para>
428
559
The Unix domain socket to where local syslog messages are
451
582
backtrace. This could be considered a feature.
452
583
</para>
453
584
<para>
454
Currently, if a client is declared <quote>invalid</quote> due to
455
having timed out, the server does not record this fact onto
456
permanent storage. This has some security implications, see
457
<xref linkend="clients"/>.
458
</para>
459
<para>
460
There is currently no way of querying the server of the current
461
status of clients, other than analyzing its <systemitem
462
class="service">syslog</systemitem> output.
463
</para>
464
<para>
465
585
There is no fine-grained control over logging and debug output.
466
586
</para>
467
587
<para>
468
Debug mode is conflated with running in the foreground.
469
</para>
470
<para>
471
The console log messages do not show a time stamp.
472
</para>
473
<para>
474
588
This server does not check the expire time of clients’ OpenPGP
475
589
keys.
476
590
</para>
591
<xi:include href="bugs.xml"/>
477
592
</refsect1>
478
593
479
594
<refsect1 id="example">
489
604
<informalexample>
490
605
<para>
491
606
Run the server in debug mode, read configuration files from
492
the <filename>~/mandos</filename> directory, and use the
493
Zeroconf service name <quote>Test</quote> to not collide with
494
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:
495
610
</para>
496
611
<para>
497
612
546
661
compromised if they are gone for too long.
547
662
</para>
548
663
<para>
549
If a client is compromised, its downtime should be duly noted
550
by the server which would therefore declare the client
551
invalid. But if the server was ever restarted, it would
552
re-read its client list from its configuration file and again
553
regard all clients therein as valid, and hence eligible to
554
receive their passwords. Therefore, be careful when
555
restarting servers if it is suspected that a client has, in
556
fact, been compromised by parties who may now be running a
557
fake Mandos client with the keys from the non-encrypted
558
initial <acronym>RAM</acronym> image of the client host. What
559
should be done in that case (if restarting the server program
560
really is necessary) is to stop the server program, edit the
561
configuration file to omit any suspect clients, and restart
562
the server program.
563
</para>
564
<para>
565
664
For more details on client-side security, see
566
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
567
666
<manvolnum>8mandos</manvolnum></citerefentry>.
572
671
<refsect1 id="see_also">
573
672
<title>SEE ALSO</title>
574
673
<para>
575
<citerefentry>
576
<refentrytitle>mandos-clients.conf</refentrytitle>
577
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
<refentrytitle>mandos.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos-client</refentrytitle>
581
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
</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>
584
684
</para>
585
685
<variablelist>
586
686
<varlistentry>
607
707
</varlistentry>
608
708
<varlistentry>
609
709
<term>
610
<ulink url="http://www.gnu.org/software/gnutls/"
611
>GnuTLS</ulink>
710
<ulink url="https://gnutls.org/">GnuTLS</ulink>
612
711
</term>
613
712
<listitem>
614
713
<para>
652
751
</varlistentry>
653
752
<varlistentry>
654
753
<term>
655
RFC 4346: <citetitle>The Transport Layer Security (TLS)
656
Protocol Version 1.1</citetitle>
754
RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
Protocol Version 1.2</citetitle>
657
756
</term>
658
757
<listitem>
659
758
<para>
660
TLS 1.1 is the protocol implemented by GnuTLS.
759
TLS 1.2 is the protocol implemented by GnuTLS.
661
760
</para>
662
761
</listitem>
663
762
</varlistentry>
673
772
</varlistentry>
674
773
<varlistentry>
675
774
<term>
676
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
677
Security</citetitle>
775
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
Security (TLS) Authentication</citetitle>
678
777
</term>
679
778
<listitem>
680
779
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0