/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: 2010-09-28 19:38:10 UTC
  • mfrom: (237.4.2 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20100928193810-hw5fktxy93epthxx
Merge from release branch.

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