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 237.4.41
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.41
- Committer: Teddy Hogeborn
- Date: 2014-02-16 13:12:20 UTC
- mto: This revision was merged to the branch mainline in revision 656.
- Revision ID: teddy@recompile.se-20140216131220-4nv9kjolkrxvn6l3
Tags: version-1.6.4-1
* Makefile (version): Changed to "1.6.4".
* NEWS (Version 1.6.4): New entry.
* debian/changelog (1.6.4-1): - '' -
* NEWS (Version 1.6.4): New entry.
* debian/changelog (1.6.4-1): - '' -
- files added:
- DBUS-API
- debian/source
- network-hooks.d
- 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 "2013-10-26">
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>
97
<sbr/>
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>
90
109
</cmdsynopsis>
91
110
<cmdsynopsis>
92
111
<command>&COMMANDNAME;</command>
110
129
<para>
111
130
<command>&COMMANDNAME;</command> is a server daemon which
112
131
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.
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
the stored pre-encrypted password for that specific client.
121
142
</para>
122
143
</refsect1>
123
144
192
213
</varlistentry>
193
214
194
215
<varlistentry>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
218
<listitem>
219
<para>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
229
</para>
230
</listitem>
231
</varlistentry>
232
233
<varlistentry>
195
234
<term><option>--priority <replaceable>
196
235
PRIORITY</replaceable></option></term>
197
236
<listitem>
198
<xi:include href="mandos-options.xml" xpointer="priority"/>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
199
239
</listitem>
200
240
</varlistentry>
201
241
241
281
</para>
242
282
</listitem>
243
283
</varlistentry>
284
285
<varlistentry>
286
<term><option>--no-ipv6</option></term>
287
<listitem>
288
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
</listitem>
290
</varlistentry>
291
292
<varlistentry>
293
<term><option>--no-restore</option></term>
294
<listitem>
295
<xi:include href="mandos-options.xml" xpointer="restore"/>
296
<para>
297
See also <xref linkend="persistent_state"/>.
298
</para>
299
</listitem>
300
</varlistentry>
301
302
<varlistentry>
303
<term><option>--statedir
304
<replaceable>DIRECTORY</replaceable></option></term>
305
<listitem>
306
<xi:include href="mandos-options.xml" xpointer="statedir"/>
307
</listitem>
308
</varlistentry>
309
310
<varlistentry>
311
<term><option>--socket
312
<replaceable>FD</replaceable></option></term>
313
<listitem>
314
<xi:include href="mandos-options.xml" xpointer="socket"/>
315
</listitem>
316
</varlistentry>
317
318
<varlistentry>
319
<term><option>--foreground</option></term>
320
<listitem>
321
<xi:include href="mandos-options.xml"
322
xpointer="foreground"/>
323
</listitem>
324
</varlistentry>
325
244
326
</variablelist>
245
327
</refsect1>
246
328
318
400
The server will, by default, continually check that the clients
319
401
are still up. If a client has not been confirmed as being up
320
402
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>
403
longer eligible to receive the encrypted password. (Manual
404
intervention is required to re-enable a client.) The timeout,
405
extended timeout, checker program, and interval between checks
406
can be configured both globally and per client; see
407
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>.
409
</para>
410
</refsect1>
411
412
<refsect1 id="approval">
413
<title>APPROVAL</title>
414
<para>
415
The server can be configured to require manual approval for a
416
client before it is sent its secret. The delay to wait for such
417
approval and the default action (approve or deny) can be
418
configured both globally and per client; see <citerefentry>
324
419
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
420
<manvolnum>5</manvolnum></citerefentry>. By default all clients
421
will be approved immediately without delay.
422
</para>
423
<para>
424
This can be used to deny a client its secret if not manually
425
approved within a specified time. It can also be used to make
426
the server delay before giving a client its secret, allowing
427
optional manual denying of this specific client.
428
</para>
429
327
430
</refsect1>
328
431
329
432
<refsect1 id="logging">
330
433
<title>LOGGING</title>
331
434
<para>
332
435
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
436
<filename class="devicefile">/dev/log</filename>. With the
334
437
<option>--debug</option> option, it will log even more messages,
335
438
and also show them on the console.
336
439
</para>
337
440
</refsect1>
338
441
442
<refsect1 id="persistent_state">
443
<title>PERSISTENT STATE</title>
444
<para>
445
Client settings, initially read from
446
<filename>clients.conf</filename>, are persistent across
447
restarts, and run-time changes will override settings in
448
<filename>clients.conf</filename>. However, if a setting is
449
<emphasis>changed</emphasis> (or a client added, or removed) in
450
<filename>clients.conf</filename>, this will take precedence.
451
</para>
452
</refsect1>
453
339
454
<refsect1 id="dbus_interface">
340
455
<title>D-BUS INTERFACE</title>
341
456
<para>
342
457
The server will by default provide a D-Bus system bus interface.
343
458
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
461
</para>
347
462
</refsect1>
348
463
349
464
<refsect1 id="exit_status">
350
465
<title>EXIT STATUS</title>
351
466
<para>
403
518
</listitem>
404
519
</varlistentry>
405
520
<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>.
521
<term><filename>/run/mandos.pid</filename></term>
522
<listitem>
523
<para>
524
The file containing the process id of the
525
<command>&COMMANDNAME;</command> process started last.
526
<emphasis >Note:</emphasis> If the <filename
527
class="directory">/run</filename> directory does not
528
exist, <filename>/var/run/mandos.pid</filename> will be
529
used instead.
530
</para>
531
</listitem>
532
</varlistentry>
533
<varlistentry>
534
<term><filename class="devicefile">/dev/log</filename></term>
535
</varlistentry>
536
<varlistentry>
537
<term><filename
538
class="directory">/var/lib/mandos</filename></term>
539
<listitem>
540
<para>
541
Directory where persistent state will be saved. Change
542
this with the <option>--statedir</option> option. See
543
also the <option>--no-restore</option> option.
411
544
</para>
412
545
</listitem>
413
546
</varlistentry>
441
574
backtrace. This could be considered a feature.
442
575
</para>
443
576
<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
577
There is no fine-grained control over logging and debug output.
456
578
</para>
457
579
<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
580
This server does not check the expire time of clients’ OpenPGP
465
581
keys.
466
582
</para>
479
595
<informalexample>
480
596
<para>
481
597
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:
598
the <filename class="directory">~/mandos</filename> directory,
599
and use the Zeroconf service name <quote>Test</quote> to not
600
collide with any other official Mandos server on this host:
485
601
</para>
486
602
<para>
487
603
536
652
compromised if they are gone for too long.
537
653
</para>
538
654
<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
655
For more details on client-side security, see
556
656
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
657
<manvolnum>8mandos</manvolnum></citerefentry>.
562
662
<refsect1 id="see_also">
563
663
<title>SEE ALSO</title>
564
664
<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>
665
<citerefentry><refentrytitle>intro</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
<manvolnum>5</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
<manvolnum>5</manvolnum></citerefentry>,
671
<citerefentry><refentrytitle>mandos-client</refentrytitle>
672
<manvolnum>8mandos</manvolnum></citerefentry>,
673
<citerefentry><refentrytitle>sh</refentrytitle>
674
<manvolnum>1</manvolnum></citerefentry>
574
675
</para>
575
676
<variablelist>
576
677
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0