/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-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

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-10-22">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-06">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </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
 
      <sbr/>
98
 
      <arg><option>--no-restore</option></arg>
99
86
    </cmdsynopsis>
100
87
    <cmdsynopsis>
101
88
      <command>&COMMANDNAME;</command>
113
100
      <arg choice="plain"><option>--check</option></arg>
114
101
    </cmdsynopsis>
115
102
  </refsynopsisdiv>
116
 
  
 
103
 
117
104
  <refsect1 id="description">
118
105
    <title>DESCRIPTION</title>
119
106
    <para>
120
107
      <command>&COMMANDNAME;</command> is a server daemon which
121
108
      handles incoming request for passwords for a pre-defined list of
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.
 
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.
132
117
    </para>
133
118
  </refsect1>
134
119
  
201
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
202
187
        </listitem>
203
188
      </varlistentry>
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
 
      
 
189
 
223
190
      <varlistentry>
224
191
        <term><option>--priority <replaceable>
225
192
        PRIORITY</replaceable></option></term>
227
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
228
195
        </listitem>
229
196
      </varlistentry>
230
 
      
 
197
 
231
198
      <varlistentry>
232
199
        <term><option>--servicename
233
200
        <replaceable>NAME</replaceable></option></term>
236
203
                      xpointer="servicename"/>
237
204
        </listitem>
238
205
      </varlistentry>
239
 
      
 
206
 
240
207
      <varlistentry>
241
208
        <term><option>--configdir
242
209
        <replaceable>DIRECTORY</replaceable></option></term>
251
218
          </para>
252
219
        </listitem>
253
220
      </varlistentry>
254
 
      
 
221
 
255
222
      <varlistentry>
256
223
        <term><option>--version</option></term>
257
224
        <listitem>
260
227
          </para>
261
228
        </listitem>
262
229
      </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>
287
230
    </variablelist>
288
231
  </refsect1>
289
 
  
 
232
 
290
233
  <refsect1 id="overview">
291
234
    <title>OVERVIEW</title>
292
235
    <xi:include href="overview.xml"/>
296
239
      <acronym>RAM</acronym> disk environment.
297
240
    </para>
298
241
  </refsect1>
299
 
  
 
242
 
300
243
  <refsect1 id="protocol">
301
244
    <title>NETWORK PROTOCOL</title>
302
245
    <para>
354
297
      </row>
355
298
    </tbody></tgroup></table>
356
299
  </refsect1>
357
 
  
 
300
 
358
301
  <refsect1 id="checking">
359
302
    <title>CHECKING</title>
360
303
    <para>
361
304
      The server will, by default, continually check that the clients
362
305
      are still up.  If a client has not been confirmed as being up
363
306
      for some time, the client is assumed to be compromised and is no
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>
 
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>
382
310
      <refentrytitle>mandos-clients.conf</refentrytitle>
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
 
    
 
311
      <manvolnum>5</manvolnum></citerefentry>.
 
312
    </para>
393
313
  </refsect1>
394
 
  
 
314
 
395
315
  <refsect1 id="logging">
396
316
    <title>LOGGING</title>
397
317
    <para>
401
321
      and also show them on the console.
402
322
    </para>
403
323
  </refsect1>
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
 
  
 
324
 
415
325
  <refsect1 id="exit_status">
416
326
    <title>EXIT STATUS</title>
417
327
    <para>
419
329
      critical error is encountered.
420
330
    </para>
421
331
  </refsect1>
422
 
  
 
332
 
423
333
  <refsect1 id="environment">
424
334
    <title>ENVIRONMENT</title>
425
335
    <variablelist>
439
349
      </varlistentry>
440
350
    </variablelist>
441
351
  </refsect1>
442
 
  
443
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
444
354
    <title>FILES</title>
445
355
    <para>
446
356
      Use the <option>--configdir</option> option to change where
472
382
        <term><filename>/var/run/mandos.pid</filename></term>
473
383
        <listitem>
474
384
          <para>
475
 
            The file containing the process id of the
476
 
            <command>&COMMANDNAME;</command> process started last.
 
385
            The file containing the process id of
 
386
            <command>&COMMANDNAME;</command>.
477
387
          </para>
478
388
        </listitem>
479
389
      </varlistentry>
507
417
      backtrace.  This could be considered a feature.
508
418
    </para>
509
419
    <para>
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"/>.
 
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.
513
429
    </para>
514
430
    <para>
515
431
      There is no fine-grained control over logging and debug output.
518
434
      Debug mode is conflated with running in the foreground.
519
435
    </para>
520
436
    <para>
 
437
      The console log messages does not show a time stamp.
 
438
    </para>
 
439
    <para>
521
440
      This server does not check the expire time of clients’ OpenPGP
522
441
      keys.
523
442
    </para>
560
479
      </para>
561
480
    </informalexample>
562
481
  </refsect1>
563
 
  
 
482
 
564
483
  <refsect1 id="security">
565
484
    <title>SECURITY</title>
566
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
567
486
      <title>SERVER</title>
568
487
      <para>
569
488
        Running this <command>&COMMANDNAME;</command> server program
572
491
        soon after startup.
573
492
      </para>
574
493
    </refsect2>
575
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
576
495
      <title>CLIENTS</title>
577
496
      <para>
578
497
        The server only gives out its stored data to clients which
585
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
586
505
        <manvolnum>5</manvolnum></citerefentry>)
587
506
        <emphasis>must</emphasis> be made non-readable by anyone
588
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
589
508
      </para>
590
509
      <para>
591
510
        As detailed in <xref linkend="checking"/>, the status of all
594
513
      </para>
595
514
      <para>
596
515
        If a client is compromised, its downtime should be duly noted
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.
 
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.
609
529
      </para>
610
530
      <para>
611
531
        For more details on client-side security, see
614
534
      </para>
615
535
    </refsect2>
616
536
  </refsect1>
617
 
  
 
537
 
618
538
  <refsect1 id="see_also">
619
539
    <title>SEE ALSO</title>
620
540
    <para>
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>
 
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>mandos-client</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
631
550
    </para>
632
551
    <variablelist>
633
552
      <varlistentry>