/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-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 OVERVIEW SYSTEM "overview.xml">
6
7
]>
7
8
 
8
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
9
10
  <refentryinfo>
10
11
    <title>&COMMANDNAME;</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
72
73
  <refsynopsisdiv>
73
74
    <cmdsynopsis>
74
75
      <command>&COMMANDNAME;</command>
75
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
 
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
 
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
79
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
80
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
81
 
      <arg>--debug</arg>
82
 
    </cmdsynopsis>
83
 
    <cmdsynopsis>
84
 
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">IF</arg></arg>
86
 
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
 
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
 
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
89
 
      <arg>--servicename<arg choice="plain">NAME</arg></arg>
90
 
      <arg>--configdir<arg choice="plain">DIRECTORY</arg></arg>
91
 
      <arg>--debug</arg>
92
 
    </cmdsynopsis>
93
 
    <cmdsynopsis>
94
 
      <command>&COMMANDNAME;</command>
95
 
      <group choice="req">
96
 
        <arg choice="plain">-h</arg>
97
 
        <arg choice="plain">--help</arg>
98
 
      </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>
99
97
    </cmdsynopsis>
100
98
    <cmdsynopsis>
101
99
      <command>&COMMANDNAME;</command>
153
151
        <term><literal>-i</literal>, <literal>--interface <replaceable>
154
152
        IF</replaceable></literal></term>
155
153
        <listitem>
156
 
          <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>
157
159
        </listitem>
158
160
      </varlistentry>
159
161
 
161
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
164
        ADDRESS</replaceable></literal></term>
163
165
        <listitem>
164
 
          <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>
165
176
        </listitem>
166
177
      </varlistentry>
167
178
 
169
180
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
181
        PORT</replaceable></literal></term>
171
182
        <listitem>
172
 
          <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>
173
188
        </listitem>
174
189
      </varlistentry>
175
190
 
186
201
      <varlistentry>
187
202
        <term><literal>--debug</literal></term>
188
203
        <listitem>
189
 
          <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>
190
209
        </listitem>
191
210
      </varlistentry>
192
211
 
194
213
        <term><literal>--priority <replaceable>
195
214
        PRIORITY</replaceable></literal></term>
196
215
        <listitem>
197
 
          <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>
198
226
        </listitem>
199
227
      </varlistentry>
200
228
 
202
230
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
231
        </literal></term>
204
232
        <listitem>
205
 
          <xi:include href="mandos-options.xml"
206
 
                      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>
207
244
        </listitem>
208
245
      </varlistentry>
209
246
 
235
272
 
236
273
  <refsect1 id="overview">
237
274
    <title>OVERVIEW</title>
238
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
239
276
    <para>
240
277
      This program is the server part.  It is a normal server program
241
278
      and will run in a normal system environment, not in an initial
274
311
        <entry>-><!-- &rarr; --></entry>
275
312
      </row>
276
313
      <row>
277
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
278
315
        <entry>-><!-- &rarr; --></entry>
279
316
      </row>
280
317
      <row>
310
347
      longer eligible to receive the encrypted password.  The timeout,
311
348
      checker program, and interval between checks can be configured
312
349
      both globally and per client; see <citerefentry>
 
350
      <refentrytitle>mandos.conf</refentrytitle>
 
351
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
313
352
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
353
      <manvolnum>5</manvolnum></citerefentry>.
315
354
    </para>
318
357
  <refsect1 id="logging">
319
358
    <title>LOGGING</title>
320
359
    <para>
321
 
      The server will send log message with various severity levels to
322
 
      <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
323
362
      <option>--debug</option> option, it will log even more messages,
324
363
      and also show them on the console.
325
364
    </para>
333
372
    </para>
334
373
  </refsect1>
335
374
 
336
 
  <refsect1 id="environment">
337
 
    <title>ENVIRONMENT</title>
338
 
    <variablelist>
339
 
      <varlistentry>
340
 
        <term><varname>PATH</varname></term>
341
 
        <listitem>
342
 
          <para>
343
 
            To start the configured checker (see <xref
344
 
            linkend="checking"/>), the server uses
345
 
            <filename>/bin/sh</filename>, which in turn uses
346
 
            <varname>PATH</varname> to search for matching commands if
347
 
            an absolute path is not given.  See <citerefentry>
348
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
349
 
            </citerefentry>.
350
 
          </para>
351
 
        </listitem>
352
 
      </varlistentry>
353
 
    </variablelist>
354
 
  </refsect1>
355
 
 
356
375
  <refsect1 id="file">
357
376
    <title>FILES</title>
358
377
    <para>
399
418
          </para>
400
419
        </listitem>
401
420
      </varlistentry>
402
 
      <varlistentry>
403
 
        <term><filename>/bin/sh</filename></term>
404
 
        <listitem>
405
 
          <para>
406
 
            This is used to start the configured checker command for
407
 
            each client.  See <citerefentry>
408
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
409
 
            <manvolnum>5</manvolnum></citerefentry> for details.
410
 
          </para>
411
 
        </listitem>
412
 
      </varlistentry>
413
421
    </variablelist>
414
422
  </refsect1>
415
 
  
 
423
 
416
424
  <refsect1 id="bugs">
417
425
    <title>BUGS</title>
418
426
    <para>
419
427
      This server might, on especially fatal errors, emit a Python
420
428
      backtrace.  This could be considered a feature.
421
429
    </para>
422
 
    <para>
423
 
      Currently, if a client is declared <quote>invalid</quote> due to
424
 
      having timed out, the server does not record this fact onto
425
 
      permanent storage.  This has some security implications, see
426
 
      <xref linkend="CLIENTS"/>.
427
 
    </para>
428
 
    <para>
429
 
      There is currently no way of querying the server of the current
430
 
      status of clients, other than analyzing its <systemitem
431
 
      class="service">syslog</systemitem> output.
432
 
    </para>
433
 
    <para>
434
 
      There is no fine-grained control over logging and debug output.
435
 
    </para>
436
 
    <para>
437
 
      Debug mode is conflated with running in the foreground.
438
 
    </para>
439
 
    <para>
440
 
      The console log messages does not show a timestamp.
441
 
    </para>
442
430
  </refsect1>
443
 
  
444
 
  <refsect1 id="example">
445
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
446
434
    <informalexample>
447
435
      <para>
448
436
        Normal invocation needs no options:
481
469
 
482
470
  <refsect1 id="security">
483
471
    <title>SECURITY</title>
484
 
    <refsect2 id="SERVER">
 
472
    <refsect2>
485
473
      <title>SERVER</title>
486
474
      <para>
487
 
        Running this <command>&COMMANDNAME;</command> server program
488
 
        should not in itself present any security risk to the host
489
 
        computer running it.  The program does not need any special
490
 
        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.
491
479
      </para>
492
480
    </refsect2>
493
 
    <refsect2 id="CLIENTS">
 
481
    <refsect2>
494
482
      <title>CLIENTS</title>
495
483
      <para>
496
484
        The server only gives out its stored data to clients which
511
499
        compromised if they are gone for too long.
512
500
      </para>
513
501
      <para>
514
 
        If a client is compromised, its downtime should be duly noted
515
 
        by the server which would therefore declare the client
516
 
        invalid.  But if the server was ever restarted, it would
517
 
        re-read its client list from its configuration file and again
518
 
        regard all clients therein as valid, and hence eligible to
519
 
        receive their passwords.  Therefore, be careful when
520
 
        restarting servers if it is suspected that a client has, in
521
 
        fact, been compromised by parties who may now be running a
522
 
        fake Mandos client with the keys from the non-encrypted
523
 
        initial RAM image of the client host.  What should be done in
524
 
        that case (if restarting the server program really is
525
 
        necessary) is to stop the server program, edit the
526
 
        configuration file to omit any suspect clients, and restart
527
 
        the server program.
528
 
      </para>
529
 
      <para>
530
502
        For more details on client-side security, see
531
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
532
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
536
508
 
537
509
  <refsect1 id="see_also">
538
510
    <title>SEE ALSO</title>
539
 
    <para>
540
 
      <citerefentry>
541
 
        <refentrytitle>mandos.conf</refentrytitle>
542
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
543
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
544
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
545
 
        <refentrytitle>password-request</refentrytitle>
546
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
547
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
548
 
      </citerefentry>
549
 
    </para>
550
511
    <variablelist>
551
512
      <varlistentry>
552
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>
553
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
554
531
        </term>
555
532
        <listitem>