/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: 2011-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

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 "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
        </listitem>
 
290
      </varlistentry>
 
291
      
 
292
      <varlistentry>
 
293
        <term><option>--statedir
 
294
        <replaceable>DIRECTORY</replaceable></option></term>
 
295
        <listitem>
 
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
297
        </listitem>
 
298
      </varlistentry>
230
299
    </variablelist>
231
300
  </refsect1>
232
 
 
 
301
  
233
302
  <refsect1 id="overview">
234
303
    <title>OVERVIEW</title>
235
304
    <xi:include href="overview.xml"/>
239
308
      <acronym>RAM</acronym> disk environment.
240
309
    </para>
241
310
  </refsect1>
242
 
 
 
311
  
243
312
  <refsect1 id="protocol">
244
313
    <title>NETWORK PROTOCOL</title>
245
314
    <para>
297
366
      </row>
298
367
    </tbody></tgroup></table>
299
368
  </refsect1>
300
 
 
 
369
  
301
370
  <refsect1 id="checking">
302
371
    <title>CHECKING</title>
303
372
    <para>
304
373
      The server will, by default, continually check that the clients
305
374
      are still up.  If a client has not been confirmed as being up
306
375
      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>
 
376
      longer eligible to receive the encrypted password.  (Manual
 
377
      intervention is required to re-enable a client.)  The timeout,
 
378
      extended timeout, checker program, and interval between checks
 
379
      can be configured both globally and per client; see
 
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
381
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
382
      receiving its password will also be treated as a successful
 
383
      checker run.
 
384
    </para>
 
385
  </refsect1>
 
386
  
 
387
  <refsect1 id="approval">
 
388
    <title>APPROVAL</title>
 
389
    <para>
 
390
      The server can be configured to require manual approval for a
 
391
      client before it is sent its secret.  The delay to wait for such
 
392
      approval and the default action (approve or deny) can be
 
393
      configured both globally and per client; see <citerefentry>
310
394
      <refentrytitle>mandos-clients.conf</refentrytitle>
311
 
      <manvolnum>5</manvolnum></citerefentry>.
312
 
    </para>
 
395
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
 
396
      will be approved immediately without delay.
 
397
    </para>
 
398
    <para>
 
399
      This can be used to deny a client its secret if not manually
 
400
      approved within a specified time.  It can also be used to make
 
401
      the server delay before giving a client its secret, allowing
 
402
      optional manual denying of this specific client.
 
403
    </para>
 
404
    
313
405
  </refsect1>
314
 
 
 
406
  
315
407
  <refsect1 id="logging">
316
408
    <title>LOGGING</title>
317
409
    <para>
318
410
      The server will send log message with various severity levels to
319
 
      <filename>/dev/log</filename>.  With the
 
411
      <filename class="devicefile">/dev/log</filename>.  With the
320
412
      <option>--debug</option> option, it will log even more messages,
321
413
      and also show them on the console.
322
414
    </para>
323
415
  </refsect1>
324
 
 
 
416
  
 
417
  <refsect1 id="dbus_interface">
 
418
    <title>D-BUS INTERFACE</title>
 
419
    <para>
 
420
      The server will by default provide a D-Bus system bus interface.
 
421
      This interface will only be accessible by the root user or a
 
422
      Mandos-specific user, if such a user exists.  For documentation
 
423
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
 
424
    </para>
 
425
  </refsect1>
 
426
  
325
427
  <refsect1 id="exit_status">
326
428
    <title>EXIT STATUS</title>
327
429
    <para>
329
431
      critical error is encountered.
330
432
    </para>
331
433
  </refsect1>
332
 
 
 
434
  
333
435
  <refsect1 id="environment">
334
436
    <title>ENVIRONMENT</title>
335
437
    <variablelist>
349
451
      </varlistentry>
350
452
    </variablelist>
351
453
  </refsect1>
352
 
 
353
 
  <refsect1 id="file">
 
454
  
 
455
  <refsect1 id="files">
354
456
    <title>FILES</title>
355
457
    <para>
356
458
      Use the <option>--configdir</option> option to change where
379
481
        </listitem>
380
482
      </varlistentry>
381
483
      <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>.
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
 
485
        <listitem>
 
486
          <para>
 
487
            The file containing the process id of the
 
488
            <command>&COMMANDNAME;</command> process started last.
 
489
          </para>
 
490
        </listitem>
 
491
      </varlistentry>
 
492
      <varlistentry>
 
493
        <term><filename class="devicefile">/dev/log</filename></term>
 
494
      </varlistentry>
 
495
      <varlistentry>
 
496
        <term><filename
 
497
        class="directory">/var/lib/mandos</filename></term>
 
498
        <listitem>
 
499
          <para>
 
500
            Directory where persistent state will be saved.  Change
 
501
            this with the <option>--statedir</option> option.  See
 
502
            also the <option>--no-restore</option> option.
387
503
          </para>
388
504
        </listitem>
389
505
      </varlistentry>
417
533
      backtrace.  This could be considered a feature.
418
534
    </para>
419
535
    <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
536
      There is no fine-grained control over logging and debug output.
432
537
    </para>
433
538
    <para>
434
539
      Debug mode is conflated with running in the foreground.
435
540
    </para>
436
541
    <para>
437
 
      The console log messages does not show a timestamp.
438
 
    </para>
439
 
    <para>
440
542
      This server does not check the expire time of clients’ OpenPGP
441
543
      keys.
442
544
    </para>
455
557
    <informalexample>
456
558
      <para>
457
559
        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:
 
560
        the <filename class="directory">~/mandos</filename> directory,
 
561
        and use the Zeroconf service name <quote>Test</quote> to not
 
562
        collide with any other official Mandos server on this host:
461
563
      </para>
462
564
      <para>
463
565
 
479
581
      </para>
480
582
    </informalexample>
481
583
  </refsect1>
482
 
 
 
584
  
483
585
  <refsect1 id="security">
484
586
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
587
    <refsect2 id="server">
486
588
      <title>SERVER</title>
487
589
      <para>
488
590
        Running this <command>&COMMANDNAME;</command> server program
489
591
        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.
 
592
        computer running it.  The program switches to a non-root user
 
593
        soon after startup.
492
594
      </para>
493
595
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
596
    <refsect2 id="clients">
495
597
      <title>CLIENTS</title>
496
598
      <para>
497
599
        The server only gives out its stored data to clients which
504
606
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
607
        <manvolnum>5</manvolnum></citerefentry>)
506
608
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
609
        except the user starting the server (usually root).
508
610
      </para>
509
611
      <para>
510
612
        As detailed in <xref linkend="checking"/>, the status of all
512
614
        compromised if they are gone for too long.
513
615
      </para>
514
616
      <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
617
        For more details on client-side security, see
532
 
        <citerefentry><refentrytitle>password-request</refentrytitle>
 
618
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
619
        <manvolnum>8mandos</manvolnum></citerefentry>.
534
620
      </para>
535
621
    </refsect2>
536
622
  </refsect1>
537
 
 
 
623
  
538
624
  <refsect1 id="see_also">
539
625
    <title>SEE ALSO</title>
540
626
    <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>
 
627
      <citerefentry><refentrytitle>intro</refentrytitle>
 
628
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
629
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
630
      <manvolnum>5</manvolnum></citerefentry>,
 
631
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
632
      <manvolnum>5</manvolnum></citerefentry>,
 
633
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
634
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
635
      <citerefentry><refentrytitle>sh</refentrytitle>
 
636
      <manvolnum>1</manvolnum></citerefentry>
550
637
    </para>
551
638
    <variablelist>
552
639
      <varlistentry>