/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 at bsnet
  • Date: 2011-11-12 18:15:29 UTC
  • mfrom: (521.1.1 doc-filename-class)
  • Revision ID: teddy@fukt.bsnet.se-20111112181529-v4emlw0v5fugv2tk
Merge doc markup fixes.

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-03">
 
5
<!ENTITY TIMESTAMP "2011-10-22">
 
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>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </copyright>
37
41
    <xi:include href="legalnotice.xml"/>
38
42
  </refentryinfo>
39
 
 
 
43
  
40
44
  <refmeta>
41
45
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
46
    <manvolnum>8</manvolnum>
48
52
      Gives encrypted passwords to authenticated Mandos clients
49
53
    </refpurpose>
50
54
  </refnamediv>
51
 
 
 
55
  
52
56
  <refsynopsisdiv>
53
57
    <cmdsynopsis>
54
58
      <command>&COMMANDNAME;</command>
83
87
      <replaceable>DIRECTORY</replaceable></option></arg>
84
88
      <sbr/>
85
89
      <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
      <sbr/>
 
98
      <arg><option>--no-restore</option></arg>
86
99
    </cmdsynopsis>
87
100
    <cmdsynopsis>
88
101
      <command>&COMMANDNAME;</command>
100
113
      <arg choice="plain"><option>--check</option></arg>
101
114
    </cmdsynopsis>
102
115
  </refsynopsisdiv>
103
 
 
 
116
  
104
117
  <refsect1 id="description">
105
118
    <title>DESCRIPTION</title>
106
119
    <para>
107
120
      <command>&COMMANDNAME;</command> is a server daemon which
108
121
      handles incoming request for passwords for a pre-defined list of
109
 
      client host computers.  The Mandos server uses Zeroconf to
110
 
      announce itself on the local network, and uses TLS to
111
 
      communicate securely with and to authenticate the clients.  The
112
 
      Mandos server uses IPv6 to allow Mandos clients to use IPv6
113
 
      link-local addresses, since the clients will probably not have
114
 
      any other addresses configured (see <xref linkend="overview"/>).
115
 
      Any authenticated client is then given the stored pre-encrypted
116
 
      password for that specific client.
 
122
      client host computers. For an introduction, see
 
123
      <citerefentry><refentrytitle>intro</refentrytitle>
 
124
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
125
      uses Zeroconf to announce itself on the local network, and uses
 
126
      TLS to communicate securely with and to authenticate the
 
127
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
128
      use IPv6 link-local addresses, since the clients will probably
 
129
      not have any other addresses configured (see <xref
 
130
      linkend="overview"/>).  Any authenticated client is then given
 
131
      the stored pre-encrypted password for that specific client.
117
132
    </para>
118
133
  </refsect1>
119
134
  
186
201
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
202
        </listitem>
188
203
      </varlistentry>
189
 
 
 
204
      
 
205
      <varlistentry>
 
206
        <term><option>--debuglevel
 
207
        <replaceable>LEVEL</replaceable></option></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Set the debugging log level.
 
211
            <replaceable>LEVEL</replaceable> is a string, one of
 
212
            <quote><literal>CRITICAL</literal></quote>,
 
213
            <quote><literal>ERROR</literal></quote>,
 
214
            <quote><literal>WARNING</literal></quote>,
 
215
            <quote><literal>INFO</literal></quote>, or
 
216
            <quote><literal>DEBUG</literal></quote>, in order of
 
217
            increasing verbosity.  The default level is
 
218
            <quote><literal>WARNING</literal></quote>.
 
219
          </para>
 
220
        </listitem>
 
221
      </varlistentry>
 
222
      
190
223
      <varlistentry>
191
224
        <term><option>--priority <replaceable>
192
225
        PRIORITY</replaceable></option></term>
194
227
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
228
        </listitem>
196
229
      </varlistentry>
197
 
 
 
230
      
198
231
      <varlistentry>
199
232
        <term><option>--servicename
200
233
        <replaceable>NAME</replaceable></option></term>
203
236
                      xpointer="servicename"/>
204
237
        </listitem>
205
238
      </varlistentry>
206
 
 
 
239
      
207
240
      <varlistentry>
208
241
        <term><option>--configdir
209
242
        <replaceable>DIRECTORY</replaceable></option></term>
218
251
          </para>
219
252
        </listitem>
220
253
      </varlistentry>
221
 
 
 
254
      
222
255
      <varlistentry>
223
256
        <term><option>--version</option></term>
224
257
        <listitem>
227
260
          </para>
228
261
        </listitem>
229
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>--no-dbus</option></term>
 
266
        <listitem>
 
267
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
268
          <para>
 
269
            See also <xref linkend="dbus_interface"/>.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry>
 
273
      
 
274
      <varlistentry>
 
275
        <term><option>--no-ipv6</option></term>
 
276
        <listitem>
 
277
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>--no-restore</option></term>
 
283
        <listitem>
 
284
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
285
        </listitem>
 
286
      </varlistentry>
230
287
    </variablelist>
231
288
  </refsect1>
232
 
 
 
289
  
233
290
  <refsect1 id="overview">
234
291
    <title>OVERVIEW</title>
235
292
    <xi:include href="overview.xml"/>
239
296
      <acronym>RAM</acronym> disk environment.
240
297
    </para>
241
298
  </refsect1>
242
 
 
 
299
  
243
300
  <refsect1 id="protocol">
244
301
    <title>NETWORK PROTOCOL</title>
245
302
    <para>
297
354
      </row>
298
355
    </tbody></tgroup></table>
299
356
  </refsect1>
300
 
 
 
357
  
301
358
  <refsect1 id="checking">
302
359
    <title>CHECKING</title>
303
360
    <para>
304
361
      The server will, by default, continually check that the clients
305
362
      are still up.  If a client has not been confirmed as being up
306
363
      for some time, the client is assumed to be compromised and is no
307
 
      longer eligible to receive the encrypted password.  The timeout,
308
 
      checker program, and interval between checks can be configured
309
 
      both globally and per client; see <citerefentry>
 
364
      longer eligible to receive the encrypted password.  (Manual
 
365
      intervention is required to re-enable a client.)  The timeout,
 
366
      extended timeout, checker program, and interval between checks
 
367
      can be configured both globally and per client; see
 
368
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
369
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
370
      receiving its password will also be treated as a successful
 
371
      checker run.
 
372
    </para>
 
373
  </refsect1>
 
374
  
 
375
  <refsect1 id="approval">
 
376
    <title>APPROVAL</title>
 
377
    <para>
 
378
      The server can be configured to require manual approval for a
 
379
      client before it is sent its secret.  The delay to wait for such
 
380
      approval and the default action (approve or deny) can be
 
381
      configured both globally and per client; see <citerefentry>
310
382
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
383
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
384
      will be approved immediately without delay.
 
385
    </para>
 
386
    <para>
 
387
      This can be used to deny a client its secret if not manually
 
388
      approved within a specified time.  It can also be used to make
 
389
      the server delay before giving a client its secret, allowing
 
390
      optional manual denying of this specific client.
 
391
    </para>
 
392
    
313
393
  </refsect1>
314
 
 
 
394
  
315
395
  <refsect1 id="logging">
316
396
    <title>LOGGING</title>
317
397
    <para>
318
398
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
399
      <filename class="devicefile">/dev/log</filename>.  With the
320
400
      <option>--debug</option> option, it will log even more messages,
321
401
      and also show them on the console.
322
402
    </para>
323
403
  </refsect1>
324
 
 
 
404
  
 
405
  <refsect1 id="dbus_interface">
 
406
    <title>D-BUS INTERFACE</title>
 
407
    <para>
 
408
      The server will by default provide a D-Bus system bus interface.
 
409
      This interface will only be accessible by the root user or a
 
410
      Mandos-specific user, if such a user exists.  For documentation
 
411
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
412
    </para>
 
413
  </refsect1>
 
414
  
325
415
  <refsect1 id="exit_status">
326
416
    <title>EXIT STATUS</title>
327
417
    <para>
329
419
      critical error is encountered.
330
420
    </para>
331
421
  </refsect1>
332
 
 
 
422
  
333
423
  <refsect1 id="environment">
334
424
    <title>ENVIRONMENT</title>
335
425
    <variablelist>
349
439
      </varlistentry>
350
440
    </variablelist>
351
441
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
442
  
 
443
  <refsect1 id="files">
354
444
    <title>FILES</title>
355
445
    <para>
356
446
      Use the <option>--configdir</option> option to change where
379
469
        </listitem>
380
470
      </varlistentry>
381
471
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
472
        <term><filename>/var/run/mandos.pid</filename></term>
383
473
        <listitem>
384
474
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
475
            The file containing the process id of the
 
476
            <command>&COMMANDNAME;</command> process started last.
387
477
          </para>
388
478
        </listitem>
389
479
      </varlistentry>
390
480
      <varlistentry>
391
 
        <term><filename>/dev/log</filename></term>
 
481
        <term><filename class="devicefile">/dev/log</filename></term>
392
482
        <listitem>
393
483
          <para>
394
484
            The Unix domain socket to where local syslog messages are
417
507
      backtrace.  This could be considered a feature.
418
508
    </para>
419
509
    <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.
 
510
      Currently, if a client is disabled due to having timed out, the
 
511
      server does not record this fact onto permanent storage.  This
 
512
      has some security implications, see <xref linkend="clients"/>.
429
513
    </para>
430
514
    <para>
431
515
      There is no fine-grained control over logging and debug output.
434
518
      Debug mode is conflated with running in the foreground.
435
519
    </para>
436
520
    <para>
437
 
      The console log messages does not show a timestamp.
438
 
    </para>
439
 
    <para>
440
521
      This server does not check the expire time of clients’ OpenPGP
441
522
      keys.
442
523
    </para>
479
560
      </para>
480
561
    </informalexample>
481
562
  </refsect1>
482
 
 
 
563
  
483
564
  <refsect1 id="security">
484
565
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
566
    <refsect2 id="server">
486
567
      <title>SERVER</title>
487
568
      <para>
488
569
        Running this <command>&COMMANDNAME;</command> server program
489
570
        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.
 
571
        computer running it.  The program switches to a non-root user
 
572
        soon after startup.
492
573
      </para>
493
574
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
575
    <refsect2 id="clients">
495
576
      <title>CLIENTS</title>
496
577
      <para>
497
578
        The server only gives out its stored data to clients which
504
585
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
586
        <manvolnum>5</manvolnum></citerefentry>)
506
587
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
588
        except the user starting the server (usually root).
508
589
      </para>
509
590
      <para>
510
591
        As detailed in <xref linkend="checking"/>, the status of all
513
594
      </para>
514
595
      <para>
515
596
        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 <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.
 
597
        by the server which would therefore disable the client.  But
 
598
        if the server was ever restarted, it would re-read its client
 
599
        list from its configuration file and again regard all clients
 
600
        therein as enabled, and hence eligible to receive their
 
601
        passwords.  Therefore, be careful when restarting servers if
 
602
        it is suspected that a client has, in fact, been compromised
 
603
        by parties who may now be running a fake Mandos client with
 
604
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
605
        image of the client host.  What should be done in that case
 
606
        (if restarting the server program really is necessary) is to
 
607
        stop the server program, edit the configuration file to omit
 
608
        any suspect clients, and restart the server program.
529
609
      </para>
530
610
      <para>
531
611
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
612
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
613
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
614
      </para>
535
615
    </refsect2>
536
616
  </refsect1>
537
 
 
 
617
  
538
618
  <refsect1 id="see_also">
539
619
    <title>SEE ALSO</title>
540
620
    <para>
541
 
      <citerefentry>
542
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
543
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>mandos.conf</refentrytitle>
545
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
546
 
        <refentrytitle>password-request</refentrytitle>
547
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
549
 
      </citerefentry>
 
621
      <citerefentry><refentrytitle>intro</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
624
      <manvolnum>5</manvolnum></citerefentry>,
 
625
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
626
      <manvolnum>5</manvolnum></citerefentry>,
 
627
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>sh</refentrytitle>
 
630
      <manvolnum>1</manvolnum></citerefentry>
550
631
    </para>
551
632
    <variablelist>
552
633
      <varlistentry>