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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 11:39:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113954-sbvgeq7z0wkdvz17
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
* mandos.xml (ENVIRONMENT): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY CONFNAME "mandos.conf">
8
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
7
<!ENTITY TIMESTAMP "2008-08-29">
9
8
]>
10
9
 
11
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
  <refentryinfo>
13
 
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>&CONFNAME;</productname>
 
12
    <title>Mandos Manual</title>
 
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
14
    <productname>Mandos</productname>
16
15
    <productnumber>&VERSION;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
17
17
    <authorgroup>
18
18
      <author>
19
19
        <firstname>Björn</firstname>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn</holder>
 
36
      <holder>Björn Påhlsson</holder>
36
37
    </copyright>
37
38
    <legalnotice>
38
39
      <para>
67
68
  <refnamediv>
68
69
    <refname><filename>&CONFNAME;</filename></refname>
69
70
    <refpurpose>
70
 
      Configuration file for Mandos
 
71
      Configuration file for the Mandos server
71
72
    </refpurpose>
72
73
  </refnamediv>
73
74
 
80
81
  <refsect1 id="description">
81
82
    <title>DESCRIPTION</title>
82
83
    <para>
83
 
      The file &CONFPATH; is a simple configuration file for mandos
84
 
      and is looked on at startup of the service. The configuration
85
 
      file must start with <literal>[server]</literal>. The format for
86
 
      the rest is a simple VAR = VALUE pair. Values may not be empty.
87
 
    </para>
88
 
 
89
 
    <para>
90
 
      The paramters are:
91
 
    </para>
92
 
 
 
84
      The file &CONFPATH; is a simple configuration file for
 
85
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
86
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
 
87
      startup.  The configuration file starts with <quote><literal
 
88
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
89
      any number of <quote><varname><replaceable>option</replaceable
 
90
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
91
      with continuations in the style of RFC 822.  <quote><varname
 
92
      ><replaceable>option</replaceable></varname>: <replaceable
 
93
      >value</replaceable></quote> is also accepted.  Note that
 
94
      leading whitespace is removed from values.  Lines beginning with
 
95
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
96
      to provide comments.
 
97
    </para>
 
98
 
 
99
  </refsect1>
 
100
  <refsect1>
 
101
    <title>OPTIONS</title>
 
102
    
93
103
    <variablelist>
94
104
      <varlistentry>
95
 
        <term><literal>interface</literal></term>
96
 
        <listitem>
97
 
          <para>
98
 
            This option allows you to override the default network
99
 
            interfaces. By default mandos will not bind to any
100
 
            specific interface but instead use default avahi-server
101
 
            behaviour.
102
 
          </para>
103
 
        </listitem>
104
 
      </varlistentry>
105
 
 
106
 
      <varlistentry>
107
 
        <term><literal>address</literal></term>
108
 
        <listitem>
109
 
          <para>
110
 
            This option allows you to override the default network
111
 
            address. By default mandos will not bind to any
112
 
            specific address but instead use default avahi-server
113
 
            behaviour.
114
 
          </para>
115
 
        </listitem>
116
 
      </varlistentry>      
117
 
 
118
 
      <varlistentry>
119
 
        <term><literal>port</literal></term>
120
 
        <listitem>
121
 
          <para>
122
 
            This option allows you to override the default port to
123
 
            listen on. By default mandos will not specify any specific
124
 
            port and instead use a random port given by the OS from
125
 
            the use of INADDR_ANY.
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>
129
 
 
130
 
      <varlistentry>
131
 
        <term><literal>debug</literal></term>
132
 
        <listitem>
133
 
          <para>
134
 
            This option allows you to modify debug mode with a true/false
135
 
            boolean value. By default is debug set to <literal>false</literal>.
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>      
139
 
 
140
 
      <varlistentry>
141
 
        <term><literal>priority</literal></term>
142
 
        <listitem>
143
 
          <para>
144
 
            This option allows you to override the default gnutls
145
 
            priority that will be used in gnutls session. See
146
 
            <citerefentry><refentrytitle>gnutls_priority_init
147
 
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
148
 
            more information on gnutls priority strings.
149
 
          </para>         
150
 
        </listitem>
151
 
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal>servicename</literal></term>
155
 
        <listitem>
156
 
          <para>
157
 
            This option allows you to override the default Zeroconf
158
 
            service name use to announce mandos as a avahi service. By
159
 
            default mandos will use "Mandos".
160
 
          </para>
 
105
        <term><varname>interface</varname></term>
 
106
        <listitem>
 
107
          <synopsis><literal>interface = </literal><replaceable
 
108
          >NAME</replaceable>
 
109
          </synopsis>
 
110
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
111
        </listitem>
 
112
      </varlistentry>
 
113
 
 
114
      <varlistentry>
 
115
        <term><varname>address</varname></term>
 
116
        <listitem>
 
117
          <synopsis><literal>address = </literal><replaceable
 
118
          >ADDRESS</replaceable>
 
119
          </synopsis>
 
120
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
121
        </listitem>
 
122
      </varlistentry>
 
123
 
 
124
      <varlistentry>
 
125
        <term><varname>port</varname></term>
 
126
        <listitem>
 
127
          <synopsis><literal>port = </literal><replaceable
 
128
          >NUMBER</replaceable>
 
129
          </synopsis>
 
130
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
 
 
134
      <varlistentry>
 
135
        <term><varname>debug</varname></term>
 
136
        <listitem>
 
137
          <synopsis><literal>debug = </literal>{ <literal
 
138
          >1</literal> | <literal>yes</literal> | <literal
 
139
          >true</literal> | <literal>on</literal> | <literal
 
140
          >0</literal> | <literal>no</literal> | <literal
 
141
          >false</literal> | <literal>off</literal> }
 
142
          </synopsis>
 
143
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
 
 
147
      <varlistentry>
 
148
        <term><varname>priority</varname></term>
 
149
        <listitem>
 
150
          <synopsis><literal>priority = </literal><replaceable
 
151
          >STRING</replaceable>
 
152
          </synopsis>
 
153
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
154
        </listitem>
 
155
      </varlistentry>
 
156
 
 
157
      <varlistentry>
 
158
        <term><varname>servicename</varname></term>
 
159
        <listitem>
 
160
          <synopsis><literal>servicename = </literal><replaceable
 
161
          >NAME</replaceable>
 
162
          </synopsis>
 
163
          <xi:include href="mandos-options.xml"
 
164
                      xpointer="servicename"/>
161
165
        </listitem>
162
166
      </varlistentry>
163
167
      
164
168
    </variablelist>
165
169
  </refsect1>
166
 
 
167
 
  <refsect1 id="examples">
168
 
    <title>EXAMPLES</title>
169
 
    <informalexample>
170
 
      <programlisting>
171
 
        [server]
172
 
        # A configuration example
173
 
        interface = eth0 
174
 
        address = 2001:DB8:
175
 
        port = 1025 
176
 
        debug = true 
177
 
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
178
 
        servicename = Mandos
179
 
      </programlisting>
180
 
    </informalexample>
181
 
  </refsect1>  
182
170
  
183
171
  <refsect1 id="files">
184
172
    <title>FILES</title>
186
174
      The file described here is &CONFPATH;
187
175
    </para>
188
176
  </refsect1>
 
177
  
 
178
  <refsect1 id="bugs">
 
179
    <title>BUGS</title>
 
180
    <para>
 
181
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
182
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
183
      requres it.
 
184
    </para>
 
185
  </refsect1>
 
186
  
 
187
  <refsect1 id="example">
 
188
    <title>EXAMPLE</title>
 
189
    <informalexample>
 
190
      <para>
 
191
        No options are actually required:
 
192
      </para>
 
193
      <programlisting>
 
194
[DEFAULT]
 
195
      </programlisting>
 
196
    </informalexample>
 
197
    <informalexample>
 
198
      <para>
 
199
        An example using all the options:
 
200
      </para>
 
201
      <programlisting>
 
202
[DEFAULT]
 
203
# A configuration example
 
204
interface = eth0
 
205
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
206
port = 1025
 
207
debug = true
 
208
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
209
servicename = Daena
 
210
      </programlisting>
 
211
    </informalexample>
 
212
  </refsect1>
 
213
  
 
214
  <refsect1 id="see_also">
 
215
    <title>SEE ALSO</title>
 
216
    <para>
 
217
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
218
      ><manvolnum>3</manvolnum></citerefentry>,
 
219
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
220
      <manvolnum>8</manvolnum></citerefentry>,
 
221
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
222
      <manvolnum>5</manvolnum></citerefentry>
 
223
    </para>
 
224
 
 
225
    <variablelist>
 
226
      <varlistentry>
 
227
        <term>
 
228
          RFC 4291: <citetitle>IP Version 6 Addressing
 
229
          Architecture</citetitle>
 
230
        </term>
 
231
        <listitem>
 
232
          <variablelist>
 
233
            <varlistentry>
 
234
              <term>Section 2.2: <citetitle>Text Representation of
 
235
              Addresses</citetitle></term>
 
236
              <listitem><para/></listitem>
 
237
            </varlistentry>
 
238
            <varlistentry>
 
239
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
240
              Address</citetitle></term>
 
241
              <listitem><para/></listitem>
 
242
            </varlistentry>
 
243
            <varlistentry>
 
244
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
245
            Addresses</citetitle></term>
 
246
            <listitem>
 
247
              <para>
 
248
                The clients use IPv6 link-local addresses, which are
 
249
                immediately usable since a link-local addresses is
 
250
                automatically assigned to a network interfaces when it
 
251
                is brought up.
 
252
              </para>
 
253
            </listitem>
 
254
            </varlistentry>
 
255
          </variablelist>
 
256
        </listitem>
 
257
      </varlistentry>
 
258
      <varlistentry>
 
259
        <term>
 
260
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
261
        </term>
 
262
        <listitem>
 
263
          <para>
 
264
            Zeroconf is the network protocol standard used by clients
 
265
            for finding the Mandos server on the local network.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
    </variablelist>
 
270
  </refsect1>
189
271
</refentry>
 
272
<!-- Local Variables: -->
 
273
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
274
<!-- time-stamp-end: "[\"']>" -->
 
275
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
276
<!-- End: -->