/mandos/trunk

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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

Show diffs side-by-side

added added

removed removed

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