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.155
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.155
- Committer: Teddy Hogeborn
- Date: 2012-06-17 22:58:07 UTC
- mfrom: (302 release)
- mto: (237.7.272 trunk)
- mto: This revision was merged to the branch mainline in revision 303.
- Revision ID: teddy@recompile.se-20120617225807-6o4z294a5fxfvlyf
Merge from release branch.
- files added:
- DBUS-API
- debian/source
- 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-01-04">
5
<!ENTITY TIMESTAMP "2012-06-17">
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>
36
39
<holder>Teddy Hogeborn</holder>
37
40
<holder>Björn Påhlsson</holder>
38
41
</copyright>
86
89
<sbr/>
87
90
<arg><option>--debug</option></arg>
88
91
<sbr/>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
94
<sbr/>
89
95
<arg><option>--no-dbus</option></arg>
96
<sbr/>
97
<arg><option>--no-ipv6</option></arg>
98
<sbr/>
99
<arg><option>--no-restore</option></arg>
100
<sbr/>
101
<arg><option>--statedir
102
<replaceable>DIRECTORY</replaceable></option></arg>
103
<sbr/>
104
<arg><option>--socket
105
<replaceable>FD</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--foreground</option></arg>
90
108
</cmdsynopsis>
91
109
<cmdsynopsis>
92
110
<command>&COMMANDNAME;</command>
110
128
<para>
111
129
<command>&COMMANDNAME;</command> is a server daemon which
112
130
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.
131
client host computers. For an introduction, see
132
<citerefentry><refentrytitle>intro</refentrytitle>
133
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
134
uses Zeroconf to announce itself on the local network, and uses
135
TLS to communicate securely with and to authenticate the
136
clients. The Mandos server uses IPv6 to allow Mandos clients to
137
use IPv6 link-local addresses, since the clients will probably
138
not have any other addresses configured (see <xref
139
linkend="overview"/>). Any authenticated client is then given
140
the stored pre-encrypted password for that specific client.
121
141
</para>
122
142
</refsect1>
123
143
192
212
</varlistentry>
193
213
194
214
<varlistentry>
215
<term><option>--debuglevel
216
<replaceable>LEVEL</replaceable></option></term>
217
<listitem>
218
<para>
219
Set the debugging log level.
220
<replaceable>LEVEL</replaceable> is a string, one of
221
<quote><literal>CRITICAL</literal></quote>,
222
<quote><literal>ERROR</literal></quote>,
223
<quote><literal>WARNING</literal></quote>,
224
<quote><literal>INFO</literal></quote>, or
225
<quote><literal>DEBUG</literal></quote>, in order of
226
increasing verbosity. The default level is
227
<quote><literal>WARNING</literal></quote>.
228
</para>
229
</listitem>
230
</varlistentry>
231
232
<varlistentry>
195
233
<term><option>--priority <replaceable>
196
234
PRIORITY</replaceable></option></term>
197
235
<listitem>
241
279
</para>
242
280
</listitem>
243
281
</varlistentry>
282
283
<varlistentry>
284
<term><option>--no-ipv6</option></term>
285
<listitem>
286
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
287
</listitem>
288
</varlistentry>
289
290
<varlistentry>
291
<term><option>--no-restore</option></term>
292
<listitem>
293
<xi:include href="mandos-options.xml" xpointer="restore"/>
294
<para>
295
See also <xref linkend="persistent_state"/>.
296
</para>
297
</listitem>
298
</varlistentry>
299
300
<varlistentry>
301
<term><option>--statedir
302
<replaceable>DIRECTORY</replaceable></option></term>
303
<listitem>
304
<xi:include href="mandos-options.xml" xpointer="statedir"/>
305
</listitem>
306
</varlistentry>
307
308
<varlistentry>
309
<term><option>--socket
310
<replaceable>FD</replaceable></option></term>
311
<listitem>
312
<xi:include href="mandos-options.xml" xpointer="socket"/>
313
</listitem>
314
</varlistentry>
315
316
<varlistentry>
317
<term><option>--foreground</option></term>
318
<listitem>
319
<xi:include href="mandos-options.xml"
320
xpointer="foreground"/>
321
</listitem>
322
</varlistentry>
323
244
324
</variablelist>
245
325
</refsect1>
246
326
318
398
The server will, by default, continually check that the clients
319
399
are still up. If a client has not been confirmed as being up
320
400
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>
401
longer eligible to receive the encrypted password. (Manual
402
intervention is required to re-enable a client.) The timeout,
403
extended timeout, checker program, and interval between checks
404
can be configured both globally and per client; see
405
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
406
<manvolnum>5</manvolnum></citerefentry>.
407
</para>
408
</refsect1>
409
410
<refsect1 id="approval">
411
<title>APPROVAL</title>
412
<para>
413
The server can be configured to require manual approval for a
414
client before it is sent its secret. The delay to wait for such
415
approval and the default action (approve or deny) can be
416
configured both globally and per client; see <citerefentry>
324
417
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
418
<manvolnum>5</manvolnum></citerefentry>. By default all clients
419
will be approved immediately without delay.
420
</para>
421
<para>
422
This can be used to deny a client its secret if not manually
423
approved within a specified time. It can also be used to make
424
the server delay before giving a client its secret, allowing
425
optional manual denying of this specific client.
426
</para>
427
327
428
</refsect1>
328
429
329
430
<refsect1 id="logging">
330
431
<title>LOGGING</title>
331
432
<para>
332
433
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
434
<filename class="devicefile">/dev/log</filename>. With the
334
435
<option>--debug</option> option, it will log even more messages,
335
436
and also show them on the console.
336
437
</para>
337
438
</refsect1>
338
439
440
<refsect1 id="persistent_state">
441
<title>PERSISTENT STATE</title>
442
<para>
443
Client settings, initially read from
444
<filename>clients.conf</filename>, are persistent across
445
restarts, and run-time changes will override settings in
446
<filename>clients.conf</filename>. However, if a setting is
447
<emphasis>changed</emphasis> (or a client added, or removed) in
448
<filename>clients.conf</filename>, this will take precedence.
449
</para>
450
</refsect1>
451
339
452
<refsect1 id="dbus_interface">
340
453
<title>D-BUS INTERFACE</title>
341
454
<para>
342
455
The server will by default provide a D-Bus system bus interface.
343
456
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
457
Mandos-specific user, if such a user exists. For documentation
458
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
459
</para>
347
460
</refsect1>
348
461
349
462
<refsect1 id="exit_status">
350
463
<title>EXIT STATUS</title>
351
464
<para>
406
519
<term><filename>/var/run/mandos.pid</filename></term>
407
520
<listitem>
408
521
<para>
409
The file containing the process id of
410
<command>&COMMANDNAME;</command>.
522
The file containing the process id of the
523
<command>&COMMANDNAME;</command> process started last.
524
</para>
525
</listitem>
526
</varlistentry>
527
<varlistentry>
528
<term><filename class="devicefile">/dev/log</filename></term>
529
</varlistentry>
530
<varlistentry>
531
<term><filename
532
class="directory">/var/lib/mandos</filename></term>
533
<listitem>
534
<para>
535
Directory where persistent state will be saved. Change
536
this with the <option>--statedir</option> option. See
537
also the <option>--no-restore</option> option.
411
538
</para>
412
539
</listitem>
413
540
</varlistentry>
441
568
backtrace. This could be considered a feature.
442
569
</para>
443
570
<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
571
There is no fine-grained control over logging and debug output.
456
572
</para>
457
573
<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
574
This server does not check the expire time of clients’ OpenPGP
465
575
keys.
466
576
</para>
479
589
<informalexample>
480
590
<para>
481
591
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:
592
the <filename class="directory">~/mandos</filename> directory,
593
and use the Zeroconf service name <quote>Test</quote> to not
594
collide with any other official Mandos server on this host:
485
595
</para>
486
596
<para>
487
597
536
646
compromised if they are gone for too long.
537
647
</para>
538
648
<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
649
For more details on client-side security, see
556
650
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
651
<manvolnum>8mandos</manvolnum></citerefentry>.
562
656
<refsect1 id="see_also">
563
657
<title>SEE ALSO</title>
564
658
<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>
659
<citerefentry><refentrytitle>intro</refentrytitle>
660
<manvolnum>8mandos</manvolnum></citerefentry>,
661
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
662
<manvolnum>5</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>sh</refentrytitle>
668
<manvolnum>1</manvolnum></citerefentry>
574
669
</para>
575
670
<variablelist>
576
671
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0