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 585
- compare with another revision
- download diff
- download tarball
- view history from revision 585
- Committer: Teddy Hogeborn
- Date: 2012-05-17 01:55:58 UTC
- Revision ID: teddy@recompile.se-20120517015558-5703p8nkquc2rhgd
* .bzrignore (statedir): Added.
- 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 "2012-01-15">
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>
38
<year>2012</year>
35
39
<holder>Teddy Hogeborn</holder>
36
40
<holder>Björn Påhlsson</holder>
37
41
</copyright>
84
88
<replaceable>DIRECTORY</replaceable></option></arg>
85
89
<sbr/>
86
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>
87
103
</cmdsynopsis>
88
104
<cmdsynopsis>
89
105
<command>&COMMANDNAME;</command>
107
123
<para>
108
124
<command>&COMMANDNAME;</command> is a server daemon which
109
125
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.
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.
118
136
</para>
119
137
</refsect1>
120
138
189
207
</varlistentry>
190
208
191
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>
192
228
<term><option>--priority <replaceable>
193
229
PRIORITY</replaceable></option></term>
194
230
<listitem>
228
264
</para>
229
265
</listitem>
230
266
</varlistentry>
267
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>
279
<term><option>--no-ipv6</option></term>
280
<listitem>
281
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
282
</listitem>
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>
231
302
</variablelist>
232
303
</refsect1>
233
304
305
376
The server will, by default, continually check that the clients
306
377
are still up. If a client has not been confirmed as being up
307
378
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>
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>.
385
</para>
386
</refsect1>
387
388
<refsect1 id="approval">
389
<title>APPROVAL</title>
390
<para>
391
The server can be configured to require manual approval for a
392
client before it is sent its secret. The delay to wait for such
393
approval and the default action (approve or deny) can be
394
configured both globally and per client; see <citerefentry>
311
395
<refentrytitle>mandos-clients.conf</refentrytitle>
312
<manvolnum>5</manvolnum></citerefentry>.
313
</para>
396
<manvolnum>5</manvolnum></citerefentry>. By default all clients
397
will be approved immediately without delay.
398
</para>
399
<para>
400
This can be used to deny a client its secret if not manually
401
approved within a specified time. It can also be used to make
402
the server delay before giving a client its secret, allowing
403
optional manual denying of this specific client.
404
</para>
405
314
406
</refsect1>
315
407
316
408
<refsect1 id="logging">
317
409
<title>LOGGING</title>
318
410
<para>
319
411
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
412
<filename class="devicefile">/dev/log</filename>. With the
321
413
<option>--debug</option> option, it will log even more messages,
322
414
and also show them on the console.
323
415
</para>
324
416
</refsect1>
325
417
418
<refsect1 id="persistent_state">
419
<title>PERSISTENT STATE</title>
420
<para>
421
Client settings, initially read from
422
<filename>clients.conf</filename>, are persistent across
423
restarts, and run-time changes will override settings in
424
<filename>clients.conf</filename>. However, if a setting is
425
<emphasis>changed</emphasis> (or a client added, or removed) in
426
<filename>clients.conf</filename>, this will take precedence.
427
</para>
428
</refsect1>
429
430
<refsect1 id="dbus_interface">
431
<title>D-BUS INTERFACE</title>
432
<para>
433
The server will by default provide a D-Bus system bus interface.
434
This interface will only be accessible by the root user or a
435
Mandos-specific user, if such a user exists. For documentation
436
of the D-Bus API, see the file <filename>DBUS-API</filename>.
437
</para>
438
</refsect1>
439
326
440
<refsect1 id="exit_status">
327
441
<title>EXIT STATUS</title>
328
442
<para>
351
465
</variablelist>
352
466
</refsect1>
353
467
354
<refsect1 id="file">
468
<refsect1 id="files">
355
469
<title>FILES</title>
356
470
<para>
357
471
Use the <option>--configdir</option> option to change where
383
497
<term><filename>/var/run/mandos.pid</filename></term>
384
498
<listitem>
385
499
<para>
386
The file containing the process id of
387
<command>&COMMANDNAME;</command>.
500
The file containing the process id of the
501
<command>&COMMANDNAME;</command> process started last.
502
</para>
503
</listitem>
504
</varlistentry>
505
<varlistentry>
506
<term><filename class="devicefile">/dev/log</filename></term>
507
</varlistentry>
508
<varlistentry>
509
<term><filename
510
class="directory">/var/lib/mandos</filename></term>
511
<listitem>
512
<para>
513
Directory where persistent state will be saved. Change
514
this with the <option>--statedir</option> option. See
515
also the <option>--no-restore</option> option.
388
516
</para>
389
517
</listitem>
390
518
</varlistentry>
418
546
backtrace. This could be considered a feature.
419
547
</para>
420
548
<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
549
There is no fine-grained control over logging and debug output.
433
550
</para>
434
551
<para>
435
552
Debug mode is conflated with running in the foreground.
436
553
</para>
437
554
<para>
438
The console log messages does not show a time stamp.
439
</para>
440
<para>
441
555
This server does not check the expire time of clients’ OpenPGP
442
556
keys.
443
557
</para>
456
570
<informalexample>
457
571
<para>
458
572
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:
573
the <filename class="directory">~/mandos</filename> directory,
574
and use the Zeroconf service name <quote>Test</quote> to not
575
collide with any other official Mandos server on this host:
462
576
</para>
463
577
<para>
464
578
483
597
484
598
<refsect1 id="security">
485
599
<title>SECURITY</title>
486
<refsect2 id="SERVER">
600
<refsect2 id="server">
487
601
<title>SERVER</title>
488
602
<para>
489
603
Running this <command>&COMMANDNAME;</command> server program
492
606
soon after startup.
493
607
</para>
494
608
</refsect2>
495
<refsect2 id="CLIENTS">
609
<refsect2 id="clients">
496
610
<title>CLIENTS</title>
497
611
<para>
498
612
The server only gives out its stored data to clients which
513
627
compromised if they are gone for too long.
514
628
</para>
515
629
<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
630
For more details on client-side security, see
533
631
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
632
<manvolnum>8mandos</manvolnum></citerefentry>.
539
637
<refsect1 id="see_also">
540
638
<title>SEE ALSO</title>
541
639
<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>
640
<citerefentry><refentrytitle>intro</refentrytitle>
641
<manvolnum>8mandos</manvolnum></citerefentry>,
642
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
643
<manvolnum>5</manvolnum></citerefentry>,
644
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
645
<manvolnum>5</manvolnum></citerefentry>,
646
<citerefentry><refentrytitle>mandos-client</refentrytitle>
647
<manvolnum>8mandos</manvolnum></citerefentry>,
648
<citerefentry><refentrytitle>sh</refentrytitle>
649
<manvolnum>1</manvolnum></citerefentry>
551
650
</para>
552
651
<variablelist>
553
652
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0