/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-30">
 
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>
67
66
  <refnamediv>
68
67
    <refname><command>&COMMANDNAME;</command></refname>
69
68
    <refpurpose>
70
 
      Gives encrypted passwords to authenticated Mandos clients
 
69
      Sends encrypted passwords to authenticated Mandos clients
71
70
    </refpurpose>
72
71
  </refnamediv>
73
72
 
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>
143
139
 
144
140
    <variablelist>
145
141
      <varlistentry>
146
 
        <term><option>-h</option></term>
147
 
        <term><option>--help</option></term>
 
142
        <term><literal>-h</literal>, <literal>--help</literal></term>
148
143
        <listitem>
149
144
          <para>
150
145
            Show a help message and exit
153
148
      </varlistentry>
154
149
 
155
150
      <varlistentry>
156
 
        <term><option>-i</option>
157
 
        <replaceable>NAME</replaceable></term>
158
 
        <term><option>--interface</option>
159
 
        <replaceable>NAME</replaceable></term>
 
151
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
152
        IF</replaceable></literal></term>
160
153
        <listitem>
161
 
          <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>
162
159
        </listitem>
163
160
      </varlistentry>
164
161
 
166
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
167
164
        ADDRESS</replaceable></literal></term>
168
165
        <listitem>
169
 
          <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>
170
176
        </listitem>
171
177
      </varlistentry>
172
178
 
174
180
        <term><literal>-p</literal>, <literal>--port <replaceable>
175
181
        PORT</replaceable></literal></term>
176
182
        <listitem>
177
 
          <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>
178
188
        </listitem>
179
189
      </varlistentry>
180
190
 
191
201
      <varlistentry>
192
202
        <term><literal>--debug</literal></term>
193
203
        <listitem>
194
 
          <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>
195
209
        </listitem>
196
210
      </varlistentry>
197
211
 
199
213
        <term><literal>--priority <replaceable>
200
214
        PRIORITY</replaceable></literal></term>
201
215
        <listitem>
202
 
          <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>
203
226
        </listitem>
204
227
      </varlistentry>
205
228
 
207
230
        <term><literal>--servicename <replaceable>NAME</replaceable>
208
231
        </literal></term>
209
232
        <listitem>
210
 
          <xi:include href="mandos-options.xml"
211
 
                      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>
212
244
        </listitem>
213
245
      </varlistentry>
214
246
 
240
272
 
241
273
  <refsect1 id="overview">
242
274
    <title>OVERVIEW</title>
243
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
244
276
    <para>
245
277
      This program is the server part.  It is a normal server program
246
278
      and will run in a normal system environment, not in an initial
279
311
        <entry>-><!-- &rarr; --></entry>
280
312
      </row>
281
313
      <row>
282
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
283
315
        <entry>-><!-- &rarr; --></entry>
284
316
      </row>
285
317
      <row>
315
347
      longer eligible to receive the encrypted password.  The timeout,
316
348
      checker program, and interval between checks can be configured
317
349
      both globally and per client; see <citerefentry>
 
350
      <refentrytitle>mandos.conf</refentrytitle>
 
351
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
318
352
      <refentrytitle>mandos-clients.conf</refentrytitle>
319
353
      <manvolnum>5</manvolnum></citerefentry>.
320
354
    </para>
323
357
  <refsect1 id="logging">
324
358
    <title>LOGGING</title>
325
359
    <para>
326
 
      The server will send log message with various severity levels to
327
 
      <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
328
362
      <option>--debug</option> option, it will log even more messages,
329
363
      and also show them on the console.
330
364
    </para>
338
372
    </para>
339
373
  </refsect1>
340
374
 
341
 
  <refsect1 id="environment">
342
 
    <title>ENVIRONMENT</title>
343
 
    <variablelist>
344
 
      <varlistentry>
345
 
        <term><varname>PATH</varname></term>
346
 
        <listitem>
347
 
          <para>
348
 
            To start the configured checker (see <xref
349
 
            linkend="checking"/>), the server uses
350
 
            <filename>/bin/sh</filename>, which in turn uses
351
 
            <varname>PATH</varname> to search for matching commands if
352
 
            an absolute path is not given.  See <citerefentry>
353
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
354
 
            </citerefentry>.
355
 
          </para>
356
 
        </listitem>
357
 
      </varlistentry>
358
 
    </variablelist>
359
 
  </refsect1>
360
 
 
361
375
  <refsect1 id="file">
362
376
    <title>FILES</title>
363
377
    <para>
404
418
          </para>
405
419
        </listitem>
406
420
      </varlistentry>
407
 
      <varlistentry>
408
 
        <term><filename>/bin/sh</filename></term>
409
 
        <listitem>
410
 
          <para>
411
 
            This is used to start the configured checker command for
412
 
            each client.  See <citerefentry>
413
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
414
 
            <manvolnum>5</manvolnum></citerefentry> for details.
415
 
          </para>
416
 
        </listitem>
417
 
      </varlistentry>
418
421
    </variablelist>
419
422
  </refsect1>
420
 
  
 
423
 
421
424
  <refsect1 id="bugs">
422
425
    <title>BUGS</title>
423
426
    <para>
424
427
      This server might, on especially fatal errors, emit a Python
425
428
      backtrace.  This could be considered a feature.
426
429
    </para>
427
 
    <para>
428
 
      Currently, if a client is declared <quote>invalid</quote> due to
429
 
      having timed out, the server does not record this fact onto
430
 
      permanent storage.  This has some security implications, see
431
 
      <xref linkend="CLIENTS"/>.
432
 
    </para>
433
 
    <para>
434
 
      There is currently no way of querying the server of the current
435
 
      status of clients, other than analyzing its <systemitem
436
 
      class="service">syslog</systemitem> output.
437
 
    </para>
438
 
    <para>
439
 
      There is no fine-grained control over logging and debug output.
440
 
    </para>
441
 
    <para>
442
 
      Debug mode is conflated with running in the foreground.
443
 
    </para>
444
 
    <para>
445
 
      The console log messages does not show a timestamp.
446
 
    </para>
447
430
  </refsect1>
448
 
  
449
 
  <refsect1 id="example">
450
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
451
434
    <informalexample>
452
435
      <para>
453
436
        Normal invocation needs no options:
454
437
      </para>
455
438
      <para>
456
 
        <userinput>&COMMANDNAME;</userinput>
 
439
        <userinput>mandos</userinput>
457
440
      </para>
458
441
    </informalexample>
459
442
    <informalexample>
466
449
      <para>
467
450
 
468
451
<!-- do not wrap this line -->
469
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
452
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
470
453
 
471
454
      </para>
472
455
    </informalexample>
478
461
      <para>
479
462
 
480
463
<!-- do not wrap this line -->
481
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
482
465
 
483
466
      </para>
484
467
    </informalexample>
486
469
 
487
470
  <refsect1 id="security">
488
471
    <title>SECURITY</title>
489
 
    <refsect2 id="SERVER">
 
472
    <refsect2>
490
473
      <title>SERVER</title>
491
474
      <para>
492
 
        Running this <command>&COMMANDNAME;</command> server program
493
 
        should not in itself present any security risk to the host
494
 
        computer running it.  The program does not need any special
495
 
        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.
496
479
      </para>
497
480
    </refsect2>
498
 
    <refsect2 id="CLIENTS">
 
481
    <refsect2>
499
482
      <title>CLIENTS</title>
500
483
      <para>
501
484
        The server only gives out its stored data to clients which
516
499
        compromised if they are gone for too long.
517
500
      </para>
518
501
      <para>
519
 
        If a client is compromised, its downtime should be duly noted
520
 
        by the server which would therefore declare the client
521
 
        invalid.  But if the server was ever restarted, it would
522
 
        re-read its client list from its configuration file and again
523
 
        regard all clients therein as valid, and hence eligible to
524
 
        receive their passwords.  Therefore, be careful when
525
 
        restarting servers if it is suspected that a client has, in
526
 
        fact, been compromised by parties who may now be running a
527
 
        fake Mandos client with the keys from the non-encrypted
528
 
        initial RAM image of the client host.  What should be done in
529
 
        that case (if restarting the server program really is
530
 
        necessary) is to stop the server program, edit the
531
 
        configuration file to omit any suspect clients, and restart
532
 
        the server program.
533
 
      </para>
534
 
      <para>
535
502
        For more details on client-side security, see
536
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
537
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
541
508
 
542
509
  <refsect1 id="see_also">
543
510
    <title>SEE ALSO</title>
544
 
    <para>
545
 
      <citerefentry>
546
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
547
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
548
 
        <refentrytitle>mandos.conf</refentrytitle>
549
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
550
 
        <refentrytitle>password-request</refentrytitle>
551
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
552
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
553
 
      </citerefentry>
554
 
    </para>
555
511
    <variablelist>
556
512
      <varlistentry>
557
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>
558
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
559
531
        </term>
560
532
        <listitem>
577
549
      </varlistentry>
578
550
      <varlistentry>
579
551
        <term>
580
 
          <ulink url="http://www.gnu.org/software/gnutls/"
581
 
          >GnuTLS</ulink>
 
552
          <ulink
 
553
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
582
554
        </term>
583
555
      <listitem>
584
556
        <para>
590
562
      </varlistentry>
591
563
      <varlistentry>
592
564
        <term>
593
 
          RFC 4291: <citetitle>IP Version 6 Addressing
594
 
          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>
595
568
        </term>
596
569
        <listitem>
597
 
          <variablelist>
598
 
            <varlistentry>
599
 
              <term>Section 2.2: <citetitle>Text Representation of
600
 
              Addresses</citetitle></term>
601
 
              <listitem><para/></listitem>
602
 
            </varlistentry>
603
 
            <varlistentry>
604
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
605
 
              Address</citetitle></term>
606
 
              <listitem><para/></listitem>
607
 
            </varlistentry>
608
 
            <varlistentry>
609
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
610
 
            Addresses</citetitle></term>
611
 
            <listitem>
612
 
              <para>
613
 
                The clients use IPv6 link-local addresses, which are
614
 
                immediately usable since a link-local addresses is
615
 
                automatically assigned to a network interfaces when it
616
 
                is brought up.
617
 
              </para>
618
 
            </listitem>
619
 
            </varlistentry>
620
 
          </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>
621
576
        </listitem>
622
577
      </varlistentry>
623
578
      <varlistentry>
624
579
        <term>
625
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
626
 
          Protocol Version 1.1</citetitle>
 
580
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
581
          (TLS) Protocol Version 1.1</citetitle></citation>
627
582
        </term>
628
583
      <listitem>
629
584
        <para>
633
588
      </varlistentry>
634
589
      <varlistentry>
635
590
        <term>
636
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
591
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
592
          Format</citetitle></citation>
637
593
        </term>
638
594
      <listitem>
639
595
        <para>
643
599
      </varlistentry>
644
600
      <varlistentry>
645
601
        <term>
646
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
647
 
          Security</citetitle>
 
602
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
603
          Transport Layer Security</citetitle></citation>
648
604
        </term>
649
605
      <listitem>
650
606
        <para>
656
612
    </variablelist>
657
613
  </refsect1>
658
614
</refentry>
659
 
<!-- Local Variables: -->
660
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
661
 
<!-- time-stamp-end: "[\"']>" -->
662
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
663
 
<!-- End: -->