/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 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
 
      <group>
78
 
        <arg choice="plain"><option>--interface
79
 
        <replaceable>NAME</replaceable></option></arg>
80
 
        <arg choice="plain"><option>-i
81
 
        <replaceable>NAME</replaceable></option></arg>
82
 
      </group>
83
 
      <sbr/>
84
 
      <group>
85
 
        <arg choice="plain"><option>--address
86
 
        <replaceable>ADDRESS</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-a
88
 
        <replaceable>ADDRESS</replaceable></option></arg>
89
 
      </group>
90
 
      <sbr/>
91
 
      <group>
92
 
        <arg choice="plain"><option>--port
93
 
        <replaceable>PORT</replaceable></option></arg>
94
 
        <arg choice="plain"><option>-p
95
 
        <replaceable>PORT</replaceable></option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <arg><option>--priority
99
 
      <replaceable>PRIORITY</replaceable></option></arg>
100
 
      <sbr/>
101
 
      <arg><option>--servicename
102
 
      <replaceable>NAME</replaceable></option></arg>
103
 
      <sbr/>
104
 
      <arg><option>--configdir
105
 
      <replaceable>DIRECTORY</replaceable></option></arg>
106
 
      <sbr/>
107
 
      <arg><option>--debug</option></arg>
108
 
    </cmdsynopsis>
109
 
    <cmdsynopsis>
110
 
      <command>&COMMANDNAME;</command>
111
 
      <group choice="req">
112
 
        <arg choice="plain"><option>-h</option></arg>
113
 
        <arg choice="plain"><option>--help</option></arg>
114
 
      </group>
115
 
    </cmdsynopsis>
116
 
    <cmdsynopsis>
117
 
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--version</option></arg>
119
 
    </cmdsynopsis>
120
 
    <cmdsynopsis>
121
 
      <command>&COMMANDNAME;</command>
122
 
      <arg choice="plain"><option>--check</option></arg>
 
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>
 
97
    </cmdsynopsis>
 
98
    <cmdsynopsis>
 
99
      <command>&COMMANDNAME;</command>
 
100
      <arg choice="plain">--version</arg>
 
101
    </cmdsynopsis>
 
102
    <cmdsynopsis>
 
103
      <command>&COMMANDNAME;</command>
 
104
      <arg choice="plain">--check</arg>
123
105
    </cmdsynopsis>
124
106
  </refsynopsisdiv>
125
107
 
157
139
 
158
140
    <variablelist>
159
141
      <varlistentry>
160
 
        <term><option>-h</option></term>
161
 
        <term><option>--help</option></term>
 
142
        <term><literal>-h</literal>, <literal>--help</literal></term>
162
143
        <listitem>
163
144
          <para>
164
145
            Show a help message and exit
167
148
      </varlistentry>
168
149
 
169
150
      <varlistentry>
170
 
        <term><option>-i</option>
171
 
        <replaceable>NAME</replaceable></term>
172
 
        <term><option>--interface</option>
173
 
        <replaceable>NAME</replaceable></term>
 
151
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
152
        IF</replaceable></literal></term>
174
153
        <listitem>
175
 
          <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>
176
159
        </listitem>
177
160
      </varlistentry>
178
161
 
180
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
181
164
        ADDRESS</replaceable></literal></term>
182
165
        <listitem>
183
 
          <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>
184
176
        </listitem>
185
177
      </varlistentry>
186
178
 
188
180
        <term><literal>-p</literal>, <literal>--port <replaceable>
189
181
        PORT</replaceable></literal></term>
190
182
        <listitem>
191
 
          <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>
192
188
        </listitem>
193
189
      </varlistentry>
194
190
 
205
201
      <varlistentry>
206
202
        <term><literal>--debug</literal></term>
207
203
        <listitem>
208
 
          <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>
209
209
        </listitem>
210
210
      </varlistentry>
211
211
 
213
213
        <term><literal>--priority <replaceable>
214
214
        PRIORITY</replaceable></literal></term>
215
215
        <listitem>
216
 
          <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>
217
226
        </listitem>
218
227
      </varlistentry>
219
228
 
221
230
        <term><literal>--servicename <replaceable>NAME</replaceable>
222
231
        </literal></term>
223
232
        <listitem>
224
 
          <xi:include href="mandos-options.xml"
225
 
                      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>
226
244
        </listitem>
227
245
      </varlistentry>
228
246
 
254
272
 
255
273
  <refsect1 id="overview">
256
274
    <title>OVERVIEW</title>
257
 
    <xi:include href="overview.xml"/>
 
275
    &OVERVIEW;
258
276
    <para>
259
277
      This program is the server part.  It is a normal server program
260
278
      and will run in a normal system environment, not in an initial
293
311
        <entry>-><!-- &rarr; --></entry>
294
312
      </row>
295
313
      <row>
296
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
314
        <entry><quote><literal>1\r\en</literal></quote></entry>
297
315
        <entry>-><!-- &rarr; --></entry>
298
316
      </row>
299
317
      <row>
329
347
      longer eligible to receive the encrypted password.  The timeout,
330
348
      checker program, and interval between checks can be configured
331
349
      both globally and per client; see <citerefentry>
 
350
      <refentrytitle>mandos.conf</refentrytitle>
 
351
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
332
352
      <refentrytitle>mandos-clients.conf</refentrytitle>
333
353
      <manvolnum>5</manvolnum></citerefentry>.
334
354
    </para>
337
357
  <refsect1 id="logging">
338
358
    <title>LOGGING</title>
339
359
    <para>
340
 
      The server will send log message with various severity levels to
341
 
      <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
342
362
      <option>--debug</option> option, it will log even more messages,
343
363
      and also show them on the console.
344
364
    </para>
352
372
    </para>
353
373
  </refsect1>
354
374
 
355
 
  <refsect1 id="environment">
356
 
    <title>ENVIRONMENT</title>
357
 
    <variablelist>
358
 
      <varlistentry>
359
 
        <term><envar>PATH</envar></term>
360
 
        <listitem>
361
 
          <para>
362
 
            To start the configured checker (see <xref
363
 
            linkend="checking"/>), the server uses
364
 
            <filename>/bin/sh</filename>, which in turn uses
365
 
            <varname>PATH</varname> to search for matching commands if
366
 
            an absolute path is not given.  See <citerefentry>
367
 
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
368
 
            </citerefentry>.
369
 
          </para>
370
 
        </listitem>
371
 
      </varlistentry>
372
 
    </variablelist>
373
 
  </refsect1>
374
 
 
375
375
  <refsect1 id="file">
376
376
    <title>FILES</title>
377
377
    <para>
418
418
          </para>
419
419
        </listitem>
420
420
      </varlistentry>
421
 
      <varlistentry>
422
 
        <term><filename>/bin/sh</filename></term>
423
 
        <listitem>
424
 
          <para>
425
 
            This is used to start the configured checker command for
426
 
            each client.  See <citerefentry>
427
 
            <refentrytitle>mandos-clients.conf</refentrytitle>
428
 
            <manvolnum>5</manvolnum></citerefentry> for details.
429
 
          </para>
430
 
        </listitem>
431
 
      </varlistentry>
432
421
    </variablelist>
433
422
  </refsect1>
434
 
  
 
423
 
435
424
  <refsect1 id="bugs">
436
425
    <title>BUGS</title>
437
426
    <para>
438
427
      This server might, on especially fatal errors, emit a Python
439
428
      backtrace.  This could be considered a feature.
440
429
    </para>
441
 
    <para>
442
 
      Currently, if a client is declared <quote>invalid</quote> due to
443
 
      having timed out, the server does not record this fact onto
444
 
      permanent storage.  This has some security implications, see
445
 
      <xref linkend="CLIENTS"/>.
446
 
    </para>
447
 
    <para>
448
 
      There is currently no way of querying the server of the current
449
 
      status of clients, other than analyzing its <systemitem
450
 
      class="service">syslog</systemitem> output.
451
 
    </para>
452
 
    <para>
453
 
      There is no fine-grained control over logging and debug output.
454
 
    </para>
455
 
    <para>
456
 
      Debug mode is conflated with running in the foreground.
457
 
    </para>
458
 
    <para>
459
 
      The console log messages does not show a timestamp.
460
 
    </para>
461
430
  </refsect1>
462
 
  
463
 
  <refsect1 id="example">
464
 
    <title>EXAMPLE</title>
 
431
 
 
432
  <refsect1 id="examples">
 
433
    <title>EXAMPLES</title>
465
434
    <informalexample>
466
435
      <para>
467
436
        Normal invocation needs no options:
468
437
      </para>
469
438
      <para>
470
 
        <userinput>&COMMANDNAME;</userinput>
 
439
        <userinput>mandos</userinput>
471
440
      </para>
472
441
    </informalexample>
473
442
    <informalexample>
480
449
      <para>
481
450
 
482
451
<!-- do not wrap this line -->
483
 
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
 
452
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
484
453
 
485
454
      </para>
486
455
    </informalexample>
492
461
      <para>
493
462
 
494
463
<!-- do not wrap this line -->
495
 
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
464
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
496
465
 
497
466
      </para>
498
467
    </informalexample>
500
469
 
501
470
  <refsect1 id="security">
502
471
    <title>SECURITY</title>
503
 
    <refsect2 id="SERVER">
 
472
    <refsect2>
504
473
      <title>SERVER</title>
505
474
      <para>
506
 
        Running this <command>&COMMANDNAME;</command> server program
507
 
        should not in itself present any security risk to the host
508
 
        computer running it.  The program does not need any special
509
 
        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.
510
479
      </para>
511
480
    </refsect2>
512
 
    <refsect2 id="CLIENTS">
 
481
    <refsect2>
513
482
      <title>CLIENTS</title>
514
483
      <para>
515
484
        The server only gives out its stored data to clients which
530
499
        compromised if they are gone for too long.
531
500
      </para>
532
501
      <para>
533
 
        If a client is compromised, its downtime should be duly noted
534
 
        by the server which would therefore declare the client
535
 
        invalid.  But if the server was ever restarted, it would
536
 
        re-read its client list from its configuration file and again
537
 
        regard all clients therein as valid, and hence eligible to
538
 
        receive their passwords.  Therefore, be careful when
539
 
        restarting servers if it is suspected that a client has, in
540
 
        fact, been compromised by parties who may now be running a
541
 
        fake Mandos client with the keys from the non-encrypted
542
 
        initial RAM image of the client host.  What should be done in
543
 
        that case (if restarting the server program really is
544
 
        necessary) is to stop the server program, edit the
545
 
        configuration file to omit any suspect clients, and restart
546
 
        the server program.
547
 
      </para>
548
 
      <para>
549
502
        For more details on client-side security, see
550
503
        <citerefentry><refentrytitle>password-request</refentrytitle>
551
504
        <manvolnum>8mandos</manvolnum></citerefentry>.
555
508
 
556
509
  <refsect1 id="see_also">
557
510
    <title>SEE ALSO</title>
558
 
    <para>
559
 
      <citerefentry>
560
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
561
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
562
 
        <refentrytitle>mandos.conf</refentrytitle>
563
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
564
 
        <refentrytitle>password-request</refentrytitle>
565
 
        <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
566
 
        <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
567
 
      </citerefentry>
568
 
    </para>
569
511
    <variablelist>
570
512
      <varlistentry>
571
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>
572
530
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
573
531
        </term>
574
532
        <listitem>
591
549
      </varlistentry>
592
550
      <varlistentry>
593
551
        <term>
594
 
          <ulink url="http://www.gnu.org/software/gnutls/"
595
 
          >GnuTLS</ulink>
 
552
          <ulink
 
553
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
596
554
        </term>
597
555
      <listitem>
598
556
        <para>
604
562
      </varlistentry>
605
563
      <varlistentry>
606
564
        <term>
607
 
          RFC 4291: <citetitle>IP Version 6 Addressing
608
 
          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>
609
568
        </term>
610
569
        <listitem>
611
 
          <variablelist>
612
 
            <varlistentry>
613
 
              <term>Section 2.2: <citetitle>Text Representation of
614
 
              Addresses</citetitle></term>
615
 
              <listitem><para/></listitem>
616
 
            </varlistentry>
617
 
            <varlistentry>
618
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
619
 
              Address</citetitle></term>
620
 
              <listitem><para/></listitem>
621
 
            </varlistentry>
622
 
            <varlistentry>
623
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
624
 
            Addresses</citetitle></term>
625
 
            <listitem>
626
 
              <para>
627
 
                The clients use IPv6 link-local addresses, which are
628
 
                immediately usable since a link-local addresses is
629
 
                automatically assigned to a network interfaces when it
630
 
                is brought up.
631
 
              </para>
632
 
            </listitem>
633
 
            </varlistentry>
634
 
          </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>
635
576
        </listitem>
636
577
      </varlistentry>
637
578
      <varlistentry>
638
579
        <term>
639
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
640
 
          Protocol Version 1.1</citetitle>
 
580
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
581
          (TLS) Protocol Version 1.1</citetitle></citation>
641
582
        </term>
642
583
      <listitem>
643
584
        <para>
647
588
      </varlistentry>
648
589
      <varlistentry>
649
590
        <term>
650
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
591
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
592
          Format</citetitle></citation>
651
593
        </term>
652
594
      <listitem>
653
595
        <para>
657
599
      </varlistentry>
658
600
      <varlistentry>
659
601
        <term>
660
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
661
 
          Security</citetitle>
 
602
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
603
          Transport Layer Security</citetitle></citation>
662
604
        </term>
663
605
      <listitem>
664
606
        <para>
670
612
    </variablelist>
671
613
  </refsect1>
672
614
</refentry>
673
 
<!-- Local Variables: -->
674
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
675
 
<!-- time-stamp-end: "[\"']>" -->
676
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
677
 
<!-- End: -->