/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-07-22 06:25:35 UTC
  • mfrom: (24.1.2 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080722062535-whz5do0b3dzw6m08
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY CONFNAME "mandos.conf">
5
 
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-02-25">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
 
]>
10
 
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
 
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
 
    <authorgroup>
19
 
      <author>
20
 
        <firstname>Björn</firstname>
21
 
        <surname>Påhlsson</surname>
22
 
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
24
 
        </address>
25
 
      </author>
26
 
      <author>
27
 
        <firstname>Teddy</firstname>
28
 
        <surname>Hogeborn</surname>
29
 
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
31
 
        </address>
32
 
      </author>
33
 
    </authorgroup>
34
 
    <copyright>
35
 
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <holder>Teddy Hogeborn</holder>
38
 
      <holder>Björn Påhlsson</holder>
39
 
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
41
 
  </refentryinfo>
42
 
  
43
 
  <refmeta>
44
 
    <refentrytitle>&CONFNAME;</refentrytitle>
45
 
    <manvolnum>5</manvolnum>
46
 
  </refmeta>
47
 
  
48
 
  <refnamediv>
49
 
    <refname><filename>&CONFNAME;</filename></refname>
50
 
    <refpurpose>
51
 
      Configuration file for the Mandos server
52
 
    </refpurpose>
53
 
  </refnamediv>
54
 
  
55
 
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
57
 
  </refsynopsisdiv>
58
 
  
59
 
  <refsect1 id="description">
60
 
    <title>DESCRIPTION</title>
61
 
    <para>
62
 
      The file &CONFPATH; is a simple configuration file for
63
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
64
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
65
 
      startup.  The configuration file starts with <quote><literal
66
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
67
 
      any number of <quote><varname><replaceable>option</replaceable
68
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
69
 
      with continuations in the style of RFC 822.  <quote><varname
70
 
      ><replaceable>option</replaceable></varname>: <replaceable
71
 
      >value</replaceable></quote> is also accepted.  Note that
72
 
      leading whitespace is removed from values.  Lines beginning with
73
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
 
      to provide comments.
75
 
    </para>
76
 
    
77
 
  </refsect1>
78
 
  <refsect1>
79
 
    <title>OPTIONS</title>
80
 
    
81
 
    <variablelist>
82
 
      <varlistentry>
83
 
        <term><option>interface<literal> = </literal><replaceable
84
 
        >NAME</replaceable></option></term>
85
 
        <listitem>
86
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
 
        </listitem>
88
 
      </varlistentry>
89
 
      
90
 
      <varlistentry>
91
 
        <term><option>address<literal> = </literal><replaceable
92
 
          >ADDRESS</replaceable></option></term>
93
 
        <listitem>
94
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
 
        </listitem>
96
 
      </varlistentry>
97
 
      
98
 
      <varlistentry>
99
 
        <term><option>port<literal> = </literal><replaceable
100
 
        >NUMBER</replaceable></option></term>
101
 
        <listitem>
102
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
 
        </listitem>
104
 
      </varlistentry>
105
 
      
106
 
      <varlistentry>
107
 
        <term><option>debug<literal> = </literal>{ <literal
108
 
          >1</literal> | <literal>yes</literal> | <literal
109
 
          >true</literal> | <literal>on</literal> | <literal
110
 
          >0</literal> | <literal>no</literal> | <literal
111
 
          >false</literal> | <literal>off</literal> }</option></term>
112
 
        <listitem>
113
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
 
        </listitem>
115
 
      </varlistentry>
116
 
      
117
 
      <varlistentry>
118
 
        <term><option>priority<literal> = </literal><replaceable
119
 
        >STRING</replaceable></option></term>
120
 
        <listitem>
121
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
 
        </listitem>
123
 
      </varlistentry>
124
 
      
125
 
      <varlistentry>
126
 
        <term><option>servicename<literal> = </literal
127
 
        ><replaceable>NAME</replaceable></option></term>
128
 
        <listitem>
129
 
          <xi:include href="mandos-options.xml"
130
 
                      xpointer="servicename"/>
131
 
        </listitem>
132
 
      </varlistentry>
133
 
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
 
      <varlistentry>
146
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
147
 
          >1</literal> | <literal>yes</literal> | <literal
148
 
          >true</literal> | <literal>on</literal> | <literal
149
 
          >0</literal> | <literal>no</literal> | <literal
150
 
          >false</literal> | <literal>off</literal> }</option></term>
151
 
        <listitem>
152
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
 
    </variablelist>
157
 
  </refsect1>
158
 
  
159
 
  <refsect1 id="files">
160
 
    <title>FILES</title>
161
 
    <para>
162
 
      The file described here is &CONFPATH;
163
 
    </para>
164
 
  </refsect1>
165
 
  
166
 
  <refsect1 id="bugs">
167
 
    <title>BUGS</title>
168
 
    <para>
169
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
170
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
171
 
      requires it.
172
 
    </para>
173
 
  </refsect1>
174
 
  
175
 
  <refsect1 id="example">
176
 
    <title>EXAMPLE</title>
177
 
    <informalexample>
178
 
      <para>
179
 
        No options are actually required:
180
 
      </para>
181
 
      <programlisting>
182
 
[DEFAULT]
183
 
      </programlisting>
184
 
    </informalexample>
185
 
    <informalexample>
186
 
      <para>
187
 
        An example using all the options:
188
 
      </para>
189
 
      <programlisting>
190
 
[DEFAULT]
191
 
# A configuration example
192
 
interface = eth0
193
 
address = fe80::aede:48ff:fe71:f6f2
194
 
port = 1025
195
 
debug = true
196
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
197
 
servicename = Daena
198
 
use_dbus = False
199
 
use_ipv6 = True
200
 
      </programlisting>
201
 
    </informalexample>
202
 
  </refsect1>
203
 
  
204
 
  <refsect1 id="see_also">
205
 
    <title>SEE ALSO</title>
206
 
    <para>
207
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
208
 
      ><manvolnum>3</manvolnum></citerefentry>,
209
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
210
 
      <manvolnum>8</manvolnum></citerefentry>,
211
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
 
      <manvolnum>5</manvolnum></citerefentry>
213
 
    </para>
214
 
    
215
 
    <variablelist>
216
 
      <varlistentry>
217
 
        <term>
218
 
          RFC 4291: <citetitle>IP Version 6 Addressing
219
 
          Architecture</citetitle>
220
 
        </term>
221
 
        <listitem>
222
 
          <variablelist>
223
 
            <varlistentry>
224
 
              <term>Section 2.2: <citetitle>Text Representation of
225
 
              Addresses</citetitle></term>
226
 
              <listitem><para/></listitem>
227
 
            </varlistentry>
228
 
            <varlistentry>
229
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
230
 
              Address</citetitle></term>
231
 
              <listitem><para/></listitem>
232
 
            </varlistentry>
233
 
            <varlistentry>
234
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
235
 
            Addresses</citetitle></term>
236
 
            <listitem>
237
 
              <para>
238
 
                The clients use IPv6 link-local addresses, which are
239
 
                immediately usable since a link-local addresses is
240
 
                automatically assigned to a network interface when it
241
 
                is brought up.
242
 
              </para>
243
 
            </listitem>
244
 
            </varlistentry>
245
 
          </variablelist>
246
 
        </listitem>
247
 
      </varlistentry>
248
 
      <varlistentry>
249
 
        <term>
250
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
251
 
        </term>
252
 
        <listitem>
253
 
          <para>
254
 
            Zeroconf is the network protocol standard used by clients
255
 
            for finding the Mandos server on the local network.
256
 
          </para>
257
 
        </listitem>
258
 
      </varlistentry>
259
 
    </variablelist>
260
 
  </refsect1>
261
 
</refentry>
262
 
<!-- Local Variables: -->
263
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
264
 
<!-- time-stamp-end: "[\"']>" -->
265
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
266
 
<!-- End: -->