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 756
- compare with another revision
- download diff
- download tarball
- view history from revision 756
- Committer: Teddy Hogeborn
- Date: 2015-05-31 20:12:27 UTC
- mfrom: (749.1.2 multiprocessing-exec)
- Revision ID: teddy@recompile.se-20150531201227-u3n1z1ito5siqh7c
Merge change to use multiprocessing module to run checkers.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- 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-02-15">
5
<!ENTITY TIMESTAMP "2015-01-25">
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>
36
40
<holder>Teddy Hogeborn</holder>
37
41
<holder>Björn Påhlsson</holder>
38
42
</copyright>
86
90
<sbr/>
87
91
<arg><option>--debug</option></arg>
88
92
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
89
96
<arg><option>--no-dbus</option></arg>
90
97
<sbr/>
91
98
<arg><option>--no-ipv6</option></arg>
99
<sbr/>
100
<arg><option>--no-restore</option></arg>
101
<sbr/>
102
<arg><option>--statedir
103
<replaceable>DIRECTORY</replaceable></option></arg>
104
<sbr/>
105
<arg><option>--socket
106
<replaceable>FD</replaceable></option></arg>
107
<sbr/>
108
<arg><option>--foreground</option></arg>
109
<sbr/>
110
<arg><option>--no-zeroconf</option></arg>
92
111
</cmdsynopsis>
93
112
<cmdsynopsis>
94
113
<command>&COMMANDNAME;</command>
112
131
<para>
113
132
<command>&COMMANDNAME;</command> is a server daemon which
114
133
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.
134
client host computers. For an introduction, see
135
<citerefentry><refentrytitle>intro</refentrytitle>
136
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
uses Zeroconf to announce itself on the local network, and uses
138
TLS to communicate securely with and to authenticate the
139
clients. The Mandos server uses IPv6 to allow Mandos clients to
140
use IPv6 link-local addresses, since the clients will probably
141
not have any other addresses configured (see <xref
142
linkend="overview"/>). Any authenticated client is then given
143
the stored pre-encrypted password for that specific client.
123
144
</para>
124
145
</refsect1>
125
146
194
215
</varlistentry>
195
216
196
217
<varlistentry>
218
<term><option>--debuglevel
219
<replaceable>LEVEL</replaceable></option></term>
220
<listitem>
221
<para>
222
Set the debugging log level.
223
<replaceable>LEVEL</replaceable> is a string, one of
224
<quote><literal>CRITICAL</literal></quote>,
225
<quote><literal>ERROR</literal></quote>,
226
<quote><literal>WARNING</literal></quote>,
227
<quote><literal>INFO</literal></quote>, or
228
<quote><literal>DEBUG</literal></quote>, in order of
229
increasing verbosity. The default level is
230
<quote><literal>WARNING</literal></quote>.
231
</para>
232
</listitem>
233
</varlistentry>
234
235
<varlistentry>
197
236
<term><option>--priority <replaceable>
198
237
PRIORITY</replaceable></option></term>
199
238
<listitem>
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<xi:include href="mandos-options.xml"
240
xpointer="priority_compat"/>
201
241
</listitem>
202
242
</varlistentry>
203
243
250
290
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
291
</listitem>
252
292
</varlistentry>
293
294
<varlistentry>
295
<term><option>--no-restore</option></term>
296
<listitem>
297
<xi:include href="mandos-options.xml" xpointer="restore"/>
298
<para>
299
See also <xref linkend="persistent_state"/>.
300
</para>
301
</listitem>
302
</varlistentry>
303
304
<varlistentry>
305
<term><option>--statedir
306
<replaceable>DIRECTORY</replaceable></option></term>
307
<listitem>
308
<xi:include href="mandos-options.xml" xpointer="statedir"/>
309
</listitem>
310
</varlistentry>
311
312
<varlistentry>
313
<term><option>--socket
314
<replaceable>FD</replaceable></option></term>
315
<listitem>
316
<xi:include href="mandos-options.xml" xpointer="socket"/>
317
</listitem>
318
</varlistentry>
319
320
<varlistentry>
321
<term><option>--foreground</option></term>
322
<listitem>
323
<xi:include href="mandos-options.xml"
324
xpointer="foreground"/>
325
</listitem>
326
</varlistentry>
327
328
<varlistentry>
329
<term><option>--no-zeroconf</option></term>
330
<listitem>
331
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
</listitem>
333
</varlistentry>
334
253
335
</variablelist>
254
336
</refsect1>
255
337
327
409
The server will, by default, continually check that the clients
328
410
are still up. If a client has not been confirmed as being up
329
411
for some time, the client is assumed to be compromised and is no
330
longer eligible to receive the encrypted password. The timeout,
331
checker program, and interval between checks can be configured
332
both globally and per client; see <citerefentry>
412
longer eligible to receive the encrypted password. (Manual
413
intervention is required to re-enable a client.) The timeout,
414
extended timeout, checker program, and interval between checks
415
can be configured both globally and per client; see
416
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
<manvolnum>5</manvolnum></citerefentry>.
418
</para>
419
</refsect1>
420
421
<refsect1 id="approval">
422
<title>APPROVAL</title>
423
<para>
424
The server can be configured to require manual approval for a
425
client before it is sent its secret. The delay to wait for such
426
approval and the default action (approve or deny) can be
427
configured both globally and per client; see <citerefentry>
333
428
<refentrytitle>mandos-clients.conf</refentrytitle>
334
<manvolnum>5</manvolnum></citerefentry>.
335
</para>
429
<manvolnum>5</manvolnum></citerefentry>. By default all clients
430
will be approved immediately without delay.
431
</para>
432
<para>
433
This can be used to deny a client its secret if not manually
434
approved within a specified time. It can also be used to make
435
the server delay before giving a client its secret, allowing
436
optional manual denying of this specific client.
437
</para>
438
336
439
</refsect1>
337
440
338
441
<refsect1 id="logging">
339
442
<title>LOGGING</title>
340
443
<para>
341
444
The server will send log message with various severity levels to
342
<filename>/dev/log</filename>. With the
445
<filename class="devicefile">/dev/log</filename>. With the
343
446
<option>--debug</option> option, it will log even more messages,
344
447
and also show them on the console.
345
448
</para>
346
449
</refsect1>
347
450
451
<refsect1 id="persistent_state">
452
<title>PERSISTENT STATE</title>
453
<para>
454
Client settings, initially read from
455
<filename>clients.conf</filename>, are persistent across
456
restarts, and run-time changes will override settings in
457
<filename>clients.conf</filename>. However, if a setting is
458
<emphasis>changed</emphasis> (or a client added, or removed) in
459
<filename>clients.conf</filename>, this will take precedence.
460
</para>
461
</refsect1>
462
348
463
<refsect1 id="dbus_interface">
349
464
<title>D-BUS INTERFACE</title>
350
465
<para>
351
466
The server will by default provide a D-Bus system bus interface.
352
467
This interface will only be accessible by the root user or a
353
Mandos-specific user, if such a user exists.
354
<!-- XXX -->
468
Mandos-specific user, if such a user exists. For documentation
469
of the D-Bus API, see the file <filename>DBUS-API</filename>.
355
470
</para>
356
471
</refsect1>
357
472
412
527
</listitem>
413
528
</varlistentry>
414
529
<varlistentry>
415
<term><filename>/var/run/mandos.pid</filename></term>
416
<listitem>
417
<para>
418
The file containing the process id of
419
<command>&COMMANDNAME;</command>.
530
<term><filename>/run/mandos.pid</filename></term>
531
<listitem>
532
<para>
533
The file containing the process id of the
534
<command>&COMMANDNAME;</command> process started last.
535
<emphasis >Note:</emphasis> If the <filename
536
class="directory">/run</filename> directory does not
537
exist, <filename>/var/run/mandos.pid</filename> will be
538
used instead.
539
</para>
540
</listitem>
541
</varlistentry>
542
<varlistentry>
543
<term><filename class="devicefile">/dev/log</filename></term>
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.
420
553
</para>
421
554
</listitem>
422
555
</varlistentry>
450
583
backtrace. This could be considered a feature.
451
584
</para>
452
585
<para>
453
Currently, if a client is declared <quote>invalid</quote> due to
454
having timed out, the server does not record this fact onto
455
permanent storage. This has some security implications, see
456
<xref linkend="clients"/>.
457
</para>
458
<para>
459
There is currently no way of querying the server of the current
460
status of clients, other than analyzing its <systemitem
461
class="service">syslog</systemitem> output.
462
</para>
463
<para>
464
586
There is no fine-grained control over logging and debug output.
465
587
</para>
466
588
<para>
467
Debug mode is conflated with running in the foreground.
468
</para>
469
<para>
470
The console log messages do not show a time stamp.
471
</para>
472
<para>
473
589
This server does not check the expire time of clients’ OpenPGP
474
590
keys.
475
591
</para>
488
604
<informalexample>
489
605
<para>
490
606
Run the server in debug mode, read configuration files from
491
the <filename>~/mandos</filename> directory, and use the
492
Zeroconf service name <quote>Test</quote> to not collide with
493
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:
494
610
</para>
495
611
<para>
496
612
545
661
compromised if they are gone for too long.
546
662
</para>
547
663
<para>
548
If a client is compromised, its downtime should be duly noted
549
by the server which would therefore declare the client
550
invalid. But if the server was ever restarted, it would
551
re-read its client list from its configuration file and again
552
regard all clients therein as valid, and hence eligible to
553
receive their passwords. Therefore, be careful when
554
restarting servers if it is suspected that a client has, in
555
fact, been compromised by parties who may now be running a
556
fake Mandos client with the keys from the non-encrypted
557
initial <acronym>RAM</acronym> image of the client host. What
558
should be done in that case (if restarting the server program
559
really is necessary) is to stop the server program, edit the
560
configuration file to omit any suspect clients, and restart
561
the server program.
562
</para>
563
<para>
564
664
For more details on client-side security, see
565
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
566
666
<manvolnum>8mandos</manvolnum></citerefentry>.
571
671
<refsect1 id="see_also">
572
672
<title>SEE ALSO</title>
573
673
<para>
574
<citerefentry>
575
<refentrytitle>mandos-clients.conf</refentrytitle>
576
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
577
<refentrytitle>mandos.conf</refentrytitle>
578
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
579
<refentrytitle>mandos-client</refentrytitle>
580
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
581
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
582
</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>
583
684
</para>
584
685
<variablelist>
585
686
<varlistentry>
606
707
</varlistentry>
607
708
<varlistentry>
608
709
<term>
609
<ulink url="http://www.gnu.org/software/gnutls/"
610
>GnuTLS</ulink>
710
<ulink url="http://gnutls.org/">GnuTLS</ulink>
611
711
</term>
612
712
<listitem>
613
713
<para>
651
751
</varlistentry>
652
752
<varlistentry>
653
753
<term>
654
RFC 4346: <citetitle>The Transport Layer Security (TLS)
655
Protocol Version 1.1</citetitle>
754
RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
Protocol Version 1.2</citetitle>
656
756
</term>
657
757
<listitem>
658
758
<para>
659
TLS 1.1 is the protocol implemented by GnuTLS.
759
TLS 1.2 is the protocol implemented by GnuTLS.
660
760
</para>
661
761
</listitem>
662
762
</varlistentry>
672
772
</varlistentry>
673
773
<varlistentry>
674
774
<term>
675
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
676
Security</citetitle>
775
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
Security (TLS) Authentication</citetitle>
677
777
</term>
678
778
<listitem>
679
779
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0