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 550
- compare with another revision
- download diff
- download tarball
- view history from revision 550
- Committer: Teddy Hogeborn
- Date: 2012-01-01 20:45:53 UTC
- Revision ID: teddy@recompile.se-20120101204553-f1zlty873gswtf5n
* README: Hint that the intro(8mandos) manual page is in the server
package.
package.
- 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-02-24">
5
<!ENTITY TIMESTAMP "2012-01-01">
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/>
95
<arg><option>--no-dbus</option></arg>
96
<sbr/>
89
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>
90
103
</cmdsynopsis>
91
104
<cmdsynopsis>
92
105
<command>&COMMANDNAME;</command>
110
123
<para>
111
124
<command>&COMMANDNAME;</command> is a server daemon which
112
125
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.
126
client host computers. For an introduction, see
127
<citerefentry><refentrytitle>intro</refentrytitle>
128
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
129
uses Zeroconf to announce itself on the local network, and uses
130
TLS to communicate securely with and to authenticate the
131
clients. The Mandos server uses IPv6 to allow Mandos clients to
132
use IPv6 link-local addresses, since the clients will probably
133
not have any other addresses configured (see <xref
134
linkend="overview"/>). Any authenticated client is then given
135
the stored pre-encrypted password for that specific client.
121
136
</para>
122
137
</refsect1>
123
138
192
207
</varlistentry>
193
208
194
209
<varlistentry>
210
<term><option>--debuglevel
211
<replaceable>LEVEL</replaceable></option></term>
212
<listitem>
213
<para>
214
Set the debugging log level.
215
<replaceable>LEVEL</replaceable> is a string, one of
216
<quote><literal>CRITICAL</literal></quote>,
217
<quote><literal>ERROR</literal></quote>,
218
<quote><literal>WARNING</literal></quote>,
219
<quote><literal>INFO</literal></quote>, or
220
<quote><literal>DEBUG</literal></quote>, in order of
221
increasing verbosity. The default level is
222
<quote><literal>WARNING</literal></quote>.
223
</para>
224
</listitem>
225
</varlistentry>
226
227
<varlistentry>
195
228
<term><option>--priority <replaceable>
196
229
PRIORITY</replaceable></option></term>
197
230
<listitem>
233
266
</varlistentry>
234
267
235
268
<varlistentry>
269
<term><option>--no-dbus</option></term>
270
<listitem>
271
<xi:include href="mandos-options.xml" xpointer="dbus"/>
272
<para>
273
See also <xref linkend="dbus_interface"/>.
274
</para>
275
</listitem>
276
</varlistentry>
277
278
<varlistentry>
236
279
<term><option>--no-ipv6</option></term>
237
280
<listitem>
238
281
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
282
</listitem>
240
283
</varlistentry>
284
285
<varlistentry>
286
<term><option>--no-restore</option></term>
287
<listitem>
288
<xi:include href="mandos-options.xml" xpointer="restore"/>
289
<para>
290
See also <xref linkend="persistent_state"/>.
291
</para>
292
</listitem>
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--statedir
297
<replaceable>DIRECTORY</replaceable></option></term>
298
<listitem>
299
<xi:include href="mandos-options.xml" xpointer="statedir"/>
300
</listitem>
301
</varlistentry>
241
302
</variablelist>
242
303
</refsect1>
243
304
315
376
The server will, by default, continually check that the clients
316
377
are still up. If a client has not been confirmed as being up
317
378
for some time, the client is assumed to be compromised and is no
318
longer eligible to receive the encrypted password. The timeout,
319
checker program, and interval between checks can be configured
320
both globally and per client; see <citerefentry>
379
longer eligible to receive the encrypted password. (Manual
380
intervention is required to re-enable a client.) The timeout,
381
extended timeout, checker program, and interval between checks
382
can be configured both globally and per client; see
383
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
<manvolnum>5</manvolnum></citerefentry>. A client successfully
385
receiving its password will also be treated as a successful
386
checker run.
387
</para>
388
</refsect1>
389
390
<refsect1 id="approval">
391
<title>APPROVAL</title>
392
<para>
393
The server can be configured to require manual approval for a
394
client before it is sent its secret. The delay to wait for such
395
approval and the default action (approve or deny) can be
396
configured both globally and per client; see <citerefentry>
321
397
<refentrytitle>mandos-clients.conf</refentrytitle>
322
<manvolnum>5</manvolnum></citerefentry>.
323
</para>
398
<manvolnum>5</manvolnum></citerefentry>. By default all clients
399
will be approved immediately without delay.
400
</para>
401
<para>
402
This can be used to deny a client its secret if not manually
403
approved within a specified time. It can also be used to make
404
the server delay before giving a client its secret, allowing
405
optional manual denying of this specific client.
406
</para>
407
324
408
</refsect1>
325
409
326
410
<refsect1 id="logging">
327
411
<title>LOGGING</title>
328
412
<para>
329
413
The server will send log message with various severity levels to
330
<filename>/dev/log</filename>. With the
414
<filename class="devicefile">/dev/log</filename>. With the
331
415
<option>--debug</option> option, it will log even more messages,
332
416
and also show them on the console.
333
417
</para>
334
418
</refsect1>
335
419
420
<refsect1 id="persistent_state">
421
<title>PERSISTENT STATE</title>
422
<para>
423
Client settings, initially read from
424
<filename>clients.conf</filename>, are persistent across
425
restarts, and run-time changes will override settings in
426
<filename>clients.conf</filename>. However, if a setting is
427
<emphasis>changed</emphasis> (or a client added, or removed) in
428
<filename>clients.conf</filename>, this will take precedence.
429
</para>
430
</refsect1>
431
432
<refsect1 id="dbus_interface">
433
<title>D-BUS INTERFACE</title>
434
<para>
435
The server will by default provide a D-Bus system bus interface.
436
This interface will only be accessible by the root user or a
437
Mandos-specific user, if such a user exists. For documentation
438
of the D-Bus API, see the file <filename>DBUS-API</filename>.
439
</para>
440
</refsect1>
441
336
442
<refsect1 id="exit_status">
337
443
<title>EXIT STATUS</title>
338
444
<para>
393
499
<term><filename>/var/run/mandos.pid</filename></term>
394
500
<listitem>
395
501
<para>
396
The file containing the process id of
397
<command>&COMMANDNAME;</command>.
502
The file containing the process id of the
503
<command>&COMMANDNAME;</command> process started last.
504
</para>
505
</listitem>
506
</varlistentry>
507
<varlistentry>
508
<term><filename class="devicefile">/dev/log</filename></term>
509
</varlistentry>
510
<varlistentry>
511
<term><filename
512
class="directory">/var/lib/mandos</filename></term>
513
<listitem>
514
<para>
515
Directory where persistent state will be saved. Change
516
this with the <option>--statedir</option> option. See
517
also the <option>--no-restore</option> option.
398
518
</para>
399
519
</listitem>
400
520
</varlistentry>
428
548
backtrace. This could be considered a feature.
429
549
</para>
430
550
<para>
431
Currently, if a client is declared <quote>invalid</quote> due to
432
having timed out, the server does not record this fact onto
433
permanent storage. This has some security implications, see
434
<xref linkend="clients"/>.
435
</para>
436
<para>
437
There is currently no way of querying the server of the current
438
status of clients, other than analyzing its <systemitem
439
class="service">syslog</systemitem> output.
440
</para>
441
<para>
442
551
There is no fine-grained control over logging and debug output.
443
552
</para>
444
553
<para>
445
554
Debug mode is conflated with running in the foreground.
446
555
</para>
447
556
<para>
448
The console log messages do not show a time stamp.
449
</para>
450
<para>
451
557
This server does not check the expire time of clients’ OpenPGP
452
558
keys.
453
559
</para>
466
572
<informalexample>
467
573
<para>
468
574
Run the server in debug mode, read configuration files from
469
the <filename>~/mandos</filename> directory, and use the
470
Zeroconf service name <quote>Test</quote> to not collide with
471
any other official Mandos server on this host:
575
the <filename class="directory">~/mandos</filename> directory,
576
and use the Zeroconf service name <quote>Test</quote> to not
577
collide with any other official Mandos server on this host:
472
578
</para>
473
579
<para>
474
580
523
629
compromised if they are gone for too long.
524
630
</para>
525
631
<para>
526
If a client is compromised, its downtime should be duly noted
527
by the server which would therefore declare the client
528
invalid. But if the server was ever restarted, it would
529
re-read its client list from its configuration file and again
530
regard all clients therein as valid, and hence eligible to
531
receive their passwords. Therefore, be careful when
532
restarting servers if it is suspected that a client has, in
533
fact, been compromised by parties who may now be running a
534
fake Mandos client with the keys from the non-encrypted
535
initial <acronym>RAM</acronym> image of the client host. What
536
should be done in that case (if restarting the server program
537
really is necessary) is to stop the server program, edit the
538
configuration file to omit any suspect clients, and restart
539
the server program.
540
</para>
541
<para>
542
632
For more details on client-side security, see
543
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
544
634
<manvolnum>8mandos</manvolnum></citerefentry>.
549
639
<refsect1 id="see_also">
550
640
<title>SEE ALSO</title>
551
641
<para>
552
<citerefentry>
553
<refentrytitle>mandos-clients.conf</refentrytitle>
554
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
555
<refentrytitle>mandos.conf</refentrytitle>
556
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
557
<refentrytitle>mandos-client</refentrytitle>
558
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
559
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
560
</citerefentry>
642
<citerefentry><refentrytitle>intro</refentrytitle>
643
<manvolnum>8mandos</manvolnum></citerefentry>,
644
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
645
<manvolnum>5</manvolnum></citerefentry>,
646
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
647
<manvolnum>5</manvolnum></citerefentry>,
648
<citerefentry><refentrytitle>mandos-client</refentrytitle>
649
<manvolnum>8mandos</manvolnum></citerefentry>,
650
<citerefentry><refentrytitle>sh</refentrytitle>
651
<manvolnum>1</manvolnum></citerefentry>
561
652
</para>
562
653
<variablelist>
563
654
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0