/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

merge

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">NAME</arg></arg>
 
76
      <arg>--interface<arg choice="plain">IF</arg></arg>
76
77
      <arg>--address<arg choice="plain">ADDRESS</arg></arg>
77
78
      <arg>--port<arg choice="plain">PORT</arg></arg>
78
79
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
82
83
    </cmdsynopsis>
83
84
    <cmdsynopsis>
84
85
      <command>&COMMANDNAME;</command>
85
 
      <arg>-i<arg choice="plain">NAME</arg></arg>
 
86
      <arg>-i<arg choice="plain">IF</arg></arg>
86
87
      <arg>-a<arg choice="plain">ADDRESS</arg></arg>
87
88
      <arg>-p<arg choice="plain">PORT</arg></arg>
88
89
      <arg>--priority<arg choice="plain">PRIORITY</arg></arg>
150
151
      </varlistentry>
151
152
 
152
153
      <varlistentry>
153
 
        <term><literal>-i</literal>, <literal>--interface <replaceable
154
 
        >NAME</replaceable></literal></term>
 
154
        <term><literal>-i</literal>, <literal>--interface <replaceable>
 
155
        IF</replaceable></literal></term>
155
156
        <listitem>
156
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
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>
157
164
        </listitem>
158
165
      </varlistentry>
159
166
 
161
168
        <term><literal>-a</literal>, <literal>--address <replaceable>
162
169
        ADDRESS</replaceable></literal></term>
163
170
        <listitem>
164
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
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>
165
181
        </listitem>
166
182
      </varlistentry>
167
183
 
169
185
        <term><literal>-p</literal>, <literal>--port <replaceable>
170
186
        PORT</replaceable></literal></term>
171
187
        <listitem>
172
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
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>
173
193
        </listitem>
174
194
      </varlistentry>
175
195
 
186
206
      <varlistentry>
187
207
        <term><literal>--debug</literal></term>
188
208
        <listitem>
189
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
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>
190
214
        </listitem>
191
215
      </varlistentry>
192
216
 
194
218
        <term><literal>--priority <replaceable>
195
219
        PRIORITY</replaceable></literal></term>
196
220
        <listitem>
197
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
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>
198
231
        </listitem>
199
232
      </varlistentry>
200
233
 
202
235
        <term><literal>--servicename <replaceable>NAME</replaceable>
203
236
        </literal></term>
204
237
        <listitem>
205
 
          <xi:include href="mandos-options.xml"
206
 
                      xpointer="servicename"/>
 
238
          <para>
 
239
            Zeroconf service name.  The default is
 
240
            <quote><literal>Mandos</literal></quote>.  This only needs
 
241
            to be changed this if it, for some reason, is necessary to
 
242
            run more than one server on the same
 
243
            <emphasis>host</emphasis>, which would not normally be
 
244
            useful.  If there are name collisions on the same
 
245
            <emphasis>network</emphasis>, the newer server will
 
246
            automatically rename itself to <quote><literal>Mandos
 
247
            #2</literal></quote>, and so on; therefore, this option is
 
248
            not needed in that case.
 
249
          </para>
207
250
        </listitem>
208
251
      </varlistentry>
209
252
 
235
278
 
236
279
  <refsect1 id="overview">
237
280
    <title>OVERVIEW</title>
238
 
    <xi:include href="overview.xml"/>
 
281
    &OVERVIEW;
239
282
    <para>
240
283
      This program is the server part.  It is a normal server program
241
284
      and will run in a normal system environment, not in an initial
274
317
        <entry>-><!-- &rarr; --></entry>
275
318
      </row>
276
319
      <row>
277
 
        <entry><quote><literal>1\r\n</literal></quote></entry>
 
320
        <entry><quote><literal>1\r\en</literal></quote></entry>
278
321
        <entry>-><!-- &rarr; --></entry>
279
322
      </row>
280
323
      <row>
310
353
      longer eligible to receive the encrypted password.  The timeout,
311
354
      checker program, and interval between checks can be configured
312
355
      both globally and per client; see <citerefentry>
 
356
      <refentrytitle>mandos.conf</refentrytitle>
 
357
      <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
313
358
      <refentrytitle>mandos-clients.conf</refentrytitle>
314
359
      <manvolnum>5</manvolnum></citerefentry>.
315
360
    </para>
318
363
  <refsect1 id="logging">
319
364
    <title>LOGGING</title>
320
365
    <para>
321
 
      The server will send log message with various severity levels to
322
 
      <filename>/dev/log</filename>.  With the
 
366
      The server will send log messaged with various severity levels
 
367
      to <filename>/dev/log</filename>.  With the
323
368
      <option>--debug</option> option, it will log even more messages,
324
369
      and also show them on the console.
325
370
    </para>
346
391
            <varname>PATH</varname> to search for matching commands if
347
392
            an absolute path is not given.  See <citerefentry>
348
393
            <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
349
 
            </citerefentry>.
 
394
          </citerefentry>
350
395
          </para>
351
396
        </listitem>
352
397
      </varlistentry>
536
581
 
537
582
  <refsect1 id="see_also">
538
583
    <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
584
    <variablelist>
551
585
      <varlistentry>
552
586
        <term>
 
587
          <citerefentry>
 
588
            <refentrytitle>password-request</refentrytitle>
 
589
            <manvolnum>8mandos</manvolnum>
 
590
          </citerefentry>
 
591
        </term>
 
592
        <listitem>
 
593
          <para>
 
594
            This is the actual program which talks to this server.
 
595
            Note that it is normally not invoked directly, and is only
 
596
            run in the initial RAM disk environment, and not on a
 
597
            fully started system.
 
598
          </para>
 
599
        </listitem>
 
600
      </varlistentry>
 
601
      <varlistentry>
 
602
        <term>
553
603
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
554
604
        </term>
555
605
        <listitem>
572
622
      </varlistentry>
573
623
      <varlistentry>
574
624
        <term>
575
 
          <ulink url="http://www.gnu.org/software/gnutls/"
576
 
          >GnuTLS</ulink>
 
625
          <ulink
 
626
              url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
577
627
        </term>
578
628
      <listitem>
579
629
        <para>
585
635
      </varlistentry>
586
636
      <varlistentry>
587
637
        <term>
588
 
          RFC 4291: <citetitle>IP Version 6 Addressing
589
 
          Architecture</citetitle>
 
638
          <citation>RFC 4291: <citetitle>IP Version 6 Addressing
 
639
          Architecture</citetitle>, section 2.5.6, Link-Local IPv6
 
640
          Unicast Addresses</citation>
590
641
        </term>
591
642
        <listitem>
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>
 
643
          <para>
 
644
            The clients use IPv6 link-local addresses, which are
 
645
            immediately usable since a link-local addresses is
 
646
            automatically assigned to a network interfaces when it is
 
647
            brought up.
 
648
          </para>
616
649
        </listitem>
617
650
      </varlistentry>
618
651
      <varlistentry>
619
652
        <term>
620
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
621
 
          Protocol Version 1.1</citetitle>
 
653
          <citation>RFC 4346: <citetitle>The Transport Layer Security
 
654
          (TLS) Protocol Version 1.1</citetitle></citation>
622
655
        </term>
623
656
      <listitem>
624
657
        <para>
628
661
      </varlistentry>
629
662
      <varlistentry>
630
663
        <term>
631
 
          RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
 
664
          <citation>RFC 4880: <citetitle>OpenPGP Message
 
665
          Format</citetitle></citation>
632
666
        </term>
633
667
      <listitem>
634
668
        <para>
638
672
      </varlistentry>
639
673
      <varlistentry>
640
674
        <term>
641
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
642
 
          Security</citetitle>
 
675
          <citation>RFC 5081: <citetitle>Using OpenPGP Keys for
 
676
          Transport Layer Security</citetitle></citation>
643
677
        </term>
644
678
      <listitem>
645
679
        <para>