/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-25 10:41:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825104116-cjd54qqs535kpdxq
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
                                syntax by name.

* mandos.conf.xml (SEE ALSO): Also refer to gnutls_priority_init(3),
                              RFC 4291, and Zeroconf.

* mandos.xml (SEE ALSO): Also refer to sections 2.2 and 2.5.5.2 of RFC
                         4291.  Stop using <citation> tags.

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">
7
6
]>
8
7
 
9
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
73
72
  <refsynopsisdiv>
74
73
    <cmdsynopsis>
75
74
      <command>&COMMANDNAME;</command>
76
 
      <arg>--interface<arg choice="plain">IF</arg></arg>
 
75
      <arg>--interface<arg choice="plain">NAME</arg></arg>
77
76
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
78
77
      <arg>--port<arg choice="plain">PORT</arg></arg>
79
78
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
83
82
    </cmdsynopsis>
84
83
    <cmdsynopsis>
85
84
      <command>&COMMANDNAME;</command>
86
 
      <arg>-i<arg choice="plain">IF</arg></arg>
 
85
      <arg>-i<arg choice="plain">NAME</arg></arg>
87
86
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
88
87
      <arg>-p<arg choice="plain">PORT</arg></arg>
89
88
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
151
150
      </varlistentry>
152
151
 
153
152
      <varlistentry>
154
 
        <term><literal>-i</literal>, <literal>--interface <replaceable>
155
 
        IF</replaceable></literal></term>
 
153
        <term><literal>-i</literal>, <literal>--interface <replaceable
 
154
        >NAME</replaceable></literal></term>
156
155
        <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>
 
156
          <xi:include href="mandos-options.xml" xpointer="interface"/>
164
157
        </listitem>
165
158
      </varlistentry>
166
159
 
168
161
        <term><literal>-a</literal>, <literal>--address <replaceable>
169
162
        ADDRESS</replaceable></literal></term>
170
163
        <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>
 
164
          <xi:include href="mandos-options.xml" xpointer="address"/>
181
165
        </listitem>
182
166
      </varlistentry>
183
167
 
185
169
        <term><literal>-p</literal>, <literal>--port <replaceable>
186
170
        PORT</replaceable></literal></term>
187
171
        <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>
 
172
          <xi:include href="mandos-options.xml" xpointer="port"/>
193
173
        </listitem>
194
174
      </varlistentry>
195
175
 
206
186
      <varlistentry>
207
187
        <term><literal>--debug</literal></term>
208
188
        <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>
 
189
          <xi:include href="mandos-options.xml" xpointer="debug"/>
214
190
        </listitem>
215
191
      </varlistentry>
216
192
 
218
194
        <term><literal>--priority <replaceable>
219
195
        PRIORITY</replaceable></literal></term>
220
196
        <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>
 
197
          <xi:include href="mandos-options.xml" xpointer="priority"/>
231
198
        </listitem>
232
199
      </varlistentry>
233
200
 
235
202
        <term><literal>--servicename <replaceable>NAME</replaceable>
236
203
        </literal></term>
237
204
        <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>
 
205
          <xi:include href="mandos-options.xml"
 
206
                      xpointer="servicename"/>
249
207
        </listitem>
250
208
      </varlistentry>
251
209
 
277
235
 
278
236
  <refsect1 id="overview">
279
237
    <title>OVERVIEW</title>
280
 
    &OVERVIEW;
 
238
    <xi:include href="overview.xml"/>
281
239
    <para>
282
240
      This program is the server part.  It is a normal server program
283
241
      and will run in a normal system environment, not in an initial
316
274
        <entry>-><!-- &rarr; --></entry>
317
275
      </row>
318
276
      <row>
319
 
        <entry><quote><literal>1\r\en</literal></quote></entry>
 
277
        <entry><quote><literal>1\r\n</literal></quote></entry>
320
278
        <entry>-><!-- &rarr; --></entry>
321
279
      </row>
322
280
      <row>
352
310
      longer eligible to receive the encrypted password.  The timeout,
353
311
      checker program, and interval between checks can be configured
354
312
      both globally and per client; see <citerefentry>
355
 
      <refentrytitle>mandos.conf</refentrytitle>
356
 
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
357
313
      <refentrytitle>mandos-clients.conf</refentrytitle>
358
314
      <manvolnum>5</manvolnum></citerefentry>.
359
315
    </para>
362
318
  <refsect1 id="logging">
363
319
    <title>LOGGING</title>
364
320
    <para>
365
 
      The server will send log messaged with various severity levels
366
 
      to <filename>/dev/log</filename>.  With the
 
321
      The server will send log message with various severity levels to
 
322
      <filename>/dev/log</filename>.  With the
367
323
      <option>--debug</option> option, it will log even more messages,
368
324
      and also show them on the console.
369
325
    </para>
390
346
            <varname>PATH</varname> to search for matching commands if
391
347
            an absolute path is not given.  See <citerefentry>
392
348
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
393
 
          </citerefentry>
 
349
            </citerefentry>.
394
350
          </para>
395
351
        </listitem>
396
352
      </varlistentry>
561
517
        re-read its client list from its configuration file and again
562
518
        regard all clients therein as valid, and hence eligible to
563
519
        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.
 
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.
571
528
      </para>
572
529
      <para>
573
530
        For more details on client-side security, see
579
536
 
580
537
  <refsect1 id="see_also">
581
538
    <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>
582
550
    <variablelist>
583
551
      <varlistentry>
584
552
        <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
553
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
602
554
        </term>
603
555
        <listitem>
620
572
      </varlistentry>
621
573
      <varlistentry>
622
574
        <term>
623
 
          <ulink
624
 
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
 
575
          <ulink url="http://www.gnu.org/software/gnutls/"
 
576
          >GnuTLS</ulink>
625
577
        </term>
626
578
      <listitem>
627
579
        <para>
633
585
      </varlistentry>
634
586
      <varlistentry>
635
587
        <term>
636
 
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
637
 
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
638
 
          Unicast Addresses</citation>
 
588
          RFC 4291: <citetitle>IP Version 6 Addressing
 
589
          Architecture</citetitle>
639
590
        </term>
640
591
        <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>
 
592
          <variablelist>
 
593
            <varlistentry>
 
594
              <term>Section 2.2: <citetitle>Text Representation of
 
595
              Addresses</citetitle></term>
 
596
              <listitem><para/></listitem>
 
597
            </varlistentry>
 
598
            <varlistentry>
 
599
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
600
              Address</citetitle></term>
 
601
              <listitem><para/></listitem>
 
602
            </varlistentry>
 
603
            <varlistentry>
 
604
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
605
            Addresses</citetitle></term>
 
606
            <listitem>
 
607
              <para>
 
608
                The clients use IPv6 link-local addresses, which are
 
609
                immediately usable since a link-local addresses is
 
610
                automatically assigned to a network interfaces when it
 
611
                is brought up.
 
612
              </para>
 
613
            </listitem>
 
614
            </varlistentry>
 
615
          </variablelist>
647
616
        </listitem>
648
617
      </varlistentry>
649
618
      <varlistentry>
650
619
        <term>
651
 
          <citation>RFC 4346: <citetitle>The Transport Layer Security
652
 
          (TLS) Protocol Version 1.1</citetitle></citation>
 
620
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
621
          Protocol Version 1.1</citetitle>
653
622
        </term>
654
623
      <listitem>
655
624
        <para>
659
628
      </varlistentry>
660
629
      <varlistentry>
661
630
        <term>
662
 
          <citation>RFC 4880: <citetitle>OpenPGP Message
663
 
          Format</citetitle></citation>
 
631
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
664
632
        </term>
665
633
      <listitem>
666
634
        <para>
670
638
      </varlistentry>
671
639
      <varlistentry>
672
640
        <term>
673
 
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
674
 
          Transport Layer Security</citetitle></citation>
 
641
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
642
          Security</citetitle>
675
643
        </term>
676
644
      <listitem>
677
645
        <para>