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 269.1.2
- compare with another revision
- download diff
- download tarball
- view history from revision 269.1.2
- Committer: teddy at bsnet
- Date: 2010-08-11 20:06:18 UTC
- mto: (237.2.182 mandos-local)
- mto: This revision was merged to the branch mainline in revision 270.
- Revision ID: teddy@fukt.bsnet.se-20100811200618-1uuv7p6cmrb2cmxu
* plugins.d/mandos-client.c: Added debug output.
- files removed:
- DBUS-API
- debian/source
- debian/upstream
- 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 "2013-10-26">
5
<!ENTITY TIMESTAMP "2009-09-17">
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@recompile.se</email>
22
<email>belorn@fukt.bsnet.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@recompile.se</email>
29
<email>teddy@fukt.bsnet.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>
40
36
<holder>Teddy Hogeborn</holder>
41
37
<holder>Björn Påhlsson</holder>
42
38
</copyright>
90
86
<sbr/>
91
87
<arg><option>--debug</option></arg>
92
88
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
96
<arg><option>--no-dbus</option></arg>
97
<sbr/>
98
89
<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>
109
90
</cmdsynopsis>
110
91
<cmdsynopsis>
111
92
<command>&COMMANDNAME;</command>
129
110
<para>
130
111
<command>&COMMANDNAME;</command> is a server daemon which
131
112
handles incoming request for passwords for a pre-defined list of
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.
113
client host computers. The Mandos server uses Zeroconf to
114
announce itself on the local network, and uses TLS to
115
communicate securely with and to authenticate the clients. The
116
Mandos server uses IPv6 to allow Mandos clients to use IPv6
117
link-local addresses, since the clients will probably not have
118
any other addresses configured (see <xref linkend="overview"/>).
119
Any authenticated client is then given the stored pre-encrypted
120
password for that specific client.
142
121
</para>
143
122
</refsect1>
144
123
213
192
</varlistentry>
214
193
215
194
<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>
234
195
<term><option>--priority <replaceable>
235
196
PRIORITY</replaceable></option></term>
236
197
<listitem>
237
<xi:include href="mandos-options.xml"
238
xpointer="priority_compat"/>
198
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
199
</listitem>
240
200
</varlistentry>
241
201
273
233
</varlistentry>
274
234
275
235
<varlistentry>
276
<term><option>--no-dbus</option></term>
277
<listitem>
278
<xi:include href="mandos-options.xml" xpointer="dbus"/>
279
<para>
280
See also <xref linkend="dbus_interface"/>.
281
</para>
282
</listitem>
283
</varlistentry>
284
285
<varlistentry>
286
236
<term><option>--no-ipv6</option></term>
287
237
<listitem>
288
238
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
289
239
</listitem>
290
240
</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
326
241
</variablelist>
327
242
</refsect1>
328
243
402
317
for some time, the client is assumed to be compromised and is no
403
318
longer eligible to receive the encrypted password. (Manual
404
319
intervention is required to re-enable a client.) The timeout,
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>
320
checker program, and interval between checks can be configured
321
both globally and per client; see <citerefentry>
419
322
<refentrytitle>mandos-clients.conf</refentrytitle>
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
323
<manvolnum>5</manvolnum></citerefentry>. A client successfully
324
receiving its password will also be treated as a successful
325
checker run.
326
</para>
430
327
</refsect1>
431
328
432
329
<refsect1 id="logging">
433
330
<title>LOGGING</title>
434
331
<para>
435
332
The server will send log message with various severity levels to
436
<filename class="devicefile">/dev/log</filename>. With the
333
<filename>/dev/log</filename>. With the
437
334
<option>--debug</option> option, it will log even more messages,
438
335
and also show them on the console.
439
336
</para>
440
337
</refsect1>
441
338
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
454
<refsect1 id="dbus_interface">
455
<title>D-BUS INTERFACE</title>
456
<para>
457
The server will by default provide a D-Bus system bus interface.
458
This interface will only be accessible by the root user or a
459
Mandos-specific user, if such a user exists. For documentation
460
of the D-Bus API, see the file <filename>DBUS-API</filename>.
461
</para>
462
</refsect1>
463
464
339
<refsect1 id="exit_status">
465
340
<title>EXIT STATUS</title>
466
341
<para>
518
393
</listitem>
519
394
</varlistentry>
520
395
<varlistentry>
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
<emphasis >Note:</emphasis> If the <filename
527
class="directory">/run</filename> directory does not
528
exist, <filename>/var/run/mandos.pid</filename> will be
529
used instead.
530
</para>
531
</listitem>
532
</varlistentry>
533
<varlistentry>
534
<term><filename class="devicefile">/dev/log</filename></term>
535
</varlistentry>
536
<varlistentry>
537
<term><filename
538
class="directory">/var/lib/mandos</filename></term>
539
<listitem>
540
<para>
541
Directory where persistent state will be saved. Change
542
this with the <option>--statedir</option> option. See
543
also the <option>--no-restore</option> option.
396
<term><filename>/var/run/mandos.pid</filename></term>
397
<listitem>
398
<para>
399
The file containing the process id of
400
<command>&COMMANDNAME;</command>.
544
401
</para>
545
402
</listitem>
546
403
</varlistentry>
574
431
backtrace. This could be considered a feature.
575
432
</para>
576
433
<para>
434
Currently, if a client is declared <quote>invalid</quote> due to
435
having timed out, the server does not record this fact onto
436
permanent storage. This has some security implications, see
437
<xref linkend="clients"/>.
438
</para>
439
<para>
440
There is currently no way of querying the server of the current
441
status of clients, other than analyzing its <systemitem
442
class="service">syslog</systemitem> output.
443
</para>
444
<para>
577
445
There is no fine-grained control over logging and debug output.
578
446
</para>
579
447
<para>
448
Debug mode is conflated with running in the foreground.
449
</para>
450
<para>
451
The console log messages do not show a time stamp.
452
</para>
453
<para>
580
454
This server does not check the expire time of clients’ OpenPGP
581
455
keys.
582
456
</para>
595
469
<informalexample>
596
470
<para>
597
471
Run the server in debug mode, read configuration files from
598
the <filename class="directory">~/mandos</filename> directory,
599
and use the Zeroconf service name <quote>Test</quote> to not
600
collide with any other official Mandos server on this host:
472
the <filename>~/mandos</filename> directory, and use the
473
Zeroconf service name <quote>Test</quote> to not collide with
474
any other official Mandos server on this host:
601
475
</para>
602
476
<para>
603
477
652
526
compromised if they are gone for too long.
653
527
</para>
654
528
<para>
529
If a client is compromised, its downtime should be duly noted
530
by the server which would therefore declare the client
531
invalid. But if the server was ever restarted, it would
532
re-read its client list from its configuration file and again
533
regard all clients therein as valid, and hence eligible to
534
receive their passwords. Therefore, be careful when
535
restarting servers if it is suspected that a client has, in
536
fact, been compromised by parties who may now be running a
537
fake Mandos client with the keys from the non-encrypted
538
initial <acronym>RAM</acronym> image of the client host. What
539
should be done in that case (if restarting the server program
540
really is necessary) is to stop the server program, edit the
541
configuration file to omit any suspect clients, and restart
542
the server program.
543
</para>
544
<para>
655
545
For more details on client-side security, see
656
546
<citerefentry><refentrytitle>mandos-client</refentrytitle>
657
547
<manvolnum>8mandos</manvolnum></citerefentry>.
662
552
<refsect1 id="see_also">
663
553
<title>SEE ALSO</title>
664
554
<para>
665
<citerefentry><refentrytitle>intro</refentrytitle>
666
<manvolnum>8mandos</manvolnum></citerefentry>,
667
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
668
<manvolnum>5</manvolnum></citerefentry>,
669
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
670
<manvolnum>5</manvolnum></citerefentry>,
671
<citerefentry><refentrytitle>mandos-client</refentrytitle>
672
<manvolnum>8mandos</manvolnum></citerefentry>,
673
<citerefentry><refentrytitle>sh</refentrytitle>
674
<manvolnum>1</manvolnum></citerefentry>
555
<citerefentry>
556
<refentrytitle>mandos-clients.conf</refentrytitle>
557
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
558
<refentrytitle>mandos.conf</refentrytitle>
559
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
560
<refentrytitle>mandos-client</refentrytitle>
561
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
562
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
563
</citerefentry>
675
564
</para>
676
565
<variablelist>
677
566
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0