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 443
- compare with another revision
- download diff
- download tarball
- view history from revision 443
- Committer: Teddy Hogeborn
- Date: 2010-09-26 17:44:43 UTC
- Revision ID: teddy@fukt.bsnet.se-20100926174443-452k363uuvczuuzg
* mandos-ctl: Also show "LastApprovalRequest" property.
- files added:
- .bzr-builddeb
- debian
- debian/po
- 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-08-31">
5
<!ENTITY TIMESTAMP "2010-09-25">
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>
31
32
</authorgroup>
32
33
<copyright>
33
34
<year>2008</year>
35
<year>2009</year>
34
36
<holder>Teddy Hogeborn</holder>
35
37
<holder>Björn Påhlsson</holder>
36
38
</copyright>
37
39
<xi:include href="legalnotice.xml"/>
38
40
</refentryinfo>
39
41
40
42
<refmeta>
41
43
<refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
<manvolnum>8</manvolnum>
48
50
Gives encrypted passwords to authenticated Mandos clients
49
51
</refpurpose>
50
52
</refnamediv>
51
53
52
54
<refsynopsisdiv>
53
55
<cmdsynopsis>
54
56
<command>&COMMANDNAME;</command>
83
85
<replaceable>DIRECTORY</replaceable></option></arg>
84
86
<sbr/>
85
87
<arg><option>--debug</option></arg>
88
<sbr/>
89
<arg><option>--no-dbus</option></arg>
90
<sbr/>
91
<arg><option>--no-ipv6</option></arg>
86
92
</cmdsynopsis>
87
93
<cmdsynopsis>
88
94
<command>&COMMANDNAME;</command>
100
106
<arg choice="plain"><option>--check</option></arg>
101
107
</cmdsynopsis>
102
108
</refsynopsisdiv>
103
109
104
110
<refsect1 id="description">
105
111
<title>DESCRIPTION</title>
106
112
<para>
115
121
Any authenticated client is then given the stored pre-encrypted
116
122
password for that specific client.
117
123
</para>
118
119
124
</refsect1>
120
125
121
126
<refsect1 id="purpose">
122
127
<title>PURPOSE</title>
123
124
128
<para>
125
129
The purpose of this is to enable <emphasis>remote and unattended
126
130
rebooting</emphasis> of client host computer with an
127
131
<emphasis>encrypted root file system</emphasis>. See <xref
128
132
linkend="overview"/> for details.
129
133
</para>
130
131
134
</refsect1>
132
135
133
136
<refsect1 id="options">
134
137
<title>OPTIONS</title>
135
136
138
<variablelist>
137
139
<varlistentry>
138
140
<term><option>--help</option></term>
190
192
<xi:include href="mandos-options.xml" xpointer="debug"/>
191
193
</listitem>
192
194
</varlistentry>
193
195
194
196
<varlistentry>
195
197
<term><option>--priority <replaceable>
196
198
PRIORITY</replaceable></option></term>
198
200
<xi:include href="mandos-options.xml" xpointer="priority"/>
199
201
</listitem>
200
202
</varlistentry>
201
203
202
204
<varlistentry>
203
205
<term><option>--servicename
204
206
<replaceable>NAME</replaceable></option></term>
207
209
xpointer="servicename"/>
208
210
</listitem>
209
211
</varlistentry>
210
212
211
213
<varlistentry>
212
214
<term><option>--configdir
213
215
<replaceable>DIRECTORY</replaceable></option></term>
222
224
</para>
223
225
</listitem>
224
226
</varlistentry>
225
227
226
228
<varlistentry>
227
229
<term><option>--version</option></term>
228
230
<listitem>
231
233
</para>
232
234
</listitem>
233
235
</varlistentry>
236
237
<varlistentry>
238
<term><option>--no-dbus</option></term>
239
<listitem>
240
<xi:include href="mandos-options.xml" xpointer="dbus"/>
241
<para>
242
See also <xref linkend="dbus_interface"/>.
243
</para>
244
</listitem>
245
</varlistentry>
246
247
<varlistentry>
248
<term><option>--no-ipv6</option></term>
249
<listitem>
250
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
</listitem>
252
</varlistentry>
234
253
</variablelist>
235
254
</refsect1>
236
255
237
256
<refsect1 id="overview">
238
257
<title>OVERVIEW</title>
239
258
<xi:include href="overview.xml"/>
240
259
<para>
241
260
This program is the server part. It is a normal server program
242
261
and will run in a normal system environment, not in an initial
243
RAM disk environment.
262
<acronym>RAM</acronym> disk environment.
244
263
</para>
245
264
</refsect1>
246
265
247
266
<refsect1 id="protocol">
248
267
<title>NETWORK PROTOCOL</title>
249
268
<para>
301
320
</row>
302
321
</tbody></tgroup></table>
303
322
</refsect1>
304
323
305
324
<refsect1 id="checking">
306
325
<title>CHECKING</title>
307
326
<para>
308
327
The server will, by default, continually check that the clients
309
328
are still up. If a client has not been confirmed as being up
310
329
for some time, the client is assumed to be compromised and is no
311
longer eligible to receive the encrypted password. The timeout,
330
longer eligible to receive the encrypted password. (Manual
331
intervention is required to re-enable a client.) The timeout,
312
332
checker program, and interval between checks can be configured
313
333
both globally and per client; see <citerefentry>
314
334
<refentrytitle>mandos-clients.conf</refentrytitle>
315
<manvolnum>5</manvolnum></citerefentry>.
316
</para>
317
</refsect1>
318
335
<manvolnum>5</manvolnum></citerefentry>. A client successfully
336
receiving its password will also be treated as a successful
337
checker run.
338
</para>
339
</refsect1>
340
341
<refsect1 id="approval">
342
<title>APPROVAL</title>
343
<para>
344
The server can be configured to require manual approval for a
345
client before it is sent its secret. The delay to wait for such
346
approval and the default action (approve or deny) can be
347
configured both globally and per client; see <citerefentry>
348
<refentrytitle>mandos-clients.conf</refentrytitle>
349
<manvolnum>5</manvolnum></citerefentry>. By default all clients
350
will be approved immediately without delay.
351
</para>
352
<para>
353
This can be used to deny a client its secret if not manually
354
approved within a specified time. It can also be used to make
355
the server delay before giving a client its secret, allowing
356
optional manual denying of this specific client.
357
</para>
358
359
</refsect1>
360
319
361
<refsect1 id="logging">
320
362
<title>LOGGING</title>
321
363
<para>
325
367
and also show them on the console.
326
368
</para>
327
369
</refsect1>
328
370
371
<refsect1 id="dbus_interface">
372
<title>D-BUS INTERFACE</title>
373
<para>
374
The server will by default provide a D-Bus system bus interface.
375
This interface will only be accessible by the root user or a
376
Mandos-specific user, if such a user exists. For documentation
377
of the D-Bus API, see the file <filename>DBUS-API</filename>.
378
</para>
379
</refsect1>
380
329
381
<refsect1 id="exit_status">
330
382
<title>EXIT STATUS</title>
331
383
<para>
333
385
critical error is encountered.
334
386
</para>
335
387
</refsect1>
336
388
337
389
<refsect1 id="environment">
338
390
<title>ENVIRONMENT</title>
339
391
<variablelist>
353
405
</varlistentry>
354
406
</variablelist>
355
407
</refsect1>
356
357
<refsect1 id="file">
408
409
<refsect1 id="files">
358
410
<title>FILES</title>
359
411
<para>
360
412
Use the <option>--configdir</option> option to change where
383
435
</listitem>
384
436
</varlistentry>
385
437
<varlistentry>
386
<term><filename>/var/run/mandos/mandos.pid</filename></term>
438
<term><filename>/var/run/mandos.pid</filename></term>
387
439
<listitem>
388
440
<para>
389
The file containing the process id of
390
<command>&COMMANDNAME;</command>.
441
The file containing the process id of the
442
<command>&COMMANDNAME;</command> process started last.
391
443
</para>
392
444
</listitem>
393
445
</varlistentry>
421
473
backtrace. This could be considered a feature.
422
474
</para>
423
475
<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.
476
Currently, if a client is disabled due to having timed out, the
477
server does not record this fact onto permanent storage. This
478
has some security implications, see <xref linkend="clients"/>.
433
479
</para>
434
480
<para>
435
481
There is no fine-grained control over logging and debug output.
438
484
Debug mode is conflated with running in the foreground.
439
485
</para>
440
486
<para>
441
The console log messages does not show a timestamp.
487
The console log messages do not show a time stamp.
488
</para>
489
<para>
490
This server does not check the expire time of clients’ OpenPGP
491
keys.
442
492
</para>
443
493
</refsect1>
444
494
479
529
</para>
480
530
</informalexample>
481
531
</refsect1>
482
532
483
533
<refsect1 id="security">
484
534
<title>SECURITY</title>
485
<refsect2 id="SERVER">
535
<refsect2 id="server">
486
536
<title>SERVER</title>
487
537
<para>
488
538
Running this <command>&COMMANDNAME;</command> server program
489
539
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.
540
computer running it. The program switches to a non-root user
541
soon after startup.
492
542
</para>
493
543
</refsect2>
494
<refsect2 id="CLIENTS">
544
<refsect2 id="clients">
495
545
<title>CLIENTS</title>
496
546
<para>
497
547
The server only gives out its stored data to clients which
504
554
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
555
<manvolnum>5</manvolnum></citerefentry>)
506
556
<emphasis>must</emphasis> be made non-readable by anyone
507
except the user running the server.
557
except the user starting the server (usually root).
508
558
</para>
509
559
<para>
510
560
As detailed in <xref linkend="checking"/>, the status of all
513
563
</para>
514
564
<para>
515
565
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 RAM image of the client host. What should be done in
525
that case (if restarting the server program really is
526
necessary) is to stop the server program, edit the
527
configuration file to omit any suspect clients, and restart
528
the server program.
566
by the server which would therefore disable the client. But
567
if the server was ever restarted, it would re-read its client
568
list from its configuration file and again regard all clients
569
therein as enabled, and hence eligible to receive their
570
passwords. Therefore, be careful when restarting servers if
571
it is suspected that a client has, in fact, been compromised
572
by parties who may now be running a fake Mandos client with
573
the keys from the non-encrypted initial <acronym>RAM</acronym>
574
image of the client host. What should be done in that case
575
(if restarting the server program really is necessary) is to
576
stop the server program, edit the configuration file to omit
577
any suspect clients, and restart the server program.
529
578
</para>
530
579
<para>
531
580
For more details on client-side security, see
532
<citerefentry><refentrytitle>password-request</refentrytitle>
581
<citerefentry><refentrytitle>mandos-client</refentrytitle>
533
582
<manvolnum>8mandos</manvolnum></citerefentry>.
534
583
</para>
535
584
</refsect2>
536
585
</refsect1>
537
586
538
587
<refsect1 id="see_also">
539
588
<title>SEE ALSO</title>
540
589
<para>
543
592
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
593
<refentrytitle>mandos.conf</refentrytitle>
545
594
<manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
<refentrytitle>password-request</refentrytitle>
595
<refentrytitle>mandos-client</refentrytitle>
547
596
<manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
597
<refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
598
</citerefentry>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0