To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/release
« back to all changes in this revision
Viewing changes to mandos.xml
- browse files at revision 298
- compare with another revision
- download diff
- download tarball
- view history from revision 298
- Committer: Teddy Hogeborn
- Date: 2012-02-21 21:27:14 UTC
- mfrom: (297.1.1 nmu)
- Revision ID: teddy@recompile.se-20120221212714-40iub281d4yvrk9r
Tags: version-1.5.3-1.1
Merge NMU change.
- 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-01-15">
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>
86
103
</cmdsynopsis>
87
104
<cmdsynopsis>
88
105
<command>&COMMANDNAME;</command>
106
123
<para>
107
124
<command>&COMMANDNAME;</command> is a server daemon which
108
125
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.
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.
117
136
</para>
118
137
</refsect1>
119
138
188
207
</varlistentry>
189
208
190
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>
191
228
<term><option>--priority <replaceable>
192
229
PRIORITY</replaceable></option></term>
193
230
<listitem>
227
264
</para>
228
265
</listitem>
229
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
<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>
230
302
</variablelist>
231
303
</refsect1>
232
304
304
376
The server will, by default, continually check that the clients
305
377
are still up. If a client has not been confirmed as being up
306
378
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>
379
longer eligible to receive the encrypted password. (Manual
380
intervention is required to re-enable a client.) The timeout,
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>
384
<manvolnum>5</manvolnum></citerefentry>.
385
</para>
386
</refsect1>
387
388
<refsect1 id="approval">
389
<title>APPROVAL</title>
390
<para>
391
The server can be configured to require manual approval for a
392
client before it is sent its secret. The delay to wait for such
393
approval and the default action (approve or deny) can be
394
configured both globally and per client; see <citerefentry>
310
395
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</para>
396
<manvolnum>5</manvolnum></citerefentry>. By default all clients
397
will be approved immediately without delay.
398
</para>
399
<para>
400
This can be used to deny a client its secret if not manually
401
approved within a specified time. It can also be used to make
402
the server delay before giving a client its secret, allowing
403
optional manual denying of this specific client.
404
</para>
405
313
406
</refsect1>
314
407
315
408
<refsect1 id="logging">
316
409
<title>LOGGING</title>
317
410
<para>
318
411
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
412
<filename class="devicefile">/dev/log</filename>. With the
320
413
<option>--debug</option> option, it will log even more messages,
321
414
and also show them on the console.
322
415
</para>
323
416
</refsect1>
324
417
418
<refsect1 id="persistent_state">
419
<title>PERSISTENT STATE</title>
420
<para>
421
Client settings, initially read from
422
<filename>clients.conf</filename>, are persistent across
423
restarts, and run-time changes will override settings in
424
<filename>clients.conf</filename>. However, if a setting is
425
<emphasis>changed</emphasis> (or a client added, or removed) in
426
<filename>clients.conf</filename>, this will take precedence.
427
</para>
428
</refsect1>
429
430
<refsect1 id="dbus_interface">
431
<title>D-BUS INTERFACE</title>
432
<para>
433
The server will by default provide a D-Bus system bus interface.
434
This interface will only be accessible by the root user or a
435
Mandos-specific user, if such a user exists. For documentation
436
of the D-Bus API, see the file <filename>DBUS-API</filename>.
437
</para>
438
</refsect1>
439
325
440
<refsect1 id="exit_status">
326
441
<title>EXIT STATUS</title>
327
442
<para>
350
465
</variablelist>
351
466
</refsect1>
352
467
353
<refsect1 id="file">
468
<refsect1 id="files">
354
469
<title>FILES</title>
355
470
<para>
356
471
Use the <option>--configdir</option> option to change where
382
497
<term><filename>/var/run/mandos.pid</filename></term>
383
498
<listitem>
384
499
<para>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
500
The file containing the process id of the
501
<command>&COMMANDNAME;</command> process started last.
502
</para>
503
</listitem>
504
</varlistentry>
505
<varlistentry>
506
<term><filename class="devicefile">/dev/log</filename></term>
507
</varlistentry>
508
<varlistentry>
509
<term><filename
510
class="directory">/var/lib/mandos</filename></term>
511
<listitem>
512
<para>
513
Directory where persistent state will be saved. Change
514
this with the <option>--statedir</option> option. See
515
also the <option>--no-restore</option> option.
387
516
</para>
388
517
</listitem>
389
518
</varlistentry>
417
546
backtrace. This could be considered a feature.
418
547
</para>
419
548
<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
549
There is no fine-grained control over logging and debug output.
432
550
</para>
433
551
<para>
434
552
Debug mode is conflated with running in the foreground.
435
553
</para>
436
554
<para>
437
The console log messages does not show a time stamp.
438
</para>
439
<para>
440
555
This server does not check the expire time of clients’ OpenPGP
441
556
keys.
442
557
</para>
455
570
<informalexample>
456
571
<para>
457
572
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:
573
the <filename class="directory">~/mandos</filename> directory,
574
and use the Zeroconf service name <quote>Test</quote> to not
575
collide with any other official Mandos server on this host:
461
576
</para>
462
577
<para>
463
578
482
597
483
598
<refsect1 id="security">
484
599
<title>SECURITY</title>
485
<refsect2 id="SERVER">
600
<refsect2 id="server">
486
601
<title>SERVER</title>
487
602
<para>
488
603
Running this <command>&COMMANDNAME;</command> server program
491
606
soon after startup.
492
607
</para>
493
608
</refsect2>
494
<refsect2 id="CLIENTS">
609
<refsect2 id="clients">
495
610
<title>CLIENTS</title>
496
611
<para>
497
612
The server only gives out its stored data to clients which
512
627
compromised if they are gone for too long.
513
628
</para>
514
629
<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
630
For more details on client-side security, see
532
631
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
632
<manvolnum>8mandos</manvolnum></citerefentry>.
538
637
<refsect1 id="see_also">
539
638
<title>SEE ALSO</title>
540
639
<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>
640
<citerefentry><refentrytitle>intro</refentrytitle>
641
<manvolnum>8mandos</manvolnum></citerefentry>,
642
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
643
<manvolnum>5</manvolnum></citerefentry>,
644
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
645
<manvolnum>5</manvolnum></citerefentry>,
646
<citerefentry><refentrytitle>mandos-client</refentrytitle>
647
<manvolnum>8mandos</manvolnum></citerefentry>,
648
<citerefentry><refentrytitle>sh</refentrytitle>
649
<manvolnum>1</manvolnum></citerefentry>
550
650
</para>
551
651
<variablelist>
552
652
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0