/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

  • Committer: Teddy Hogeborn
  • Date: 2008-09-08 18:54:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908185447-dm2ertwxa20qbckf
* INSTALL: Even better text.

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