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