/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2011-08-08">
 
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>
 
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>
86
97
    </cmdsynopsis>
87
98
    <cmdsynopsis>
88
99
      <command>&COMMANDNAME;</command>
100
111
      <arg choice="plain"><option>--check</option></arg>
101
112
    </cmdsynopsis>
102
113
  </refsynopsisdiv>
103
 
 
 
114
  
104
115
  <refsect1 id="description">
105
116
    <title>DESCRIPTION</title>
106
117
    <para>
107
118
      <command>&COMMANDNAME;</command> is a server daemon which
108
119
      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.
 
120
      client host computers. For an introduction, see
 
121
      <citerefentry><refentrytitle>intro</refentrytitle>
 
122
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
123
      uses Zeroconf to announce itself on the local network, and uses
 
124
      TLS to communicate securely with and to authenticate the
 
125
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
126
      use IPv6 link-local addresses, since the clients will probably
 
127
      not have any other addresses configured (see <xref
 
128
      linkend="overview"/>).  Any authenticated client is then given
 
129
      the stored pre-encrypted password for that specific client.
117
130
    </para>
118
131
  </refsect1>
119
132
  
186
199
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
200
        </listitem>
188
201
      </varlistentry>
189
 
 
 
202
      
 
203
      <varlistentry>
 
204
        <term><option>--debuglevel
 
205
        <replaceable>LEVEL</replaceable></option></term>
 
206
        <listitem>
 
207
          <para>
 
208
            Set the debugging log level.
 
209
            <replaceable>LEVEL</replaceable> is a string, one of
 
210
            <quote><literal>CRITICAL</literal></quote>,
 
211
            <quote><literal>ERROR</literal></quote>,
 
212
            <quote><literal>WARNING</literal></quote>,
 
213
            <quote><literal>INFO</literal></quote>, or
 
214
            <quote><literal>DEBUG</literal></quote>, in order of
 
215
            increasing verbosity.  The default level is
 
216
            <quote><literal>WARNING</literal></quote>.
 
217
          </para>
 
218
        </listitem>
 
219
      </varlistentry>
 
220
      
190
221
      <varlistentry>
191
222
        <term><option>--priority <replaceable>
192
223
        PRIORITY</replaceable></option></term>
194
225
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
226
        </listitem>
196
227
      </varlistentry>
197
 
 
 
228
      
198
229
      <varlistentry>
199
230
        <term><option>--servicename
200
231
        <replaceable>NAME</replaceable></option></term>
203
234
                      xpointer="servicename"/>
204
235
        </listitem>
205
236
      </varlistentry>
206
 
 
 
237
      
207
238
      <varlistentry>
208
239
        <term><option>--configdir
209
240
        <replaceable>DIRECTORY</replaceable></option></term>
218
249
          </para>
219
250
        </listitem>
220
251
      </varlistentry>
221
 
 
 
252
      
222
253
      <varlistentry>
223
254
        <term><option>--version</option></term>
224
255
        <listitem>
227
258
          </para>
228
259
        </listitem>
229
260
      </varlistentry>
 
261
      
 
262
      <varlistentry>
 
263
        <term><option>--no-dbus</option></term>
 
264
        <listitem>
 
265
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
266
          <para>
 
267
            See also <xref linkend="dbus_interface"/>.
 
268
          </para>
 
269
        </listitem>
 
270
      </varlistentry>
 
271
      
 
272
      <varlistentry>
 
273
        <term><option>--no-ipv6</option></term>
 
274
        <listitem>
 
275
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
276
        </listitem>
 
277
      </varlistentry>
230
278
    </variablelist>
231
279
  </refsect1>
232
 
 
 
280
  
233
281
  <refsect1 id="overview">
234
282
    <title>OVERVIEW</title>
235
283
    <xi:include href="overview.xml"/>
239
287
      <acronym>RAM</acronym> disk environment.
240
288
    </para>
241
289
  </refsect1>
242
 
 
 
290
  
243
291
  <refsect1 id="protocol">
244
292
    <title>NETWORK PROTOCOL</title>
245
293
    <para>
297
345
      </row>
298
346
    </tbody></tgroup></table>
299
347
  </refsect1>
300
 
 
 
348
  
301
349
  <refsect1 id="checking">
302
350
    <title>CHECKING</title>
303
351
    <para>
304
352
      The server will, by default, continually check that the clients
305
353
      are still up.  If a client has not been confirmed as being up
306
354
      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>
 
355
      longer eligible to receive the encrypted password.  (Manual
 
356
      intervention is required to re-enable a client.)  The timeout,
 
357
      extended timeout, checker program, and interval between checks
 
358
      can be configured both globally and per client; see
 
359
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
360
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
361
      receiving its password will also be treated as a successful
 
362
      checker run.
 
363
    </para>
 
364
  </refsect1>
 
365
  
 
366
  <refsect1 id="approval">
 
367
    <title>APPROVAL</title>
 
368
    <para>
 
369
      The server can be configured to require manual approval for a
 
370
      client before it is sent its secret.  The delay to wait for such
 
371
      approval and the default action (approve or deny) can be
 
372
      configured both globally and per client; see <citerefentry>
310
373
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
374
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
375
      will be approved immediately without delay.
 
376
    </para>
 
377
    <para>
 
378
      This can be used to deny a client its secret if not manually
 
379
      approved within a specified time.  It can also be used to make
 
380
      the server delay before giving a client its secret, allowing
 
381
      optional manual denying of this specific client.
 
382
    </para>
 
383
    
313
384
  </refsect1>
314
 
 
 
385
  
315
386
  <refsect1 id="logging">
316
387
    <title>LOGGING</title>
317
388
    <para>
321
392
      and also show them on the console.
322
393
    </para>
323
394
  </refsect1>
324
 
 
 
395
  
 
396
  <refsect1 id="dbus_interface">
 
397
    <title>D-BUS INTERFACE</title>
 
398
    <para>
 
399
      The server will by default provide a D-Bus system bus interface.
 
400
      This interface will only be accessible by the root user or a
 
401
      Mandos-specific user, if such a user exists.  For documentation
 
402
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
403
    </para>
 
404
  </refsect1>
 
405
  
325
406
  <refsect1 id="exit_status">
326
407
    <title>EXIT STATUS</title>
327
408
    <para>
329
410
      critical error is encountered.
330
411
    </para>
331
412
  </refsect1>
332
 
 
 
413
  
333
414
  <refsect1 id="environment">
334
415
    <title>ENVIRONMENT</title>
335
416
    <variablelist>
349
430
      </varlistentry>
350
431
    </variablelist>
351
432
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
433
  
 
434
  <refsect1 id="files">
354
435
    <title>FILES</title>
355
436
    <para>
356
437
      Use the <option>--configdir</option> option to change where
379
460
        </listitem>
380
461
      </varlistentry>
381
462
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
 
463
        <term><filename>/var/run/mandos.pid</filename></term>
383
464
        <listitem>
384
465
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
466
            The file containing the process id of the
 
467
            <command>&COMMANDNAME;</command> process started last.
387
468
          </para>
388
469
        </listitem>
389
470
      </varlistentry>
417
498
      backtrace.  This could be considered a feature.
418
499
    </para>
419
500
    <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.
 
501
      Currently, if a client is disabled due to having timed out, the
 
502
      server does not record this fact onto permanent storage.  This
 
503
      has some security implications, see <xref linkend="clients"/>.
429
504
    </para>
430
505
    <para>
431
506
      There is no fine-grained control over logging and debug output.
434
509
      Debug mode is conflated with running in the foreground.
435
510
    </para>
436
511
    <para>
437
 
      The console log messages does not show a timestamp.
 
512
      The console log messages do not show a time stamp.
 
513
    </para>
 
514
    <para>
 
515
      This server does not check the expire time of clients’ OpenPGP
 
516
      keys.
438
517
    </para>
439
518
  </refsect1>
440
519
  
475
554
      </para>
476
555
    </informalexample>
477
556
  </refsect1>
478
 
 
 
557
  
479
558
  <refsect1 id="security">
480
559
    <title>SECURITY</title>
481
 
    <refsect2 id="SERVER">
 
560
    <refsect2 id="server">
482
561
      <title>SERVER</title>
483
562
      <para>
484
563
        Running this <command>&COMMANDNAME;</command> server program
485
564
        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.
 
565
        computer running it.  The program switches to a non-root user
 
566
        soon after startup.
488
567
      </para>
489
568
    </refsect2>
490
 
    <refsect2 id="CLIENTS">
 
569
    <refsect2 id="clients">
491
570
      <title>CLIENTS</title>
492
571
      <para>
493
572
        The server only gives out its stored data to clients which
500
579
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
580
        <manvolnum>5</manvolnum></citerefentry>)
502
581
        <emphasis>must</emphasis> be made non-readable by anyone
503
 
        except the user running the server.
 
582
        except the user starting the server (usually root).
504
583
      </para>
505
584
      <para>
506
585
        As detailed in <xref linkend="checking"/>, the status of all
509
588
      </para>
510
589
      <para>
511
590
        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.
 
591
        by the server which would therefore disable the client.  But
 
592
        if the server was ever restarted, it would re-read its client
 
593
        list from its configuration file and again regard all clients
 
594
        therein as enabled, and hence eligible to receive their
 
595
        passwords.  Therefore, be careful when restarting servers if
 
596
        it is suspected that a client has, in fact, been compromised
 
597
        by parties who may now be running a fake Mandos client with
 
598
        the keys from the non-encrypted initial <acronym>RAM</acronym>
 
599
        image of the client host.  What should be done in that case
 
600
        (if restarting the server program really is necessary) is to
 
601
        stop the server program, edit the configuration file to omit
 
602
        any suspect clients, and restart the server program.
525
603
      </para>
526
604
      <para>
527
605
        For more details on client-side security, see
528
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
606
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
529
607
        <manvolnum>8mandos</manvolnum></citerefentry>.
530
608
      </para>
531
609
    </refsect2>
532
610
  </refsect1>
533
 
 
 
611
  
534
612
  <refsect1 id="see_also">
535
613
    <title>SEE ALSO</title>
536
614
    <para>
537
 
      <citerefentry>
538
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
539
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
540
 
        <refentrytitle>mandos.conf</refentrytitle>
541
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
542
 
        <refentrytitle>password-request</refentrytitle>
543
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
544
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
545
 
      </citerefentry>
 
615
      <citerefentry><refentrytitle>intro</refentrytitle>
 
616
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
617
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
618
      <manvolnum>5</manvolnum></citerefentry>,
 
619
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
620
      <manvolnum>5</manvolnum></citerefentry>,
 
621
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
622
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
623
      <citerefentry><refentrytitle>sh</refentrytitle>
 
624
      <manvolnum>1</manvolnum></citerefentry>
546
625
    </para>
547
626
    <variablelist>
548
627
      <varlistentry>