/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

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