/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-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

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 "2018-02-08">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-04">
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
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
34
      <holder>Teddy Hogeborn</holder>
46
35
      <holder>Björn Påhlsson</holder>
47
36
    </copyright>
48
37
    <xi:include href="legalnotice.xml"/>
49
38
  </refentryinfo>
50
 
  
 
39
 
51
40
  <refmeta>
52
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
53
42
    <manvolnum>8</manvolnum>
59
48
      Gives encrypted passwords to authenticated Mandos clients
60
49
    </refpurpose>
61
50
  </refnamediv>
62
 
  
 
51
 
63
52
  <refsynopsisdiv>
64
53
    <cmdsynopsis>
65
54
      <command>&COMMANDNAME;</command>
94
83
      <replaceable>DIRECTORY</replaceable></option></arg>
95
84
      <sbr/>
96
85
      <arg><option>--debug</option></arg>
97
 
      <sbr/>
98
 
      <arg><option>--debuglevel
99
 
      <replaceable>LEVEL</replaceable></option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--no-dbus</option></arg>
102
 
      <sbr/>
103
 
      <arg><option>--no-ipv6</option></arg>
104
 
      <sbr/>
105
 
      <arg><option>--no-restore</option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--statedir
108
 
      <replaceable>DIRECTORY</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--socket
111
 
      <replaceable>FD</replaceable></option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--foreground</option></arg>
114
 
      <sbr/>
115
 
      <arg><option>--no-zeroconf</option></arg>
116
86
    </cmdsynopsis>
117
87
    <cmdsynopsis>
118
88
      <command>&COMMANDNAME;</command>
130
100
      <arg choice="plain"><option>--check</option></arg>
131
101
    </cmdsynopsis>
132
102
  </refsynopsisdiv>
133
 
  
 
103
 
134
104
  <refsect1 id="description">
135
105
    <title>DESCRIPTION</title>
136
106
    <para>
137
107
      <command>&COMMANDNAME;</command> is a server daemon which
138
108
      handles incoming request for passwords for a pre-defined list of
139
 
      client host computers. For an introduction, see
140
 
      <citerefentry><refentrytitle>intro</refentrytitle>
141
 
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
142
 
      uses Zeroconf to announce itself on the local network, and uses
143
 
      TLS to communicate securely with and to authenticate the
144
 
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
145
 
      use IPv6 link-local addresses, since the clients will probably
146
 
      not have any other addresses configured (see <xref
147
 
      linkend="overview"/>).  Any authenticated client is then given
148
 
      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.
149
117
    </para>
150
118
  </refsect1>
151
119
  
218
186
          <xi:include href="mandos-options.xml" xpointer="debug"/>
219
187
        </listitem>
220
188
      </varlistentry>
221
 
      
222
 
      <varlistentry>
223
 
        <term><option>--debuglevel
224
 
        <replaceable>LEVEL</replaceable></option></term>
225
 
        <listitem>
226
 
          <para>
227
 
            Set the debugging log level.
228
 
            <replaceable>LEVEL</replaceable> is a string, one of
229
 
            <quote><literal>CRITICAL</literal></quote>,
230
 
            <quote><literal>ERROR</literal></quote>,
231
 
            <quote><literal>WARNING</literal></quote>,
232
 
            <quote><literal>INFO</literal></quote>, or
233
 
            <quote><literal>DEBUG</literal></quote>, in order of
234
 
            increasing verbosity.  The default level is
235
 
            <quote><literal>WARNING</literal></quote>.
236
 
          </para>
237
 
        </listitem>
238
 
      </varlistentry>
239
 
      
 
189
 
240
190
      <varlistentry>
241
191
        <term><option>--priority <replaceable>
242
192
        PRIORITY</replaceable></option></term>
244
194
          <xi:include href="mandos-options.xml" xpointer="priority"/>
245
195
        </listitem>
246
196
      </varlistentry>
247
 
      
 
197
 
248
198
      <varlistentry>
249
199
        <term><option>--servicename
250
200
        <replaceable>NAME</replaceable></option></term>
253
203
                      xpointer="servicename"/>
254
204
        </listitem>
255
205
      </varlistentry>
256
 
      
 
206
 
257
207
      <varlistentry>
258
208
        <term><option>--configdir
259
209
        <replaceable>DIRECTORY</replaceable></option></term>
268
218
          </para>
269
219
        </listitem>
270
220
      </varlistentry>
271
 
      
 
221
 
272
222
      <varlistentry>
273
223
        <term><option>--version</option></term>
274
224
        <listitem>
277
227
          </para>
278
228
        </listitem>
279
229
      </varlistentry>
280
 
      
281
 
      <varlistentry>
282
 
        <term><option>--no-dbus</option></term>
283
 
        <listitem>
284
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
285
 
          <para>
286
 
            See also <xref linkend="dbus_interface"/>.
287
 
          </para>
288
 
        </listitem>
289
 
      </varlistentry>
290
 
      
291
 
      <varlistentry>
292
 
        <term><option>--no-ipv6</option></term>
293
 
        <listitem>
294
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
      
298
 
      <varlistentry>
299
 
        <term><option>--no-restore</option></term>
300
 
        <listitem>
301
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
302
 
          <para>
303
 
            See also <xref linkend="persistent_state"/>.
304
 
          </para>
305
 
        </listitem>
306
 
      </varlistentry>
307
 
      
308
 
      <varlistentry>
309
 
        <term><option>--statedir
310
 
        <replaceable>DIRECTORY</replaceable></option></term>
311
 
        <listitem>
312
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
313
 
        </listitem>
314
 
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--socket
318
 
        <replaceable>FD</replaceable></option></term>
319
 
        <listitem>
320
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
321
 
        </listitem>
322
 
      </varlistentry>
323
 
      
324
 
      <varlistentry>
325
 
        <term><option>--foreground</option></term>
326
 
        <listitem>
327
 
          <xi:include href="mandos-options.xml"
328
 
                      xpointer="foreground"/>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
      
332
 
      <varlistentry>
333
 
        <term><option>--no-zeroconf</option></term>
334
 
        <listitem>
335
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
      
339
230
    </variablelist>
340
231
  </refsect1>
341
 
  
 
232
 
342
233
  <refsect1 id="overview">
343
234
    <title>OVERVIEW</title>
344
235
    <xi:include href="overview.xml"/>
348
239
      <acronym>RAM</acronym> disk environment.
349
240
    </para>
350
241
  </refsect1>
351
 
  
 
242
 
352
243
  <refsect1 id="protocol">
353
244
    <title>NETWORK PROTOCOL</title>
354
245
    <para>
406
297
      </row>
407
298
    </tbody></tgroup></table>
408
299
  </refsect1>
409
 
  
 
300
 
410
301
  <refsect1 id="checking">
411
302
    <title>CHECKING</title>
412
303
    <para>
413
304
      The server will, by default, continually check that the clients
414
305
      are still up.  If a client has not been confirmed as being up
415
306
      for some time, the client is assumed to be compromised and is no
416
 
      longer eligible to receive the encrypted password.  (Manual
417
 
      intervention is required to re-enable a client.)  The timeout,
418
 
      extended timeout, checker program, and interval between checks
419
 
      can be configured both globally and per client; see
420
 
      <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>
421
311
      <manvolnum>5</manvolnum></citerefentry>.
422
312
    </para>
423
313
  </refsect1>
424
 
  
425
 
  <refsect1 id="approval">
426
 
    <title>APPROVAL</title>
427
 
    <para>
428
 
      The server can be configured to require manual approval for a
429
 
      client before it is sent its secret.  The delay to wait for such
430
 
      approval and the default action (approve or deny) can be
431
 
      configured both globally and per client; see <citerefentry>
432
 
      <refentrytitle>mandos-clients.conf</refentrytitle>
433
 
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
434
 
      will be approved immediately without delay.
435
 
    </para>
436
 
    <para>
437
 
      This can be used to deny a client its secret if not manually
438
 
      approved within a specified time.  It can also be used to make
439
 
      the server delay before giving a client its secret, allowing
440
 
      optional manual denying of this specific client.
441
 
    </para>
442
 
    
443
 
  </refsect1>
444
 
  
 
314
 
445
315
  <refsect1 id="logging">
446
316
    <title>LOGGING</title>
447
317
    <para>
448
318
      The server will send log message with various severity levels to
449
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
319
      <filename>/dev/log</filename>.  With the
450
320
      <option>--debug</option> option, it will log even more messages,
451
321
      and also show them on the console.
452
322
    </para>
453
323
  </refsect1>
454
 
  
455
 
  <refsect1 id="persistent_state">
456
 
    <title>PERSISTENT STATE</title>
457
 
    <para>
458
 
      Client settings, initially read from
459
 
      <filename>clients.conf</filename>, are persistent across
460
 
      restarts, and run-time changes will override settings in
461
 
      <filename>clients.conf</filename>.  However, if a setting is
462
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
463
 
      <filename>clients.conf</filename>, this will take precedence.
464
 
    </para>
465
 
  </refsect1>
466
 
  
467
 
  <refsect1 id="dbus_interface">
468
 
    <title>D-BUS INTERFACE</title>
469
 
    <para>
470
 
      The server will by default provide a D-Bus system bus interface.
471
 
      This interface will only be accessible by the root user or a
472
 
      Mandos-specific user, if such a user exists.  For documentation
473
 
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
474
 
    </para>
475
 
  </refsect1>
476
 
  
 
324
 
477
325
  <refsect1 id="exit_status">
478
326
    <title>EXIT STATUS</title>
479
327
    <para>
481
329
      critical error is encountered.
482
330
    </para>
483
331
  </refsect1>
484
 
  
 
332
 
485
333
  <refsect1 id="environment">
486
334
    <title>ENVIRONMENT</title>
487
335
    <variablelist>
501
349
      </varlistentry>
502
350
    </variablelist>
503
351
  </refsect1>
504
 
  
505
 
  <refsect1 id="files">
 
352
 
 
353
  <refsect1 id="file">
506
354
    <title>FILES</title>
507
355
    <para>
508
356
      Use the <option>--configdir</option> option to change where
531
379
        </listitem>
532
380
      </varlistentry>
533
381
      <varlistentry>
534
 
        <term><filename>/run/mandos.pid</filename></term>
535
 
        <listitem>
536
 
          <para>
537
 
            The file containing the process id of the
538
 
            <command>&COMMANDNAME;</command> process started last.
539
 
            <emphasis >Note:</emphasis> If the <filename
540
 
            class="directory">/run</filename> directory does not
541
 
            exist, <filename>/var/run/mandos.pid</filename> will be
542
 
            used instead.
543
 
          </para>
544
 
        </listitem>
545
 
      </varlistentry>
546
 
      <varlistentry>
547
 
        <term><filename
548
 
        class="directory">/var/lib/mandos</filename></term>
549
 
        <listitem>
550
 
          <para>
551
 
            Directory where persistent state will be saved.  Change
552
 
            this with the <option>--statedir</option> option.  See
553
 
            also the <option>--no-restore</option> option.
554
 
          </para>
555
 
        </listitem>
556
 
      </varlistentry>
557
 
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
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>.
 
387
          </para>
 
388
        </listitem>
 
389
      </varlistentry>
 
390
      <varlistentry>
 
391
        <term><filename>/dev/log</filename></term>
559
392
        <listitem>
560
393
          <para>
561
394
            The Unix domain socket to where local syslog messages are
584
417
      backtrace.  This could be considered a feature.
585
418
    </para>
586
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>
587
431
      There is no fine-grained control over logging and debug output.
588
432
    </para>
589
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>
590
440
      This server does not check the expire time of clients’ OpenPGP
591
441
      keys.
592
442
    </para>
593
 
    <xi:include href="bugs.xml"/>
594
443
  </refsect1>
595
444
  
596
445
  <refsect1 id="example">
606
455
    <informalexample>
607
456
      <para>
608
457
        Run the server in debug mode, read configuration files from
609
 
        the <filename class="directory">~/mandos</filename> directory,
610
 
        and use the Zeroconf service name <quote>Test</quote> to not
611
 
        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:
612
461
      </para>
613
462
      <para>
614
463
 
630
479
      </para>
631
480
    </informalexample>
632
481
  </refsect1>
633
 
  
 
482
 
634
483
  <refsect1 id="security">
635
484
    <title>SECURITY</title>
636
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
637
486
      <title>SERVER</title>
638
487
      <para>
639
488
        Running this <command>&COMMANDNAME;</command> server program
640
489
        should not in itself present any security risk to the host
641
 
        computer running it.  The program switches to a non-root user
642
 
        soon after startup.
 
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.
643
492
      </para>
644
493
    </refsect2>
645
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
646
495
      <title>CLIENTS</title>
647
496
      <para>
648
497
        The server only gives out its stored data to clients which
655
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
656
505
        <manvolnum>5</manvolnum></citerefentry>)
657
506
        <emphasis>must</emphasis> be made non-readable by anyone
658
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
659
508
      </para>
660
509
      <para>
661
510
        As detailed in <xref linkend="checking"/>, the status of all
663
512
        compromised if they are gone for too long.
664
513
      </para>
665
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>
666
531
        For more details on client-side security, see
667
 
        <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
532
        <citerefentry><refentrytitle>password-request</refentrytitle>
668
533
        <manvolnum>8mandos</manvolnum></citerefentry>.
669
534
      </para>
670
535
    </refsect2>
671
536
  </refsect1>
672
 
  
 
537
 
673
538
  <refsect1 id="see_also">
674
539
    <title>SEE ALSO</title>
675
540
    <para>
676
 
      <citerefentry><refentrytitle>intro</refentrytitle>
677
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
678
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
679
 
      <manvolnum>5</manvolnum></citerefentry>,
680
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
681
 
      <manvolnum>5</manvolnum></citerefentry>,
682
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
683
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
684
 
      <citerefentry><refentrytitle>sh</refentrytitle>
685
 
      <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>password-request</refentrytitle>
 
547
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
548
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
 
549
      </citerefentry>
686
550
    </para>
687
551
    <variablelist>
688
552
      <varlistentry>
709
573
      </varlistentry>
710
574
      <varlistentry>
711
575
        <term>
712
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
576
          <ulink url="http://www.gnu.org/software/gnutls/"
 
577
          >GnuTLS</ulink>
713
578
        </term>
714
579
      <listitem>
715
580
        <para>
753
618
      </varlistentry>
754
619
      <varlistentry>
755
620
        <term>
756
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
 
          Protocol Version 1.2</citetitle>
 
621
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
622
          Protocol Version 1.1</citetitle>
758
623
        </term>
759
624
      <listitem>
760
625
        <para>
761
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
626
          TLS 1.1 is the protocol implemented by GnuTLS.
762
627
        </para>
763
628
      </listitem>
764
629
      </varlistentry>
774
639
      </varlistentry>
775
640
      <varlistentry>
776
641
        <term>
777
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
 
          Security (TLS) Authentication</citetitle>
 
642
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
643
          Security</citetitle>
779
644
        </term>
780
645
      <listitem>
781
646
        <para>