/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 16:33:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906163354-x2l238fvbs2xashj
* .bzrignore: Rename "password-request" to "mandos-client".

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