/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-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

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-02">
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>--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>
96
86
    </cmdsynopsis>
97
87
    <cmdsynopsis>
98
88
      <command>&COMMANDNAME;</command>
110
100
      <arg choice="plain"><option>--check</option></arg>
111
101
    </cmdsynopsis>
112
102
  </refsynopsisdiv>
113
 
  
 
103
 
114
104
  <refsect1 id="description">
115
105
    <title>DESCRIPTION</title>
116
106
    <para>
196
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
197
187
        </listitem>
198
188
      </varlistentry>
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
 
      
 
189
 
218
190
      <varlistentry>
219
191
        <term><option>--priority <replaceable>
220
192
        PRIORITY</replaceable></option></term>
222
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
223
195
        </listitem>
224
196
      </varlistentry>
225
 
      
 
197
 
226
198
      <varlistentry>
227
199
        <term><option>--servicename
228
200
        <replaceable>NAME</replaceable></option></term>
231
203
                      xpointer="servicename"/>
232
204
        </listitem>
233
205
      </varlistentry>
234
 
      
 
206
 
235
207
      <varlistentry>
236
208
        <term><option>--configdir
237
209
        <replaceable>DIRECTORY</replaceable></option></term>
246
218
          </para>
247
219
        </listitem>
248
220
      </varlistentry>
249
 
      
 
221
 
250
222
      <varlistentry>
251
223
        <term><option>--version</option></term>
252
224
        <listitem>
255
227
          </para>
256
228
        </listitem>
257
229
      </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>
275
230
    </variablelist>
276
231
  </refsect1>
277
 
  
 
232
 
278
233
  <refsect1 id="overview">
279
234
    <title>OVERVIEW</title>
280
235
    <xi:include href="overview.xml"/>
284
239
      <acronym>RAM</acronym> disk environment.
285
240
    </para>
286
241
  </refsect1>
287
 
  
 
242
 
288
243
  <refsect1 id="protocol">
289
244
    <title>NETWORK PROTOCOL</title>
290
245
    <para>
342
297
      </row>
343
298
    </tbody></tgroup></table>
344
299
  </refsect1>
345
 
  
 
300
 
346
301
  <refsect1 id="checking">
347
302
    <title>CHECKING</title>
348
303
    <para>
349
304
      The server will, by default, continually check that the clients
350
305
      are still up.  If a client has not been confirmed as being up
351
306
      for some time, the client is assumed to be compromised and is no
352
 
      longer eligible to receive the encrypted password.  (Manual
353
 
      intervention is required to re-enable a client.)  The timeout,
 
307
      longer eligible to receive the encrypted password.  The timeout,
354
308
      checker program, and interval between checks can be configured
355
309
      both globally and per client; see <citerefentry>
356
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
  
 
311
      <manvolnum>5</manvolnum></citerefentry>.
 
312
    </para>
 
313
  </refsect1>
 
314
 
383
315
  <refsect1 id="logging">
384
316
    <title>LOGGING</title>
385
317
    <para>
389
321
      and also show them on the console.
390
322
    </para>
391
323
  </refsect1>
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
 
  
 
324
 
403
325
  <refsect1 id="exit_status">
404
326
    <title>EXIT STATUS</title>
405
327
    <para>
407
329
      critical error is encountered.
408
330
    </para>
409
331
  </refsect1>
410
 
  
 
332
 
411
333
  <refsect1 id="environment">
412
334
    <title>ENVIRONMENT</title>
413
335
    <variablelist>
427
349
      </varlistentry>
428
350
    </variablelist>
429
351
  </refsect1>
430
 
  
431
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
432
354
    <title>FILES</title>
433
355
    <para>
434
356
      Use the <option>--configdir</option> option to change where
457
379
        </listitem>
458
380
      </varlistentry>
459
381
      <varlistentry>
460
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
382
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
461
383
        <listitem>
462
384
          <para>
463
 
            The file containing the process id of the
464
 
            <command>&COMMANDNAME;</command> process started last.
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
465
387
          </para>
466
388
        </listitem>
467
389
      </varlistentry>
495
417
      backtrace.  This could be considered a feature.
496
418
    </para>
497
419
    <para>
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"/>.
 
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.
501
429
    </para>
502
430
    <para>
503
431
      There is no fine-grained control over logging and debug output.
506
434
      Debug mode is conflated with running in the foreground.
507
435
    </para>
508
436
    <para>
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.
 
437
      The console log messages does not show a timestamp.
514
438
    </para>
515
439
  </refsect1>
516
440
  
551
475
      </para>
552
476
    </informalexample>
553
477
  </refsect1>
554
 
  
 
478
 
555
479
  <refsect1 id="security">
556
480
    <title>SECURITY</title>
557
 
    <refsect2 id="server">
 
481
    <refsect2 id="SERVER">
558
482
      <title>SERVER</title>
559
483
      <para>
560
484
        Running this <command>&COMMANDNAME;</command> server program
561
485
        should not in itself present any security risk to the host
562
 
        computer running it.  The program switches to a non-root user
563
 
        soon after startup.
 
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.
564
488
      </para>
565
489
    </refsect2>
566
 
    <refsect2 id="clients">
 
490
    <refsect2 id="CLIENTS">
567
491
      <title>CLIENTS</title>
568
492
      <para>
569
493
        The server only gives out its stored data to clients which
576
500
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
577
501
        <manvolnum>5</manvolnum></citerefentry>)
578
502
        <emphasis>must</emphasis> be made non-readable by anyone
579
 
        except the user starting the server (usually root).
 
503
        except the user running the server.
580
504
      </para>
581
505
      <para>
582
506
        As detailed in <xref linkend="checking"/>, the status of all
585
509
      </para>
586
510
      <para>
587
511
        If a client is compromised, its downtime should be duly noted
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.
 
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.
600
525
      </para>
601
526
      <para>
602
527
        For more details on client-side security, see
603
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
528
        <citerefentry><refentrytitle>password-request</refentrytitle>
604
529
        <manvolnum>8mandos</manvolnum></citerefentry>.
605
530
      </para>
606
531
    </refsect2>
607
532
  </refsect1>
608
 
  
 
533
 
609
534
  <refsect1 id="see_also">
610
535
    <title>SEE ALSO</title>
611
536
    <para>
614
539
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
615
540
        <refentrytitle>mandos.conf</refentrytitle>
616
541
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
617
 
        <refentrytitle>mandos-client</refentrytitle>
 
542
        <refentrytitle>password-request</refentrytitle>
618
543
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
619
544
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
620
545
      </citerefentry>