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

  • Committer: Teddy Hogeborn
  • Date: 2017-02-23 20:35:20 UTC
  • Revision ID: teddy@recompile.se-20170223203520-7ti8vo1m86ib192m
Tags: version-1.7.15-1
http://bugs.debian.org/855589
* Makefile (version): Change to 1.7.15.
* NEWS (Version 1.7.15): Add new entry.
* debian/changelog (1.7.15-1): - '' -

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