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 629
- compare with another revision
- download diff
- download tarball
- view history from revision 629
- Committer: Teddy Hogeborn
- Date: 2013-10-20 22:20:11 UTC
- Revision ID: teddy@recompile.se-20131020222011-g2fvjicx5lrv4h4e
* mandos-change-keytype: Bug fix: call mandos-keygen from $PATH, not
current directory.
current directory.
- files added:
- .bzr-builddeb
- debian
- debian/po
- debian/source
- network-hooks.d
- 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 "2013-10-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>
34
40
<holder>Teddy Hogeborn</holder>
35
41
<holder>Björn Påhlsson</holder>
36
42
</copyright>
37
43
<xi:include href="legalnotice.xml"/>
38
44
</refentryinfo>
39
45
40
46
<refmeta>
41
47
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
48
<manvolnum>8</manvolnum>
48
54
Gives encrypted passwords to authenticated Mandos clients
49
55
</refpurpose>
50
56
</refnamediv>
51
57
52
58
<refsynopsisdiv>
53
59
<cmdsynopsis>
54
60
<command>&COMMANDNAME;</command>
83
89
<replaceable>DIRECTORY</replaceable></option></arg>
84
90
<sbr/>
85
91
<arg><option>--debug</option></arg>
92
<sbr/>
93
<arg><option>--debuglevel
94
<replaceable>LEVEL</replaceable></option></arg>
95
<sbr/>
96
<arg><option>--no-dbus</option></arg>
97
<sbr/>
98
<arg><option>--no-ipv6</option></arg>
99
<sbr/>
100
<arg><option>--no-restore</option></arg>
101
<sbr/>
102
<arg><option>--statedir
103
<replaceable>DIRECTORY</replaceable></option></arg>
104
<sbr/>
105
<arg><option>--socket
106
<replaceable>FD</replaceable></option></arg>
107
<sbr/>
108
<arg><option>--foreground</option></arg>
86
109
</cmdsynopsis>
87
110
<cmdsynopsis>
88
111
<command>&COMMANDNAME;</command>
100
123
<arg choice="plain"><option>--check</option></arg>
101
124
</cmdsynopsis>
102
125
</refsynopsisdiv>
103
126
104
127
<refsect1 id="description">
105
128
<title>DESCRIPTION</title>
106
129
<para>
107
130
<command>&COMMANDNAME;</command> is a server daemon which
108
131
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.
132
client host computers. For an introduction, see
133
<citerefentry><refentrytitle>intro</refentrytitle>
134
<manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
uses Zeroconf to announce itself on the local network, and uses
136
TLS to communicate securely with and to authenticate the
137
clients. The Mandos server uses IPv6 to allow Mandos clients to
138
use IPv6 link-local addresses, since the clients will probably
139
not have any other addresses configured (see <xref
140
linkend="overview"/>). Any authenticated client is then given
141
the stored pre-encrypted password for that specific client.
117
142
</para>
118
143
</refsect1>
119
144
186
211
<xi:include href="mandos-options.xml" xpointer="debug"/>
187
212
</listitem>
188
213
</varlistentry>
189
214
215
<varlistentry>
216
<term><option>--debuglevel
217
<replaceable>LEVEL</replaceable></option></term>
218
<listitem>
219
<para>
220
Set the debugging log level.
221
<replaceable>LEVEL</replaceable> is a string, one of
222
<quote><literal>CRITICAL</literal></quote>,
223
<quote><literal>ERROR</literal></quote>,
224
<quote><literal>WARNING</literal></quote>,
225
<quote><literal>INFO</literal></quote>, or
226
<quote><literal>DEBUG</literal></quote>, in order of
227
increasing verbosity. The default level is
228
<quote><literal>WARNING</literal></quote>.
229
</para>
230
</listitem>
231
</varlistentry>
232
190
233
<varlistentry>
191
234
<term><option>--priority <replaceable>
192
235
PRIORITY</replaceable></option></term>
194
237
<xi:include href="mandos-options.xml" xpointer="priority"/>
195
238
</listitem>
196
239
</varlistentry>
197
240
198
241
<varlistentry>
199
242
<term><option>--servicename
200
243
<replaceable>NAME</replaceable></option></term>
203
246
xpointer="servicename"/>
204
247
</listitem>
205
248
</varlistentry>
206
249
207
250
<varlistentry>
208
251
<term><option>--configdir
209
252
<replaceable>DIRECTORY</replaceable></option></term>
218
261
</para>
219
262
</listitem>
220
263
</varlistentry>
221
264
222
265
<varlistentry>
223
266
<term><option>--version</option></term>
224
267
<listitem>
227
270
</para>
228
271
</listitem>
229
272
</varlistentry>
273
274
<varlistentry>
275
<term><option>--no-dbus</option></term>
276
<listitem>
277
<xi:include href="mandos-options.xml" xpointer="dbus"/>
278
<para>
279
See also <xref linkend="dbus_interface"/>.
280
</para>
281
</listitem>
282
</varlistentry>
283
284
<varlistentry>
285
<term><option>--no-ipv6</option></term>
286
<listitem>
287
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
288
</listitem>
289
</varlistentry>
290
291
<varlistentry>
292
<term><option>--no-restore</option></term>
293
<listitem>
294
<xi:include href="mandos-options.xml" xpointer="restore"/>
295
<para>
296
See also <xref linkend="persistent_state"/>.
297
</para>
298
</listitem>
299
</varlistentry>
300
301
<varlistentry>
302
<term><option>--statedir
303
<replaceable>DIRECTORY</replaceable></option></term>
304
<listitem>
305
<xi:include href="mandos-options.xml" xpointer="statedir"/>
306
</listitem>
307
</varlistentry>
308
309
<varlistentry>
310
<term><option>--socket
311
<replaceable>FD</replaceable></option></term>
312
<listitem>
313
<xi:include href="mandos-options.xml" xpointer="socket"/>
314
</listitem>
315
</varlistentry>
316
317
<varlistentry>
318
<term><option>--foreground</option></term>
319
<listitem>
320
<xi:include href="mandos-options.xml"
321
xpointer="foreground"/>
322
</listitem>
323
</varlistentry>
324
230
325
</variablelist>
231
326
</refsect1>
232
327
233
328
<refsect1 id="overview">
234
329
<title>OVERVIEW</title>
235
330
<xi:include href="overview.xml"/>
239
334
<acronym>RAM</acronym> disk environment.
240
335
</para>
241
336
</refsect1>
242
337
243
338
<refsect1 id="protocol">
244
339
<title>NETWORK PROTOCOL</title>
245
340
<para>
297
392
</row>
298
393
</tbody></tgroup></table>
299
394
</refsect1>
300
395
301
396
<refsect1 id="checking">
302
397
<title>CHECKING</title>
303
398
<para>
304
399
The server will, by default, continually check that the clients
305
400
are still up. If a client has not been confirmed as being up
306
401
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>
402
longer eligible to receive the encrypted password. (Manual
403
intervention is required to re-enable a client.) The timeout,
404
extended timeout, checker program, and interval between checks
405
can be configured both globally and per client; see
406
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
407
<manvolnum>5</manvolnum></citerefentry>.
408
</para>
409
</refsect1>
410
411
<refsect1 id="approval">
412
<title>APPROVAL</title>
413
<para>
414
The server can be configured to require manual approval for a
415
client before it is sent its secret. The delay to wait for such
416
approval and the default action (approve or deny) can be
417
configured both globally and per client; see <citerefentry>
310
418
<refentrytitle>mandos-clients.conf</refentrytitle>
311
<manvolnum>5</manvolnum></citerefentry>.
312
</para>
419
<manvolnum>5</manvolnum></citerefentry>. By default all clients
420
will be approved immediately without delay.
421
</para>
422
<para>
423
This can be used to deny a client its secret if not manually
424
approved within a specified time. It can also be used to make
425
the server delay before giving a client its secret, allowing
426
optional manual denying of this specific client.
427
</para>
428
313
429
</refsect1>
314
430
315
431
<refsect1 id="logging">
316
432
<title>LOGGING</title>
317
433
<para>
318
434
The server will send log message with various severity levels to
319
<filename>/dev/log</filename>. With the
435
<filename class="devicefile">/dev/log</filename>. With the
320
436
<option>--debug</option> option, it will log even more messages,
321
437
and also show them on the console.
322
438
</para>
323
439
</refsect1>
324
440
441
<refsect1 id="persistent_state">
442
<title>PERSISTENT STATE</title>
443
<para>
444
Client settings, initially read from
445
<filename>clients.conf</filename>, are persistent across
446
restarts, and run-time changes will override settings in
447
<filename>clients.conf</filename>. However, if a setting is
448
<emphasis>changed</emphasis> (or a client added, or removed) in
449
<filename>clients.conf</filename>, this will take precedence.
450
</para>
451
</refsect1>
452
453
<refsect1 id="dbus_interface">
454
<title>D-BUS INTERFACE</title>
455
<para>
456
The server will by default provide a D-Bus system bus interface.
457
This interface will only be accessible by the root user or a
458
Mandos-specific user, if such a user exists. For documentation
459
of the D-Bus API, see the file <filename>DBUS-API</filename>.
460
</para>
461
</refsect1>
462
325
463
<refsect1 id="exit_status">
326
464
<title>EXIT STATUS</title>
327
465
<para>
329
467
critical error is encountered.
330
468
</para>
331
469
</refsect1>
332
470
333
471
<refsect1 id="environment">
334
472
<title>ENVIRONMENT</title>
335
473
<variablelist>
349
487
</varlistentry>
350
488
</variablelist>
351
489
</refsect1>
352
353
<refsect1 id="file">
490
491
<refsect1 id="files">
354
492
<title>FILES</title>
355
493
<para>
356
494
Use the <option>--configdir</option> option to change where
379
517
</listitem>
380
518
</varlistentry>
381
519
<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>.
520
<term><filename>/run/mandos.pid</filename></term>
521
<listitem>
522
<para>
523
The file containing the process id of the
524
<command>&COMMANDNAME;</command> process started last.
525
</para>
526
</listitem>
527
</varlistentry>
528
<varlistentry>
529
<term><filename class="devicefile">/dev/log</filename></term>
530
</varlistentry>
531
<varlistentry>
532
<term><filename
533
class="directory">/var/lib/mandos</filename></term>
534
<listitem>
535
<para>
536
Directory where persistent state will be saved. Change
537
this with the <option>--statedir</option> option. See
538
also the <option>--no-restore</option> option.
387
539
</para>
388
540
</listitem>
389
541
</varlistentry>
417
569
backtrace. This could be considered a feature.
418
570
</para>
419
571
<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
572
There is no fine-grained control over logging and debug output.
432
573
</para>
433
574
<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
575
This server does not check the expire time of clients’ OpenPGP
441
576
keys.
442
577
</para>
455
590
<informalexample>
456
591
<para>
457
592
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:
593
the <filename class="directory">~/mandos</filename> directory,
594
and use the Zeroconf service name <quote>Test</quote> to not
595
collide with any other official Mandos server on this host:
461
596
</para>
462
597
<para>
463
598
479
614
</para>
480
615
</informalexample>
481
616
</refsect1>
482
617
483
618
<refsect1 id="security">
484
619
<title>SECURITY</title>
485
<refsect2 id="SERVER">
620
<refsect2 id="server">
486
621
<title>SERVER</title>
487
622
<para>
488
623
Running this <command>&COMMANDNAME;</command> server program
491
626
soon after startup.
492
627
</para>
493
628
</refsect2>
494
<refsect2 id="CLIENTS">
629
<refsect2 id="clients">
495
630
<title>CLIENTS</title>
496
631
<para>
497
632
The server only gives out its stored data to clients which
504
639
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
640
<manvolnum>5</manvolnum></citerefentry>)
506
641
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
642
except the user starting the server (usually root).
508
643
</para>
509
644
<para>
510
645
As detailed in <xref linkend="checking"/>, the status of all
512
647
compromised if they are gone for too long.
513
648
</para>
514
649
<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
650
For more details on client-side security, see
532
651
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
652
<manvolnum>8mandos</manvolnum></citerefentry>.
534
653
</para>
535
654
</refsect2>
536
655
</refsect1>
537
656
538
657
<refsect1 id="see_also">
539
658
<title>SEE ALSO</title>
540
659
<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>
660
<citerefentry><refentrytitle>intro</refentrytitle>
661
<manvolnum>8mandos</manvolnum></citerefentry>,
662
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
663
<manvolnum>5</manvolnum></citerefentry>,
664
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
665
<manvolnum>5</manvolnum></citerefentry>,
666
<citerefentry><refentrytitle>mandos-client</refentrytitle>
667
<manvolnum>8mandos</manvolnum></citerefentry>,
668
<citerefentry><refentrytitle>sh</refentrytitle>
669
<manvolnum>1</manvolnum></citerefentry>
550
670
</para>
551
671
<variablelist>
552
672
<varlistentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0