/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

Merge some small changes.

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-05">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
 
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>
 
99
      <sbr/>
 
100
      <arg><option>--statedir
 
101
      <replaceable>DIRECTORY</replaceable></option></arg>
86
102
    </cmdsynopsis>
87
103
    <cmdsynopsis>
88
104
      <command>&COMMANDNAME;</command>
100
116
      <arg choice="plain"><option>--check</option></arg>
101
117
    </cmdsynopsis>
102
118
  </refsynopsisdiv>
103
 
 
 
119
  
104
120
  <refsect1 id="description">
105
121
    <title>DESCRIPTION</title>
106
122
    <para>
107
123
      <command>&COMMANDNAME;</command> is a server daemon which
108
124
      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.
 
125
      client host computers. For an introduction, see
 
126
      <citerefentry><refentrytitle>intro</refentrytitle>
 
127
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
 
128
      uses Zeroconf to announce itself on the local network, and uses
 
129
      TLS to communicate securely with and to authenticate the
 
130
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
 
131
      use IPv6 link-local addresses, since the clients will probably
 
132
      not have any other addresses configured (see <xref
 
133
      linkend="overview"/>).  Any authenticated client is then given
 
134
      the stored pre-encrypted password for that specific client.
117
135
    </para>
118
136
  </refsect1>
119
137
  
186
204
          <xi:include href="mandos-options.xml" xpointer="debug"/>
187
205
        </listitem>
188
206
      </varlistentry>
189
 
 
 
207
      
 
208
      <varlistentry>
 
209
        <term><option>--debuglevel
 
210
        <replaceable>LEVEL</replaceable></option></term>
 
211
        <listitem>
 
212
          <para>
 
213
            Set the debugging log level.
 
214
            <replaceable>LEVEL</replaceable> is a string, one of
 
215
            <quote><literal>CRITICAL</literal></quote>,
 
216
            <quote><literal>ERROR</literal></quote>,
 
217
            <quote><literal>WARNING</literal></quote>,
 
218
            <quote><literal>INFO</literal></quote>, or
 
219
            <quote><literal>DEBUG</literal></quote>, in order of
 
220
            increasing verbosity.  The default level is
 
221
            <quote><literal>WARNING</literal></quote>.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
      
190
226
      <varlistentry>
191
227
        <term><option>--priority <replaceable>
192
228
        PRIORITY</replaceable></option></term>
194
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
195
231
        </listitem>
196
232
      </varlistentry>
197
 
 
 
233
      
198
234
      <varlistentry>
199
235
        <term><option>--servicename
200
236
        <replaceable>NAME</replaceable></option></term>
203
239
                      xpointer="servicename"/>
204
240
        </listitem>
205
241
      </varlistentry>
206
 
 
 
242
      
207
243
      <varlistentry>
208
244
        <term><option>--configdir
209
245
        <replaceable>DIRECTORY</replaceable></option></term>
218
254
          </para>
219
255
        </listitem>
220
256
      </varlistentry>
221
 
 
 
257
      
222
258
      <varlistentry>
223
259
        <term><option>--version</option></term>
224
260
        <listitem>
227
263
          </para>
228
264
        </listitem>
229
265
      </varlistentry>
 
266
      
 
267
      <varlistentry>
 
268
        <term><option>--no-dbus</option></term>
 
269
        <listitem>
 
270
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
271
          <para>
 
272
            See also <xref linkend="dbus_interface"/>.
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
      
 
277
      <varlistentry>
 
278
        <term><option>--no-ipv6</option></term>
 
279
        <listitem>
 
280
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
281
        </listitem>
 
282
      </varlistentry>
 
283
      
 
284
      <varlistentry>
 
285
        <term><option>--no-restore</option></term>
 
286
        <listitem>
 
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
288
        </listitem>
 
289
      </varlistentry>
 
290
      
 
291
      <varlistentry>
 
292
        <term><option>--statedir
 
293
        <replaceable>DIRECTORY</replaceable></option></term>
 
294
        <listitem>
 
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
296
        </listitem>
 
297
      </varlistentry>
230
298
    </variablelist>
231
299
  </refsect1>
232
 
 
 
300
  
233
301
  <refsect1 id="overview">
234
302
    <title>OVERVIEW</title>
235
303
    <xi:include href="overview.xml"/>
239
307
      <acronym>RAM</acronym> disk environment.
240
308
    </para>
241
309
  </refsect1>
242
 
 
 
310
  
243
311
  <refsect1 id="protocol">
244
312
    <title>NETWORK PROTOCOL</title>
245
313
    <para>
297
365
      </row>
298
366
    </tbody></tgroup></table>
299
367
  </refsect1>
300
 
 
 
368
  
301
369
  <refsect1 id="checking">
302
370
    <title>CHECKING</title>
303
371
    <para>
304
372
      The server will, by default, continually check that the clients
305
373
      are still up.  If a client has not been confirmed as being up
306
374
      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>
 
375
      longer eligible to receive the encrypted password.  (Manual
 
376
      intervention is required to re-enable a client.)  The timeout,
 
377
      extended timeout, checker program, and interval between checks
 
378
      can be configured both globally and per client; see
 
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
 
383
    </para>
 
384
  </refsect1>
 
385
  
 
386
  <refsect1 id="approval">
 
387
    <title>APPROVAL</title>
 
388
    <para>
 
389
      The server can be configured to require manual approval for a
 
390
      client before it is sent its secret.  The delay to wait for such
 
391
      approval and the default action (approve or deny) can be
 
392
      configured both globally and per client; see <citerefentry>
310
393
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
394
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
395
      will be approved immediately without delay.
 
396
    </para>
 
397
    <para>
 
398
      This can be used to deny a client its secret if not manually
 
399
      approved within a specified time.  It can also be used to make
 
400
      the server delay before giving a client its secret, allowing
 
401
      optional manual denying of this specific client.
 
402
    </para>
 
403
    
313
404
  </refsect1>
314
 
 
 
405
  
315
406
  <refsect1 id="logging">
316
407
    <title>LOGGING</title>
317
408
    <para>
318
409
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
410
      <filename class="devicefile">/dev/log</filename>.  With the
320
411
      <option>--debug</option> option, it will log even more messages,
321
412
      and also show them on the console.
322
413
    </para>
323
414
  </refsect1>
324
 
 
 
415
  
 
416
  <refsect1 id="dbus_interface">
 
417
    <title>D-BUS INTERFACE</title>
 
418
    <para>
 
419
      The server will by default provide a D-Bus system bus interface.
 
420
      This interface will only be accessible by the root user or a
 
421
      Mandos-specific user, if such a user exists.  For documentation
 
422
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
423
    </para>
 
424
  </refsect1>
 
425
  
325
426
  <refsect1 id="exit_status">
326
427
    <title>EXIT STATUS</title>
327
428
    <para>
329
430
      critical error is encountered.
330
431
    </para>
331
432
  </refsect1>
332
 
 
 
433
  
333
434
  <refsect1 id="environment">
334
435
    <title>ENVIRONMENT</title>
335
436
    <variablelist>
349
450
      </varlistentry>
350
451
    </variablelist>
351
452
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
453
  
 
454
  <refsect1 id="files">
354
455
    <title>FILES</title>
355
456
    <para>
356
457
      Use the <option>--configdir</option> option to change where
382
483
        <term><filename>/var/run/mandos.pid</filename></term>
383
484
        <listitem>
384
485
          <para>
385
 
            The file containing the process id of
386
 
            <command>&COMMANDNAME;</command>.
 
486
            The file containing the process id of the
 
487
            <command>&COMMANDNAME;</command> process started last.
 
488
          </para>
 
489
        </listitem>
 
490
      </varlistentry>
 
491
      <varlistentry>
 
492
        <term><filename class="devicefile">/dev/log</filename></term>
 
493
      </varlistentry>
 
494
      <varlistentry>
 
495
        <term><filename
 
496
        class="directory">/var/lib/mandos</filename></term>
 
497
        <listitem>
 
498
          <para>
 
499
            Directory where persistent state will be saved.  Change
 
500
            this with the <option>--statedir</option> option.  See
 
501
            also the <option>--no-restore</option> option.
387
502
          </para>
388
503
        </listitem>
389
504
      </varlistentry>
417
532
      backtrace.  This could be considered a feature.
418
533
    </para>
419
534
    <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
535
      There is no fine-grained control over logging and debug output.
432
536
    </para>
433
537
    <para>
434
538
      Debug mode is conflated with running in the foreground.
435
539
    </para>
436
540
    <para>
437
 
      The console log messages does not show a time stamp.
438
 
    </para>
439
 
    <para>
440
541
      This server does not check the expire time of clients’ OpenPGP
441
542
      keys.
442
543
    </para>
455
556
    <informalexample>
456
557
      <para>
457
558
        Run the server in debug mode, read configuration files from
458
 
        the <filename>~/mandos</filename> directory, and use the
459
 
        Zeroconf service name <quote>Test</quote> to not collide with
460
 
        any other official Mandos server on this host:
 
559
        the <filename class="directory">~/mandos</filename> directory,
 
560
        and use the Zeroconf service name <quote>Test</quote> to not
 
561
        collide with any other official Mandos server on this host:
461
562
      </para>
462
563
      <para>
463
564
 
479
580
      </para>
480
581
    </informalexample>
481
582
  </refsect1>
482
 
 
 
583
  
483
584
  <refsect1 id="security">
484
585
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
586
    <refsect2 id="server">
486
587
      <title>SERVER</title>
487
588
      <para>
488
589
        Running this <command>&COMMANDNAME;</command> server program
491
592
        soon after startup.
492
593
      </para>
493
594
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
595
    <refsect2 id="clients">
495
596
      <title>CLIENTS</title>
496
597
      <para>
497
598
        The server only gives out its stored data to clients which
504
605
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
606
        <manvolnum>5</manvolnum></citerefentry>)
506
607
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
608
        except the user starting the server (usually root).
508
609
      </para>
509
610
      <para>
510
611
        As detailed in <xref linkend="checking"/>, the status of all
512
613
        compromised if they are gone for too long.
513
614
      </para>
514
615
      <para>
515
 
        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.
529
 
      </para>
530
 
      <para>
531
616
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
617
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
618
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
619
      </para>
535
620
    </refsect2>
536
621
  </refsect1>
537
 
 
 
622
  
538
623
  <refsect1 id="see_also">
539
624
    <title>SEE ALSO</title>
540
625
    <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>
 
626
      <citerefentry><refentrytitle>intro</refentrytitle>
 
627
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
628
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
629
      <manvolnum>5</manvolnum></citerefentry>,
 
630
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
631
      <manvolnum>5</manvolnum></citerefentry>,
 
632
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
633
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
634
      <citerefentry><refentrytitle>sh</refentrytitle>
 
635
      <manvolnum>1</manvolnum></citerefentry>
550
636
    </para>
551
637
    <variablelist>
552
638
      <varlistentry>