/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-08-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
3
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
7
7
]>
8
8
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
10
10
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
 
11
    <title>&COMMANDNAME;</title>
12
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
13
    <productname>&COMMANDNAME;</productname>
14
14
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
15
    <authorgroup>
17
16
      <author>
18
17
        <firstname>Björn</firstname>
74
73
  <refsynopsisdiv>
75
74
    <cmdsynopsis>
76
75
      <command>&COMMANDNAME;</command>
77
 
      <arg>--interface<arg choice="plain">NAME</arg></arg>
78
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
79
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
80
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
81
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
82
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
83
 
      <arg>--debug</arg>
84
 
    </cmdsynopsis>
85
 
    <cmdsynopsis>
86
 
      <command>&COMMANDNAME;</command>
87
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
88
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
89
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
90
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
91
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
92
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
93
 
      <arg>--debug</arg>
94
 
    </cmdsynopsis>
95
 
    <cmdsynopsis>
96
 
      <command>&COMMANDNAME;</command>
97
 
      <group choice="req">
98
 
        <arg choice="plain">-h</arg>
99
 
        <arg choice="plain">--help</arg>
100
 
      </group>
 
76
      <arg choice="opt">--interface<arg choice="plain">IF</arg></arg>
 
77
      <arg choice="opt">--address<arg choice="plain">ADDRESS</arg></arg>
 
78
      <arg choice="opt">--port<arg choice="plain">PORT</arg></arg>
 
79
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
 
80
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
 
81
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
82
      <arg choice="opt">--debug</arg>
 
83
    </cmdsynopsis>
 
84
    <cmdsynopsis>
 
85
      <command>&COMMANDNAME;</command>
 
86
      <arg choice="opt">-i<arg choice="plain">IF</arg></arg>
 
87
      <arg choice="opt">-a<arg choice="plain">ADDRESS</arg></arg>
 
88
      <arg choice="opt">-p<arg choice="plain">PORT</arg></arg>
 
89
      <arg choice="opt">--priority<arg choice="plain">PRIORITY</arg></arg>
 
90
      <arg choice="opt">--servicename<arg choice="plain">NAME</arg></arg>
 
91
      <arg choice="opt">--configdir<arg choice="plain">DIRECTORY</arg></arg>
 
92
      <arg choice="opt">--debug</arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice="plain">--help</arg>
101
97
    </cmdsynopsis>
102
98
    <cmdsynopsis>
103
99
      <command>&COMMANDNAME;</command>
152
148
      </varlistentry>
153
149
 
154
150
      <varlistentry>
155
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
156
 
        >NAME</replaceable></literal></term>
 
151
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
152
        IF</replaceable></literal></term>
157
153
        <listitem>
158
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
154
          <para>
 
155
            Only announce the server and listen to requests on network
 
156
            interface <replaceable>IF</replaceable>.  Default is to
 
157
            use all available interfaces.
 
158
          </para>
159
159
        </listitem>
160
160
      </varlistentry>
161
161
 
163
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
164
164
        ADDRESS</replaceable></literal></term>
165
165
        <listitem>
166
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
166
          <para>
 
167
            If this option is used, the server will only listen to a
 
168
            specific address.  This must currently be an IPv6 address;
 
169
            an IPv4 address can be specified using the
 
170
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
 
171
            Also, if a link-local address is specified, an interface
 
172
            should be set, since a link-local address is only valid on
 
173
            a single interface.  By default, the server will listen to
 
174
            all available addresses.
 
175
          </para>
167
176
        </listitem>
168
177
      </varlistentry>
169
178
 
171
180
        <term><literal>-p</literal>, <literal>--port <replaceable>
172
181
        PORT</replaceable></literal></term>
173
182
        <listitem>
174
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
183
          <para>
 
184
            If this option is used, the server to bind to that
 
185
            port. By default, the server will listen to an arbitrary
 
186
            port given by the operating system.
 
187
          </para>
175
188
        </listitem>
176
189
      </varlistentry>
177
190
 
188
201
      <varlistentry>
189
202
        <term><literal>--debug</literal></term>
190
203
        <listitem>
191
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
204
          <para>
 
205
            If the server is run in debug mode, it will run in the
 
206
            foreground and print a lot of debugging information.  The
 
207
            default is <emphasis>not</emphasis> to run in debug mode.
 
208
          </para>
192
209
        </listitem>
193
210
      </varlistentry>
194
211
 
196
213
        <term><literal>--priority <replaceable>
197
214
        PRIORITY</replaceable></literal></term>
198
215
        <listitem>
199
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
216
          <para>
 
217
            GnuTLS priority string for the TLS handshake with the
 
218
            clients.  The default is
 
219
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
220
            See <citerefentry><refentrytitle>gnutls_priority_init
 
221
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
 
222
            for the syntax.  <emphasis>Warning</emphasis>: changing
 
223
            this may make the TLS handshake fail, making communication
 
224
            with clients impossible.
 
225
          </para>
200
226
        </listitem>
201
227
      </varlistentry>
202
228
 
204
230
        <term><literal>--servicename <replaceable>NAME</replaceable>
205
231
        </literal></term>
206
232
        <listitem>
207
 
          <xi:include href="mandos-options.xml"
208
 
                      xpointer="servicename"/>
 
233
          <para>
 
234
            Zeroconf service name.  The default is
 
235
            <quote><literal>Mandos</literal></quote>.  You only need
 
236
            to change this if you for some reason want to run more
 
237
            than one server on the same <emphasis>host</emphasis>,
 
238
            which would not normally be useful.  If there are name
 
239
            collisions on the same <emphasis>network</emphasis>, the
 
240
            newer server will automatically rename itself to
 
241
            <quote><literal>Mandos #2</literal></quote>, and so on;
 
242
            therefore, this option is not needed in that case.
 
243
          </para>
209
244
        </listitem>
210
245
      </varlistentry>
211
246
 
237
272
 
238
273
  <refsect1 id="overview">
239
274
    <title>OVERVIEW</title>
240
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
241
276
    <para>
242
277
      This program is the server part.  It is a normal server program
243
278
      and will run in a normal system environment, not in an initial
276
311
        <entry>-><!-- &rarr; --></entry>
277
312
      </row>
278
313
      <row>
279
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
280
315
        <entry>-><!-- &rarr; --></entry>
281
316
      </row>
282
317
      <row>
312
347
      longer eligible to receive the encrypted password.  The timeout,
313
348
      checker program, and interval between checks can be configured
314
349
      both globally and per client; see <citerefentry>
 
350
      <refentrytitle>mandos.conf</refentrytitle>
 
351
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
315
352
      <refentrytitle>mandos-clients.conf</refentrytitle>
316
353
      <manvolnum>5</manvolnum></citerefentry>.
317
354
    </para>
320
357
  <refsect1 id="logging">
321
358
    <title>LOGGING</title>
322
359
    <para>
323
 
      The server will send log message with various severity levels to
324
 
      <filename>/dev/log</filename>.  With the
 
360
      The server will send log messaged with various severity levels
 
361
      to <filename>/dev/log</filename>.  With the
325
362
      <option>--debug</option> option, it will log even more messages,
326
363
      and also show them on the console.
327
364
    </para>
335
372
    </para>
336
373
  </refsect1>
337
374
 
338
 
  <refsect1 id="environment">
339
 
    <title>ENVIRONMENT</title>
340
 
    <variablelist>
341
 
      <varlistentry>
342
 
        <term><varname>PATH</varname></term>
343
 
        <listitem>
344
 
          <para>
345
 
            To start the configured checker (see <xref
346
 
            linkend="checking"/>), the server uses
347
 
            <filename>/bin/sh</filename>, which in turn uses
348
 
            <varname>PATH</varname> to search for matching commands if
349
 
            an absolute path is not given.  See <citerefentry>
350
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
351
 
            </citerefentry>.
352
 
          </para>
353
 
        </listitem>
354
 
      </varlistentry>
355
 
    </variablelist>
356
 
  </refsect1>
357
 
 
358
375
  <refsect1 id="file">
359
376
    <title>FILES</title>
360
377
    <para>
401
418
          </para>
402
419
        </listitem>
403
420
      </varlistentry>
404
 
      <varlistentry>
405
 
        <term><filename>/bin/sh</filename></term>
406
 
        <listitem>
407
 
          <para>
408
 
            This is used to start the configured checker command for
409
 
            each client.  See <citerefentry>
410
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
411
 
            <manvolnum>5</manvolnum></citerefentry> for details.
412
 
          </para>
413
 
        </listitem>
414
 
      </varlistentry>
415
421
    </variablelist>
416
422
  </refsect1>
417
 
  
 
423
 
418
424
  <refsect1 id="bugs">
419
425
    <title>BUGS</title>
420
426
    <para>
421
427
      This server might, on especially fatal errors, emit a Python
422
428
      backtrace.  This could be considered a feature.
423
429
    </para>
424
 
    <para>
425
 
      Currently, if a client is declared <quote>invalid</quote> due to
426
 
      having timed out, the server does not record this fact onto
427
 
      permanent storage.  This has some security implications, see
428
 
      <xref linkend="CLIENTS"/>.
429
 
    </para>
430
 
    <para>
431
 
      There is currently no way of querying the server of the current
432
 
      status of clients, other than analyzing its <systemitem
433
 
      class="service">syslog</systemitem> output.
434
 
    </para>
435
 
    <para>
436
 
      There is no fine-grained control over logging and debug output.
437
 
    </para>
438
 
    <para>
439
 
      Debug mode is conflated with running in the foreground.
440
 
    </para>
441
 
    <para>
442
 
      The console log messages does not show a timestamp.
443
 
    </para>
444
430
  </refsect1>
445
 
  
446
 
  <refsect1 id="example">
447
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
448
434
    <informalexample>
449
435
      <para>
450
436
        Normal invocation needs no options:
451
437
      </para>
452
438
      <para>
453
 
        <userinput>&COMMANDNAME;</userinput>
 
439
        <userinput>mandos</userinput>
454
440
      </para>
455
441
    </informalexample>
456
442
    <informalexample>
463
449
      <para>
464
450
 
465
451
<!-- do not wrap this line -->
466
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
452
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
467
453
 
468
454
      </para>
469
455
    </informalexample>
475
461
      <para>
476
462
 
477
463
<!-- do not wrap this line -->
478
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
479
465
 
480
466
      </para>
481
467
    </informalexample>
483
469
 
484
470
  <refsect1 id="security">
485
471
    <title>SECURITY</title>
486
 
    <refsect2 id="SERVER">
 
472
    <refsect2>
487
473
      <title>SERVER</title>
488
474
      <para>
489
 
        Running this <command>&COMMANDNAME;</command> server program
490
 
        should not in itself present any security risk to the host
491
 
        computer running it.  The program does not need any special
492
 
        privileges to run, and is designed to run as a non-root user.
 
475
        Running this &COMMANDNAME; server program should not in itself
 
476
        present any security risk to the host computer running it.
 
477
        The program does not need any special privileges to run, and
 
478
        is designed to run as a non-root user.
493
479
      </para>
494
480
    </refsect2>
495
 
    <refsect2 id="CLIENTS">
 
481
    <refsect2>
496
482
      <title>CLIENTS</title>
497
483
      <para>
498
484
        The server only gives out its stored data to clients which
513
499
        compromised if they are gone for too long.
514
500
      </para>
515
501
      <para>
516
 
        If a client is compromised, its downtime should be duly noted
517
 
        by the server which would therefore declare the client
518
 
        invalid.  But if the server was ever restarted, it would
519
 
        re-read its client list from its configuration file and again
520
 
        regard all clients therein as valid, and hence eligible to
521
 
        receive their passwords.  Therefore, be careful when
522
 
        restarting servers if it is suspected that a client has, in
523
 
        fact, been compromised by parties who may now be running a
524
 
        fake Mandos client with the keys from the non-encrypted
525
 
        initial RAM image of the client host.  What should be done in
526
 
        that case (if restarting the server program really is
527
 
        necessary) is to stop the server program, edit the
528
 
        configuration file to omit any suspect clients, and restart
529
 
        the server program.
530
 
      </para>
531
 
      <para>
532
502
        For more details on client-side security, see
533
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
534
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
538
508
 
539
509
  <refsect1 id="see_also">
540
510
    <title>SEE ALSO</title>
541
 
    <para>
542
 
      <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>mandos.conf</refentrytitle>
546
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>password-request</refentrytitle>
548
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
549
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
550
 
      </citerefentry>
551
 
    </para>
552
511
    <variablelist>
553
512
      <varlistentry>
554
513
        <term>
 
514
          <citerefentry>
 
515
            <refentrytitle>password-request</refentrytitle>
 
516
            <manvolnum>8mandos</manvolnum>
 
517
          </citerefentry>
 
518
        </term>
 
519
        <listitem>
 
520
          <para>
 
521
            This is the actual program which talks to this server.
 
522
            Note that it is normally not invoked directly, and is only
 
523
            run in the initial RAM disk environment, and not on a
 
524
            fully started system.
 
525
          </para>
 
526
        </listitem>
 
527
      </varlistentry>
 
528
      <varlistentry>
 
529
        <term>
555
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
556
531
        </term>
557
532
        <listitem>
574
549
      </varlistentry>
575
550
      <varlistentry>
576
551
        <term>
577
 
          <ulink url="http://www.gnu.org/software/gnutls/"
578
 
          >GnuTLS</ulink>
 
552
          <ulink
 
553
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
579
554
        </term>
580
555
      <listitem>
581
556
        <para>
587
562
      </varlistentry>
588
563
      <varlistentry>
589
564
        <term>
590
 
          RFC 4291: <citetitle>IP Version 6 Addressing
591
 
          Architecture</citetitle>
 
565
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
566
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
567
          Unicast Addresses</citation>
592
568
        </term>
593
569
        <listitem>
594
 
          <variablelist>
595
 
            <varlistentry>
596
 
              <term>Section 2.2: <citetitle>Text Representation of
597
 
              Addresses</citetitle></term>
598
 
              <listitem><para/></listitem>
599
 
            </varlistentry>
600
 
            <varlistentry>
601
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
602
 
              Address</citetitle></term>
603
 
              <listitem><para/></listitem>
604
 
            </varlistentry>
605
 
            <varlistentry>
606
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
607
 
            Addresses</citetitle></term>
608
 
            <listitem>
609
 
              <para>
610
 
                The clients use IPv6 link-local addresses, which are
611
 
                immediately usable since a link-local addresses is
612
 
                automatically assigned to a network interfaces when it
613
 
                is brought up.
614
 
              </para>
615
 
            </listitem>
616
 
            </varlistentry>
617
 
          </variablelist>
 
570
          <para>
 
571
            The clients use IPv6 link-local addresses, which are
 
572
            immediately usable since a link-local addresses is
 
573
            automatically assigned to a network interfaces when it is
 
574
            brought up.
 
575
          </para>
618
576
        </listitem>
619
577
      </varlistentry>
620
578
      <varlistentry>
621
579
        <term>
622
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
623
 
          Protocol Version 1.1</citetitle>
 
580
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
581
          (TLS) Protocol Version 1.1</citetitle></citation>
624
582
        </term>
625
583
      <listitem>
626
584
        <para>
630
588
      </varlistentry>
631
589
      <varlistentry>
632
590
        <term>
633
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
591
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
592
          Format</citetitle></citation>
634
593
        </term>
635
594
      <listitem>
636
595
        <para>
640
599
      </varlistentry>
641
600
      <varlistentry>
642
601
        <term>
643
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
644
 
          Security</citetitle>
 
602
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
603
          Transport Layer Security</citetitle></citation>
645
604
        </term>
646
605
      <listitem>
647
606
        <para>
653
612
    </variablelist>
654
613
  </refsect1>
655
614
</refentry>
656
 
<!-- Local Variables: -->
657
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
658
 
<!-- time-stamp-end: "[\"']>" -->
659
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
660
 
<!-- End: -->