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 334
- compare with another revision
- download diff
- download tarball
- view history from revision 334
- Committer: Teddy Hogeborn
- Date: 2016-02-29 21:28:39 UTC
- Revision ID: teddy@recompile.se-20160229212839-hoz3rw1us3uds68n
Tags: version-1.7.3-1
* Makefile (version): Changed to "1.7.3".
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
* NEWS (Version 1.7.3): New entry.
* debian/changelog (1.7.3-1): - '' -
- 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 "2016-02-28">
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>
42
<year>2016</year>
36
43
<holder>Teddy Hogeborn</holder>
37
44
<holder>Björn Påhlsson</holder>
38
45
</copyright>
85
92
<replaceable>DIRECTORY</replaceable></option></arg>
86
93
<sbr/>
87
94
<arg><option>--debug</option></arg>
95
<sbr/>
96
<arg><option>--debuglevel
97
<replaceable>LEVEL</replaceable></option></arg>
98
<sbr/>
99
<arg><option>--no-dbus</option></arg>
100
<sbr/>
101
<arg><option>--no-ipv6</option></arg>
102
<sbr/>
103
<arg><option>--no-restore</option></arg>
104
<sbr/>
105
<arg><option>--statedir
106
<replaceable>DIRECTORY</replaceable></option></arg>
107
<sbr/>
108
<arg><option>--socket
109
<replaceable>FD</replaceable></option></arg>
110
<sbr/>
111
<arg><option>--foreground</option></arg>
112
<sbr/>
113
<arg><option>--no-zeroconf</option></arg>
88
114
</cmdsynopsis>
89
115
<cmdsynopsis>
90
116
<command>&COMMANDNAME;</command>
108
134
<para>
109
135
<command>&COMMANDNAME;</command> is a server daemon which
110
136
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.
137
client host computers. For an introduction, see
138
<citerefentry><refentrytitle>intro</refentrytitle>
139
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
140
uses Zeroconf to announce itself on the local network, and uses
141
TLS to communicate securely with and to authenticate the
142
clients. The Mandos server uses IPv6 to allow Mandos clients to
143
use IPv6 link-local addresses, since the clients will probably
144
not have any other addresses configured (see <xref
145
linkend="overview"/>). Any authenticated client is then given
146
the stored pre-encrypted password for that specific client.
119
147
</para>
120
148
</refsect1>
121
149
190
218
</varlistentry>
191
219
192
220
<varlistentry>
221
<term><option>--debuglevel
222
<replaceable>LEVEL</replaceable></option></term>
223
<listitem>
224
<para>
225
Set the debugging log level.
226
<replaceable>LEVEL</replaceable> is a string, one of
227
<quote><literal>CRITICAL</literal></quote>,
228
<quote><literal>ERROR</literal></quote>,
229
<quote><literal>WARNING</literal></quote>,
230
<quote><literal>INFO</literal></quote>, or
231
<quote><literal>DEBUG</literal></quote>, in order of
232
increasing verbosity. The default level is
233
<quote><literal>WARNING</literal></quote>.
234
</para>
235
</listitem>
236
</varlistentry>
237
238
<varlistentry>
193
239
<term><option>--priority <replaceable>
194
240
PRIORITY</replaceable></option></term>
195
241
<listitem>
229
275
</para>
230
276
</listitem>
231
277
</varlistentry>
278
279
<varlistentry>
280
<term><option>--no-dbus</option></term>
281
<listitem>
282
<xi:include href="mandos-options.xml" xpointer="dbus"/>
283
<para>
284
See also <xref linkend="dbus_interface"/>.
285
</para>
286
</listitem>
287
</varlistentry>
288
289
<varlistentry>
290
<term><option>--no-ipv6</option></term>
291
<listitem>
292
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
293
</listitem>
294
</varlistentry>
295
296
<varlistentry>
297
<term><option>--no-restore</option></term>
298
<listitem>
299
<xi:include href="mandos-options.xml" xpointer="restore"/>
300
<para>
301
See also <xref linkend="persistent_state"/>.
302
</para>
303
</listitem>
304
</varlistentry>
305
306
<varlistentry>
307
<term><option>--statedir
308
<replaceable>DIRECTORY</replaceable></option></term>
309
<listitem>
310
<xi:include href="mandos-options.xml" xpointer="statedir"/>
311
</listitem>
312
</varlistentry>
313
314
<varlistentry>
315
<term><option>--socket
316
<replaceable>FD</replaceable></option></term>
317
<listitem>
318
<xi:include href="mandos-options.xml" xpointer="socket"/>
319
</listitem>
320
</varlistentry>
321
322
<varlistentry>
323
<term><option>--foreground</option></term>
324
<listitem>
325
<xi:include href="mandos-options.xml"
326
xpointer="foreground"/>
327
</listitem>
328
</varlistentry>
329
330
<varlistentry>
331
<term><option>--no-zeroconf</option></term>
332
<listitem>
333
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
</listitem>
335
</varlistentry>
336
232
337
</variablelist>
233
338
</refsect1>
234
339
306
411
The server will, by default, continually check that the clients
307
412
are still up. If a client has not been confirmed as being up
308
413
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>
414
longer eligible to receive the encrypted password. (Manual
415
intervention is required to re-enable a client.) The timeout,
416
extended timeout, checker program, and interval between checks
417
can be configured both globally and per client; see
418
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
<manvolnum>5</manvolnum></citerefentry>.
420
</para>
421
</refsect1>
422
423
<refsect1 id="approval">
424
<title>APPROVAL</title>
425
<para>
426
The server can be configured to require manual approval for a
427
client before it is sent its secret. The delay to wait for such
428
approval and the default action (approve or deny) can be
429
configured both globally and per client; see <citerefentry>
312
430
<refentrytitle>mandos-clients.conf</refentrytitle>
313
<manvolnum>5</manvolnum></citerefentry>.
314
</para>
431
<manvolnum>5</manvolnum></citerefentry>. By default all clients
432
will be approved immediately without delay.
433
</para>
434
<para>
435
This can be used to deny a client its secret if not manually
436
approved within a specified time. It can also be used to make
437
the server delay before giving a client its secret, allowing
438
optional manual denying of this specific client.
439
</para>
440
315
441
</refsect1>
316
442
317
443
<refsect1 id="logging">
318
444
<title>LOGGING</title>
319
445
<para>
320
446
The server will send log message with various severity levels to
321
<filename>/dev/log</filename>. With the
447
<filename class="devicefile">/dev/log</filename>. With the
322
448
<option>--debug</option> option, it will log even more messages,
323
449
and also show them on the console.
324
450
</para>
325
451
</refsect1>
326
452
453
<refsect1 id="persistent_state">
454
<title>PERSISTENT STATE</title>
455
<para>
456
Client settings, initially read from
457
<filename>clients.conf</filename>, are persistent across
458
restarts, and run-time changes will override settings in
459
<filename>clients.conf</filename>. However, if a setting is
460
<emphasis>changed</emphasis> (or a client added, or removed) in
461
<filename>clients.conf</filename>, this will take precedence.
462
</para>
463
</refsect1>
464
465
<refsect1 id="dbus_interface">
466
<title>D-BUS INTERFACE</title>
467
<para>
468
The server will by default provide a D-Bus system bus interface.
469
This interface will only be accessible by the root user or a
470
Mandos-specific user, if such a user exists. For documentation
471
of the D-Bus API, see the file <filename>DBUS-API</filename>.
472
</para>
473
</refsect1>
474
327
475
<refsect1 id="exit_status">
328
476
<title>EXIT STATUS</title>
329
477
<para>
381
529
</listitem>
382
530
</varlistentry>
383
531
<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>.
389
</para>
390
</listitem>
391
</varlistentry>
392
<varlistentry>
393
<term><filename>/dev/log</filename></term>
532
<term><filename>/run/mandos.pid</filename></term>
533
<listitem>
534
<para>
535
The file containing the process id of the
536
<command>&COMMANDNAME;</command> process started last.
537
<emphasis >Note:</emphasis> If the <filename
538
class="directory">/run</filename> directory does not
539
exist, <filename>/var/run/mandos.pid</filename> will be
540
used instead.
541
</para>
542
</listitem>
543
</varlistentry>
544
<varlistentry>
545
<term><filename
546
class="directory">/var/lib/mandos</filename></term>
547
<listitem>
548
<para>
549
Directory where persistent state will be saved. Change
550
this with the <option>--statedir</option> option. See
551
also the <option>--no-restore</option> option.
552
</para>
553
</listitem>
554
</varlistentry>
555
<varlistentry>
556
<term><filename class="devicefile">/dev/log</filename></term>
394
557
<listitem>
395
558
<para>
396
559
The Unix domain socket to where local syslog messages are
419
582
backtrace. This could be considered a feature.
420
583
</para>
421
584
<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
585
There is no fine-grained control over logging and debug output.
434
586
</para>
435
587
<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
588
This server does not check the expire time of clients’ OpenPGP
443
589
keys.
444
590
</para>
457
603
<informalexample>
458
604
<para>
459
605
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:
606
the <filename class="directory">~/mandos</filename> directory,
607
and use the Zeroconf service name <quote>Test</quote> to not
608
collide with any other official Mandos server on this host:
463
609
</para>
464
610
<para>
465
611
514
660
compromised if they are gone for too long.
515
661
</para>
516
662
<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
663
For more details on client-side security, see
534
664
<citerefentry><refentrytitle>mandos-client</refentrytitle>
535
665
<manvolnum>8mandos</manvolnum></citerefentry>.
540
670
<refsect1 id="see_also">
541
671
<title>SEE ALSO</title>
542
672
<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>
673
<citerefentry><refentrytitle>intro</refentrytitle>
674
<manvolnum>8mandos</manvolnum></citerefentry>,
675
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
676
<manvolnum>5</manvolnum></citerefentry>,
677
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
678
<manvolnum>5</manvolnum></citerefentry>,
679
<citerefentry><refentrytitle>mandos-client</refentrytitle>
680
<manvolnum>8mandos</manvolnum></citerefentry>,
681
<citerefentry><refentrytitle>sh</refentrytitle>
682
<manvolnum>1</manvolnum></citerefentry>
552
683
</para>
553
684
<variablelist>
554
685
<varlistentry>
575
706
</varlistentry>
576
707
<varlistentry>
577
708
<term>
578
<ulink url="http://www.gnu.org/software/gnutls/"
579
>GnuTLS</ulink>
709
<ulink url="http://gnutls.org/">GnuTLS</ulink>
580
710
</term>
581
711
<listitem>
582
712
<para>
620
750
</varlistentry>
621
751
<varlistentry>
622
752
<term>
623
RFC 4346: <citetitle>The Transport Layer Security (TLS)
624
Protocol Version 1.1</citetitle>
753
RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
Protocol Version 1.2</citetitle>
625
755
</term>
626
756
<listitem>
627
757
<para>
628
TLS 1.1 is the protocol implemented by GnuTLS.
758
TLS 1.2 is the protocol implemented by GnuTLS.
629
759
</para>
630
760
</listitem>
631
761
</varlistentry>
641
771
</varlistentry>
642
772
<varlistentry>
643
773
<term>
644
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
645
Security</citetitle>
774
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
Security (TLS) Authentication</citetitle>
646
776
</term>
647
777
<listitem>
648
778
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0