To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos.xml
- browse files at revision 237.7.342
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.342
- Committer: Teddy Hogeborn
- Date: 2015-12-05 02:00:01 UTC
- mfrom: (330 release)
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 331.
- Revision ID: teddy@recompile.se-20151205020001-b0cpa52ame0usaul
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 "2015-07-20">
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>
36
42
<holder>Teddy Hogeborn</holder>
37
43
<holder>Björn Påhlsson</holder>
38
44
</copyright>
86
92
<sbr/>
87
93
<arg><option>--debug</option></arg>
88
94
<sbr/>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
97
<sbr/>
89
98
<arg><option>--no-dbus</option></arg>
99
<sbr/>
100
<arg><option>--no-ipv6</option></arg>
101
<sbr/>
102
<arg><option>--no-restore</option></arg>
103
<sbr/>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--foreground</option></arg>
111
<sbr/>
112
<arg><option>--no-zeroconf</option></arg>
90
113
</cmdsynopsis>
91
114
<cmdsynopsis>
92
115
<command>&COMMANDNAME;</command>
110
133
<para>
111
134
<command>&COMMANDNAME;</command> is a server daemon which
112
135
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.
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
121
146
</para>
122
147
</refsect1>
123
148
192
217
</varlistentry>
193
218
194
219
<varlistentry>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
222
<listitem>
223
<para>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
233
</para>
234
</listitem>
235
</varlistentry>
236
237
<varlistentry>
195
238
<term><option>--priority <replaceable>
196
239
PRIORITY</replaceable></option></term>
197
240
<listitem>
241
284
</para>
242
285
</listitem>
243
286
</varlistentry>
287
288
<varlistentry>
289
<term><option>--no-ipv6</option></term>
290
<listitem>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
</listitem>
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--no-restore</option></term>
297
<listitem>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
<para>
300
See also <xref linkend="persistent_state"/>.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
308
<listitem>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
</listitem>
311
</varlistentry>
312
313
<varlistentry>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
316
<listitem>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
</listitem>
319
</varlistentry>
320
321
<varlistentry>
322
<term><option>--foreground</option></term>
323
<listitem>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>--no-zeroconf</option></term>
331
<listitem>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
</listitem>
334
</varlistentry>
335
244
336
</variablelist>
245
337
</refsect1>
246
338
318
410
The server will, by default, continually check that the clients
319
411
are still up. If a client has not been confirmed as being up
320
412
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>
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
<manvolnum>5</manvolnum></citerefentry>.
419
</para>
420
</refsect1>
421
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
424
<para>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
324
429
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
432
</para>
433
<para>
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
438
</para>
439
327
440
</refsect1>
328
441
329
442
<refsect1 id="logging">
330
443
<title>LOGGING</title>
331
444
<para>
332
445
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
334
447
<option>--debug</option> option, it will log even more messages,
335
448
and also show them on the console.
336
449
</para>
337
450
</refsect1>
338
451
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
454
<para>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
461
</para>
462
</refsect1>
463
339
464
<refsect1 id="dbus_interface">
340
465
<title>D-BUS INTERFACE</title>
341
466
<para>
342
467
The server will by default provide a D-Bus system bus interface.
343
468
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
471
</para>
347
472
</refsect1>
348
473
349
474
<refsect1 id="exit_status">
350
475
<title>EXIT STATUS</title>
351
476
<para>
403
528
</listitem>
404
529
</varlistentry>
405
530
<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>.
531
<term><filename>/run/mandos.pid</filename></term>
532
<listitem>
533
<para>
534
The file containing the process id of the
535
<command>&COMMANDNAME;</command> process started last.
536
<emphasis >Note:</emphasis> If the <filename
537
class="directory">/run</filename> directory does not
538
exist, <filename>/var/run/mandos.pid</filename> will be
539
used instead.
540
</para>
541
</listitem>
542
</varlistentry>
543
<varlistentry>
544
<term><filename class="devicefile">/dev/log</filename></term>
545
</varlistentry>
546
<varlistentry>
547
<term><filename
548
class="directory">/var/lib/mandos</filename></term>
549
<listitem>
550
<para>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
411
554
</para>
412
555
</listitem>
413
556
</varlistentry>
441
584
backtrace. This could be considered a feature.
442
585
</para>
443
586
<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
587
There is no fine-grained control over logging and debug output.
456
588
</para>
457
589
<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
590
This server does not check the expire time of clients’ OpenPGP
465
591
keys.
466
592
</para>
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="http://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