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 359
- compare with another revision
- download diff
- download tarball
- view history from revision 359
- Committer: Teddy Hogeborn
- Date: 2017-02-23 20:35:20 UTC
- Revision ID: teddy@recompile.se-20170223203520-7ti8vo1m86ib192m
Tags: version-1.7.15-1
* Makefile (version): Change to 1.7.15.
* NEWS (Version 1.7.15): Add new entry.
* debian/changelog (1.7.15-1): - '' -
* NEWS (Version 1.7.15): Add new entry.
* debian/changelog (1.7.15-1): - '' -
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- etc-plugins.d-README
- files modified:
- .bzrignore
added
removed
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
<!ENTITY TIMESTAMP "2008-09-06">
5
<!ENTITY TIMESTAMP "2017-02-23">
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
7
8
]>
8
9
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
<refentryinfo>
11
<refentryinfo>
11
12
<title>Mandos Manual</title>
12
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
<productname>Mandos</productname>
14
<productnumber>&VERSION;</productnumber>
15
<productnumber>&version;</productnumber>
15
16
<date>&TIMESTAMP;</date>
16
17
<authorgroup>
17
18
<author>
18
19
<firstname>Björn</firstname>
19
20
<surname>Påhlsson</surname>
20
21
<address>
21
<email>belorn@fukt.bsnet.se</email>
22
<email>belorn@recompile.se</email>
22
23
</address>
23
24
</author>
24
25
<author>
25
26
<firstname>Teddy</firstname>
26
27
<surname>Hogeborn</surname>
27
28
<address>
28
<email>teddy@fukt.bsnet.se</email>
29
<email>teddy@recompile.se</email>
29
30
</address>
30
31
</author>
31
32
</authorgroup>
32
33
<copyright>
33
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>
34
44
<holder>Teddy Hogeborn</holder>
35
45
<holder>Björn Påhlsson</holder>
36
46
</copyright>
37
47
<xi:include href="legalnotice.xml"/>
38
48
</refentryinfo>
39
49
40
50
<refmeta>
41
51
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
52
<manvolnum>8</manvolnum>
48
58
Gives encrypted passwords to authenticated Mandos clients
49
59
</refpurpose>
50
60
</refnamediv>
51
61
52
62
<refsynopsisdiv>
53
63
<cmdsynopsis>
54
64
<command>&COMMANDNAME;</command>
83
93
<replaceable>DIRECTORY</replaceable></option></arg>
84
94
<sbr/>
85
95
<arg><option>--debug</option></arg>
96
<sbr/>
97
<arg><option>--debuglevel
98
<replaceable>LEVEL</replaceable></option></arg>
99
<sbr/>
100
<arg><option>--no-dbus</option></arg>
101
<sbr/>
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>
86
115
</cmdsynopsis>
87
116
<cmdsynopsis>
88
117
<command>&COMMANDNAME;</command>
100
129
<arg choice="plain"><option>--check</option></arg>
101
130
</cmdsynopsis>
102
131
</refsynopsisdiv>
103
132
104
133
<refsect1 id="description">
105
134
<title>DESCRIPTION</title>
106
135
<para>
107
136
<command>&COMMANDNAME;</command> is a server daemon which
108
137
handles incoming request for passwords for a pre-defined list of
109
client host computers. The Mandos server uses Zeroconf to
110
announce itself on the local network, and uses TLS to
111
communicate securely with and to authenticate the clients. The
112
Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
link-local addresses, since the clients will probably not have
114
any other addresses configured (see <xref linkend="overview"/>).
115
Any authenticated client is then given the stored pre-encrypted
116
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.
117
148
</para>
118
149
</refsect1>
119
150
186
217
<xi:include href="mandos-options.xml" xpointer="debug"/>
187
218
</listitem>
188
219
</varlistentry>
189
220
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
190
239
<varlistentry>
191
240
<term><option>--priority <replaceable>
192
241
PRIORITY</replaceable></option></term>
194
243
<xi:include href="mandos-options.xml" xpointer="priority"/>
195
244
</listitem>
196
245
</varlistentry>
197
246
198
247
<varlistentry>
199
248
<term><option>--servicename
200
249
<replaceable>NAME</replaceable></option></term>
203
252
xpointer="servicename"/>
204
253
</listitem>
205
254
</varlistentry>
206
255
207
256
<varlistentry>
208
257
<term><option>--configdir
209
258
<replaceable>DIRECTORY</replaceable></option></term>
218
267
</para>
219
268
</listitem>
220
269
</varlistentry>
221
270
222
271
<varlistentry>
223
272
<term><option>--version</option></term>
224
273
<listitem>
227
276
</para>
228
277
</listitem>
229
278
</varlistentry>
279
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>
291
<term><option>--no-ipv6</option></term>
292
<listitem>
293
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
294
</listitem>
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
230
338
</variablelist>
231
339
</refsect1>
232
340
233
341
<refsect1 id="overview">
234
342
<title>OVERVIEW</title>
235
343
<xi:include href="overview.xml"/>
239
347
<acronym>RAM</acronym> disk environment.
240
348
</para>
241
349
</refsect1>
242
350
243
351
<refsect1 id="protocol">
244
352
<title>NETWORK PROTOCOL</title>
245
353
<para>
297
405
</row>
298
406
</tbody></tgroup></table>
299
407
</refsect1>
300
408
301
409
<refsect1 id="checking">
302
410
<title>CHECKING</title>
303
411
<para>
304
412
The server will, by default, continually check that the clients
305
413
are still up. If a client has not been confirmed as being up
306
414
for some time, the client is assumed to be compromised and is no
307
longer eligible to receive the encrypted password. The timeout,
308
checker program, and interval between checks can be configured
309
both globally and per client; see <citerefentry>
415
longer eligible to receive the encrypted password. (Manual
416
intervention is required to re-enable a client.) The timeout,
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>
310
431
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</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
313
442
</refsect1>
314
443
315
444
<refsect1 id="logging">
316
445
<title>LOGGING</title>
317
446
<para>
318
447
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
448
<filename class="devicefile">/dev/log</filename>. With the
320
449
<option>--debug</option> option, it will log even more messages,
321
450
and also show them on the console.
322
451
</para>
323
452
</refsect1>
324
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
325
476
<refsect1 id="exit_status">
326
477
<title>EXIT STATUS</title>
327
478
<para>
329
480
critical error is encountered.
330
481
</para>
331
482
</refsect1>
332
483
333
484
<refsect1 id="environment">
334
485
<title>ENVIRONMENT</title>
335
486
<variablelist>
349
500
</varlistentry>
350
501
</variablelist>
351
502
</refsect1>
352
353
<refsect1 id="file">
503
504
<refsect1 id="files">
354
505
<title>FILES</title>
355
506
<para>
356
507
Use the <option>--configdir</option> option to change where
379
530
</listitem>
380
531
</varlistentry>
381
532
<varlistentry>
382
<term><filename>/var/run/mandos.pid</filename></term>
383
<listitem>
384
<para>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
387
</para>
388
</listitem>
389
</varlistentry>
390
<varlistentry>
391
<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>
392
558
<listitem>
393
559
<para>
394
560
The Unix domain socket to where local syslog messages are
417
583
backtrace. This could be considered a feature.
418
584
</para>
419
585
<para>
420
Currently, if a client is declared <quote>invalid</quote> due to
421
having timed out, the server does not record this fact onto
422
permanent storage. This has some security implications, see
423
<xref linkend="CLIENTS"/>.
424
</para>
425
<para>
426
There is currently no way of querying the server of the current
427
status of clients, other than analyzing its <systemitem
428
class="service">syslog</systemitem> output.
429
</para>
430
<para>
431
586
There is no fine-grained control over logging and debug output.
432
587
</para>
433
588
<para>
434
Debug mode is conflated with running in the foreground.
435
</para>
436
<para>
437
The console log messages does not show a time stamp.
438
</para>
439
<para>
440
589
This server does not check the expire time of clients’ OpenPGP
441
590
keys.
442
591
</para>
592
<xi:include href="bugs.xml"/>
443
593
</refsect1>
444
594
445
595
<refsect1 id="example">
455
605
<informalexample>
456
606
<para>
457
607
Run the server in debug mode, read configuration files from
458
the <filename>~/mandos</filename> directory, and use the
459
Zeroconf service name <quote>Test</quote> to not collide with
460
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:
461
611
</para>
462
612
<para>
463
613
479
629
</para>
480
630
</informalexample>
481
631
</refsect1>
482
632
483
633
<refsect1 id="security">
484
634
<title>SECURITY</title>
485
<refsect2 id="SERVER">
635
<refsect2 id="server">
486
636
<title>SERVER</title>
487
637
<para>
488
638
Running this <command>&COMMANDNAME;</command> server program
491
641
soon after startup.
492
642
</para>
493
643
</refsect2>
494
<refsect2 id="CLIENTS">
644
<refsect2 id="clients">
495
645
<title>CLIENTS</title>
496
646
<para>
497
647
The server only gives out its stored data to clients which
504
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
655
<manvolnum>5</manvolnum></citerefentry>)
506
656
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
657
except the user starting the server (usually root).
508
658
</para>
509
659
<para>
510
660
As detailed in <xref linkend="checking"/>, the status of all
512
662
compromised if they are gone for too long.
513
663
</para>
514
664
<para>
515
If a client is compromised, its downtime should be duly noted
516
by the server which would therefore declare the client
517
invalid. But if the server was ever restarted, it would
518
re-read its client list from its configuration file and again
519
regard all clients therein as valid, and hence eligible to
520
receive their passwords. Therefore, be careful when
521
restarting servers if it is suspected that a client has, in
522
fact, been compromised by parties who may now be running a
523
fake Mandos client with the keys from the non-encrypted
524
initial <acronym>RAM</acronym> image of the client host. What
525
should be done in that case (if restarting the server program
526
really is necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
528
the server program.
529
</para>
530
<para>
531
665
For more details on client-side security, see
532
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
667
<manvolnum>8mandos</manvolnum></citerefentry>.
534
668
</para>
535
669
</refsect2>
536
670
</refsect1>
537
671
538
672
<refsect1 id="see_also">
539
673
<title>SEE ALSO</title>
540
674
<para>
541
<citerefentry>
542
<refentrytitle>mandos-clients.conf</refentrytitle>
543
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>mandos.conf</refentrytitle>
545
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>mandos-client</refentrytitle>
547
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
</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>
550
685
</para>
551
686
<variablelist>
552
687
<varlistentry>
573
708
</varlistentry>
574
709
<varlistentry>
575
710
<term>
576
<ulink url="http://www.gnu.org/software/gnutls/"
577
>GnuTLS</ulink>
711
<ulink url="https://gnutls.org/">GnuTLS</ulink>
578
712
</term>
579
713
<listitem>
580
714
<para>
618
752
</varlistentry>
619
753
<varlistentry>
620
754
<term>
621
RFC 4346: <citetitle>The Transport Layer Security (TLS)
622
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
623
757
</term>
624
758
<listitem>
625
759
<para>
626
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
627
761
</para>
628
762
</listitem>
629
763
</varlistentry>
639
773
</varlistentry>
640
774
<varlistentry>
641
775
<term>
642
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
643
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
644
778
</term>
645
779
<listitem>
646
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0