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 537
- compare with another revision
- download diff
- download tarball
- view history from revision 537
- Committer: Björn Påhlsson
- Date: 2011-12-26 15:23:45 UTC
- Revision ID: belorn@recompile.se-20111226152345-cd9mz98e7eiqbfbx
nicer stacktrace when mandos-monitor fail during startup
- 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 "2008-09-30">
5
<!ENTITY TIMESTAMP "2011-11-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
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
35
38
<holder>Teddy Hogeborn</holder>
36
39
<holder>Björn Påhlsson</holder>
37
40
</copyright>
84
87
<replaceable>DIRECTORY</replaceable></option></arg>
85
88
<sbr/>
86
89
<arg><option>--debug</option></arg>
90
<sbr/>
91
<arg><option>--debuglevel
92
<replaceable>LEVEL</replaceable></option></arg>
93
<sbr/>
94
<arg><option>--no-dbus</option></arg>
95
<sbr/>
96
<arg><option>--no-ipv6</option></arg>
97
<sbr/>
98
<arg><option>--no-restore</option></arg>
99
<sbr/>
100
<arg><option>--statedir
101
<replaceable>DIRECTORY</replaceable></option></arg>
87
102
</cmdsynopsis>
88
103
<cmdsynopsis>
89
104
<command>&COMMANDNAME;</command>
107
122
<para>
108
123
<command>&COMMANDNAME;</command> is a server daemon which
109
124
handles incoming request for passwords for a pre-defined list of
110
client host computers. The Mandos server uses Zeroconf to
111
announce itself on the local network, and uses TLS to
112
communicate securely with and to authenticate the clients. The
113
Mandos server uses IPv6 to allow Mandos clients to use IPv6
114
link-local addresses, since the clients will probably not have
115
any other addresses configured (see <xref linkend="overview"/>).
116
Any authenticated client is then given the stored pre-encrypted
117
password for that specific client.
125
client host computers. For an introduction, see
126
<citerefentry><refentrytitle>intro</refentrytitle>
127
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
128
uses Zeroconf to announce itself on the local network, and uses
129
TLS to communicate securely with and to authenticate the
130
clients. The Mandos server uses IPv6 to allow Mandos clients to
131
use IPv6 link-local addresses, since the clients will probably
132
not have any other addresses configured (see <xref
133
linkend="overview"/>). Any authenticated client is then given
134
the stored pre-encrypted password for that specific client.
118
135
</para>
119
136
</refsect1>
120
137
189
206
</varlistentry>
190
207
191
208
<varlistentry>
209
<term><option>--debuglevel
210
<replaceable>LEVEL</replaceable></option></term>
211
<listitem>
212
<para>
213
Set the debugging log level.
214
<replaceable>LEVEL</replaceable> is a string, one of
215
<quote><literal>CRITICAL</literal></quote>,
216
<quote><literal>ERROR</literal></quote>,
217
<quote><literal>WARNING</literal></quote>,
218
<quote><literal>INFO</literal></quote>, or
219
<quote><literal>DEBUG</literal></quote>, in order of
220
increasing verbosity. The default level is
221
<quote><literal>WARNING</literal></quote>.
222
</para>
223
</listitem>
224
</varlistentry>
225
226
<varlistentry>
192
227
<term><option>--priority <replaceable>
193
228
PRIORITY</replaceable></option></term>
194
229
<listitem>
228
263
</para>
229
264
</listitem>
230
265
</varlistentry>
266
267
<varlistentry>
268
<term><option>--no-dbus</option></term>
269
<listitem>
270
<xi:include href="mandos-options.xml" xpointer="dbus"/>
271
<para>
272
See also <xref linkend="dbus_interface"/>.
273
</para>
274
</listitem>
275
</varlistentry>
276
277
<varlistentry>
278
<term><option>--no-ipv6</option></term>
279
<listitem>
280
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
281
</listitem>
282
</varlistentry>
283
284
<varlistentry>
285
<term><option>--no-restore</option></term>
286
<listitem>
287
<xi:include href="mandos-options.xml" xpointer="restore"/>
288
</listitem>
289
</varlistentry>
290
291
<varlistentry>
292
<term><option>--statedir
293
<replaceable>DIRECTORY</replaceable></option></term>
294
<listitem>
295
<xi:include href="mandos-options.xml" xpointer="statedir"/>
296
</listitem>
297
</varlistentry>
231
298
</variablelist>
232
299
</refsect1>
233
300
305
372
The server will, by default, continually check that the clients
306
373
are still up. If a client has not been confirmed as being up
307
374
for some time, the client is assumed to be compromised and is no
308
longer eligible to receive the encrypted password. The timeout,
309
checker program, and interval between checks can be configured
310
both globally and per client; see <citerefentry>
375
longer eligible to receive the encrypted password. (Manual
376
intervention is required to re-enable a client.) The timeout,
377
extended timeout, checker program, and interval between checks
378
can be configured both globally and per client; see
379
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
<manvolnum>5</manvolnum></citerefentry>. A client successfully
381
receiving its password will also be treated as a successful
382
checker run.
383
</para>
384
</refsect1>
385
386
<refsect1 id="approval">
387
<title>APPROVAL</title>
388
<para>
389
The server can be configured to require manual approval for a
390
client before it is sent its secret. The delay to wait for such
391
approval and the default action (approve or deny) can be
392
configured both globally and per client; see <citerefentry>
311
393
<refentrytitle>mandos-clients.conf</refentrytitle>
312
<manvolnum>5</manvolnum></citerefentry>.
313
</para>
394
<manvolnum>5</manvolnum></citerefentry>. By default all clients
395
will be approved immediately without delay.
396
</para>
397
<para>
398
This can be used to deny a client its secret if not manually
399
approved within a specified time. It can also be used to make
400
the server delay before giving a client its secret, allowing
401
optional manual denying of this specific client.
402
</para>
403
314
404
</refsect1>
315
405
316
406
<refsect1 id="logging">
317
407
<title>LOGGING</title>
318
408
<para>
319
409
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
410
<filename class="devicefile">/dev/log</filename>. With the
321
411
<option>--debug</option> option, it will log even more messages,
322
412
and also show them on the console.
323
413
</para>
324
414
</refsect1>
325
415
416
<refsect1 id="dbus_interface">
417
<title>D-BUS INTERFACE</title>
418
<para>
419
The server will by default provide a D-Bus system bus interface.
420
This interface will only be accessible by the root user or a
421
Mandos-specific user, if such a user exists. For documentation
422
of the D-Bus API, see the file <filename>DBUS-API</filename>.
423
</para>
424
</refsect1>
425
326
426
<refsect1 id="exit_status">
327
427
<title>EXIT STATUS</title>
328
428
<para>
351
451
</variablelist>
352
452
</refsect1>
353
453
354
<refsect1 id="file">
454
<refsect1 id="files">
355
455
<title>FILES</title>
356
456
<para>
357
457
Use the <option>--configdir</option> option to change where
383
483
<term><filename>/var/run/mandos.pid</filename></term>
384
484
<listitem>
385
485
<para>
386
The file containing the process id of
387
<command>&COMMANDNAME;</command>.
486
The file containing the process id of the
487
<command>&COMMANDNAME;</command> process started last.
488
</para>
489
</listitem>
490
</varlistentry>
491
<varlistentry>
492
<term><filename class="devicefile">/dev/log</filename></term>
493
</varlistentry>
494
<varlistentry>
495
<term><filename
496
class="directory">/var/lib/mandos</filename></term>
497
<listitem>
498
<para>
499
Directory where persistent state will be saved. Change
500
this with the <option>--statedir</option> option. See
501
also the <option>--no-restore</option> option.
388
502
</para>
389
503
</listitem>
390
504
</varlistentry>
418
532
backtrace. This could be considered a feature.
419
533
</para>
420
534
<para>
421
Currently, if a client is declared <quote>invalid</quote> due to
422
having timed out, the server does not record this fact onto
423
permanent storage. This has some security implications, see
424
<xref linkend="CLIENTS"/>.
425
</para>
426
<para>
427
There is currently no way of querying the server of the current
428
status of clients, other than analyzing its <systemitem
429
class="service">syslog</systemitem> output.
430
</para>
431
<para>
432
535
There is no fine-grained control over logging and debug output.
433
536
</para>
434
537
<para>
435
538
Debug mode is conflated with running in the foreground.
436
539
</para>
437
540
<para>
438
The console log messages does not show a time stamp.
439
</para>
440
<para>
441
541
This server does not check the expire time of clients’ OpenPGP
442
542
keys.
443
543
</para>
456
556
<informalexample>
457
557
<para>
458
558
Run the server in debug mode, read configuration files from
459
the <filename>~/mandos</filename> directory, and use the
460
Zeroconf service name <quote>Test</quote> to not collide with
461
any other official Mandos server on this host:
559
the <filename class="directory">~/mandos</filename> directory,
560
and use the Zeroconf service name <quote>Test</quote> to not
561
collide with any other official Mandos server on this host:
462
562
</para>
463
563
<para>
464
564
483
583
484
584
<refsect1 id="security">
485
585
<title>SECURITY</title>
486
<refsect2 id="SERVER">
586
<refsect2 id="server">
487
587
<title>SERVER</title>
488
588
<para>
489
589
Running this <command>&COMMANDNAME;</command> server program
492
592
soon after startup.
493
593
</para>
494
594
</refsect2>
495
<refsect2 id="CLIENTS">
595
<refsect2 id="clients">
496
596
<title>CLIENTS</title>
497
597
<para>
498
598
The server only gives out its stored data to clients which
513
613
compromised if they are gone for too long.
514
614
</para>
515
615
<para>
516
If a client is compromised, its downtime should be duly noted
517
by the server which would therefore declare the client
518
invalid. But if the server was ever restarted, it would
519
re-read its client list from its configuration file and again
520
regard all clients therein as valid, and hence eligible to
521
receive their passwords. Therefore, be careful when
522
restarting servers if it is suspected that a client has, in
523
fact, been compromised by parties who may now be running a
524
fake Mandos client with the keys from the non-encrypted
525
initial <acronym>RAM</acronym> image of the client host. What
526
should be done in that case (if restarting the server program
527
really is necessary) is to stop the server program, edit the
528
configuration file to omit any suspect clients, and restart
529
the server program.
530
</para>
531
<para>
532
616
For more details on client-side security, see
533
617
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
618
<manvolnum>8mandos</manvolnum></citerefentry>.
539
623
<refsect1 id="see_also">
540
624
<title>SEE ALSO</title>
541
625
<para>
542
<citerefentry>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>mandos-client</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
</citerefentry>
626
<citerefentry><refentrytitle>intro</refentrytitle>
627
<manvolnum>8mandos</manvolnum></citerefentry>,
628
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
629
<manvolnum>5</manvolnum></citerefentry>,
630
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
631
<manvolnum>5</manvolnum></citerefentry>,
632
<citerefentry><refentrytitle>mandos-client</refentrytitle>
633
<manvolnum>8mandos</manvolnum></citerefentry>,
634
<citerefentry><refentrytitle>sh</refentrytitle>
635
<manvolnum>1</manvolnum></citerefentry>
551
636
</para>
552
637
<variablelist>
553
638
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0