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 932
- compare with another revision
- download diff
- download tarball
- view history from revision 932
- Committer: Teddy Hogeborn
- Date: 2018-02-12 14:54:58 UTC
- Revision ID: teddy@recompile.se-20180212145458-mkcjkw4cd9s18izm
Client bug fix: Revert change to plugin-runner
* plugin-runner.c (free_plugin): Bug fix: Don't free() plugin name.
* plugin-runner.c (free_plugin): Bug fix: Don't free() plugin name.
- files added:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- debian/mandos-client.config
- 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 "2008-09-30">
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
<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>
35
45
<holder>Teddy Hogeborn</holder>
36
46
<holder>Björn Påhlsson</holder>
37
47
</copyright>
84
94
<replaceable>DIRECTORY</replaceable></option></arg>
85
95
<sbr/>
86
96
<arg><option>--debug</option></arg>
97
<sbr/>
98
<arg><option>--debuglevel
99
<replaceable>LEVEL</replaceable></option></arg>
100
<sbr/>
101
<arg><option>--no-dbus</option></arg>
102
<sbr/>
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>
87
116
</cmdsynopsis>
88
117
<cmdsynopsis>
89
118
<command>&COMMANDNAME;</command>
107
136
<para>
108
137
<command>&COMMANDNAME;</command> is a server daemon which
109
138
handles incoming request for passwords for a pre-defined list of
110
client host computers. The Mandos server uses Zeroconf to
111
announce itself on the local network, and uses TLS to
112
communicate securely with and to authenticate the clients. The
113
Mandos server uses IPv6 to allow Mandos clients to use IPv6
114
link-local addresses, since the clients will probably not have
115
any other addresses configured (see <xref linkend="overview"/>).
116
Any authenticated client is then given the stored pre-encrypted
117
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.
118
149
</para>
119
150
</refsect1>
120
151
189
220
</varlistentry>
190
221
191
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>
192
241
<term><option>--priority <replaceable>
193
242
PRIORITY</replaceable></option></term>
194
243
<listitem>
228
277
</para>
229
278
</listitem>
230
279
</varlistentry>
280
281
<varlistentry>
282
<term><option>--no-dbus</option></term>
283
<listitem>
284
<xi:include href="mandos-options.xml" xpointer="dbus"/>
285
<para>
286
See also <xref linkend="dbus_interface"/>.
287
</para>
288
</listitem>
289
</varlistentry>
290
291
<varlistentry>
292
<term><option>--no-ipv6</option></term>
293
<listitem>
294
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
</listitem>
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
231
339
</variablelist>
232
340
</refsect1>
233
341
305
413
The server will, by default, continually check that the clients
306
414
are still up. If a client has not been confirmed as being up
307
415
for some time, the client is assumed to be compromised and is no
308
longer eligible to receive the encrypted password. The timeout,
309
checker program, and interval between checks can be configured
310
both globally and per client; see <citerefentry>
416
longer eligible to receive the encrypted password. (Manual
417
intervention is required to re-enable a client.) The timeout,
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>
311
432
<refentrytitle>mandos-clients.conf</refentrytitle>
312
<manvolnum>5</manvolnum></citerefentry>.
313
</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
314
443
</refsect1>
315
444
316
445
<refsect1 id="logging">
317
446
<title>LOGGING</title>
318
447
<para>
319
448
The server will send log message with various severity levels to
320
<filename>/dev/log</filename>. With the
449
<filename class="devicefile">/dev/log</filename>. With the
321
450
<option>--debug</option> option, it will log even more messages,
322
451
and also show them on the console.
323
452
</para>
324
453
</refsect1>
325
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
467
<refsect1 id="dbus_interface">
468
<title>D-BUS INTERFACE</title>
469
<para>
470
The server will by default provide a D-Bus system bus interface.
471
This interface will only be accessible by the root user or a
472
Mandos-specific user, if such a user exists. For documentation
473
of the D-Bus API, see the file <filename>DBUS-API</filename>.
474
</para>
475
</refsect1>
476
326
477
<refsect1 id="exit_status">
327
478
<title>EXIT STATUS</title>
328
479
<para>
351
502
</variablelist>
352
503
</refsect1>
353
504
354
<refsect1 id="file">
505
<refsect1 id="files">
355
506
<title>FILES</title>
356
507
<para>
357
508
Use the <option>--configdir</option> option to change where
380
531
</listitem>
381
532
</varlistentry>
382
533
<varlistentry>
383
<term><filename>/var/run/mandos.pid</filename></term>
384
<listitem>
385
<para>
386
The file containing the process id of
387
<command>&COMMANDNAME;</command>.
388
</para>
389
</listitem>
390
</varlistentry>
391
<varlistentry>
392
<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>
393
559
<listitem>
394
560
<para>
395
561
The Unix domain socket to where local syslog messages are
418
584
backtrace. This could be considered a feature.
419
585
</para>
420
586
<para>
421
Currently, if a client is declared <quote>invalid</quote> due to
422
having timed out, the server does not record this fact onto
423
permanent storage. This has some security implications, see
424
<xref linkend="CLIENTS"/>.
425
</para>
426
<para>
427
There is currently no way of querying the server of the current
428
status of clients, other than analyzing its <systemitem
429
class="service">syslog</systemitem> output.
430
</para>
431
<para>
432
587
There is no fine-grained control over logging and debug output.
433
588
</para>
434
589
<para>
435
Debug mode is conflated with running in the foreground.
436
</para>
437
<para>
438
The console log messages does not show a time stamp.
439
</para>
440
<para>
441
590
This server does not check the expire time of clients’ OpenPGP
442
591
keys.
443
592
</para>
593
<xi:include href="bugs.xml"/>
444
594
</refsect1>
445
595
446
596
<refsect1 id="example">
456
606
<informalexample>
457
607
<para>
458
608
Run the server in debug mode, read configuration files from
459
the <filename>~/mandos</filename> directory, and use the
460
Zeroconf service name <quote>Test</quote> to not collide with
461
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:
462
612
</para>
463
613
<para>
464
614
483
633
484
634
<refsect1 id="security">
485
635
<title>SECURITY</title>
486
<refsect2 id="SERVER">
636
<refsect2 id="server">
487
637
<title>SERVER</title>
488
638
<para>
489
639
Running this <command>&COMMANDNAME;</command> server program
492
642
soon after startup.
493
643
</para>
494
644
</refsect2>
495
<refsect2 id="CLIENTS">
645
<refsect2 id="clients">
496
646
<title>CLIENTS</title>
497
647
<para>
498
648
The server only gives out its stored data to clients which
513
663
compromised if they are gone for too long.
514
664
</para>
515
665
<para>
516
If a client is compromised, its downtime should be duly noted
517
by the server which would therefore declare the client
518
invalid. But if the server was ever restarted, it would
519
re-read its client list from its configuration file and again
520
regard all clients therein as valid, and hence eligible to
521
receive their passwords. Therefore, be careful when
522
restarting servers if it is suspected that a client has, in
523
fact, been compromised by parties who may now be running a
524
fake Mandos client with the keys from the non-encrypted
525
initial <acronym>RAM</acronym> image of the client host. What
526
should be done in that case (if restarting the server program
527
really is necessary) is to stop the server program, edit the
528
configuration file to omit any suspect clients, and restart
529
the server program.
530
</para>
531
<para>
532
666
For more details on client-side security, see
533
667
<citerefentry><refentrytitle>mandos-client</refentrytitle>
534
668
<manvolnum>8mandos</manvolnum></citerefentry>.
539
673
<refsect1 id="see_also">
540
674
<title>SEE ALSO</title>
541
675
<para>
542
<citerefentry>
543
<refentrytitle>mandos-clients.conf</refentrytitle>
544
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
<refentrytitle>mandos.conf</refentrytitle>
546
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
<refentrytitle>mandos-client</refentrytitle>
548
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
</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>
551
686
</para>
552
687
<variablelist>
553
688
<varlistentry>
574
709
</varlistentry>
575
710
<varlistentry>
576
711
<term>
577
<ulink url="http://www.gnu.org/software/gnutls/"
578
>GnuTLS</ulink>
712
<ulink url="https://gnutls.org/">GnuTLS</ulink>
579
713
</term>
580
714
<listitem>
581
715
<para>
619
753
</varlistentry>
620
754
<varlistentry>
621
755
<term>
622
RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
Protocol Version 1.1</citetitle>
756
RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
Protocol Version 1.2</citetitle>
624
758
</term>
625
759
<listitem>
626
760
<para>
627
TLS 1.1 is the protocol implemented by GnuTLS.
761
TLS 1.2 is the protocol implemented by GnuTLS.
628
762
</para>
629
763
</listitem>
630
764
</varlistentry>
640
774
</varlistentry>
641
775
<varlistentry>
642
776
<term>
643
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
Security</citetitle>
777
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
Security (TLS) Authentication</citetitle>
645
779
</term>
646
780
<listitem>
647
781
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0