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 544
- compare with another revision
- download diff
- download tarball
- view history from revision 544
- Committer: Teddy Hogeborn
- Date: 2011-12-31 23:05:34 UTC
- Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.
- 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-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
<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
</listitem>
290
</varlistentry>
291
292
<varlistentry>
293
<term><option>--statedir
294
<replaceable>DIRECTORY</replaceable></option></term>
295
<listitem>
296
<xi:include href="mandos-options.xml" xpointer="statedir"/>
297
</listitem>
298
</varlistentry>
231
299
</variablelist>
232
300
</refsect1>
233
301
305
373
The server will, by default, continually check that the clients
306
374
are still up. If a client has not been confirmed as being up
307
375
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>
376
longer eligible to receive the encrypted password. (Manual
377
intervention is required to re-enable a client.) The timeout,
378
extended timeout, checker program, and interval between checks
379
can be configured both globally and per client; see
380
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
<manvolnum>5</manvolnum></citerefentry>. A client successfully
382
receiving its password will also be treated as a successful
383
checker run.
384
</para>
385
</refsect1>
386
387
<refsect1 id="approval">
388
<title>APPROVAL</title>
389
<para>
390
The server can be configured to require manual approval for a
391
client before it is sent its secret. The delay to wait for such
392
approval and the default action (approve or deny) can be
393
configured both globally and per client; see <citerefentry>
311
394
<refentrytitle>mandos-clients.conf</refentrytitle>
312
<manvolnum>5</manvolnum></citerefentry>.
313
</para>
395
<manvolnum>5</manvolnum></citerefentry>. By default all clients
396
will be approved immediately without delay.
397
</para>
398
<para>
399
This can be used to deny a client its secret if not manually
400
approved within a specified time. It can also be used to make
401
the server delay before giving a client its secret, allowing
402
optional manual denying of this specific client.
403
</para>
404
314
405
</refsect1>
315
406
316
407
<refsect1 id="logging">
317
408
<title>LOGGING</title>
318
409
<para>
319
410
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
411
<filename class="devicefile">/dev/log</filename>. With the
321
412
<option>--debug</option> option, it will log even more messages,
322
413
and also show them on the console.
323
414
</para>
324
415
</refsect1>
325
416
417
<refsect1 id="dbus_interface">
418
<title>D-BUS INTERFACE</title>
419
<para>
420
The server will by default provide a D-Bus system bus interface.
421
This interface will only be accessible by the root user or a
422
Mandos-specific user, if such a user exists. For documentation
423
of the D-Bus API, see the file <filename>DBUS-API</filename>.
424
</para>
425
</refsect1>
426
326
427
<refsect1 id="exit_status">
327
428
<title>EXIT STATUS</title>
328
429
<para>
351
452
</variablelist>
352
453
</refsect1>
353
454
354
<refsect1 id="file">
455
<refsect1 id="files">
355
456
<title>FILES</title>
356
457
<para>
357
458
Use the <option>--configdir</option> option to change where
383
484
<term><filename>/var/run/mandos.pid</filename></term>
384
485
<listitem>
385
486
<para>
386
The file containing the process id of
387
<command>&COMMANDNAME;</command>.
487
The file containing the process id of the
488
<command>&COMMANDNAME;</command> process started last.
489
</para>
490
</listitem>
491
</varlistentry>
492
<varlistentry>
493
<term><filename class="devicefile">/dev/log</filename></term>
494
</varlistentry>
495
<varlistentry>
496
<term><filename
497
class="directory">/var/lib/mandos</filename></term>
498
<listitem>
499
<para>
500
Directory where persistent state will be saved. Change
501
this with the <option>--statedir</option> option. See
502
also the <option>--no-restore</option> option.
388
503
</para>
389
504
</listitem>
390
505
</varlistentry>
418
533
backtrace. This could be considered a feature.
419
534
</para>
420
535
<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
536
There is no fine-grained control over logging and debug output.
433
537
</para>
434
538
<para>
435
539
Debug mode is conflated with running in the foreground.
436
540
</para>
437
541
<para>
438
The console log messages does not show a time stamp.
439
</para>
440
<para>
441
542
This server does not check the expire time of clients’ OpenPGP
442
543
keys.
443
544
</para>
456
557
<informalexample>
457
558
<para>
458
559
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:
560
the <filename class="directory">~/mandos</filename> directory,
561
and use the Zeroconf service name <quote>Test</quote> to not
562
collide with any other official Mandos server on this host:
462
563
</para>
463
564
<para>
464
565
483
584
484
585
<refsect1 id="security">
485
586
<title>SECURITY</title>
486
<refsect2 id="SERVER">
587
<refsect2 id="server">
487
588
<title>SERVER</title>
488
589
<para>
489
590
Running this <command>&COMMANDNAME;</command> server program
492
593
soon after startup.
493
594
</para>
494
595
</refsect2>
495
<refsect2 id="CLIENTS">
596
<refsect2 id="clients">
496
597
<title>CLIENTS</title>
497
598
<para>
498
599
The server only gives out its stored data to clients which
513
614
compromised if they are gone for too long.
514
615
</para>
515
616
<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
617
For more details on client-side security, see
533
618
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
619
<manvolnum>8mandos</manvolnum></citerefentry>.
539
624
<refsect1 id="see_also">
540
625
<title>SEE ALSO</title>
541
626
<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>
627
<citerefentry><refentrytitle>intro</refentrytitle>
628
<manvolnum>8mandos</manvolnum></citerefentry>,
629
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
630
<manvolnum>5</manvolnum></citerefentry>,
631
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
632
<manvolnum>5</manvolnum></citerefentry>,
633
<citerefentry><refentrytitle>mandos-client</refentrytitle>
634
<manvolnum>8mandos</manvolnum></citerefentry>,
635
<citerefentry><refentrytitle>sh</refentrytitle>
636
<manvolnum>1</manvolnum></citerefentry>
551
637
</para>
552
638
<variablelist>
553
639
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0