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.32
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.32
- Committer: Teddy Hogeborn
- Date: 2012-06-01 18:39:03 UTC
- mfrom: (237.8.1 release)
- mto: (237.4.33 release)
- mto: This revision was merged to the branch mainline in revision 593.
- Revision ID: teddy@recompile.se-20120601183903-hydodgfmlau5d109
Tags: version-1.5.5-1
* Makefile (version): Changed to "1.5.5".
* NEWS (Version 1.5.5): New entry.
* debian/changelog (1.5.5-1): - '' -
* NEWS (Version 1.5.5): New entry.
* debian/changelog (1.5.5-1): - '' -
- files added:
- DBUS-API
- debian/source
- network-hooks.d
- files removed:
- debian/mandos-client.config
- 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-05-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>
36
39
<holder>Teddy Hogeborn</holder>
37
40
<holder>Björn Påhlsson</holder>
38
41
</copyright>
85
88
<replaceable>DIRECTORY</replaceable></option></arg>
86
89
<sbr/>
87
90
<arg><option>--debug</option></arg>
91
<sbr/>
92
<arg><option>--debuglevel
93
<replaceable>LEVEL</replaceable></option></arg>
94
<sbr/>
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>
88
106
</cmdsynopsis>
89
107
<cmdsynopsis>
90
108
<command>&COMMANDNAME;</command>
108
126
<para>
109
127
<command>&COMMANDNAME;</command> is a server daemon which
110
128
handles incoming request for passwords for a pre-defined list of
111
client host computers. The Mandos server uses Zeroconf to
112
announce itself on the local network, and uses TLS to
113
communicate securely with and to authenticate the clients. The
114
Mandos server uses IPv6 to allow Mandos clients to use IPv6
115
link-local addresses, since the clients will probably not have
116
any other addresses configured (see <xref linkend="overview"/>).
117
Any authenticated client is then given the stored pre-encrypted
118
password for that specific client.
129
client host computers. For an introduction, see
130
<citerefentry><refentrytitle>intro</refentrytitle>
131
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
132
uses Zeroconf to announce itself on the local network, and uses
133
TLS to communicate securely with and to authenticate the
134
clients. The Mandos server uses IPv6 to allow Mandos clients to
135
use IPv6 link-local addresses, since the clients will probably
136
not have any other addresses configured (see <xref
137
linkend="overview"/>). Any authenticated client is then given
138
the stored pre-encrypted password for that specific client.
119
139
</para>
120
140
</refsect1>
121
141
190
210
</varlistentry>
191
211
192
212
<varlistentry>
213
<term><option>--debuglevel
214
<replaceable>LEVEL</replaceable></option></term>
215
<listitem>
216
<para>
217
Set the debugging log level.
218
<replaceable>LEVEL</replaceable> is a string, one of
219
<quote><literal>CRITICAL</literal></quote>,
220
<quote><literal>ERROR</literal></quote>,
221
<quote><literal>WARNING</literal></quote>,
222
<quote><literal>INFO</literal></quote>, or
223
<quote><literal>DEBUG</literal></quote>, in order of
224
increasing verbosity. The default level is
225
<quote><literal>WARNING</literal></quote>.
226
</para>
227
</listitem>
228
</varlistentry>
229
230
<varlistentry>
193
231
<term><option>--priority <replaceable>
194
232
PRIORITY</replaceable></option></term>
195
233
<listitem>
229
267
</para>
230
268
</listitem>
231
269
</varlistentry>
270
271
<varlistentry>
272
<term><option>--no-dbus</option></term>
273
<listitem>
274
<xi:include href="mandos-options.xml" xpointer="dbus"/>
275
<para>
276
See also <xref linkend="dbus_interface"/>.
277
</para>
278
</listitem>
279
</varlistentry>
280
281
<varlistentry>
282
<term><option>--no-ipv6</option></term>
283
<listitem>
284
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
285
</listitem>
286
</varlistentry>
287
288
<varlistentry>
289
<term><option>--no-restore</option></term>
290
<listitem>
291
<xi:include href="mandos-options.xml" xpointer="restore"/>
292
<para>
293
See also <xref linkend="persistent_state"/>.
294
</para>
295
</listitem>
296
</varlistentry>
297
298
<varlistentry>
299
<term><option>--statedir
300
<replaceable>DIRECTORY</replaceable></option></term>
301
<listitem>
302
<xi:include href="mandos-options.xml" xpointer="statedir"/>
303
</listitem>
304
</varlistentry>
305
306
<varlistentry>
307
<term><option>--socket
308
<replaceable>FD</replaceable></option></term>
309
<listitem>
310
<xi:include href="mandos-options.xml" xpointer="socket"/>
311
</listitem>
312
</varlistentry>
313
232
314
</variablelist>
233
315
</refsect1>
234
316
306
388
The server will, by default, continually check that the clients
307
389
are still up. If a client has not been confirmed as being up
308
390
for some time, the client is assumed to be compromised and is no
309
longer eligible to receive the encrypted password. The timeout,
310
checker program, and interval between checks can be configured
311
both globally and per client; see <citerefentry>
391
longer eligible to receive the encrypted password. (Manual
392
intervention is required to re-enable a client.) The timeout,
393
extended timeout, checker program, and interval between checks
394
can be configured both globally and per client; see
395
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
396
<manvolnum>5</manvolnum></citerefentry>.
397
</para>
398
</refsect1>
399
400
<refsect1 id="approval">
401
<title>APPROVAL</title>
402
<para>
403
The server can be configured to require manual approval for a
404
client before it is sent its secret. The delay to wait for such
405
approval and the default action (approve or deny) can be
406
configured both globally and per client; see <citerefentry>
312
407
<refentrytitle>mandos-clients.conf</refentrytitle>
313
<manvolnum>5</manvolnum></citerefentry>.
314
</para>
408
<manvolnum>5</manvolnum></citerefentry>. By default all clients
409
will be approved immediately without delay.
410
</para>
411
<para>
412
This can be used to deny a client its secret if not manually
413
approved within a specified time. It can also be used to make
414
the server delay before giving a client its secret, allowing
415
optional manual denying of this specific client.
416
</para>
417
315
418
</refsect1>
316
419
317
420
<refsect1 id="logging">
318
421
<title>LOGGING</title>
319
422
<para>
320
423
The server will send log message with various severity levels to
321
<filename>/dev/log</filename>. With the
424
<filename class="devicefile">/dev/log</filename>. With the
322
425
<option>--debug</option> option, it will log even more messages,
323
426
and also show them on the console.
324
427
</para>
325
428
</refsect1>
326
429
430
<refsect1 id="persistent_state">
431
<title>PERSISTENT STATE</title>
432
<para>
433
Client settings, initially read from
434
<filename>clients.conf</filename>, are persistent across
435
restarts, and run-time changes will override settings in
436
<filename>clients.conf</filename>. However, if a setting is
437
<emphasis>changed</emphasis> (or a client added, or removed) in
438
<filename>clients.conf</filename>, this will take precedence.
439
</para>
440
</refsect1>
441
442
<refsect1 id="dbus_interface">
443
<title>D-BUS INTERFACE</title>
444
<para>
445
The server will by default provide a D-Bus system bus interface.
446
This interface will only be accessible by the root user or a
447
Mandos-specific user, if such a user exists. For documentation
448
of the D-Bus API, see the file <filename>DBUS-API</filename>.
449
</para>
450
</refsect1>
451
327
452
<refsect1 id="exit_status">
328
453
<title>EXIT STATUS</title>
329
454
<para>
384
509
<term><filename>/var/run/mandos.pid</filename></term>
385
510
<listitem>
386
511
<para>
387
The file containing the process id of
388
<command>&COMMANDNAME;</command>.
512
The file containing the process id of the
513
<command>&COMMANDNAME;</command> process started last.
514
</para>
515
</listitem>
516
</varlistentry>
517
<varlistentry>
518
<term><filename class="devicefile">/dev/log</filename></term>
519
</varlistentry>
520
<varlistentry>
521
<term><filename
522
class="directory">/var/lib/mandos</filename></term>
523
<listitem>
524
<para>
525
Directory where persistent state will be saved. Change
526
this with the <option>--statedir</option> option. See
527
also the <option>--no-restore</option> option.
389
528
</para>
390
529
</listitem>
391
530
</varlistentry>
419
558
backtrace. This could be considered a feature.
420
559
</para>
421
560
<para>
422
Currently, if a client is declared <quote>invalid</quote> due to
423
having timed out, the server does not record this fact onto
424
permanent storage. This has some security implications, see
425
<xref linkend="clients"/>.
426
</para>
427
<para>
428
There is currently no way of querying the server of the current
429
status of clients, other than analyzing its <systemitem
430
class="service">syslog</systemitem> output.
431
</para>
432
<para>
433
561
There is no fine-grained control over logging and debug output.
434
562
</para>
435
563
<para>
436
564
Debug mode is conflated with running in the foreground.
437
565
</para>
438
566
<para>
439
The console log messages does not show a time stamp.
440
</para>
441
<para>
442
567
This server does not check the expire time of clients’ OpenPGP
443
568
keys.
444
569
</para>
457
582
<informalexample>
458
583
<para>
459
584
Run the server in debug mode, read configuration files from
460
the <filename>~/mandos</filename> directory, and use the
461
Zeroconf service name <quote>Test</quote> to not collide with
462
any other official Mandos server on this host:
585
the <filename class="directory">~/mandos</filename> directory,
586
and use the Zeroconf service name <quote>Test</quote> to not
587
collide with any other official Mandos server on this host:
463
588
</para>
464
589
<para>
465
590
514
639
compromised if they are gone for too long.
515
640
</para>
516
641
<para>
517
If a client is compromised, its downtime should be duly noted
518
by the server which would therefore declare the client
519
invalid. But if the server was ever restarted, it would
520
re-read its client list from its configuration file and again
521
regard all clients therein as valid, and hence eligible to
522
receive their passwords. Therefore, be careful when
523
restarting servers if it is suspected that a client has, in
524
fact, been compromised by parties who may now be running a
525
fake Mandos client with the keys from the non-encrypted
526
initial <acronym>RAM</acronym> image of the client host. What
527
should be done in that case (if restarting the server program
528
really is necessary) is to stop the server program, edit the
529
configuration file to omit any suspect clients, and restart
530
the server program.
531
</para>
532
<para>
533
642
For more details on client-side security, see
534
643
<citerefentry><refentrytitle>mandos-client</refentrytitle>
535
644
<manvolnum>8mandos</manvolnum></citerefentry>.
540
649
<refsect1 id="see_also">
541
650
<title>SEE ALSO</title>
542
651
<para>
543
<citerefentry>
544
<refentrytitle>mandos-clients.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>mandos-client</refentrytitle>
549
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
550
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
551
</citerefentry>
652
<citerefentry><refentrytitle>intro</refentrytitle>
653
<manvolnum>8mandos</manvolnum></citerefentry>,
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
655
<manvolnum>5</manvolnum></citerefentry>,
656
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
657
<manvolnum>5</manvolnum></citerefentry>,
658
<citerefentry><refentrytitle>mandos-client</refentrytitle>
659
<manvolnum>8mandos</manvolnum></citerefentry>,
660
<citerefentry><refentrytitle>sh</refentrytitle>
661
<manvolnum>1</manvolnum></citerefentry>
552
662
</para>
553
663
<variablelist>
554
664
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0