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 203
- compare with another revision
- download diff
- download tarball
- view history from revision 203
- Committer: Teddy Hogeborn
- Date: 2008-09-21 14:05:44 UTC
- mfrom: (24.1.103 mandos)
- Revision ID: teddy@fukt.bsnet.se-20080921140544-e9qo7alcl0bne2mn
Merge.
- files added:
- debian/mandos-client.config
- files removed:
- DBUS-API
- debian/source
- network-hooks.d
- 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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
<!ENTITY TIMESTAMP "2012-01-15">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
6
<!ENTITY TIMESTAMP "2008-09-21">
8
7
]>
9
8
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
<refentryinfo>
10
<refentryinfo>
12
11
<title>Mandos Manual</title>
13
12
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
<productname>Mandos</productname>
15
<productnumber>&version;</productnumber>
14
<productnumber>&VERSION;</productnumber>
16
15
<date>&TIMESTAMP;</date>
17
16
<authorgroup>
18
17
<author>
19
18
<firstname>Björn</firstname>
20
19
<surname>Påhlsson</surname>
21
20
<address>
22
<email>belorn@recompile.se</email>
21
<email>belorn@fukt.bsnet.se</email>
23
22
</address>
24
23
</author>
25
24
<author>
26
25
<firstname>Teddy</firstname>
27
26
<surname>Hogeborn</surname>
28
27
<address>
29
<email>teddy@recompile.se</email>
28
<email>teddy@fukt.bsnet.se</email>
30
29
</address>
31
30
</author>
32
31
</authorgroup>
33
32
<copyright>
34
33
<year>2008</year>
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
38
<year>2012</year>
39
34
<holder>Teddy Hogeborn</holder>
40
35
<holder>Björn Påhlsson</holder>
41
36
</copyright>
88
83
<replaceable>DIRECTORY</replaceable></option></arg>
89
84
<sbr/>
90
85
<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
86
</cmdsynopsis>
104
87
<cmdsynopsis>
105
88
<command>&COMMANDNAME;</command>
123
106
<para>
124
107
<command>&COMMANDNAME;</command> is a server daemon which
125
108
handles incoming request for passwords for a pre-defined list of
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.
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.
136
117
</para>
137
118
</refsect1>
138
119
207
188
</varlistentry>
208
189
209
190
<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>
228
191
<term><option>--priority <replaceable>
229
192
PRIORITY</replaceable></option></term>
230
193
<listitem>
264
227
</para>
265
228
</listitem>
266
229
</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>
302
230
</variablelist>
303
231
</refsect1>
304
232
376
304
The server will, by default, continually check that the clients
377
305
are still up. If a client has not been confirmed as being up
378
306
for some time, the client is assumed to be compromised and is no
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>
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>
310
<refentrytitle>mandos-clients.conf</refentrytitle>
384
311
<manvolnum>5</manvolnum></citerefentry>.
385
312
</para>
386
313
</refsect1>
387
314
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>
395
<refentrytitle>mandos-clients.conf</refentrytitle>
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
406
</refsect1>
407
408
315
<refsect1 id="logging">
409
316
<title>LOGGING</title>
410
317
<para>
411
318
The server will send log message with various severity levels to
412
<filename class="devicefile">/dev/log</filename>. With the
319
<filename>/dev/log</filename>. With the
413
320
<option>--debug</option> option, it will log even more messages,
414
321
and also show them on the console.
415
322
</para>
416
323
</refsect1>
417
324
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
440
325
<refsect1 id="exit_status">
441
326
<title>EXIT STATUS</title>
442
327
<para>
465
350
</variablelist>
466
351
</refsect1>
467
352
468
<refsect1 id="files">
353
<refsect1 id="file">
469
354
<title>FILES</title>
470
355
<para>
471
356
Use the <option>--configdir</option> option to change where
497
382
<term><filename>/var/run/mandos.pid</filename></term>
498
383
<listitem>
499
384
<para>
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.
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
516
387
</para>
517
388
</listitem>
518
389
</varlistentry>
546
417
backtrace. This could be considered a feature.
547
418
</para>
548
419
<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>
549
431
There is no fine-grained control over logging and debug output.
550
432
</para>
551
433
<para>
552
434
Debug mode is conflated with running in the foreground.
553
435
</para>
554
436
<para>
437
The console log messages does not show a time stamp.
438
</para>
439
<para>
555
440
This server does not check the expire time of clients’ OpenPGP
556
441
keys.
557
442
</para>
570
455
<informalexample>
571
456
<para>
572
457
Run the server in debug mode, read configuration files from
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:
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:
576
461
</para>
577
462
<para>
578
463
597
482
598
483
<refsect1 id="security">
599
484
<title>SECURITY</title>
600
<refsect2 id="server">
485
<refsect2 id="SERVER">
601
486
<title>SERVER</title>
602
487
<para>
603
488
Running this <command>&COMMANDNAME;</command> server program
606
491
soon after startup.
607
492
</para>
608
493
</refsect2>
609
<refsect2 id="clients">
494
<refsect2 id="CLIENTS">
610
495
<title>CLIENTS</title>
611
496
<para>
612
497
The server only gives out its stored data to clients which
627
512
compromised if they are gone for too long.
628
513
</para>
629
514
<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>
630
531
For more details on client-side security, see
631
532
<citerefentry><refentrytitle>mandos-client</refentrytitle>
632
533
<manvolnum>8mandos</manvolnum></citerefentry>.
637
538
<refsect1 id="see_also">
638
539
<title>SEE ALSO</title>
639
540
<para>
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>
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>
650
550
</para>
651
551
<variablelist>
652
552
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0