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 611
- compare with another revision
- download diff
- download tarball
- view history from revision 611
- Committer: Teddy Hogeborn
- Date: 2012-06-24 03:45:55 UTC
- Revision ID: teddy@recompile.se-20120624034555-7p0dtbpsz0dgsn4d
* mandos (Client.start_checker): Add comment. Break long line.
- files added:
- DBUS-API
- debian/source
- network-hooks.d
- files removed:
- debian/mandos-client.config
- files modified:
- .bzrignore
added
removed
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-09-21">
5
<!ENTITY TIMESTAMP "2012-06-17">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<refentryinfo>
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
16
17
<authorgroup>
17
18
<author>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
20
21
<address>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
22
23
</address>
23
24
</author>
24
25
<author>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
27
28
<address>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
29
30
</address>
30
31
</author>
31
32
</authorgroup>
32
33
<copyright>
33
34
<year>2008</year>
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
38
<year>2012</year>
34
39
<holder>Teddy Hogeborn</holder>
35
40
<holder>Björn Påhlsson</holder>
36
41
</copyright>
83
88
<replaceable>DIRECTORY</replaceable></option></arg>
84
89
<sbr/>
85
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>
103
<sbr/>
104
<arg><option>--socket
105
<replaceable>FD</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--foreground</option></arg>
86
108
</cmdsynopsis>
87
109
<cmdsynopsis>
88
110
<command>&COMMANDNAME;</command>
106
128
<para>
107
129
<command>&COMMANDNAME;</command> is a server daemon which
108
130
handles incoming request for passwords for a pre-defined list of
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
password for that specific client.
131
client host computers. For an introduction, see
132
<citerefentry><refentrytitle>intro</refentrytitle>
133
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
134
uses Zeroconf to announce itself on the local network, and uses
135
TLS to communicate securely with and to authenticate the
136
clients. The Mandos server uses IPv6 to allow Mandos clients to
137
use IPv6 link-local addresses, since the clients will probably
138
not have any other addresses configured (see <xref
139
linkend="overview"/>). Any authenticated client is then given
140
the stored pre-encrypted password for that specific client.
117
141
</para>
118
142
</refsect1>
119
143
188
212
</varlistentry>
189
213
190
214
<varlistentry>
215
<term><option>--debuglevel
216
<replaceable>LEVEL</replaceable></option></term>
217
<listitem>
218
<para>
219
Set the debugging log level.
220
<replaceable>LEVEL</replaceable> is a string, one of
221
<quote><literal>CRITICAL</literal></quote>,
222
<quote><literal>ERROR</literal></quote>,
223
<quote><literal>WARNING</literal></quote>,
224
<quote><literal>INFO</literal></quote>, or
225
<quote><literal>DEBUG</literal></quote>, in order of
226
increasing verbosity. The default level is
227
<quote><literal>WARNING</literal></quote>.
228
</para>
229
</listitem>
230
</varlistentry>
231
232
<varlistentry>
191
233
<term><option>--priority <replaceable>
192
234
PRIORITY</replaceable></option></term>
193
235
<listitem>
227
269
</para>
228
270
</listitem>
229
271
</varlistentry>
272
273
<varlistentry>
274
<term><option>--no-dbus</option></term>
275
<listitem>
276
<xi:include href="mandos-options.xml" xpointer="dbus"/>
277
<para>
278
See also <xref linkend="dbus_interface"/>.
279
</para>
280
</listitem>
281
</varlistentry>
282
283
<varlistentry>
284
<term><option>--no-ipv6</option></term>
285
<listitem>
286
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
287
</listitem>
288
</varlistentry>
289
290
<varlistentry>
291
<term><option>--no-restore</option></term>
292
<listitem>
293
<xi:include href="mandos-options.xml" xpointer="restore"/>
294
<para>
295
See also <xref linkend="persistent_state"/>.
296
</para>
297
</listitem>
298
</varlistentry>
299
300
<varlistentry>
301
<term><option>--statedir
302
<replaceable>DIRECTORY</replaceable></option></term>
303
<listitem>
304
<xi:include href="mandos-options.xml" xpointer="statedir"/>
305
</listitem>
306
</varlistentry>
307
308
<varlistentry>
309
<term><option>--socket
310
<replaceable>FD</replaceable></option></term>
311
<listitem>
312
<xi:include href="mandos-options.xml" xpointer="socket"/>
313
</listitem>
314
</varlistentry>
315
316
<varlistentry>
317
<term><option>--foreground</option></term>
318
<listitem>
319
<xi:include href="mandos-options.xml"
320
xpointer="foreground"/>
321
</listitem>
322
</varlistentry>
323
230
324
</variablelist>
231
325
</refsect1>
232
326
304
398
The server will, by default, continually check that the clients
305
399
are still up. If a client has not been confirmed as being up
306
400
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
401
longer eligible to receive the encrypted password. (Manual
402
intervention is required to re-enable a client.) The timeout,
403
extended timeout, checker program, and interval between checks
404
can be configured both globally and per client; see
405
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
406
<manvolnum>5</manvolnum></citerefentry>.
407
</para>
408
</refsect1>
409
410
<refsect1 id="approval">
411
<title>APPROVAL</title>
412
<para>
413
The server can be configured to require manual approval for a
414
client before it is sent its secret. The delay to wait for such
415
approval and the default action (approve or deny) can be
416
configured both globally and per client; see <citerefentry>
310
417
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</para>
418
<manvolnum>5</manvolnum></citerefentry>. By default all clients
419
will be approved immediately without delay.
420
</para>
421
<para>
422
This can be used to deny a client its secret if not manually
423
approved within a specified time. It can also be used to make
424
the server delay before giving a client its secret, allowing
425
optional manual denying of this specific client.
426
</para>
427
313
428
</refsect1>
314
429
315
430
<refsect1 id="logging">
316
431
<title>LOGGING</title>
317
432
<para>
318
433
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
434
<filename class="devicefile">/dev/log</filename>. With the
320
435
<option>--debug</option> option, it will log even more messages,
321
436
and also show them on the console.
322
437
</para>
323
438
</refsect1>
324
439
440
<refsect1 id="persistent_state">
441
<title>PERSISTENT STATE</title>
442
<para>
443
Client settings, initially read from
444
<filename>clients.conf</filename>, are persistent across
445
restarts, and run-time changes will override settings in
446
<filename>clients.conf</filename>. However, if a setting is
447
<emphasis>changed</emphasis> (or a client added, or removed) in
448
<filename>clients.conf</filename>, this will take precedence.
449
</para>
450
</refsect1>
451
452
<refsect1 id="dbus_interface">
453
<title>D-BUS INTERFACE</title>
454
<para>
455
The server will by default provide a D-Bus system bus interface.
456
This interface will only be accessible by the root user or a
457
Mandos-specific user, if such a user exists. For documentation
458
of the D-Bus API, see the file <filename>DBUS-API</filename>.
459
</para>
460
</refsect1>
461
325
462
<refsect1 id="exit_status">
326
463
<title>EXIT STATUS</title>
327
464
<para>
350
487
</variablelist>
351
488
</refsect1>
352
489
353
<refsect1 id="file">
490
<refsect1 id="files">
354
491
<title>FILES</title>
355
492
<para>
356
493
Use the <option>--configdir</option> option to change where
382
519
<term><filename>/var/run/mandos.pid</filename></term>
383
520
<listitem>
384
521
<para>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
522
The file containing the process id of the
523
<command>&COMMANDNAME;</command> process started last.
524
</para>
525
</listitem>
526
</varlistentry>
527
<varlistentry>
528
<term><filename class="devicefile">/dev/log</filename></term>
529
</varlistentry>
530
<varlistentry>
531
<term><filename
532
class="directory">/var/lib/mandos</filename></term>
533
<listitem>
534
<para>
535
Directory where persistent state will be saved. Change
536
this with the <option>--statedir</option> option. See
537
also the <option>--no-restore</option> option.
387
538
</para>
388
539
</listitem>
389
540
</varlistentry>
417
568
backtrace. This could be considered a feature.
418
569
</para>
419
570
<para>
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
424
</para>
425
<para>
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
429
</para>
430
<para>
431
571
There is no fine-grained control over logging and debug output.
432
572
</para>
433
573
<para>
434
Debug mode is conflated with running in the foreground.
435
</para>
436
<para>
437
The console log messages does not show a time stamp.
438
</para>
439
<para>
440
574
This server does not check the expire time of clients’ OpenPGP
441
575
keys.
442
576
</para>
455
589
<informalexample>
456
590
<para>
457
591
Run the server in debug mode, read configuration files from
458
the <filename>~/mandos</filename> directory, and use the
459
Zeroconf service name <quote>Test</quote> to not collide with
460
any other official Mandos server on this host:
592
the <filename class="directory">~/mandos</filename> directory,
593
and use the Zeroconf service name <quote>Test</quote> to not
594
collide with any other official Mandos server on this host:
461
595
</para>
462
596
<para>
463
597
482
616
483
617
<refsect1 id="security">
484
618
<title>SECURITY</title>
485
<refsect2 id="SERVER">
619
<refsect2 id="server">
486
620
<title>SERVER</title>
487
621
<para>
488
622
Running this <command>&COMMANDNAME;</command> server program
491
625
soon after startup.
492
626
</para>
493
627
</refsect2>
494
<refsect2 id="CLIENTS">
628
<refsect2 id="clients">
495
629
<title>CLIENTS</title>
496
630
<para>
497
631
The server only gives out its stored data to clients which
512
646
compromised if they are gone for too long.
513
647
</para>
514
648
<para>
515
If a client is compromised, its downtime should be duly noted
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
528
the server program.
529
</para>
530
<para>
531
649
For more details on client-side security, see
532
650
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
651
<manvolnum>8mandos</manvolnum></citerefentry>.
538
656
<refsect1 id="see_also">
539
657
<title>SEE ALSO</title>
540
658
<para>
541
<citerefentry>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
</citerefentry>
659
<citerefentry><refentrytitle>intro</refentrytitle>
660
<manvolnum>8mandos</manvolnum></citerefentry>,
661
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
662
<manvolnum>5</manvolnum></citerefentry>,
663
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
664
<manvolnum>5</manvolnum></citerefentry>,
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>sh</refentrytitle>
668
<manvolnum>1</manvolnum></citerefentry>
550
669
</para>
551
670
<variablelist>
552
671
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0