/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.xml

* debian/rules (binary-common): Exclude network-hooks.d from
                                dh_fixperms.
* mandos (DBusObjectWithProperties.Set): Bug fix: handle byte arrays.
* mandos-clients.conf.xml (DESCRIPTION): Add reference to persistent
                                         state.
* mandos-options.xml (restore): Adjust wording slightly.
* mandos.xml (OPTIONS/--no-restore): Refer to "PERSISTENT STATE"
                                     section.
  (PERSISTENT STATE): New section.

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 "2012-01-01">
 
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>
 
38
      <year>2012</year>
34
39
      <holder>Teddy Hogeborn</holder>
35
40
      <holder>Björn Påhlsson</holder>
36
41
    </copyright>
37
42
    <xi:include href="legalnotice.xml"/>
38
43
  </refentryinfo>
39
 
 
 
44
  
40
45
  <refmeta>
41
46
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
47
    <manvolnum>8</manvolnum>
48
53
      Gives encrypted passwords to authenticated Mandos clients
49
54
    </refpurpose>
50
55
  </refnamediv>
51
 
 
 
56
  
52
57
  <refsynopsisdiv>
53
58
    <cmdsynopsis>
54
59
      <command>&COMMANDNAME;</command>
83
88
      <replaceable>DIRECTORY</replaceable></option></arg>
84
89
      <sbr/>
85
90
      <arg><option>--debug</option></arg>
 
91
      <sbr/>
 
92
      <arg><option>--debuglevel
 
93
      <replaceable>LEVEL</replaceable></option></arg>
 
94
      <sbr/>
 
95
      <arg><option>--no-dbus</option></arg>
 
96
      <sbr/>
 
97
      <arg><option>--no-ipv6</option></arg>
 
98
      <sbr/>
 
99
      <arg><option>--no-restore</option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--statedir
 
102
      <replaceable>DIRECTORY</replaceable></option></arg>
86
103
    </cmdsynopsis>
87
104
    <cmdsynopsis>
88
105
      <command>&COMMANDNAME;</command>
100
117
      <arg choice="plain"><option>--check</option></arg>
101
118
    </cmdsynopsis>
102
119
  </refsynopsisdiv>
103
 
 
 
120
  
104
121
  <refsect1 id="description">
105
122
    <title>DESCRIPTION</title>
106
123
    <para>
107
124
      <command>&COMMANDNAME;</command> is a server daemon which
108
125
      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.
 
126
      client host computers. For an introduction, see
 
127
      <citerefentry><refentrytitle>intro</refentrytitle>
 
128
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
129
      uses Zeroconf to announce itself on the local network, and uses
 
130
      TLS to communicate securely with and to authenticate the
 
131
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
132
      use IPv6 link-local addresses, since the clients will probably
 
133
      not have any other addresses configured (see <xref
 
134
      linkend="overview"/>).  Any authenticated client is then given
 
135
      the stored pre-encrypted password for that specific client.
117
136
    </para>
118
137
  </refsect1>
119
138
  
186
205
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
206
        </listitem>
188
207
      </varlistentry>
189
 
 
 
208
      
 
209
      <varlistentry>
 
210
        <term><option>--debuglevel
 
211
        <replaceable>LEVEL</replaceable></option></term>
 
212
        <listitem>
 
213
          <para>
 
214
            Set the debugging log level.
 
215
            <replaceable>LEVEL</replaceable> is a string, one of
 
216
            <quote><literal>CRITICAL</literal></quote>,
 
217
            <quote><literal>ERROR</literal></quote>,
 
218
            <quote><literal>WARNING</literal></quote>,
 
219
            <quote><literal>INFO</literal></quote>, or
 
220
            <quote><literal>DEBUG</literal></quote>, in order of
 
221
            increasing verbosity.  The default level is
 
222
            <quote><literal>WARNING</literal></quote>.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
      
190
227
      <varlistentry>
191
228
        <term><option>--priority <replaceable>
192
229
        PRIORITY</replaceable></option></term>
194
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
232
        </listitem>
196
233
      </varlistentry>
197
 
 
 
234
      
198
235
      <varlistentry>
199
236
        <term><option>--servicename
200
237
        <replaceable>NAME</replaceable></option></term>
203
240
                      xpointer="servicename"/>
204
241
        </listitem>
205
242
      </varlistentry>
206
 
 
 
243
      
207
244
      <varlistentry>
208
245
        <term><option>--configdir
209
246
        <replaceable>DIRECTORY</replaceable></option></term>
218
255
          </para>
219
256
        </listitem>
220
257
      </varlistentry>
221
 
 
 
258
      
222
259
      <varlistentry>
223
260
        <term><option>--version</option></term>
224
261
        <listitem>
227
264
          </para>
228
265
        </listitem>
229
266
      </varlistentry>
 
267
      
 
268
      <varlistentry>
 
269
        <term><option>--no-dbus</option></term>
 
270
        <listitem>
 
271
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
272
          <para>
 
273
            See also <xref linkend="dbus_interface"/>.
 
274
          </para>
 
275
        </listitem>
 
276
      </varlistentry>
 
277
      
 
278
      <varlistentry>
 
279
        <term><option>--no-ipv6</option></term>
 
280
        <listitem>
 
281
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
      
 
285
      <varlistentry>
 
286
        <term><option>--no-restore</option></term>
 
287
        <listitem>
 
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
289
          <para>
 
290
            See also <xref linkend="persistent_state"/>.
 
291
          </para>
 
292
        </listitem>
 
293
      </varlistentry>
 
294
      
 
295
      <varlistentry>
 
296
        <term><option>--statedir
 
297
        <replaceable>DIRECTORY</replaceable></option></term>
 
298
        <listitem>
 
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
300
        </listitem>
 
301
      </varlistentry>
230
302
    </variablelist>
231
303
  </refsect1>
232
 
 
 
304
  
233
305
  <refsect1 id="overview">
234
306
    <title>OVERVIEW</title>
235
307
    <xi:include href="overview.xml"/>
239
311
      <acronym>RAM</acronym> disk environment.
240
312
    </para>
241
313
  </refsect1>
242
 
 
 
314
  
243
315
  <refsect1 id="protocol">
244
316
    <title>NETWORK PROTOCOL</title>
245
317
    <para>
297
369
      </row>
298
370
    </tbody></tgroup></table>
299
371
  </refsect1>
300
 
 
 
372
  
301
373
  <refsect1 id="checking">
302
374
    <title>CHECKING</title>
303
375
    <para>
304
376
      The server will, by default, continually check that the clients
305
377
      are still up.  If a client has not been confirmed as being up
306
378
      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>
 
379
      longer eligible to receive the encrypted password.  (Manual
 
380
      intervention is required to re-enable a client.)  The timeout,
 
381
      extended timeout, checker program, and interval between checks
 
382
      can be configured both globally and per client; see
 
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
384
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
385
      receiving its password will also be treated as a successful
 
386
      checker run.
 
387
    </para>
 
388
  </refsect1>
 
389
  
 
390
  <refsect1 id="approval">
 
391
    <title>APPROVAL</title>
 
392
    <para>
 
393
      The server can be configured to require manual approval for a
 
394
      client before it is sent its secret.  The delay to wait for such
 
395
      approval and the default action (approve or deny) can be
 
396
      configured both globally and per client; see <citerefentry>
310
397
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
398
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
399
      will be approved immediately without delay.
 
400
    </para>
 
401
    <para>
 
402
      This can be used to deny a client its secret if not manually
 
403
      approved within a specified time.  It can also be used to make
 
404
      the server delay before giving a client its secret, allowing
 
405
      optional manual denying of this specific client.
 
406
    </para>
 
407
    
313
408
  </refsect1>
314
 
 
 
409
  
315
410
  <refsect1 id="logging">
316
411
    <title>LOGGING</title>
317
412
    <para>
318
413
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
414
      <filename class="devicefile">/dev/log</filename>.  With the
320
415
      <option>--debug</option> option, it will log even more messages,
321
416
      and also show them on the console.
322
417
    </para>
323
418
  </refsect1>
324
 
 
 
419
  
 
420
  <refsect1 id="persistent_state">
 
421
    <title>PERSISTENT STATE</title>
 
422
    <para>
 
423
      Client settings, initially read from
 
424
      <filename>clients.conf</filename>, are persistent across
 
425
      restarts, and run-time changes will override settings in
 
426
      <filename>clients.conf</filename>.  However, if a setting is
 
427
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
428
      <filename>clients.conf</filename>, this will take precedence.
 
429
    </para>
 
430
  </refsect1>
 
431
  
 
432
  <refsect1 id="dbus_interface">
 
433
    <title>D-BUS INTERFACE</title>
 
434
    <para>
 
435
      The server will by default provide a D-Bus system bus interface.
 
436
      This interface will only be accessible by the root user or a
 
437
      Mandos-specific user, if such a user exists.  For documentation
 
438
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
439
    </para>
 
440
  </refsect1>
 
441
  
325
442
  <refsect1 id="exit_status">
326
443
    <title>EXIT STATUS</title>
327
444
    <para>
329
446
      critical error is encountered.
330
447
    </para>
331
448
  </refsect1>
332
 
 
 
449
  
333
450
  <refsect1 id="environment">
334
451
    <title>ENVIRONMENT</title>
335
452
    <variablelist>
349
466
      </varlistentry>
350
467
    </variablelist>
351
468
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
469
  
 
470
  <refsect1 id="files">
354
471
    <title>FILES</title>
355
472
    <para>
356
473
      Use the <option>--configdir</option> option to change where
379
496
        </listitem>
380
497
      </varlistentry>
381
498
      <varlistentry>
382
 
        <term><filename>/var/run/mandos/mandos.pid</filename></term>
383
 
        <listitem>
384
 
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
499
        <term><filename>/var/run/mandos.pid</filename></term>
 
500
        <listitem>
 
501
          <para>
 
502
            The file containing the process id of the
 
503
            <command>&COMMANDNAME;</command> process started last.
 
504
          </para>
 
505
        </listitem>
 
506
      </varlistentry>
 
507
      <varlistentry>
 
508
        <term><filename class="devicefile">/dev/log</filename></term>
 
509
      </varlistentry>
 
510
      <varlistentry>
 
511
        <term><filename
 
512
        class="directory">/var/lib/mandos</filename></term>
 
513
        <listitem>
 
514
          <para>
 
515
            Directory where persistent state will be saved.  Change
 
516
            this with the <option>--statedir</option> option.  See
 
517
            also the <option>--no-restore</option> option.
387
518
          </para>
388
519
        </listitem>
389
520
      </varlistentry>
417
548
      backtrace.  This could be considered a feature.
418
549
    </para>
419
550
    <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.
429
 
    </para>
430
 
    <para>
431
551
      There is no fine-grained control over logging and debug output.
432
552
    </para>
433
553
    <para>
434
554
      Debug mode is conflated with running in the foreground.
435
555
    </para>
436
556
    <para>
437
 
      The console log messages does not show a timestamp.
 
557
      This server does not check the expire time of clients’ OpenPGP
 
558
      keys.
438
559
    </para>
439
560
  </refsect1>
440
561
  
451
572
    <informalexample>
452
573
      <para>
453
574
        Run the server in debug mode, read configuration files from
454
 
        the <filename>~/mandos</filename> directory, and use the
455
 
        Zeroconf service name <quote>Test</quote> to not collide with
456
 
        any other official Mandos server on this host:
 
575
        the <filename class="directory">~/mandos</filename> directory,
 
576
        and use the Zeroconf service name <quote>Test</quote> to not
 
577
        collide with any other official Mandos server on this host:
457
578
      </para>
458
579
      <para>
459
580
 
475
596
      </para>
476
597
    </informalexample>
477
598
  </refsect1>
478
 
 
 
599
  
479
600
  <refsect1 id="security">
480
601
    <title>SECURITY</title>
481
 
    <refsect2 id="SERVER">
 
602
    <refsect2 id="server">
482
603
      <title>SERVER</title>
483
604
      <para>
484
605
        Running this <command>&COMMANDNAME;</command> server program
485
606
        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.
 
607
        computer running it.  The program switches to a non-root user
 
608
        soon after startup.
488
609
      </para>
489
610
    </refsect2>
490
 
    <refsect2 id="CLIENTS">
 
611
    <refsect2 id="clients">
491
612
      <title>CLIENTS</title>
492
613
      <para>
493
614
        The server only gives out its stored data to clients which
500
621
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
622
        <manvolnum>5</manvolnum></citerefentry>)
502
623
        <emphasis>must</emphasis> be made non-readable by anyone
503
 
        except the user running the server.
 
624
        except the user starting the server (usually root).
504
625
      </para>
505
626
      <para>
506
627
        As detailed in <xref linkend="checking"/>, the status of all
508
629
        compromised if they are gone for too long.
509
630
      </para>
510
631
      <para>
511
 
        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.
525
 
      </para>
526
 
      <para>
527
632
        For more details on client-side security, see
528
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
633
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
529
634
        <manvolnum>8mandos</manvolnum></citerefentry>.
530
635
      </para>
531
636
    </refsect2>
532
637
  </refsect1>
533
 
 
 
638
  
534
639
  <refsect1 id="see_also">
535
640
    <title>SEE ALSO</title>
536
641
    <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>
 
642
      <citerefentry><refentrytitle>intro</refentrytitle>
 
643
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
644
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
645
      <manvolnum>5</manvolnum></citerefentry>,
 
646
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
647
      <manvolnum>5</manvolnum></citerefentry>,
 
648
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
649
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
650
      <citerefentry><refentrytitle>sh</refentrytitle>
 
651
      <manvolnum>1</manvolnum></citerefentry>
546
652
    </para>
547
653
    <variablelist>
548
654
      <varlistentry>