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 788
- compare with another revision
- download diff
- download tarball
- view history from revision 788
- Committer: Teddy Hogeborn
- Date: 2015-08-10 21:23:46 UTC
- mfrom: (237.4.57 release)
- Revision ID: teddy@recompile.se-20150810212346-wvobzmqnnit9q8px
Merge from release branch.
- 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-12-09">
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>
90
99
<sbr/>
91
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>
92
113
</cmdsynopsis>
93
114
<cmdsynopsis>
94
115
<command>&COMMANDNAME;</command>
112
133
<para>
113
134
<command>&COMMANDNAME;</command> is a server daemon which
114
135
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.
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.
123
146
</para>
124
147
</refsect1>
125
148
194
217
</varlistentry>
195
218
196
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>
197
238
<term><option>--priority <replaceable>
198
239
PRIORITY</replaceable></option></term>
199
240
<listitem>
250
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
292
</listitem>
252
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
253
336
</variablelist>
254
337
</refsect1>
255
338
329
412
for some time, the client is assumed to be compromised and is no
330
413
longer eligible to receive the encrypted password. (Manual
331
414
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>
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>
334
429
<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.
338
</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
339
440
</refsect1>
340
441
341
442
<refsect1 id="logging">
342
443
<title>LOGGING</title>
343
444
<para>
344
445
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
346
447
<option>--debug</option> option, it will log even more messages,
347
448
and also show them on the console.
348
449
</para>
349
450
</refsect1>
350
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
351
464
<refsect1 id="dbus_interface">
352
465
<title>D-BUS INTERFACE</title>
353
466
<para>
354
467
The server will by default provide a D-Bus system bus interface.
355
468
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists.
357
<!-- 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>.
358
471
</para>
359
472
</refsect1>
360
473
415
528
</listitem>
416
529
</varlistentry>
417
530
<varlistentry>
418
<term><filename>/var/run/mandos.pid</filename></term>
419
<listitem>
420
<para>
421
The file containing the process id of
422
<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.
423
554
</para>
424
555
</listitem>
425
556
</varlistentry>
453
584
backtrace. This could be considered a feature.
454
585
</para>
455
586
<para>
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
has some security implications, see <xref linkend="clients"/>.
459
</para>
460
<para>
461
There is currently no way of querying the server of the current
462
status of clients, other than analyzing its <systemitem
463
class="service">syslog</systemitem> output.
464
</para>
465
<para>
466
587
There is no fine-grained control over logging and debug output.
467
588
</para>
468
589
<para>
469
Debug mode is conflated with running in the foreground.
470
</para>
471
<para>
472
The console log messages do not show a time stamp.
473
</para>
474
<para>
475
590
This server does not check the expire time of clients’ OpenPGP
476
591
keys.
477
592
</para>
490
605
<informalexample>
491
606
<para>
492
607
Run the server in debug mode, read configuration files from
493
the <filename>~/mandos</filename> directory, and use the
494
Zeroconf service name <quote>Test</quote> to not collide with
495
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:
496
611
</para>
497
612
<para>
498
613
547
662
compromised if they are gone for too long.
548
663
</para>
549
664
<para>
550
If a client is compromised, its downtime should be duly noted
551
by the server which would therefore disable the client. But
552
if the server was ever restarted, it would re-read its client
553
list from its configuration file and again regard all clients
554
therein as enabled, and hence eligible to receive their
555
passwords. Therefore, be careful when restarting servers if
556
it is suspected that a client has, in fact, been compromised
557
by parties who may now be running a fake Mandos client with
558
the keys from the non-encrypted initial <acronym>RAM</acronym>
559
image of the client host. What should be done in that case
560
(if restarting the server program really is necessary) is to
561
stop the server program, edit the configuration file to omit
562
any suspect clients, and restart the server program.
563
</para>
564
<para>
565
665
For more details on client-side security, see
566
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
567
667
<manvolnum>8mandos</manvolnum></citerefentry>.
572
672
<refsect1 id="see_also">
573
673
<title>SEE ALSO</title>
574
674
<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>
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>
584
685
</para>
585
686
<variablelist>
586
687
<varlistentry>
607
708
</varlistentry>
608
709
<varlistentry>
609
710
<term>
610
<ulink url="http://www.gnu.org/software/gnutls/"
611
>GnuTLS</ulink>
711
<ulink url="http://gnutls.org/">GnuTLS</ulink>
612
712
</term>
613
713
<listitem>
614
714
<para>
652
752
</varlistentry>
653
753
<varlistentry>
654
754
<term>
655
RFC 4346: <citetitle>The Transport Layer Security (TLS)
656
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
657
757
</term>
658
758
<listitem>
659
759
<para>
660
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
661
761
</para>
662
762
</listitem>
663
763
</varlistentry>
673
773
</varlistentry>
674
774
<varlistentry>
675
775
<term>
676
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
677
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
678
778
</term>
679
779
<listitem>
680
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0