/mandos/release

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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

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 "2011-02-27">
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
 
      <year>2011</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
41
37
    <xi:include href="legalnotice.xml"/>
42
38
  </refentryinfo>
43
 
  
 
39
 
44
40
  <refmeta>
45
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
46
42
    <manvolnum>8</manvolnum>
52
48
      Gives encrypted passwords to authenticated Mandos clients
53
49
    </refpurpose>
54
50
  </refnamediv>
55
 
  
 
51
 
56
52
  <refsynopsisdiv>
57
53
    <cmdsynopsis>
58
54
      <command>&COMMANDNAME;</command>
87
83
      <replaceable>DIRECTORY</replaceable></option></arg>
88
84
      <sbr/>
89
85
      <arg><option>--debug</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--debuglevel
92
 
      <replaceable>LEVEL</replaceable></option></arg>
93
 
      <sbr/>
94
 
      <arg><option>--no-dbus</option></arg>
95
 
      <sbr/>
96
 
      <arg><option>--no-ipv6</option></arg>
97
86
    </cmdsynopsis>
98
87
    <cmdsynopsis>
99
88
      <command>&COMMANDNAME;</command>
111
100
      <arg choice="plain"><option>--check</option></arg>
112
101
    </cmdsynopsis>
113
102
  </refsynopsisdiv>
114
 
  
 
103
 
115
104
  <refsect1 id="description">
116
105
    <title>DESCRIPTION</title>
117
106
    <para>
126
115
      Any authenticated client is then given the stored pre-encrypted
127
116
      password for that specific client.
128
117
    </para>
 
118
 
129
119
  </refsect1>
130
120
  
131
121
  <refsect1 id="purpose">
132
122
    <title>PURPOSE</title>
 
123
 
133
124
    <para>
134
125
      The purpose of this is to enable <emphasis>remote and unattended
135
126
      rebooting</emphasis> of client host computer with an
136
127
      <emphasis>encrypted root file system</emphasis>.  See <xref
137
128
      linkend="overview"/> for details.
138
129
    </para>
 
130
    
139
131
  </refsect1>
140
132
  
141
133
  <refsect1 id="options">
142
134
    <title>OPTIONS</title>
 
135
    
143
136
    <variablelist>
144
137
      <varlistentry>
145
138
        <term><option>--help</option></term>
197
190
          <xi:include href="mandos-options.xml" xpointer="debug"/>
198
191
        </listitem>
199
192
      </varlistentry>
200
 
      
201
 
      <varlistentry>
202
 
        <term><option>--debuglevel
203
 
        <replaceable>LEVEL</replaceable></option></term>
204
 
        <listitem>
205
 
          <para>
206
 
            Set the debugging log level.
207
 
            <replaceable>LEVEL</replaceable> is a string, one of
208
 
            <quote><literal>CRITICAL</literal></quote>,
209
 
            <quote><literal>ERROR</literal></quote>,
210
 
            <quote><literal>WARNING</literal></quote>,
211
 
            <quote><literal>INFO</literal></quote>, or
212
 
            <quote><literal>DEBUG</literal></quote>, in order of
213
 
            increasing verbosity.  The default level is
214
 
            <quote><literal>WARNING</literal></quote>.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
 
193
 
219
194
      <varlistentry>
220
195
        <term><option>--priority <replaceable>
221
196
        PRIORITY</replaceable></option></term>
223
198
          <xi:include href="mandos-options.xml" xpointer="priority"/>
224
199
        </listitem>
225
200
      </varlistentry>
226
 
      
 
201
 
227
202
      <varlistentry>
228
203
        <term><option>--servicename
229
204
        <replaceable>NAME</replaceable></option></term>
232
207
                      xpointer="servicename"/>
233
208
        </listitem>
234
209
      </varlistentry>
235
 
      
 
210
 
236
211
      <varlistentry>
237
212
        <term><option>--configdir
238
213
        <replaceable>DIRECTORY</replaceable></option></term>
247
222
          </para>
248
223
        </listitem>
249
224
      </varlistentry>
250
 
      
 
225
 
251
226
      <varlistentry>
252
227
        <term><option>--version</option></term>
253
228
        <listitem>
256
231
          </para>
257
232
        </listitem>
258
233
      </varlistentry>
259
 
      
260
 
      <varlistentry>
261
 
        <term><option>--no-dbus</option></term>
262
 
        <listitem>
263
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
264
 
          <para>
265
 
            See also <xref linkend="dbus_interface"/>.
266
 
          </para>
267
 
        </listitem>
268
 
      </varlistentry>
269
 
      
270
 
      <varlistentry>
271
 
        <term><option>--no-ipv6</option></term>
272
 
        <listitem>
273
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
274
 
        </listitem>
275
 
      </varlistentry>
276
234
    </variablelist>
277
235
  </refsect1>
278
 
  
 
236
 
279
237
  <refsect1 id="overview">
280
238
    <title>OVERVIEW</title>
281
239
    <xi:include href="overview.xml"/>
285
243
      <acronym>RAM</acronym> disk environment.
286
244
    </para>
287
245
  </refsect1>
288
 
  
 
246
 
289
247
  <refsect1 id="protocol">
290
248
    <title>NETWORK PROTOCOL</title>
291
249
    <para>
343
301
      </row>
344
302
    </tbody></tgroup></table>
345
303
  </refsect1>
346
 
  
 
304
 
347
305
  <refsect1 id="checking">
348
306
    <title>CHECKING</title>
349
307
    <para>
350
308
      The server will, by default, continually check that the clients
351
309
      are still up.  If a client has not been confirmed as being up
352
310
      for some time, the client is assumed to be compromised and is no
353
 
      longer eligible to receive the encrypted password.  (Manual
354
 
      intervention is required to re-enable a client.)  The timeout,
 
311
      longer eligible to receive the encrypted password.  The timeout,
355
312
      checker program, and interval between checks can be configured
356
313
      both globally and per client; see <citerefentry>
357
314
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
359
 
      receiving its password will also be treated as a successful
360
 
      checker run.
361
 
    </para>
362
 
  </refsect1>
363
 
  
364
 
  <refsect1 id="approval">
365
 
    <title>APPROVAL</title>
366
 
    <para>
367
 
      The server can be configured to require manual approval for a
368
 
      client before it is sent its secret.  The delay to wait for such
369
 
      approval and the default action (approve or deny) can be
370
 
      configured both globally and per client; see <citerefentry>
371
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
372
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
373
 
      will be approved immediately without delay.
374
 
    </para>
375
 
    <para>
376
 
      This can be used to deny a client its secret if not manually
377
 
      approved within a specified time.  It can also be used to make
378
 
      the server delay before giving a client its secret, allowing
379
 
      optional manual denying of this specific client.
380
 
    </para>
381
 
    
382
 
  </refsect1>
383
 
  
 
315
      <manvolnum>5</manvolnum></citerefentry>.
 
316
    </para>
 
317
  </refsect1>
 
318
 
384
319
  <refsect1 id="logging">
385
320
    <title>LOGGING</title>
386
321
    <para>
390
325
      and also show them on the console.
391
326
    </para>
392
327
  </refsect1>
393
 
  
394
 
  <refsect1 id="dbus_interface">
395
 
    <title>D-BUS INTERFACE</title>
396
 
    <para>
397
 
      The server will by default provide a D-Bus system bus interface.
398
 
      This interface will only be accessible by the root user or a
399
 
      Mandos-specific user, if such a user exists.  For documentation
400
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
401
 
    </para>
402
 
  </refsect1>
403
 
  
 
328
 
404
329
  <refsect1 id="exit_status">
405
330
    <title>EXIT STATUS</title>
406
331
    <para>
408
333
      critical error is encountered.
409
334
    </para>
410
335
  </refsect1>
411
 
  
 
336
 
412
337
  <refsect1 id="environment">
413
338
    <title>ENVIRONMENT</title>
414
339
    <variablelist>
428
353
      </varlistentry>
429
354
    </variablelist>
430
355
  </refsect1>
431
 
  
432
 
  <refsect1 id="files">
 
356
 
 
357
  <refsect1 id="file">
433
358
    <title>FILES</title>
434
359
    <para>
435
360
      Use the <option>--configdir</option> option to change where
458
383
        </listitem>
459
384
      </varlistentry>
460
385
      <varlistentry>
461
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
386
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
462
387
        <listitem>
463
388
          <para>
464
 
            The file containing the process id of the
465
 
            <command>&COMMANDNAME;</command> process started last.
 
389
            The file containing the process id of
 
390
            <command>&COMMANDNAME;</command>.
466
391
          </para>
467
392
        </listitem>
468
393
      </varlistentry>
496
421
      backtrace.  This could be considered a feature.
497
422
    </para>
498
423
    <para>
499
 
      Currently, if a client is disabled due to having timed out, the
500
 
      server does not record this fact onto permanent storage.  This
501
 
      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.
502
433
    </para>
503
434
    <para>
504
435
      There is no fine-grained control over logging and debug output.
507
438
      Debug mode is conflated with running in the foreground.
508
439
    </para>
509
440
    <para>
510
 
      The console log messages do not show a time stamp.
511
 
    </para>
512
 
    <para>
513
 
      This server does not check the expire time of clients’ OpenPGP
514
 
      keys.
 
441
      The console log messages does not show a timestamp.
515
442
    </para>
516
443
  </refsect1>
517
444
  
552
479
      </para>
553
480
    </informalexample>
554
481
  </refsect1>
555
 
  
 
482
 
556
483
  <refsect1 id="security">
557
484
    <title>SECURITY</title>
558
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
559
486
      <title>SERVER</title>
560
487
      <para>
561
488
        Running this <command>&COMMANDNAME;</command> server program
562
489
        should not in itself present any security risk to the host
563
 
        computer running it.  The program switches to a non-root user
564
 
        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.
565
492
      </para>
566
493
    </refsect2>
567
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
568
495
      <title>CLIENTS</title>
569
496
      <para>
570
497
        The server only gives out its stored data to clients which
577
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
578
505
        <manvolnum>5</manvolnum></citerefentry>)
579
506
        <emphasis>must</emphasis> be made non-readable by anyone
580
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
581
508
      </para>
582
509
      <para>
583
510
        As detailed in <xref linkend="checking"/>, the status of all
586
513
      </para>
587
514
      <para>
588
515
        If a client is compromised, its downtime should be duly noted
589
 
        by the server which would therefore disable the client.  But
590
 
        if the server was ever restarted, it would re-read its client
591
 
        list from its configuration file and again regard all clients
592
 
        therein as enabled, and hence eligible to receive their
593
 
        passwords.  Therefore, be careful when restarting servers if
594
 
        it is suspected that a client has, in fact, been compromised
595
 
        by parties who may now be running a fake Mandos client with
596
 
        the keys from the non-encrypted initial <acronym>RAM</acronym>
597
 
        image of the client host.  What should be done in that case
598
 
        (if restarting the server program really is necessary) is to
599
 
        stop the server program, edit the configuration file to omit
600
 
        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.
601
529
      </para>
602
530
      <para>
603
531
        For more details on client-side security, see
604
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
605
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
606
534
      </para>
607
535
    </refsect2>
608
536
  </refsect1>
609
 
  
 
537
 
610
538
  <refsect1 id="see_also">
611
539
    <title>SEE ALSO</title>
612
540
    <para>
615
543
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
616
544
        <refentrytitle>mandos.conf</refentrytitle>
617
545
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
618
 
        <refentrytitle>mandos-client</refentrytitle>
 
546
        <refentrytitle>password-request</refentrytitle>
619
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
620
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
621
549
      </citerefentry>