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 360
- compare with another revision
- download diff
- download tarball
- view history from revision 360
- Committer: Teddy Hogeborn
- Date: 2017-08-20 18:53:16 UTC
- mfrom: (237.7.458 trunk)
- Revision ID: teddy@recompile.se-20170820185316-3i5080cpg08f0e8q
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-09-17">
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
43
<year>2017</year>
36
44
<holder>Teddy Hogeborn</holder>
37
45
<holder>Björn Påhlsson</holder>
38
46
</copyright>
86
94
<sbr/>
87
95
<arg><option>--debug</option></arg>
88
96
<sbr/>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
99
<sbr/>
100
<arg><option>--no-dbus</option></arg>
101
<sbr/>
89
102
<arg><option>--no-ipv6</option></arg>
103
<sbr/>
104
<arg><option>--no-restore</option></arg>
105
<sbr/>
106
<arg><option>--statedir
107
<replaceable>DIRECTORY</replaceable></option></arg>
108
<sbr/>
109
<arg><option>--socket
110
<replaceable>FD</replaceable></option></arg>
111
<sbr/>
112
<arg><option>--foreground</option></arg>
113
<sbr/>
114
<arg><option>--no-zeroconf</option></arg>
90
115
</cmdsynopsis>
91
116
<cmdsynopsis>
92
117
<command>&COMMANDNAME;</command>
110
135
<para>
111
136
<command>&COMMANDNAME;</command> is a server daemon which
112
137
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.
138
client host computers. For an introduction, see
139
<citerefentry><refentrytitle>intro</refentrytitle>
140
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
141
uses Zeroconf to announce itself on the local network, and uses
142
TLS to communicate securely with and to authenticate the
143
clients. The Mandos server uses IPv6 to allow Mandos clients to
144
use IPv6 link-local addresses, since the clients will probably
145
not have any other addresses configured (see <xref
146
linkend="overview"/>). Any authenticated client is then given
147
the stored pre-encrypted password for that specific client.
121
148
</para>
122
149
</refsect1>
123
150
192
219
</varlistentry>
193
220
194
221
<varlistentry>
222
<term><option>--debuglevel
223
<replaceable>LEVEL</replaceable></option></term>
224
<listitem>
225
<para>
226
Set the debugging log level.
227
<replaceable>LEVEL</replaceable> is a string, one of
228
<quote><literal>CRITICAL</literal></quote>,
229
<quote><literal>ERROR</literal></quote>,
230
<quote><literal>WARNING</literal></quote>,
231
<quote><literal>INFO</literal></quote>, or
232
<quote><literal>DEBUG</literal></quote>, in order of
233
increasing verbosity. The default level is
234
<quote><literal>WARNING</literal></quote>.
235
</para>
236
</listitem>
237
</varlistentry>
238
239
<varlistentry>
195
240
<term><option>--priority <replaceable>
196
241
PRIORITY</replaceable></option></term>
197
242
<listitem>
233
278
</varlistentry>
234
279
235
280
<varlistentry>
281
<term><option>--no-dbus</option></term>
282
<listitem>
283
<xi:include href="mandos-options.xml" xpointer="dbus"/>
284
<para>
285
See also <xref linkend="dbus_interface"/>.
286
</para>
287
</listitem>
288
</varlistentry>
289
290
<varlistentry>
236
291
<term><option>--no-ipv6</option></term>
237
292
<listitem>
238
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
239
294
</listitem>
240
295
</varlistentry>
296
297
<varlistentry>
298
<term><option>--no-restore</option></term>
299
<listitem>
300
<xi:include href="mandos-options.xml" xpointer="restore"/>
301
<para>
302
See also <xref linkend="persistent_state"/>.
303
</para>
304
</listitem>
305
</varlistentry>
306
307
<varlistentry>
308
<term><option>--statedir
309
<replaceable>DIRECTORY</replaceable></option></term>
310
<listitem>
311
<xi:include href="mandos-options.xml" xpointer="statedir"/>
312
</listitem>
313
</varlistentry>
314
315
<varlistentry>
316
<term><option>--socket
317
<replaceable>FD</replaceable></option></term>
318
<listitem>
319
<xi:include href="mandos-options.xml" xpointer="socket"/>
320
</listitem>
321
</varlistentry>
322
323
<varlistentry>
324
<term><option>--foreground</option></term>
325
<listitem>
326
<xi:include href="mandos-options.xml"
327
xpointer="foreground"/>
328
</listitem>
329
</varlistentry>
330
331
<varlistentry>
332
<term><option>--no-zeroconf</option></term>
333
<listitem>
334
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
335
</listitem>
336
</varlistentry>
337
241
338
</variablelist>
242
339
</refsect1>
243
340
317
414
for some time, the client is assumed to be compromised and is no
318
415
longer eligible to receive the encrypted password. (Manual
319
416
intervention is required to re-enable a client.) The timeout,
320
checker program, and interval between checks can be configured
321
both globally and per client; see <citerefentry>
417
extended timeout, checker program, and interval between checks
418
can be configured both globally and per client; see
419
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
420
<manvolnum>5</manvolnum></citerefentry>.
421
</para>
422
</refsect1>
423
424
<refsect1 id="approval">
425
<title>APPROVAL</title>
426
<para>
427
The server can be configured to require manual approval for a
428
client before it is sent its secret. The delay to wait for such
429
approval and the default action (approve or deny) can be
430
configured both globally and per client; see <citerefentry>
322
431
<refentrytitle>mandos-clients.conf</refentrytitle>
323
<manvolnum>5</manvolnum></citerefentry>. A client successfully
324
receiving its password will also be treated as a successful
325
checker run.
326
</para>
432
<manvolnum>5</manvolnum></citerefentry>. By default all clients
433
will be approved immediately without delay.
434
</para>
435
<para>
436
This can be used to deny a client its secret if not manually
437
approved within a specified time. It can also be used to make
438
the server delay before giving a client its secret, allowing
439
optional manual denying of this specific client.
440
</para>
441
327
442
</refsect1>
328
443
329
444
<refsect1 id="logging">
330
445
<title>LOGGING</title>
331
446
<para>
332
447
The server will send log message with various severity levels to
333
<filename>/dev/log</filename>. With the
448
<filename class="devicefile">/dev/log</filename>. With the
334
449
<option>--debug</option> option, it will log even more messages,
335
450
and also show them on the console.
336
451
</para>
337
452
</refsect1>
338
453
454
<refsect1 id="persistent_state">
455
<title>PERSISTENT STATE</title>
456
<para>
457
Client settings, initially read from
458
<filename>clients.conf</filename>, are persistent across
459
restarts, and run-time changes will override settings in
460
<filename>clients.conf</filename>. However, if a setting is
461
<emphasis>changed</emphasis> (or a client added, or removed) in
462
<filename>clients.conf</filename>, this will take precedence.
463
</para>
464
</refsect1>
465
466
<refsect1 id="dbus_interface">
467
<title>D-BUS INTERFACE</title>
468
<para>
469
The server will by default provide a D-Bus system bus interface.
470
This interface will only be accessible by the root user or a
471
Mandos-specific user, if such a user exists. For documentation
472
of the D-Bus API, see the file <filename>DBUS-API</filename>.
473
</para>
474
</refsect1>
475
339
476
<refsect1 id="exit_status">
340
477
<title>EXIT STATUS</title>
341
478
<para>
393
530
</listitem>
394
531
</varlistentry>
395
532
<varlistentry>
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>.
401
</para>
402
</listitem>
403
</varlistentry>
404
<varlistentry>
405
<term><filename>/dev/log</filename></term>
533
<term><filename>/run/mandos.pid</filename></term>
534
<listitem>
535
<para>
536
The file containing the process id of the
537
<command>&COMMANDNAME;</command> process started last.
538
<emphasis >Note:</emphasis> If the <filename
539
class="directory">/run</filename> directory does not
540
exist, <filename>/var/run/mandos.pid</filename> will be
541
used instead.
542
</para>
543
</listitem>
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.
553
</para>
554
</listitem>
555
</varlistentry>
556
<varlistentry>
557
<term><filename class="devicefile">/dev/log</filename></term>
406
558
<listitem>
407
559
<para>
408
560
The Unix domain socket to where local syslog messages are
431
583
backtrace. This could be considered a feature.
432
584
</para>
433
585
<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>
445
586
There is no fine-grained control over logging and debug output.
446
587
</para>
447
588
<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>
454
589
This server does not check the expire time of clients’ OpenPGP
455
590
keys.
456
591
</para>
592
<xi:include href="bugs.xml"/>
457
593
</refsect1>
458
594
459
595
<refsect1 id="example">
469
605
<informalexample>
470
606
<para>
471
607
Run the server in debug mode, read configuration files from
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:
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:
475
611
</para>
476
612
<para>
477
613
526
662
compromised if they are gone for too long.
527
663
</para>
528
664
<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>
545
665
For more details on client-side security, see
546
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
547
667
<manvolnum>8mandos</manvolnum></citerefentry>.
552
672
<refsect1 id="see_also">
553
673
<title>SEE ALSO</title>
554
674
<para>
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
<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>
564
685
</para>
565
686
<variablelist>
566
687
<varlistentry>
587
708
</varlistentry>
588
709
<varlistentry>
589
710
<term>
590
<ulink url="http://www.gnu.org/software/gnutls/"
591
>GnuTLS</ulink>
711
<ulink url="https://gnutls.org/">GnuTLS</ulink>
592
712
</term>
593
713
<listitem>
594
714
<para>
632
752
</varlistentry>
633
753
<varlistentry>
634
754
<term>
635
RFC 4346: <citetitle>The Transport Layer Security (TLS)
636
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
637
757
</term>
638
758
<listitem>
639
759
<para>
640
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
641
761
</para>
642
762
</listitem>
643
763
</varlistentry>
653
773
</varlistentry>
654
774
<varlistentry>
655
775
<term>
656
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
657
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
658
778
</term>
659
779
<listitem>
660
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0