/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-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

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