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 325
- compare with another revision
- download diff
- download tarball
- view history from revision 325
- Committer: Teddy Hogeborn
- Date: 2015-08-10 19:10:26 UTC
- mfrom: (237.7.335 trunk)
- Revision ID: teddy@recompile.se-20150810191026-0jss9yy8t6o6pl39
Merge from trunk.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- 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-07-20">
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>
40
<year>2014</year>
41
<year>2015</year>
36
42
<holder>Teddy Hogeborn</holder>
37
43
<holder>Björn Påhlsson</holder>
38
44
</copyright>
85
91
<replaceable>DIRECTORY</replaceable></option></arg>
86
92
<sbr/>
87
93
<arg><option>--debug</option></arg>
94
<sbr/>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
97
<sbr/>
98
<arg><option>--no-dbus</option></arg>
99
<sbr/>
100
<arg><option>--no-ipv6</option></arg>
101
<sbr/>
102
<arg><option>--no-restore</option></arg>
103
<sbr/>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--foreground</option></arg>
111
<sbr/>
112
<arg><option>--no-zeroconf</option></arg>
88
113
</cmdsynopsis>
89
114
<cmdsynopsis>
90
115
<command>&COMMANDNAME;</command>
108
133
<para>
109
134
<command>&COMMANDNAME;</command> is a server daemon which
110
135
handles incoming request for passwords for a pre-defined list of
111
client host computers. The Mandos server uses Zeroconf to
112
announce itself on the local network, and uses TLS to
113
communicate securely with and to authenticate the clients. The
114
Mandos server uses IPv6 to allow Mandos clients to use IPv6
115
link-local addresses, since the clients will probably not have
116
any other addresses configured (see <xref linkend="overview"/>).
117
Any authenticated client is then given the stored pre-encrypted
118
password for that specific client.
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
119
146
</para>
120
147
</refsect1>
121
148
190
217
</varlistentry>
191
218
192
219
<varlistentry>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
222
<listitem>
223
<para>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
233
</para>
234
</listitem>
235
</varlistentry>
236
237
<varlistentry>
193
238
<term><option>--priority <replaceable>
194
239
PRIORITY</replaceable></option></term>
195
240
<listitem>
229
274
</para>
230
275
</listitem>
231
276
</varlistentry>
277
278
<varlistentry>
279
<term><option>--no-dbus</option></term>
280
<listitem>
281
<xi:include href="mandos-options.xml" xpointer="dbus"/>
282
<para>
283
See also <xref linkend="dbus_interface"/>.
284
</para>
285
</listitem>
286
</varlistentry>
287
288
<varlistentry>
289
<term><option>--no-ipv6</option></term>
290
<listitem>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
</listitem>
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--no-restore</option></term>
297
<listitem>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
<para>
300
See also <xref linkend="persistent_state"/>.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
308
<listitem>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
</listitem>
311
</varlistentry>
312
313
<varlistentry>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
316
<listitem>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
</listitem>
319
</varlistentry>
320
321
<varlistentry>
322
<term><option>--foreground</option></term>
323
<listitem>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>--no-zeroconf</option></term>
331
<listitem>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
</listitem>
334
</varlistentry>
335
232
336
</variablelist>
233
337
</refsect1>
234
338
306
410
The server will, by default, continually check that the clients
307
411
are still up. If a client has not been confirmed as being up
308
412
for some time, the client is assumed to be compromised and is no
309
longer eligible to receive the encrypted password. The timeout,
310
checker program, and interval between checks can be configured
311
both globally and per client; see <citerefentry>
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
<manvolnum>5</manvolnum></citerefentry>.
419
</para>
420
</refsect1>
421
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
424
<para>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
312
429
<refentrytitle>mandos-clients.conf</refentrytitle>
313
<manvolnum>5</manvolnum></citerefentry>.
314
</para>
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
432
</para>
433
<para>
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
438
</para>
439
315
440
</refsect1>
316
441
317
442
<refsect1 id="logging">
318
443
<title>LOGGING</title>
319
444
<para>
320
445
The server will send log message with various severity levels to
321
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
322
447
<option>--debug</option> option, it will log even more messages,
323
448
and also show them on the console.
324
449
</para>
325
450
</refsect1>
326
451
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
454
<para>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
461
</para>
462
</refsect1>
463
464
<refsect1 id="dbus_interface">
465
<title>D-BUS INTERFACE</title>
466
<para>
467
The server will by default provide a D-Bus system bus interface.
468
This interface will only be accessible by the root user or a
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
</para>
472
</refsect1>
473
327
474
<refsect1 id="exit_status">
328
475
<title>EXIT STATUS</title>
329
476
<para>
381
528
</listitem>
382
529
</varlistentry>
383
530
<varlistentry>
384
<term><filename>/var/run/mandos.pid</filename></term>
385
<listitem>
386
<para>
387
The file containing the process id of
388
<command>&COMMANDNAME;</command>.
531
<term><filename>/run/mandos.pid</filename></term>
532
<listitem>
533
<para>
534
The file containing the process id of the
535
<command>&COMMANDNAME;</command> process started last.
536
<emphasis >Note:</emphasis> If the <filename
537
class="directory">/run</filename> directory does not
538
exist, <filename>/var/run/mandos.pid</filename> will be
539
used instead.
540
</para>
541
</listitem>
542
</varlistentry>
543
<varlistentry>
544
<term><filename class="devicefile">/dev/log</filename></term>
545
</varlistentry>
546
<varlistentry>
547
<term><filename
548
class="directory">/var/lib/mandos</filename></term>
549
<listitem>
550
<para>
551
Directory where persistent state will be saved. Change
552
this with the <option>--statedir</option> option. See
553
also the <option>--no-restore</option> option.
389
554
</para>
390
555
</listitem>
391
556
</varlistentry>
419
584
backtrace. This could be considered a feature.
420
585
</para>
421
586
<para>
422
Currently, if a client is declared <quote>invalid</quote> due to
423
having timed out, the server does not record this fact onto
424
permanent storage. This has some security implications, see
425
<xref linkend="clients"/>.
426
</para>
427
<para>
428
There is currently no way of querying the server of the current
429
status of clients, other than analyzing its <systemitem
430
class="service">syslog</systemitem> output.
431
</para>
432
<para>
433
587
There is no fine-grained control over logging and debug output.
434
588
</para>
435
589
<para>
436
Debug mode is conflated with running in the foreground.
437
</para>
438
<para>
439
The console log messages does not show a time stamp.
440
</para>
441
<para>
442
590
This server does not check the expire time of clients’ OpenPGP
443
591
keys.
444
592
</para>
457
605
<informalexample>
458
606
<para>
459
607
Run the server in debug mode, read configuration files from
460
the <filename>~/mandos</filename> directory, and use the
461
Zeroconf service name <quote>Test</quote> to not collide with
462
any other official Mandos server on this host:
608
the <filename class="directory">~/mandos</filename> directory,
609
and use the Zeroconf service name <quote>Test</quote> to not
610
collide with any other official Mandos server on this host:
463
611
</para>
464
612
<para>
465
613
514
662
compromised if they are gone for too long.
515
663
</para>
516
664
<para>
517
If a client is compromised, its downtime should be duly noted
518
by the server which would therefore declare the client
519
invalid. But if the server was ever restarted, it would
520
re-read its client list from its configuration file and again
521
regard all clients therein as valid, and hence eligible to
522
receive their passwords. Therefore, be careful when
523
restarting servers if it is suspected that a client has, in
524
fact, been compromised by parties who may now be running a
525
fake Mandos client with the keys from the non-encrypted
526
initial <acronym>RAM</acronym> image of the client host. What
527
should be done in that case (if restarting the server program
528
really is necessary) is to stop the server program, edit the
529
configuration file to omit any suspect clients, and restart
530
the server program.
531
</para>
532
<para>
533
665
For more details on client-side security, see
534
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
535
667
<manvolnum>8mandos</manvolnum></citerefentry>.
540
672
<refsect1 id="see_also">
541
673
<title>SEE ALSO</title>
542
674
<para>
543
<citerefentry>
544
<refentrytitle>mandos-clients.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos.conf</refentrytitle>
547
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>mandos-client</refentrytitle>
549
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
550
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
551
</citerefentry>
675
<citerefentry><refentrytitle>intro</refentrytitle>
676
<manvolnum>8mandos</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
680
<manvolnum>5</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>mandos-client</refentrytitle>
682
<manvolnum>8mandos</manvolnum></citerefentry>,
683
<citerefentry><refentrytitle>sh</refentrytitle>
684
<manvolnum>1</manvolnum></citerefentry>
552
685
</para>
553
686
<variablelist>
554
687
<varlistentry>
575
708
</varlistentry>
576
709
<varlistentry>
577
710
<term>
578
<ulink url="http://www.gnu.org/software/gnutls/"
579
>GnuTLS</ulink>
711
<ulink url="http://gnutls.org/">GnuTLS</ulink>
580
712
</term>
581
713
<listitem>
582
714
<para>
620
752
</varlistentry>
621
753
<varlistentry>
622
754
<term>
623
RFC 4346: <citetitle>The Transport Layer Security (TLS)
624
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
625
757
</term>
626
758
<listitem>
627
759
<para>
628
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
629
761
</para>
630
762
</listitem>
631
763
</varlistentry>
641
773
</varlistentry>
642
774
<varlistentry>
643
775
<term>
644
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
645
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
646
778
</term>
647
779
<listitem>
648
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0