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 removed:
- plugins.d/plymouth
- 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-12-09">
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/>
89
95
<arg><option>--no-dbus</option></arg>
90
96
<sbr/>
91
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>
92
103
</cmdsynopsis>
93
104
<cmdsynopsis>
94
105
<command>&COMMANDNAME;</command>
112
123
<para>
113
124
<command>&COMMANDNAME;</command> is a server daemon which
114
125
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
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.
123
136
</para>
124
137
</refsect1>
125
138
194
207
</varlistentry>
195
208
196
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>
197
228
<term><option>--priority <replaceable>
198
229
PRIORITY</replaceable></option></term>
199
230
<listitem>
250
281
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
282
</listitem>
252
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>
253
302
</variablelist>
254
303
</refsect1>
255
304
329
378
for some time, the client is assumed to be compromised and is no
330
379
longer eligible to receive the encrypted password. (Manual
331
380
intervention is required to re-enable a client.) The timeout,
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
334
<refentrytitle>mandos-clients.conf</refentrytitle>
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>
335
384
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
385
receiving its password will also be treated as a successful
337
386
checker run.
338
387
</para>
339
388
</refsect1>
340
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>
397
<refentrytitle>mandos-clients.conf</refentrytitle>
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
408
</refsect1>
409
341
410
<refsect1 id="logging">
342
411
<title>LOGGING</title>
343
412
<para>
344
413
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
414
<filename class="devicefile">/dev/log</filename>. With the
346
415
<option>--debug</option> option, it will log even more messages,
347
416
and also show them on the console.
348
417
</para>
349
418
</refsect1>
350
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
351
432
<refsect1 id="dbus_interface">
352
433
<title>D-BUS INTERFACE</title>
353
434
<para>
354
435
The server will by default provide a D-Bus system bus interface.
355
436
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists.
357
<!-- XXX -->
437
Mandos-specific user, if such a user exists. For documentation
438
of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
439
</para>
359
440
</refsect1>
360
441
418
499
<term><filename>/var/run/mandos.pid</filename></term>
419
500
<listitem>
420
501
<para>
421
The file containing the process id of
422
<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.
423
518
</para>
424
519
</listitem>
425
520
</varlistentry>
453
548
backtrace. This could be considered a feature.
454
549
</para>
455
550
<para>
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
has some security implications, see <xref linkend="clients"/>.
459
</para>
460
<para>
461
There is currently no way of querying the server of the current
462
status of clients, other than analyzing its <systemitem
463
class="service">syslog</systemitem> output.
464
</para>
465
<para>
466
551
There is no fine-grained control over logging and debug output.
467
552
</para>
468
553
<para>
469
554
Debug mode is conflated with running in the foreground.
470
555
</para>
471
556
<para>
472
The console log messages do not show a time stamp.
473
</para>
474
<para>
475
557
This server does not check the expire time of clients’ OpenPGP
476
558
keys.
477
559
</para>
490
572
<informalexample>
491
573
<para>
492
574
Run the server in debug mode, read configuration files from
493
the <filename>~/mandos</filename> directory, and use the
494
Zeroconf service name <quote>Test</quote> to not collide with
495
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:
496
578
</para>
497
579
<para>
498
580
547
629
compromised if they are gone for too long.
548
630
</para>
549
631
<para>
550
If a client is compromised, its downtime should be duly noted
551
by the server which would therefore disable the client. But
552
if the server was ever restarted, it would re-read its client
553
list from its configuration file and again regard all clients
554
therein as enabled, and hence eligible to receive their
555
passwords. Therefore, be careful when restarting servers if
556
it is suspected that a client has, in fact, been compromised
557
by parties who may now be running a fake Mandos client with
558
the keys from the non-encrypted initial <acronym>RAM</acronym>
559
image of the client host. What should be done in that case
560
(if restarting the server program really is necessary) is to
561
stop the server program, edit the configuration file to omit
562
any suspect clients, and restart the server program.
563
</para>
564
<para>
565
632
For more details on client-side security, see
566
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
567
634
<manvolnum>8mandos</manvolnum></citerefentry>.
572
639
<refsect1 id="see_also">
573
640
<title>SEE ALSO</title>
574
641
<para>
575
<citerefentry>
576
<refentrytitle>mandos-clients.conf</refentrytitle>
577
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
578
<refentrytitle>mandos.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos-client</refentrytitle>
581
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
583
</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>
584
652
</para>
585
653
<variablelist>
586
654
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0