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 237.4.37
- compare with another revision
- download diff
- download tarball
- view history from revision 237.4.37
- Committer: Teddy Hogeborn
- Date: 2013-10-24 20:38:44 UTC
- mto: This revision was merged to the branch mainline in revision 635.
- Revision ID: teddy@recompile.se-20131024203844-j0y0ir6vnlj9mkix
Tags: version-1.6.2-1
* Makefile (version): Changed to "1.6.2".
* NEWS (Version 1.6.2): New entry.
* debian/changelog (1.6.2-1): - '' -
* NEWS (Version 1.6.2): New entry.
* debian/changelog (1.6.2-1): - '' -
- 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-09-17">
5
<!ENTITY TIMESTAMP "2013-10-23">
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>
39
<year>2013</year>
36
40
<holder>Teddy Hogeborn</holder>
37
41
<holder>Björn Påhlsson</holder>
38
42
</copyright>
86
90
<sbr/>
87
91
<arg><option>--debug</option></arg>
88
92
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
89
96
<arg><option>--no-dbus</option></arg>
90
97
<sbr/>
91
98
<arg><option>--no-ipv6</option></arg>
99
<sbr/>
100
<arg><option>--no-restore</option></arg>
101
<sbr/>
102
<arg><option>--statedir
103
<replaceable>DIRECTORY</replaceable></option></arg>
104
<sbr/>
105
<arg><option>--socket
106
<replaceable>FD</replaceable></option></arg>
107
<sbr/>
108
<arg><option>--foreground</option></arg>
92
109
</cmdsynopsis>
93
110
<cmdsynopsis>
94
111
<command>&COMMANDNAME;</command>
112
129
<para>
113
130
<command>&COMMANDNAME;</command> is a server daemon which
114
131
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.
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
the stored pre-encrypted password for that specific client.
123
142
</para>
124
143
</refsect1>
125
144
194
213
</varlistentry>
195
214
196
215
<varlistentry>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
218
<listitem>
219
<para>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
229
</para>
230
</listitem>
231
</varlistentry>
232
233
<varlistentry>
197
234
<term><option>--priority <replaceable>
198
235
PRIORITY</replaceable></option></term>
199
236
<listitem>
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
201
239
</listitem>
202
240
</varlistentry>
203
241
250
288
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
289
</listitem>
252
290
</varlistentry>
291
292
<varlistentry>
293
<term><option>--no-restore</option></term>
294
<listitem>
295
<xi:include href="mandos-options.xml" xpointer="restore"/>
296
<para>
297
See also <xref linkend="persistent_state"/>.
298
</para>
299
</listitem>
300
</varlistentry>
301
302
<varlistentry>
303
<term><option>--statedir
304
<replaceable>DIRECTORY</replaceable></option></term>
305
<listitem>
306
<xi:include href="mandos-options.xml" xpointer="statedir"/>
307
</listitem>
308
</varlistentry>
309
310
<varlistentry>
311
<term><option>--socket
312
<replaceable>FD</replaceable></option></term>
313
<listitem>
314
<xi:include href="mandos-options.xml" xpointer="socket"/>
315
</listitem>
316
</varlistentry>
317
318
<varlistentry>
319
<term><option>--foreground</option></term>
320
<listitem>
321
<xi:include href="mandos-options.xml"
322
xpointer="foreground"/>
323
</listitem>
324
</varlistentry>
325
253
326
</variablelist>
254
327
</refsect1>
255
328
329
402
for some time, the client is assumed to be compromised and is no
330
403
longer eligible to receive the encrypted password. (Manual
331
404
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>
405
extended timeout, checker program, and interval between checks
406
can be configured both globally and per client; see
407
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
<manvolnum>5</manvolnum></citerefentry>.
409
</para>
410
</refsect1>
411
412
<refsect1 id="approval">
413
<title>APPROVAL</title>
414
<para>
415
The server can be configured to require manual approval for a
416
client before it is sent its secret. The delay to wait for such
417
approval and the default action (approve or deny) can be
418
configured both globally and per client; see <citerefentry>
334
419
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
checker run.
338
</para>
420
<manvolnum>5</manvolnum></citerefentry>. By default all clients
421
will be approved immediately without delay.
422
</para>
423
<para>
424
This can be used to deny a client its secret if not manually
425
approved within a specified time. It can also be used to make
426
the server delay before giving a client its secret, allowing
427
optional manual denying of this specific client.
428
</para>
429
339
430
</refsect1>
340
431
341
432
<refsect1 id="logging">
342
433
<title>LOGGING</title>
343
434
<para>
344
435
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
436
<filename class="devicefile">/dev/log</filename>. With the
346
437
<option>--debug</option> option, it will log even more messages,
347
438
and also show them on the console.
348
439
</para>
349
440
</refsect1>
350
441
442
<refsect1 id="persistent_state">
443
<title>PERSISTENT STATE</title>
444
<para>
445
Client settings, initially read from
446
<filename>clients.conf</filename>, are persistent across
447
restarts, and run-time changes will override settings in
448
<filename>clients.conf</filename>. However, if a setting is
449
<emphasis>changed</emphasis> (or a client added, or removed) in
450
<filename>clients.conf</filename>, this will take precedence.
451
</para>
452
</refsect1>
453
351
454
<refsect1 id="dbus_interface">
352
455
<title>D-BUS INTERFACE</title>
353
456
<para>
354
457
The server will by default provide a D-Bus system bus interface.
355
458
This interface will only be accessible by the root user or a
356
Mandos-specific user, if such a user exists.
357
<!-- XXX -->
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
358
461
</para>
359
462
</refsect1>
360
463
415
518
</listitem>
416
519
</varlistentry>
417
520
<varlistentry>
418
<term><filename>/var/run/mandos.pid</filename></term>
419
<listitem>
420
<para>
421
The file containing the process id of
422
<command>&COMMANDNAME;</command>.
521
<term><filename>/run/mandos.pid</filename></term>
522
<listitem>
523
<para>
524
The file containing the process id of the
525
<command>&COMMANDNAME;</command> process started last.
526
</para>
527
</listitem>
528
</varlistentry>
529
<varlistentry>
530
<term><filename class="devicefile">/dev/log</filename></term>
531
</varlistentry>
532
<varlistentry>
533
<term><filename
534
class="directory">/var/lib/mandos</filename></term>
535
<listitem>
536
<para>
537
Directory where persistent state will be saved. Change
538
this with the <option>--statedir</option> option. See
539
also the <option>--no-restore</option> option.
423
540
</para>
424
541
</listitem>
425
542
</varlistentry>
453
570
backtrace. This could be considered a feature.
454
571
</para>
455
572
<para>
456
Currently, if a client is declared <quote>invalid</quote> due to
457
having timed out, the server does not record this fact onto
458
permanent storage. This has some security implications, see
459
<xref linkend="clients"/>.
460
</para>
461
<para>
462
There is currently no way of querying the server of the current
463
status of clients, other than analyzing its <systemitem
464
class="service">syslog</systemitem> output.
465
</para>
466
<para>
467
573
There is no fine-grained control over logging and debug output.
468
574
</para>
469
575
<para>
470
Debug mode is conflated with running in the foreground.
471
</para>
472
<para>
473
The console log messages do not show a time stamp.
474
</para>
475
<para>
476
576
This server does not check the expire time of clients’ OpenPGP
477
577
keys.
478
578
</para>
491
591
<informalexample>
492
592
<para>
493
593
Run the server in debug mode, read configuration files from
494
the <filename>~/mandos</filename> directory, and use the
495
Zeroconf service name <quote>Test</quote> to not collide with
496
any other official Mandos server on this host:
594
the <filename class="directory">~/mandos</filename> directory,
595
and use the Zeroconf service name <quote>Test</quote> to not
596
collide with any other official Mandos server on this host:
497
597
</para>
498
598
<para>
499
599
548
648
compromised if they are gone for too long.
549
649
</para>
550
650
<para>
551
If a client is compromised, its downtime should be duly noted
552
by the server which would therefore declare the client
553
invalid. But if the server was ever restarted, it would
554
re-read its client list from its configuration file and again
555
regard all clients therein as valid, and hence eligible to
556
receive their passwords. Therefore, be careful when
557
restarting servers if it is suspected that a client has, in
558
fact, been compromised by parties who may now be running a
559
fake Mandos client with the keys from the non-encrypted
560
initial <acronym>RAM</acronym> image of the client host. What
561
should be done in that case (if restarting the server program
562
really is necessary) is to stop the server program, edit the
563
configuration file to omit any suspect clients, and restart
564
the server program.
565
</para>
566
<para>
567
651
For more details on client-side security, see
568
652
<citerefentry><refentrytitle>mandos-client</refentrytitle>
569
653
<manvolnum>8mandos</manvolnum></citerefentry>.
574
658
<refsect1 id="see_also">
575
659
<title>SEE ALSO</title>
576
660
<para>
577
<citerefentry>
578
<refentrytitle>mandos-clients.conf</refentrytitle>
579
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
580
<refentrytitle>mandos.conf</refentrytitle>
581
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
582
<refentrytitle>mandos-client</refentrytitle>
583
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
584
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
585
</citerefentry>
661
<citerefentry><refentrytitle>intro</refentrytitle>
662
<manvolnum>8mandos</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
666
<manvolnum>5</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
668
<manvolnum>8mandos</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>sh</refentrytitle>
670
<manvolnum>1</manvolnum></citerefentry>
586
671
</para>
587
672
<variablelist>
588
673
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0