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 237.7.337
- compare with another revision
- download diff
- download tarball
- view history from revision 237.7.337
- Committer: Teddy Hogeborn
- Date: 2015-10-04 13:44:03 UTC
- mto: (237.7.594 trunk)
- mto: This revision was merged to the branch mainline in revision 327.
- Revision ID: teddy@recompile.se-20151004134403-jn72bwgbw3aocllk
* initramfs-tools-hook: Don't try to chmod symlinks.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- debian/upstream
- network-hooks.d
- plugin-helpers
- files removed:
- plugins.d/usplash
- files renamed:
- plugins.d/password-request.c => plugins.d/mandos-client.c
- plugins.d/password-request.xml => plugins.d/mandos-client.xml
- 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-02">
5
<!ENTITY TIMESTAMP "2015-07-20">
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>
34
42
<holder>Teddy Hogeborn</holder>
35
43
<holder>Björn Påhlsson</holder>
36
44
</copyright>
37
45
<xi:include href="legalnotice.xml"/>
38
46
</refentryinfo>
39
47
40
48
<refmeta>
41
49
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
50
<manvolnum>8</manvolnum>
48
56
Gives encrypted passwords to authenticated Mandos clients
49
57
</refpurpose>
50
58
</refnamediv>
51
59
52
60
<refsynopsisdiv>
53
61
<cmdsynopsis>
54
62
<command>&COMMANDNAME;</command>
83
91
<replaceable>DIRECTORY</replaceable></option></arg>
84
92
<sbr/>
85
93
<arg><option>--debug</option></arg>
94
<sbr/>
95
<arg><option>--debuglevel
96
<replaceable>LEVEL</replaceable></option></arg>
97
<sbr/>
98
<arg><option>--no-dbus</option></arg>
99
<sbr/>
100
<arg><option>--no-ipv6</option></arg>
101
<sbr/>
102
<arg><option>--no-restore</option></arg>
103
<sbr/>
104
<arg><option>--statedir
105
<replaceable>DIRECTORY</replaceable></option></arg>
106
<sbr/>
107
<arg><option>--socket
108
<replaceable>FD</replaceable></option></arg>
109
<sbr/>
110
<arg><option>--foreground</option></arg>
111
<sbr/>
112
<arg><option>--no-zeroconf</option></arg>
86
113
</cmdsynopsis>
87
114
<cmdsynopsis>
88
115
<command>&COMMANDNAME;</command>
100
127
<arg choice="plain"><option>--check</option></arg>
101
128
</cmdsynopsis>
102
129
</refsynopsisdiv>
103
130
104
131
<refsect1 id="description">
105
132
<title>DESCRIPTION</title>
106
133
<para>
107
134
<command>&COMMANDNAME;</command> is a server daemon which
108
135
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.
136
client host computers. For an introduction, see
137
<citerefentry><refentrytitle>intro</refentrytitle>
138
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
139
uses Zeroconf to announce itself on the local network, and uses
140
TLS to communicate securely with and to authenticate the
141
clients. The Mandos server uses IPv6 to allow Mandos clients to
142
use IPv6 link-local addresses, since the clients will probably
143
not have any other addresses configured (see <xref
144
linkend="overview"/>). Any authenticated client is then given
145
the stored pre-encrypted password for that specific client.
117
146
</para>
118
147
</refsect1>
119
148
186
215
<xi:include href="mandos-options.xml" xpointer="debug"/>
187
216
</listitem>
188
217
</varlistentry>
189
218
219
<varlistentry>
220
<term><option>--debuglevel
221
<replaceable>LEVEL</replaceable></option></term>
222
<listitem>
223
<para>
224
Set the debugging log level.
225
<replaceable>LEVEL</replaceable> is a string, one of
226
<quote><literal>CRITICAL</literal></quote>,
227
<quote><literal>ERROR</literal></quote>,
228
<quote><literal>WARNING</literal></quote>,
229
<quote><literal>INFO</literal></quote>, or
230
<quote><literal>DEBUG</literal></quote>, in order of
231
increasing verbosity. The default level is
232
<quote><literal>WARNING</literal></quote>.
233
</para>
234
</listitem>
235
</varlistentry>
236
190
237
<varlistentry>
191
238
<term><option>--priority <replaceable>
192
239
PRIORITY</replaceable></option></term>
194
241
<xi:include href="mandos-options.xml" xpointer="priority"/>
195
242
</listitem>
196
243
</varlistentry>
197
244
198
245
<varlistentry>
199
246
<term><option>--servicename
200
247
<replaceable>NAME</replaceable></option></term>
203
250
xpointer="servicename"/>
204
251
</listitem>
205
252
</varlistentry>
206
253
207
254
<varlistentry>
208
255
<term><option>--configdir
209
256
<replaceable>DIRECTORY</replaceable></option></term>
218
265
</para>
219
266
</listitem>
220
267
</varlistentry>
221
268
222
269
<varlistentry>
223
270
<term><option>--version</option></term>
224
271
<listitem>
227
274
</para>
228
275
</listitem>
229
276
</varlistentry>
277
278
<varlistentry>
279
<term><option>--no-dbus</option></term>
280
<listitem>
281
<xi:include href="mandos-options.xml" xpointer="dbus"/>
282
<para>
283
See also <xref linkend="dbus_interface"/>.
284
</para>
285
</listitem>
286
</varlistentry>
287
288
<varlistentry>
289
<term><option>--no-ipv6</option></term>
290
<listitem>
291
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
292
</listitem>
293
</varlistentry>
294
295
<varlistentry>
296
<term><option>--no-restore</option></term>
297
<listitem>
298
<xi:include href="mandos-options.xml" xpointer="restore"/>
299
<para>
300
See also <xref linkend="persistent_state"/>.
301
</para>
302
</listitem>
303
</varlistentry>
304
305
<varlistentry>
306
<term><option>--statedir
307
<replaceable>DIRECTORY</replaceable></option></term>
308
<listitem>
309
<xi:include href="mandos-options.xml" xpointer="statedir"/>
310
</listitem>
311
</varlistentry>
312
313
<varlistentry>
314
<term><option>--socket
315
<replaceable>FD</replaceable></option></term>
316
<listitem>
317
<xi:include href="mandos-options.xml" xpointer="socket"/>
318
</listitem>
319
</varlistentry>
320
321
<varlistentry>
322
<term><option>--foreground</option></term>
323
<listitem>
324
<xi:include href="mandos-options.xml"
325
xpointer="foreground"/>
326
</listitem>
327
</varlistentry>
328
329
<varlistentry>
330
<term><option>--no-zeroconf</option></term>
331
<listitem>
332
<xi:include href="mandos-options.xml" xpointer="zeroconf"/>
333
</listitem>
334
</varlistentry>
335
230
336
</variablelist>
231
337
</refsect1>
232
338
233
339
<refsect1 id="overview">
234
340
<title>OVERVIEW</title>
235
341
<xi:include href="overview.xml"/>
239
345
<acronym>RAM</acronym> disk environment.
240
346
</para>
241
347
</refsect1>
242
348
243
349
<refsect1 id="protocol">
244
350
<title>NETWORK PROTOCOL</title>
245
351
<para>
297
403
</row>
298
404
</tbody></tgroup></table>
299
405
</refsect1>
300
406
301
407
<refsect1 id="checking">
302
408
<title>CHECKING</title>
303
409
<para>
304
410
The server will, by default, continually check that the clients
305
411
are still up. If a client has not been confirmed as being up
306
412
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>
413
longer eligible to receive the encrypted password. (Manual
414
intervention is required to re-enable a client.) The timeout,
415
extended timeout, checker program, and interval between checks
416
can be configured both globally and per client; see
417
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
418
<manvolnum>5</manvolnum></citerefentry>.
419
</para>
420
</refsect1>
421
422
<refsect1 id="approval">
423
<title>APPROVAL</title>
424
<para>
425
The server can be configured to require manual approval for a
426
client before it is sent its secret. The delay to wait for such
427
approval and the default action (approve or deny) can be
428
configured both globally and per client; see <citerefentry>
310
429
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</para>
430
<manvolnum>5</manvolnum></citerefentry>. By default all clients
431
will be approved immediately without delay.
432
</para>
433
<para>
434
This can be used to deny a client its secret if not manually
435
approved within a specified time. It can also be used to make
436
the server delay before giving a client its secret, allowing
437
optional manual denying of this specific client.
438
</para>
439
313
440
</refsect1>
314
441
315
442
<refsect1 id="logging">
316
443
<title>LOGGING</title>
317
444
<para>
318
445
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
446
<filename class="devicefile">/dev/log</filename>. With the
320
447
<option>--debug</option> option, it will log even more messages,
321
448
and also show them on the console.
322
449
</para>
323
450
</refsect1>
324
451
452
<refsect1 id="persistent_state">
453
<title>PERSISTENT STATE</title>
454
<para>
455
Client settings, initially read from
456
<filename>clients.conf</filename>, are persistent across
457
restarts, and run-time changes will override settings in
458
<filename>clients.conf</filename>. However, if a setting is
459
<emphasis>changed</emphasis> (or a client added, or removed) in
460
<filename>clients.conf</filename>, this will take precedence.
461
</para>
462
</refsect1>
463
464
<refsect1 id="dbus_interface">
465
<title>D-BUS INTERFACE</title>
466
<para>
467
The server will by default provide a D-Bus system bus interface.
468
This interface will only be accessible by the root user or a
469
Mandos-specific user, if such a user exists. For documentation
470
of the D-Bus API, see the file <filename>DBUS-API</filename>.
471
</para>
472
</refsect1>
473
325
474
<refsect1 id="exit_status">
326
475
<title>EXIT STATUS</title>
327
476
<para>
329
478
critical error is encountered.
330
479
</para>
331
480
</refsect1>
332
481
333
482
<refsect1 id="environment">
334
483
<title>ENVIRONMENT</title>
335
484
<variablelist>
349
498
</varlistentry>
350
499
</variablelist>
351
500
</refsect1>
352
353
<refsect1 id="file">
501
502
<refsect1 id="files">
354
503
<title>FILES</title>
355
504
<para>
356
505
Use the <option>--configdir</option> option to change where
379
528
</listitem>
380
529
</varlistentry>
381
530
<varlistentry>
382
<term><filename>/var/run/mandos/mandos.pid</filename></term>
383
<listitem>
384
<para>
385
The file containing the process id of
386
<command>&COMMANDNAME;</command>.
531
<term><filename>/run/mandos.pid</filename></term>
532
<listitem>
533
<para>
534
The file containing the process id of the
535
<command>&COMMANDNAME;</command> process started last.
536
<emphasis >Note:</emphasis> If the <filename
537
class="directory">/run</filename> directory does not
538
exist, <filename>/var/run/mandos.pid</filename> will be
539
used instead.
540
</para>
541
</listitem>
542
</varlistentry>
543
<varlistentry>
544
<term><filename class="devicefile">/dev/log</filename></term>
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.
387
554
</para>
388
555
</listitem>
389
556
</varlistentry>
417
584
backtrace. This could be considered a feature.
418
585
</para>
419
586
<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
587
There is no fine-grained control over logging and debug output.
432
588
</para>
433
589
<para>
434
Debug mode is conflated with running in the foreground.
435
</para>
436
<para>
437
The console log messages does not show a timestamp.
590
This server does not check the expire time of clients’ OpenPGP
591
keys.
438
592
</para>
439
593
</refsect1>
440
594
451
605
<informalexample>
452
606
<para>
453
607
Run the server in debug mode, read configuration files from
454
the <filename>~/mandos</filename> directory, and use the
455
Zeroconf service name <quote>Test</quote> to not collide with
456
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:
457
611
</para>
458
612
<para>
459
613
475
629
</para>
476
630
</informalexample>
477
631
</refsect1>
478
632
479
633
<refsect1 id="security">
480
634
<title>SECURITY</title>
481
<refsect2 id="SERVER">
635
<refsect2 id="server">
482
636
<title>SERVER</title>
483
637
<para>
484
638
Running this <command>&COMMANDNAME;</command> server program
485
639
should not in itself present any security risk to the host
486
computer running it. The program does not need any special
487
privileges to run, and is designed to run as a non-root user.
640
computer running it. The program switches to a non-root user
641
soon after startup.
488
642
</para>
489
643
</refsect2>
490
<refsect2 id="CLIENTS">
644
<refsect2 id="clients">
491
645
<title>CLIENTS</title>
492
646
<para>
493
647
The server only gives out its stored data to clients which
500
654
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
655
<manvolnum>5</manvolnum></citerefentry>)
502
656
<emphasis>must</emphasis> be made non-readable by anyone
503
except the user running the server.
657
except the user starting the server (usually root).
504
658
</para>
505
659
<para>
506
660
As detailed in <xref linkend="checking"/>, the status of all
508
662
compromised if they are gone for too long.
509
663
</para>
510
664
<para>
511
If a client is compromised, its downtime should be duly noted
512
by the server which would therefore declare the client
513
invalid. But if the server was ever restarted, it would
514
re-read its client list from its configuration file and again
515
regard all clients therein as valid, and hence eligible to
516
receive their passwords. Therefore, be careful when
517
restarting servers if it is suspected that a client has, in
518
fact, been compromised by parties who may now be running a
519
fake Mandos client with the keys from the non-encrypted
520
initial <acronym>RAM</acronym> image of the client host. What
521
should be done in that case (if restarting the server program
522
really is necessary) is to stop the server program, edit the
523
configuration file to omit any suspect clients, and restart
524
the server program.
525
</para>
526
<para>
527
665
For more details on client-side security, see
528
<citerefentry><refentrytitle>password-request</refentrytitle>
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
529
667
<manvolnum>8mandos</manvolnum></citerefentry>.
530
668
</para>
531
669
</refsect2>
532
670
</refsect1>
533
671
534
672
<refsect1 id="see_also">
535
673
<title>SEE ALSO</title>
536
674
<para>
537
<citerefentry>
538
<refentrytitle>mandos-clients.conf</refentrytitle>
539
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
540
<refentrytitle>mandos.conf</refentrytitle>
541
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
<refentrytitle>password-request</refentrytitle>
543
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
544
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
545
</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>
546
685
</para>
547
686
<variablelist>
548
687
<varlistentry>
569
708
</varlistentry>
570
709
<varlistentry>
571
710
<term>
572
<ulink url="http://www.gnu.org/software/gnutls/"
573
>GnuTLS</ulink>
711
<ulink url="http://gnutls.org/">GnuTLS</ulink>
574
712
</term>
575
713
<listitem>
576
714
<para>
614
752
</varlistentry>
615
753
<varlistentry>
616
754
<term>
617
RFC 4346: <citetitle>The Transport Layer Security (TLS)
618
Protocol Version 1.1</citetitle>
755
RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
Protocol Version 1.2</citetitle>
619
757
</term>
620
758
<listitem>
621
759
<para>
622
TLS 1.1 is the protocol implemented by GnuTLS.
760
TLS 1.2 is the protocol implemented by GnuTLS.
623
761
</para>
624
762
</listitem>
625
763
</varlistentry>
635
773
</varlistentry>
636
774
<varlistentry>
637
775
<term>
638
RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
639
Security</citetitle>
776
RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
Security (TLS) Authentication</citetitle>
640
778
</term>
641
779
<listitem>
642
780
<para>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0