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 364
- compare with another revision
- download diff
- download tarball
- view history from revision 364
- Committer: Teddy Hogeborn
- Date: 2018-02-12 14:57:14 UTC
- mfrom: (237.7.480 trunk)
- Revision ID: teddy@recompile.se-20180212145714-esg3hktbm7ma14sw
Merge from trunk
- files added:
- bugs.xml
- 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 "2010-09-11">
5
<!ENTITY TIMESTAMP "2018-02-08">
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>
44
<year>2018</year>
36
45
<holder>Teddy Hogeborn</holder>
37
46
<holder>Björn Påhlsson</holder>
38
47
</copyright>
86
95
<sbr/>
87
96
<arg><option>--debug</option></arg>
88
97
<sbr/>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
100
<sbr/>
89
101
<arg><option>--no-dbus</option></arg>
90
102
<sbr/>
91
103
<arg><option>--no-ipv6</option></arg>
104
<sbr/>
105
<arg><option>--no-restore</option></arg>
106
<sbr/>
107
<arg><option>--statedir
108
<replaceable>DIRECTORY</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--socket
111
<replaceable>FD</replaceable></option></arg>
112
<sbr/>
113
<arg><option>--foreground</option></arg>
114
<sbr/>
115
<arg><option>--no-zeroconf</option></arg>
92
116
</cmdsynopsis>
93
117
<cmdsynopsis>
94
118
<command>&COMMANDNAME;</command>
112
136
<para>
113
137
<command>&COMMANDNAME;</command> is a server daemon which
114
138
handles incoming request for passwords for a pre-defined list of
115
client host computers. The Mandos server uses Zeroconf to
116
announce itself on the local network, and uses TLS to
117
communicate securely with and to authenticate the clients. The
118
Mandos server uses IPv6 to allow Mandos clients to use IPv6
119
link-local addresses, since the clients will probably not have
120
any other addresses configured (see <xref linkend="overview"/>).
121
Any authenticated client is then given the stored pre-encrypted
122
password for that specific client.
139
client host computers. For an introduction, see
140
<citerefentry><refentrytitle>intro</refentrytitle>
141
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
uses Zeroconf to announce itself on the local network, and uses
143
TLS to communicate securely with and to authenticate the
144
clients. The Mandos server uses IPv6 to allow Mandos clients to
145
use IPv6 link-local addresses, since the clients will probably
146
not have any other addresses configured (see <xref
147
linkend="overview"/>). Any authenticated client is then given
148
the stored pre-encrypted password for that specific client.
123
149
</para>
124
150
</refsect1>
125
151
194
220
</varlistentry>
195
221
196
222
<varlistentry>
223
<term><option>--debuglevel
224
<replaceable>LEVEL</replaceable></option></term>
225
<listitem>
226
<para>
227
Set the debugging log level.
228
<replaceable>LEVEL</replaceable> is a string, one of
229
<quote><literal>CRITICAL</literal></quote>,
230
<quote><literal>ERROR</literal></quote>,
231
<quote><literal>WARNING</literal></quote>,
232
<quote><literal>INFO</literal></quote>, or
233
<quote><literal>DEBUG</literal></quote>, in order of
234
increasing verbosity. The default level is
235
<quote><literal>WARNING</literal></quote>.
236
</para>
237
</listitem>
238
</varlistentry>
239
240
<varlistentry>
197
241
<term><option>--priority <replaceable>
198
242
PRIORITY</replaceable></option></term>
199
243
<listitem>
250
294
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
295
</listitem>
252
296
</varlistentry>
297
298
<varlistentry>
299
<term><option>--no-restore</option></term>
300
<listitem>
301
<xi:include href="mandos-options.xml" xpointer="restore"/>
302
<para>
303
See also <xref linkend="persistent_state"/>.
304
</para>
305
</listitem>
306
</varlistentry>
307
308
<varlistentry>
309
<term><option>--statedir
310
<replaceable>DIRECTORY</replaceable></option></term>
311
<listitem>
312
<xi:include href="mandos-options.xml" xpointer="statedir"/>
313
</listitem>
314
</varlistentry>
315
316
<varlistentry>
317
<term><option>--socket
318
<replaceable>FD</replaceable></option></term>
319
<listitem>
320
<xi:include href="mandos-options.xml" xpointer="socket"/>
321
</listitem>
322
</varlistentry>
323
324
<varlistentry>
325
<term><option>--foreground</option></term>
326
<listitem>
327
<xi:include href="mandos-options.xml"
328
xpointer="foreground"/>
329
</listitem>
330
</varlistentry>
331
332
<varlistentry>
333
<term><option>--no-zeroconf</option></term>
334
<listitem>
335
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
</listitem>
337
</varlistentry>
338
253
339
</variablelist>
254
340
</refsect1>
255
341
329
415
for some time, the client is assumed to be compromised and is no
330
416
longer eligible to receive the encrypted password. (Manual
331
417
intervention is required to re-enable a client.) The timeout,
332
checker program, and interval between checks can be configured
333
both globally and per client; see <citerefentry>
418
extended timeout, checker program, and interval between checks
419
can be configured both globally and per client; see
420
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
<manvolnum>5</manvolnum></citerefentry>.
422
</para>
423
</refsect1>
424
425
<refsect1 id="approval">
426
<title>APPROVAL</title>
427
<para>
428
The server can be configured to require manual approval for a
429
client before it is sent its secret. The delay to wait for such
430
approval and the default action (approve or deny) can be
431
configured both globally and per client; see <citerefentry>
334
432
<refentrytitle>mandos-clients.conf</refentrytitle>
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
checker run.
338
</para>
433
<manvolnum>5</manvolnum></citerefentry>. By default all clients
434
will be approved immediately without delay.
435
</para>
436
<para>
437
This can be used to deny a client its secret if not manually
438
approved within a specified time. It can also be used to make
439
the server delay before giving a client its secret, allowing
440
optional manual denying of this specific client.
441
</para>
442
339
443
</refsect1>
340
444
341
445
<refsect1 id="logging">
342
446
<title>LOGGING</title>
343
447
<para>
344
448
The server will send log message with various severity levels to
345
<filename>/dev/log</filename>. With the
449
<filename class="devicefile">/dev/log</filename>. With the
346
450
<option>--debug</option> option, it will log even more messages,
347
451
and also show them on the console.
348
452
</para>
349
453
</refsect1>
350
454
455
<refsect1 id="persistent_state">
456
<title>PERSISTENT STATE</title>
457
<para>
458
Client settings, initially read from
459
<filename>clients.conf</filename>, are persistent across
460
restarts, and run-time changes will override settings in
461
<filename>clients.conf</filename>. However, if a setting is
462
<emphasis>changed</emphasis> (or a client added, or removed) in
463
<filename>clients.conf</filename>, this will take precedence.
464
</para>
465
</refsect1>
466
351
467
<refsect1 id="dbus_interface">
352
468
<title>D-BUS INTERFACE</title>
353
469
<para>
415
531
</listitem>
416
532
</varlistentry>
417
533
<varlistentry>
418
<term><filename>/var/run/mandos.pid</filename></term>
419
<listitem>
420
<para>
421
The file containing the process id of
422
<command>&COMMANDNAME;</command>.
423
</para>
424
</listitem>
425
</varlistentry>
426
<varlistentry>
427
<term><filename>/dev/log</filename></term>
534
<term><filename>/run/mandos.pid</filename></term>
535
<listitem>
536
<para>
537
The file containing the process id of the
538
<command>&COMMANDNAME;</command> process started last.
539
<emphasis >Note:</emphasis> If the <filename
540
class="directory">/run</filename> directory does not
541
exist, <filename>/var/run/mandos.pid</filename> will be
542
used instead.
543
</para>
544
</listitem>
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.
554
</para>
555
</listitem>
556
</varlistentry>
557
<varlistentry>
558
<term><filename class="devicefile">/dev/log</filename></term>
428
559
<listitem>
429
560
<para>
430
561
The Unix domain socket to where local syslog messages are
453
584
backtrace. This could be considered a feature.
454
585
</para>
455
586
<para>
456
Currently, if a client is disabled due to having timed out, the
457
server does not record this fact onto permanent storage. This
458
has some security implications, see <xref linkend="clients"/>.
459
</para>
460
<para>
461
587
There is no fine-grained control over logging and debug output.
462
588
</para>
463
589
<para>
464
Debug mode is conflated with running in the foreground.
465
</para>
466
<para>
467
The console log messages do not show a time stamp.
468
</para>
469
<para>
470
590
This server does not check the expire time of clients’ OpenPGP
471
591
keys.
472
592
</para>
593
<xi:include href="bugs.xml"/>
473
594
</refsect1>
474
595
475
596
<refsect1 id="example">
485
606
<informalexample>
486
607
<para>
487
608
Run the server in debug mode, read configuration files from
488
the <filename>~/mandos</filename> directory, and use the
489
Zeroconf service name <quote>Test</quote> to not collide with
490
any other official Mandos server on this host:
609
the <filename class="directory">~/mandos</filename> directory,
610
and use the Zeroconf service name <quote>Test</quote> to not
611
collide with any other official Mandos server on this host:
491
612
</para>
492
613
<para>
493
614
542
663
compromised if they are gone for too long.
543
664
</para>
544
665
<para>
545
If a client is compromised, its downtime should be duly noted
546
by the server which would therefore disable the client. But
547
if the server was ever restarted, it would re-read its client
548
list from its configuration file and again regard all clients
549
therein as enabled, and hence eligible to receive their
550
passwords. Therefore, be careful when restarting servers if
551
it is suspected that a client has, in fact, been compromised
552
by parties who may now be running a fake Mandos client with
553
the keys from the non-encrypted initial <acronym>RAM</acronym>
554
image of the client host. What should be done in that case
555
(if restarting the server program really is necessary) is to
556
stop the server program, edit the configuration file to omit
557
any suspect clients, and restart the server program.
558
</para>
559
<para>
560
666
For more details on client-side security, see
561
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
562
668
<manvolnum>8mandos</manvolnum></citerefentry>.
567
673
<refsect1 id="see_also">
568
674
<title>SEE ALSO</title>
569
675
<para>
570
<citerefentry>
571
<refentrytitle>mandos-clients.conf</refentrytitle>
572
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
573
<refentrytitle>mandos.conf</refentrytitle>
574
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
575
<refentrytitle>mandos-client</refentrytitle>
576
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
577
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
578
</citerefentry>
676
<citerefentry><refentrytitle>intro</refentrytitle>
677
<manvolnum>8mandos</manvolnum></citerefentry>,
678
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
<manvolnum>5</manvolnum></citerefentry>,
680
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
<manvolnum>5</manvolnum></citerefentry>,
682
<citerefentry><refentrytitle>mandos-client</refentrytitle>
683
<manvolnum>8mandos</manvolnum></citerefentry>,
684
<citerefentry><refentrytitle>sh</refentrytitle>
685
<manvolnum>1</manvolnum></citerefentry>
579
686
</para>
580
687
<variablelist>
581
688
<varlistentry>
602
709
</varlistentry>
603
710
<varlistentry>
604
711
<term>
605
<ulink url="http://www.gnu.org/software/gnutls/"
606
>GnuTLS</ulink>
712
<ulink url="https://gnutls.org/">GnuTLS</ulink>
607
713
</term>
608
714
<listitem>
609
715
<para>
647
753
</varlistentry>
648
754
<varlistentry>
649
755
<term>
650
RFC 4346: <citetitle>The Transport Layer Security (TLS)
651
Protocol Version 1.1</citetitle>
756
RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
Protocol Version 1.2</citetitle>
652
758
</term>
653
759
<listitem>
654
760
<para>
655
TLS 1.1 is the protocol implemented by GnuTLS.
761
TLS 1.2 is the protocol implemented by GnuTLS.
656
762
</para>
657
763
</listitem>
658
764
</varlistentry>
668
774
</varlistentry>
669
775
<varlistentry>
670
776
<term>
671
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
672
Security</citetitle>
777
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
Security (TLS) Authentication</citetitle>
673
779
</term>
674
780
<listitem>
675
781
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0