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 629
- compare with another revision
- download diff
- download tarball
- view history from revision 629
- Committer: Teddy Hogeborn
- Date: 2013-10-20 22:20:11 UTC
- Revision ID: teddy@recompile.se-20131020222011-g2fvjicx5lrv4h4e
* mandos-change-keytype: Bug fix: call mandos-keygen from $PATH, not
current directory.
current directory.
- 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-10-03">
5
<!ENTITY TIMESTAMP "2013-10-20">
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>
39
<year>2013</year>
35
40
<holder>Teddy Hogeborn</holder>
36
41
<holder>Björn Påhlsson</holder>
37
42
</copyright>
84
89
<replaceable>DIRECTORY</replaceable></option></arg>
85
90
<sbr/>
86
91
<arg><option>--debug</option></arg>
92
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
96
<arg><option>--no-dbus</option></arg>
97
<sbr/>
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>
87
109
</cmdsynopsis>
88
110
<cmdsynopsis>
89
111
<command>&COMMANDNAME;</command>
107
129
<para>
108
130
<command>&COMMANDNAME;</command> is a server daemon which
109
131
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.
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.
118
142
</para>
119
143
</refsect1>
120
144
189
213
</varlistentry>
190
214
191
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>
192
234
<term><option>--priority <replaceable>
193
235
PRIORITY</replaceable></option></term>
194
236
<listitem>
228
270
</para>
229
271
</listitem>
230
272
</varlistentry>
273
274
<varlistentry>
275
<term><option>--no-dbus</option></term>
276
<listitem>
277
<xi:include href="mandos-options.xml" xpointer="dbus"/>
278
<para>
279
See also <xref linkend="dbus_interface"/>.
280
</para>
281
</listitem>
282
</varlistentry>
283
284
<varlistentry>
285
<term><option>--no-ipv6</option></term>
286
<listitem>
287
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
288
</listitem>
289
</varlistentry>
290
291
<varlistentry>
292
<term><option>--no-restore</option></term>
293
<listitem>
294
<xi:include href="mandos-options.xml" xpointer="restore"/>
295
<para>
296
See also <xref linkend="persistent_state"/>.
297
</para>
298
</listitem>
299
</varlistentry>
300
301
<varlistentry>
302
<term><option>--statedir
303
<replaceable>DIRECTORY</replaceable></option></term>
304
<listitem>
305
<xi:include href="mandos-options.xml" xpointer="statedir"/>
306
</listitem>
307
</varlistentry>
308
309
<varlistentry>
310
<term><option>--socket
311
<replaceable>FD</replaceable></option></term>
312
<listitem>
313
<xi:include href="mandos-options.xml" xpointer="socket"/>
314
</listitem>
315
</varlistentry>
316
317
<varlistentry>
318
<term><option>--foreground</option></term>
319
<listitem>
320
<xi:include href="mandos-options.xml"
321
xpointer="foreground"/>
322
</listitem>
323
</varlistentry>
324
231
325
</variablelist>
232
326
</refsect1>
233
327
305
399
The server will, by default, continually check that the clients
306
400
are still up. If a client has not been confirmed as being up
307
401
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>
402
longer eligible to receive the encrypted password. (Manual
403
intervention is required to re-enable a client.) The timeout,
404
extended timeout, checker program, and interval between checks
405
can be configured both globally and per client; see
406
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>.
408
</para>
409
</refsect1>
410
411
<refsect1 id="approval">
412
<title>APPROVAL</title>
413
<para>
414
The server can be configured to require manual approval for a
415
client before it is sent its secret. The delay to wait for such
416
approval and the default action (approve or deny) can be
417
configured both globally and per client; see <citerefentry>
311
418
<refentrytitle>mandos-clients.conf</refentrytitle>
312
<manvolnum>5</manvolnum></citerefentry>.
313
</para>
419
<manvolnum>5</manvolnum></citerefentry>. By default all clients
420
will be approved immediately without delay.
421
</para>
422
<para>
423
This can be used to deny a client its secret if not manually
424
approved within a specified time. It can also be used to make
425
the server delay before giving a client its secret, allowing
426
optional manual denying of this specific client.
427
</para>
428
314
429
</refsect1>
315
430
316
431
<refsect1 id="logging">
317
432
<title>LOGGING</title>
318
433
<para>
319
434
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
435
<filename class="devicefile">/dev/log</filename>. With the
321
436
<option>--debug</option> option, it will log even more messages,
322
437
and also show them on the console.
323
438
</para>
324
439
</refsect1>
325
440
441
<refsect1 id="persistent_state">
442
<title>PERSISTENT STATE</title>
443
<para>
444
Client settings, initially read from
445
<filename>clients.conf</filename>, are persistent across
446
restarts, and run-time changes will override settings in
447
<filename>clients.conf</filename>. However, if a setting is
448
<emphasis>changed</emphasis> (or a client added, or removed) in
449
<filename>clients.conf</filename>, this will take precedence.
450
</para>
451
</refsect1>
452
453
<refsect1 id="dbus_interface">
454
<title>D-BUS INTERFACE</title>
455
<para>
456
The server will by default provide a D-Bus system bus interface.
457
This interface will only be accessible by the root user or a
458
Mandos-specific user, if such a user exists. For documentation
459
of the D-Bus API, see the file <filename>DBUS-API</filename>.
460
</para>
461
</refsect1>
462
326
463
<refsect1 id="exit_status">
327
464
<title>EXIT STATUS</title>
328
465
<para>
380
517
</listitem>
381
518
</varlistentry>
382
519
<varlistentry>
383
<term><filename>/var/run/mandos.pid</filename></term>
384
<listitem>
385
<para>
386
The file containing the process id of
387
<command>&COMMANDNAME;</command>.
520
<term><filename>/run/mandos.pid</filename></term>
521
<listitem>
522
<para>
523
The file containing the process id of the
524
<command>&COMMANDNAME;</command> process started last.
525
</para>
526
</listitem>
527
</varlistentry>
528
<varlistentry>
529
<term><filename class="devicefile">/dev/log</filename></term>
530
</varlistentry>
531
<varlistentry>
532
<term><filename
533
class="directory">/var/lib/mandos</filename></term>
534
<listitem>
535
<para>
536
Directory where persistent state will be saved. Change
537
this with the <option>--statedir</option> option. See
538
also the <option>--no-restore</option> option.
388
539
</para>
389
540
</listitem>
390
541
</varlistentry>
418
569
backtrace. This could be considered a feature.
419
570
</para>
420
571
<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
572
There is no fine-grained control over logging and debug output.
433
573
</para>
434
574
<para>
435
Debug mode is conflated with running in the foreground.
436
</para>
437
<para>
438
The console log messages does not show a time stamp.
439
</para>
440
<para>
441
575
This server does not check the expire time of clients’ OpenPGP
442
576
keys.
443
577
</para>
456
590
<informalexample>
457
591
<para>
458
592
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:
593
the <filename class="directory">~/mandos</filename> directory,
594
and use the Zeroconf service name <quote>Test</quote> to not
595
collide with any other official Mandos server on this host:
462
596
</para>
463
597
<para>
464
598
513
647
compromised if they are gone for too long.
514
648
</para>
515
649
<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
650
For more details on client-side security, see
533
651
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
652
<manvolnum>8mandos</manvolnum></citerefentry>.
539
657
<refsect1 id="see_also">
540
658
<title>SEE ALSO</title>
541
659
<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>
660
<citerefentry><refentrytitle>intro</refentrytitle>
661
<manvolnum>8mandos</manvolnum></citerefentry>,
662
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
663
<manvolnum>5</manvolnum></citerefentry>,
664
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
665
<manvolnum>5</manvolnum></citerefentry>,
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
667
<manvolnum>8mandos</manvolnum></citerefentry>,
668
<citerefentry><refentrytitle>sh</refentrytitle>
669
<manvolnum>1</manvolnum></citerefentry>
551
670
</para>
552
671
<variablelist>
553
672
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0