/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-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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
<!ENTITY TIMESTAMP "2008-08-29">
7
7
]>
8
8
 
9
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
10
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
12
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
14
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
15
16
    <authorgroup>
16
17
      <author>
17
18
        <firstname>Björn</firstname>
73
74
  <refsynopsisdiv>
74
75
    <cmdsynopsis>
75
76
      <command>&COMMANDNAME;</command>
76
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
77
      <arg>--interface<arg choice="plain">NAME</arg></arg>
77
78
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
79
      <arg>--port<arg choice="plain">PORT</arg></arg>
79
80
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
83
84
    </cmdsynopsis>
84
85
    <cmdsynopsis>
85
86
      <command>&COMMANDNAME;</command>
86
 
      <arg>-i<arg choice="plain">IF</arg></arg>
 
87
      <arg>-i<arg choice="plain">NAME</arg></arg>
87
88
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
89
      <arg>-p<arg choice="plain">PORT</arg></arg>
89
90
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
151
152
      </varlistentry>
152
153
 
153
154
      <varlistentry>
154
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
155
 
        IF</replaceable></literal></term>
 
155
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
156
        >NAME</replaceable></literal></term>
156
157
        <listitem>
157
 
          <para>
158
 
            Only announce the server and listen to requests on network
159
 
            interface <replaceable>IF</replaceable>.  Default is to
160
 
            use all available interfaces.  <emphasis>Note:</emphasis>
161
 
            a failure to bind to the specified interface is not
162
 
            considered critical, and the server does not exit.
163
 
          </para>
 
158
          <xi:include href="mandos-options.xml" xpointer="interface"/>
164
159
        </listitem>
165
160
      </varlistentry>
166
161
 
168
163
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
164
        ADDRESS</replaceable></literal></term>
170
165
        <listitem>
171
 
          <para>
172
 
            If this option is used, the server will only listen to a
173
 
            specific address.  This must currently be an IPv6 address;
174
 
            an IPv4 address can be specified using the
175
 
            <quote><literal>::FFFF:192.0.2.3</literal></quote> syntax.
176
 
            Also, if a link-local address is specified, an interface
177
 
            should be set, since a link-local address is only valid on
178
 
            a single interface.  By default, the server will listen to
179
 
            all available addresses.
180
 
          </para>
 
166
          <xi:include href="mandos-options.xml" xpointer="address"/>
181
167
        </listitem>
182
168
      </varlistentry>
183
169
 
185
171
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
172
        PORT</replaceable></literal></term>
187
173
        <listitem>
188
 
          <para>
189
 
            If this option is used, the server to bind to that
190
 
            port. By default, the server will listen to an arbitrary
191
 
            port given by the operating system.
192
 
          </para>
 
174
          <xi:include href="mandos-options.xml" xpointer="port"/>
193
175
        </listitem>
194
176
      </varlistentry>
195
177
 
206
188
      <varlistentry>
207
189
        <term><literal>--debug</literal></term>
208
190
        <listitem>
209
 
          <para>
210
 
            If the server is run in debug mode, it will run in the
211
 
            foreground and print a lot of debugging information.  The
212
 
            default is <emphasis>not</emphasis> to run in debug mode.
213
 
          </para>
 
191
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
192
        </listitem>
215
193
      </varlistentry>
216
194
 
218
196
        <term><literal>--priority <replaceable>
219
197
        PRIORITY</replaceable></literal></term>
220
198
        <listitem>
221
 
          <para>
222
 
            GnuTLS priority string for the TLS handshake with the
223
 
            clients.  The default is
224
 
            <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
225
 
            See <citerefentry><refentrytitle>gnutls_priority_init
226
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>
227
 
            for the syntax.  <emphasis>Warning</emphasis>: changing
228
 
            this may make the TLS handshake fail, making communication
229
 
            with clients impossible.
230
 
          </para>
 
199
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
200
        </listitem>
232
201
      </varlistentry>
233
202
 
235
204
        <term><literal>--servicename <replaceable>NAME</replaceable>
236
205
        </literal></term>
237
206
        <listitem>
238
 
          <para>
239
 
            Zeroconf service name.  The default is
240
 
            <quote><literal>Mandos</literal></quote>.  You only need
241
 
            to change this if you for some reason want to run more
242
 
            than one server on the same <emphasis>host</emphasis>,
243
 
            which would not normally be useful.  If there are name
244
 
            collisions on the same <emphasis>network</emphasis>, the
245
 
            newer server will automatically rename itself to
246
 
            <quote><literal>Mandos #2</literal></quote>, and so on;
247
 
            therefore, this option is not needed in that case.
248
 
          </para>
 
207
          <xi:include href="mandos-options.xml"
 
208
                      xpointer="servicename"/>
249
209
        </listitem>
250
210
      </varlistentry>
251
211
 
277
237
 
278
238
  <refsect1 id="overview">
279
239
    <title>OVERVIEW</title>
280
 
    &OVERVIEW;
 
240
    <xi:include href="overview.xml"/>
281
241
    <para>
282
242
      This program is the server part.  It is a normal server program
283
243
      and will run in a normal system environment, not in an initial
316
276
        <entry>-><!-- &rarr; --></entry>
317
277
      </row>
318
278
      <row>
319
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
279
        <entry><quote><literal>1\r\n</literal></quote></entry>
320
280
        <entry>-><!-- &rarr; --></entry>
321
281
      </row>
322
282
      <row>
352
312
      longer eligible to receive the encrypted password.  The timeout,
353
313
      checker program, and interval between checks can be configured
354
314
      both globally and per client; see <citerefentry>
355
 
      <refentrytitle>mandos.conf</refentrytitle>
356
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
357
315
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
316
      <manvolnum>5</manvolnum></citerefentry>.
359
317
    </para>
362
320
  <refsect1 id="logging">
363
321
    <title>LOGGING</title>
364
322
    <para>
365
 
      The server will send log messaged with various severity levels
366
 
      to <filename>/dev/log</filename>.  With the
 
323
      The server will send log message with various severity levels to
 
324
      <filename>/dev/log</filename>.  With the
367
325
      <option>--debug</option> option, it will log even more messages,
368
326
      and also show them on the console.
369
327
    </para>
390
348
            <varname>PATH</varname> to search for matching commands if
391
349
            an absolute path is not given.  See <citerefentry>
392
350
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
393
 
          </citerefentry>
 
351
            </citerefentry>.
394
352
          </para>
395
353
        </listitem>
396
354
      </varlistentry>
492
450
        Normal invocation needs no options:
493
451
      </para>
494
452
      <para>
495
 
        <userinput>mandos</userinput>
 
453
        <userinput>&COMMANDNAME;</userinput>
496
454
      </para>
497
455
    </informalexample>
498
456
    <informalexample>
505
463
      <para>
506
464
 
507
465
<!-- do not wrap this line -->
508
 
<userinput>mandos --debug --configdir ~/mandos --servicename Test</userinput>
 
466
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
509
467
 
510
468
      </para>
511
469
    </informalexample>
517
475
      <para>
518
476
 
519
477
<!-- do not wrap this line -->
520
 
<userinput>mandos --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
 
478
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
521
479
 
522
480
      </para>
523
481
    </informalexample>
561
519
        re-read its client list from its configuration file and again
562
520
        regard all clients therein as valid, and hence eligible to
563
521
        receive their passwords.  Therefore, be careful when
564
 
        restarting servers if you suspect that a client has, in fact,
565
 
        been compromised by parties who may now be running a fake
566
 
        Mandos client with the keys from the non-encrypted initial RAM
567
 
        image of the client host.  What should be done in that case
568
 
        (if restarting the server program really is necessary) is to
569
 
        stop the server program, edit the configuration file to omit
570
 
        any suspect clients, and restart the server program.
 
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.
571
530
      </para>
572
531
      <para>
573
532
        For more details on client-side security, see
579
538
 
580
539
  <refsect1 id="see_also">
581
540
    <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>
582
552
    <variablelist>
583
553
      <varlistentry>
584
554
        <term>
585
 
          <citerefentry>
586
 
            <refentrytitle>password-request</refentrytitle>
587
 
            <manvolnum>8mandos</manvolnum>
588
 
          </citerefentry>
589
 
        </term>
590
 
        <listitem>
591
 
          <para>
592
 
            This is the actual program which talks to this server.
593
 
            Note that it is normally not invoked directly, and is only
594
 
            run in the initial RAM disk environment, and not on a
595
 
            fully started system.
596
 
          </para>
597
 
        </listitem>
598
 
      </varlistentry>
599
 
      <varlistentry>
600
 
        <term>
601
555
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
602
556
        </term>
603
557
        <listitem>
620
574
      </varlistentry>
621
575
      <varlistentry>
622
576
        <term>
623
 
          <ulink
624
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
577
          <ulink url="http://www.gnu.org/software/gnutls/"
 
578
          >GnuTLS</ulink>
625
579
        </term>
626
580
      <listitem>
627
581
        <para>
633
587
      </varlistentry>
634
588
      <varlistentry>
635
589
        <term>
636
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
 
          Unicast Addresses</citation>
 
590
          RFC 4291: <citetitle>IP Version 6 Addressing
 
591
          Architecture</citetitle>
639
592
        </term>
640
593
        <listitem>
641
 
          <para>
642
 
            The clients use IPv6 link-local addresses, which are
643
 
            immediately usable since a link-local addresses is
644
 
            automatically assigned to a network interfaces when it is
645
 
            brought up.
646
 
          </para>
 
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>
647
618
        </listitem>
648
619
      </varlistentry>
649
620
      <varlistentry>
650
621
        <term>
651
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
652
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
622
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
623
          Protocol Version 1.1</citetitle>
653
624
        </term>
654
625
      <listitem>
655
626
        <para>
659
630
      </varlistentry>
660
631
      <varlistentry>
661
632
        <term>
662
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
663
 
          Format</citetitle></citation>
 
633
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
664
634
        </term>
665
635
      <listitem>
666
636
        <para>
670
640
      </varlistentry>
671
641
      <varlistentry>
672
642
        <term>
673
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
674
 
          Transport Layer Security</citetitle></citation>
 
643
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
644
          Security</citetitle>
675
645
        </term>
676
646
      <listitem>
677
647
        <para>
683
653
    </variablelist>
684
654
  </refsect1>
685
655
</refentry>
 
656
<!-- Local Variables: -->
 
657
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
658
<!-- time-stamp-end: "[\"']>" -->
 
659
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
660
<!-- End: -->