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 759
- compare with another revision
- download diff
- download tarball
- view history from revision 759
- Committer: Teddy Hogeborn
- Date: 2015-07-06 20:29:34 UTC
- mfrom: (738.1.6 route-external)
- Revision ID: teddy@recompile.se-20150706202934-09j06jm2fiw1bn80
Merge change to add local route when network is "unreachable".
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- debian/mandos-client.config
- files renamed:
- mandos-list => mandos-ctl
- 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 "2009-01-04">
5
<!ENTITY TIMESTAMP "2015-01-25">
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
35
<year>2009</year>
36
<year>2010</year>
37
<year>2011</year>
38
<year>2012</year>
39
<year>2013</year>
36
40
<holder>Teddy Hogeborn</holder>
37
41
<holder>Björn Påhlsson</holder>
38
42
</copyright>
86
90
<sbr/>
87
91
<arg><option>--debug</option></arg>
88
92
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
89
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>
109
<sbr/>
110
<arg><option>--no-zeroconf</option></arg>
90
111
</cmdsynopsis>
91
112
<cmdsynopsis>
92
113
<command>&COMMANDNAME;</command>
110
131
<para>
111
132
<command>&COMMANDNAME;</command> is a server daemon which
112
133
handles incoming request for passwords for a pre-defined list of
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.
134
client host computers. For an introduction, see
135
<citerefentry><refentrytitle>intro</refentrytitle>
136
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
137
uses Zeroconf to announce itself on the local network, and uses
138
TLS to communicate securely with and to authenticate the
139
clients. The Mandos server uses IPv6 to allow Mandos clients to
140
use IPv6 link-local addresses, since the clients will probably
141
not have any other addresses configured (see <xref
142
linkend="overview"/>). Any authenticated client is then given
143
the stored pre-encrypted password for that specific client.
121
144
</para>
122
145
</refsect1>
123
146
192
215
</varlistentry>
193
216
194
217
<varlistentry>
218
<term><option>--debuglevel
219
<replaceable>LEVEL</replaceable></option></term>
220
<listitem>
221
<para>
222
Set the debugging log level.
223
<replaceable>LEVEL</replaceable> is a string, one of
224
<quote><literal>CRITICAL</literal></quote>,
225
<quote><literal>ERROR</literal></quote>,
226
<quote><literal>WARNING</literal></quote>,
227
<quote><literal>INFO</literal></quote>, or
228
<quote><literal>DEBUG</literal></quote>, in order of
229
increasing verbosity. The default level is
230
<quote><literal>WARNING</literal></quote>.
231
</para>
232
</listitem>
233
</varlistentry>
234
235
<varlistentry>
195
236
<term><option>--priority <replaceable>
196
237
PRIORITY</replaceable></option></term>
197
238
<listitem>
198
<xi:include href="mandos-options.xml" xpointer="priority"/>
239
<xi:include href="mandos-options.xml"
240
xpointer="priority_compat"/>
199
241
</listitem>
200
242
</varlistentry>
201
243
241
283
</para>
242
284
</listitem>
243
285
</varlistentry>
286
287
<varlistentry>
288
<term><option>--no-ipv6</option></term>
289
<listitem>
290
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
291
</listitem>
292
</varlistentry>
293
294
<varlistentry>
295
<term><option>--no-restore</option></term>
296
<listitem>
297
<xi:include href="mandos-options.xml" xpointer="restore"/>
298
<para>
299
See also <xref linkend="persistent_state"/>.
300
</para>
301
</listitem>
302
</varlistentry>
303
304
<varlistentry>
305
<term><option>--statedir
306
<replaceable>DIRECTORY</replaceable></option></term>
307
<listitem>
308
<xi:include href="mandos-options.xml" xpointer="statedir"/>
309
</listitem>
310
</varlistentry>
311
312
<varlistentry>
313
<term><option>--socket
314
<replaceable>FD</replaceable></option></term>
315
<listitem>
316
<xi:include href="mandos-options.xml" xpointer="socket"/>
317
</listitem>
318
</varlistentry>
319
320
<varlistentry>
321
<term><option>--foreground</option></term>
322
<listitem>
323
<xi:include href="mandos-options.xml"
324
xpointer="foreground"/>
325
</listitem>
326
</varlistentry>
327
328
<varlistentry>
329
<term><option>--no-zeroconf</option></term>
330
<listitem>
331
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
</listitem>
333
</varlistentry>
334
244
335
</variablelist>
245
336
</refsect1>
246
337
318
409
The server will, by default, continually check that the clients
319
410
are still up. If a client has not been confirmed as being up
320
411
for some time, the client is assumed to be compromised and is no
321
longer eligible to receive the encrypted password. The timeout,
322
checker program, and interval between checks can be configured
323
both globally and per client; see <citerefentry>
412
longer eligible to receive the encrypted password. (Manual
413
intervention is required to re-enable a client.) The timeout,
414
extended timeout, checker program, and interval between checks
415
can be configured both globally and per client; see
416
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
<manvolnum>5</manvolnum></citerefentry>.
418
</para>
419
</refsect1>
420
421
<refsect1 id="approval">
422
<title>APPROVAL</title>
423
<para>
424
The server can be configured to require manual approval for a
425
client before it is sent its secret. The delay to wait for such
426
approval and the default action (approve or deny) can be
427
configured both globally and per client; see <citerefentry>
324
428
<refentrytitle>mandos-clients.conf</refentrytitle>
325
<manvolnum>5</manvolnum></citerefentry>.
326
</para>
429
<manvolnum>5</manvolnum></citerefentry>. By default all clients
430
will be approved immediately without delay.
431
</para>
432
<para>
433
This can be used to deny a client its secret if not manually
434
approved within a specified time. It can also be used to make
435
the server delay before giving a client its secret, allowing
436
optional manual denying of this specific client.
437
</para>
438
327
439
</refsect1>
328
440
329
441
<refsect1 id="logging">
330
442
<title>LOGGING</title>
331
443
<para>
332
444
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
445
<filename class="devicefile">/dev/log</filename>. With the
334
446
<option>--debug</option> option, it will log even more messages,
335
447
and also show them on the console.
336
448
</para>
337
449
</refsect1>
338
450
451
<refsect1 id="persistent_state">
452
<title>PERSISTENT STATE</title>
453
<para>
454
Client settings, initially read from
455
<filename>clients.conf</filename>, are persistent across
456
restarts, and run-time changes will override settings in
457
<filename>clients.conf</filename>. However, if a setting is
458
<emphasis>changed</emphasis> (or a client added, or removed) in
459
<filename>clients.conf</filename>, this will take precedence.
460
</para>
461
</refsect1>
462
339
463
<refsect1 id="dbus_interface">
340
464
<title>D-BUS INTERFACE</title>
341
465
<para>
342
466
The server will by default provide a D-Bus system bus interface.
343
467
This interface will only be accessible by the root user or a
344
Mandos-specific user, if such a user exists.
345
<!-- XXX -->
468
Mandos-specific user, if such a user exists. For documentation
469
of the D-Bus API, see the file <filename>DBUS-API</filename>.
346
470
</para>
347
471
</refsect1>
348
472
349
473
<refsect1 id="exit_status">
350
474
<title>EXIT STATUS</title>
351
475
<para>
403
527
</listitem>
404
528
</varlistentry>
405
529
<varlistentry>
406
<term><filename>/var/run/mandos.pid</filename></term>
407
<listitem>
408
<para>
409
The file containing the process id of
410
<command>&COMMANDNAME;</command>.
530
<term><filename>/run/mandos.pid</filename></term>
531
<listitem>
532
<para>
533
The file containing the process id of the
534
<command>&COMMANDNAME;</command> process started last.
535
<emphasis >Note:</emphasis> If the <filename
536
class="directory">/run</filename> directory does not
537
exist, <filename>/var/run/mandos.pid</filename> will be
538
used instead.
539
</para>
540
</listitem>
541
</varlistentry>
542
<varlistentry>
543
<term><filename class="devicefile">/dev/log</filename></term>
544
</varlistentry>
545
<varlistentry>
546
<term><filename
547
class="directory">/var/lib/mandos</filename></term>
548
<listitem>
549
<para>
550
Directory where persistent state will be saved. Change
551
this with the <option>--statedir</option> option. See
552
also the <option>--no-restore</option> option.
411
553
</para>
412
554
</listitem>
413
555
</varlistentry>
441
583
backtrace. This could be considered a feature.
442
584
</para>
443
585
<para>
444
Currently, if a client is declared <quote>invalid</quote> due to
445
having timed out, the server does not record this fact onto
446
permanent storage. This has some security implications, see
447
<xref linkend="clients"/>.
448
</para>
449
<para>
450
There is currently no way of querying the server of the current
451
status of clients, other than analyzing its <systemitem
452
class="service">syslog</systemitem> output.
453
</para>
454
<para>
455
586
There is no fine-grained control over logging and debug output.
456
587
</para>
457
588
<para>
458
Debug mode is conflated with running in the foreground.
459
</para>
460
<para>
461
The console log messages does not show a time stamp.
462
</para>
463
<para>
464
589
This server does not check the expire time of clients’ OpenPGP
465
590
keys.
466
591
</para>
479
604
<informalexample>
480
605
<para>
481
606
Run the server in debug mode, read configuration files from
482
the <filename>~/mandos</filename> directory, and use the
483
Zeroconf service name <quote>Test</quote> to not collide with
484
any other official Mandos server on this host:
607
the <filename class="directory">~/mandos</filename> directory,
608
and use the Zeroconf service name <quote>Test</quote> to not
609
collide with any other official Mandos server on this host:
485
610
</para>
486
611
<para>
487
612
536
661
compromised if they are gone for too long.
537
662
</para>
538
663
<para>
539
If a client is compromised, its downtime should be duly noted
540
by the server which would therefore declare the client
541
invalid. But if the server was ever restarted, it would
542
re-read its client list from its configuration file and again
543
regard all clients therein as valid, and hence eligible to
544
receive their passwords. Therefore, be careful when
545
restarting servers if it is suspected that a client has, in
546
fact, been compromised by parties who may now be running a
547
fake Mandos client with the keys from the non-encrypted
548
initial <acronym>RAM</acronym> image of the client host. What
549
should be done in that case (if restarting the server program
550
really is necessary) is to stop the server program, edit the
551
configuration file to omit any suspect clients, and restart
552
the server program.
553
</para>
554
<para>
555
664
For more details on client-side security, see
556
665
<citerefentry><refentrytitle>mandos-client</refentrytitle>
557
666
<manvolnum>8mandos</manvolnum></citerefentry>.
562
671
<refsect1 id="see_also">
563
672
<title>SEE ALSO</title>
564
673
<para>
565
<citerefentry>
566
<refentrytitle>mandos-clients.conf</refentrytitle>
567
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
568
<refentrytitle>mandos.conf</refentrytitle>
569
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
570
<refentrytitle>mandos-client</refentrytitle>
571
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
572
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
573
</citerefentry>
674
<citerefentry><refentrytitle>intro</refentrytitle>
675
<manvolnum>8mandos</manvolnum></citerefentry>,
676
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
677
<manvolnum>5</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos-client</refentrytitle>
681
<manvolnum>8mandos</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>sh</refentrytitle>
683
<manvolnum>1</manvolnum></citerefentry>
574
684
</para>
575
685
<variablelist>
576
686
<varlistentry>
597
707
</varlistentry>
598
708
<varlistentry>
599
709
<term>
600
<ulink url="http://www.gnu.org/software/gnutls/"
601
>GnuTLS</ulink>
710
<ulink url="http://gnutls.org/">GnuTLS</ulink>
602
711
</term>
603
712
<listitem>
604
713
<para>
642
751
</varlistentry>
643
752
<varlistentry>
644
753
<term>
645
RFC 4346: <citetitle>The Transport Layer Security (TLS)
646
Protocol Version 1.1</citetitle>
754
RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
Protocol Version 1.2</citetitle>
647
756
</term>
648
757
<listitem>
649
758
<para>
650
TLS 1.1 is the protocol implemented by GnuTLS.
759
TLS 1.2 is the protocol implemented by GnuTLS.
651
760
</para>
652
761
</listitem>
653
762
</varlistentry>
663
772
</varlistentry>
664
773
<varlistentry>
665
774
<term>
666
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
667
Security</citetitle>
775
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
Security (TLS) Authentication</citetitle>
668
777
</term>
669
778
<listitem>
670
779
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0