/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-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
5
5
<!--
6
6
This file is used by both mandos(8) and mandos.conf(5), since these
7
7
options can be used both on the command line and in the config file.
8
 
 
9
 
It is also used for some texts by mandos-client(8mandos).
10
8
-->
11
9
 
12
10
<section>
17
15
    and listen to requests on the specified network interface.
18
16
    Default is to use all available interfaces.  <emphasis
19
17
    >Note:</emphasis> a failure to bind to the specified
20
 
    interface is not considered critical, and the server will not
21
 
    exit, but instead continue normally.
 
18
    interface is not considered critical, and the server does not
 
19
    exit, but will instead continue normally.
22
20
  </para>
23
21
  
24
22
  <para id="address">
26
24
    specified IPv6 address.  If a link-local address is specified, an
27
25
    interface should be set, since a link-local address is only valid
28
26
    on a single interface.  By default, the server will listen to all
29
 
    available addresses.  If set, this must normally be an IPv6
30
 
    address; an IPv4 address can only be specified using IPv4-mapped
31
 
    IPv6 address syntax: <quote><systemitem class="ipaddress"
32
 
    >::FFFF:192.0.2.3</systemitem ></quote>.  (Only if IPv6 usage is
33
 
    <emphasis>disabled</emphasis> (see below) must this be an IPv4
34
 
    address.)
 
27
    available addresses.  If set, this must be an IPv6 address; an
 
28
    IPv4 address can only be specified using IPv4-mapped IPv6 address
 
29
    syntax: <quote><systemitem class="ipaddress"
 
30
    >::FFFF:192.0.2.3</systemitem ></quote>.
35
31
  </para>
36
32
  
37
33
  <para id="port">
47
43
  </para>
48
44
  
49
45
  <para id="priority">
50
 
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
 
46
    GnuTLS priority string for the TLS handshake with the clients.
51
47
    The default is
52
 
    <quote><literal>SECURE128&#8203;:!CTYPE-X.509&#8203;:+CTYPE-RAWPK&#8203;:!RSA&#8203;:!VERS-ALL&#8203;:+VERS-TLS1.3&#8203;:%PROFILE_ULTRA</literal></quote>
53
 
    when using raw public keys in TLS, and
54
 
    <quote><literal>SECURE256&#8203;:!CTYPE-X.509&#8203;:+CTYPE-OPENPGP&#8203;:!RSA&#8203;:+SIGN-DSA-SHA256</literal></quote>
55
 
    when using OpenPGP keys in TLS,.  See <citerefentry><refentrytitle
56
 
    >gnutls_priority_init</refentrytitle>
57
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
58
 
    <emphasis>Warning</emphasis>: changing this may make the
59
 
    <acronym>TLS</acronym> handshake fail, making server-client
60
 
    communication impossible.  Changing this option may also make the
61
 
    network traffic decryptable by an attacker.
 
48
    <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
49
    See <citerefentry><refentrytitle>gnutls_priority_init
 
50
    </refentrytitle><manvolnum>3</manvolnum></citerefentry> for the
 
51
    syntax.  <emphasis>Warning</emphasis>: changing this may make the
 
52
    TLS handshake fail, making communication with clients impossible.
62
53
  </para>
63
54
  
64
55
  <para id="servicename">
65
56
    Zeroconf service name.  The default is
66
57
    <quote><literal>Mandos</literal></quote>.  This only needs to be
67
 
    changed if for some reason is would be necessary to run more than
68
 
    one server on the same <emphasis>host</emphasis>.  This would not
 
58
    changed this if it, for some reason, is necessary to run more than
 
59
    one server on the same <emphasis>host</emphasis>, which would not
69
60
    normally be useful.  If there are name collisions on the same
70
61
    <emphasis>network</emphasis>, the newer server will automatically
71
62
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
72
63
    so on; therefore, this option is not needed in that case.
73
64
  </para>
74
65
  
75
 
  <para id="dbus">
76
 
    This option controls whether the server will provide a D-Bus
77
 
    system bus interface.  The default is to provide such an
78
 
    interface.
79
 
  </para>
80
 
  
81
 
  <para id="ipv6">
82
 
    This option controls whether the server will use IPv6 sockets and
83
 
    addresses.  The default is to use IPv6.  This option should
84
 
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
85
 
    IPv4-only environments</emphasis>.  This is because <citerefentry>
86
 
    <refentrytitle>mandos-client</refentrytitle>
87
 
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
88
 
    IPv6 link-local addresses, and will not be able to find or connect
89
 
    to the server if this option is turned off.  <emphasis>Only
90
 
    advanced users should consider changing this option</emphasis>.
91
 
  </para>
92
 
  
93
 
  <para id="restore">
94
 
    This option controls whether the server will restore its state
95
 
    from the last time it ran.  Default is to restore last state.
96
 
  </para>
97
 
  
98
 
  <para id="statedir">
99
 
    Directory to save (and restore) state in.  Default is
100
 
    <quote><filename
101
 
    class="directory">/var/lib/mandos</filename></quote>.
102
 
  </para>
103
 
  
104
 
  <para id="socket">
105
 
    If this option is used, the server will not create a new network
106
 
    socket, but will instead use the supplied file descriptor.  By
107
 
    default, the server will create a new network socket.
108
 
  </para>
109
 
  
110
 
  <para id="foreground">
111
 
    This option will make the server run in the foreground and not
112
 
    write a PID file.  The default is to <emphasis>not</emphasis> run
113
 
    in the foreground, except in <option>debug</option> mode, which
114
 
    implies this option.
115
 
  </para>
116
 
  
117
 
  <para id="zeroconf">
118
 
    This option controls whether the server will announce its
119
 
    existence using Zeroconf.  Default is to use Zeroconf.  If
120
 
    Zeroconf is not used, a <option>port</option> number or a
121
 
    <option>socket</option> is required.
122
 
  </para>
123
 
  
124
66
</section>