/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: 2012-05-03 20:16:22 UTC
  • Revision ID: teddy@recompile.se-20120503201622-d9yezi9t17i00lio
* mandos-ctl: Use new string format method.  Bug fix: --version now
              shows the program name.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
18
21
        <surname>Påhlsson</surname>
19
22
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
21
24
        </address>
22
25
      </author>
23
26
      <author>
24
27
        <firstname>Teddy</firstname>
25
28
        <surname>Hogeborn</surname>
26
29
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
28
31
        </address>
29
32
      </author>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
33
39
      <holder>Teddy Hogeborn</holder>
34
40
      <holder>Björn Påhlsson</holder>
35
41
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
42
    <xi:include href="legalnotice.xml"/>
59
43
  </refentryinfo>
60
 
 
 
44
  
61
45
  <refmeta>
62
46
    <refentrytitle>&CONFNAME;</refentrytitle>
63
47
    <manvolnum>5</manvolnum>
69
53
      Configuration file for the Mandos server
70
54
    </refpurpose>
71
55
  </refnamediv>
72
 
 
 
56
  
73
57
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
58
    <synopsis>&CONFPATH;</synopsis>
77
59
  </refsynopsisdiv>
78
 
 
 
60
  
79
61
  <refsect1 id="description">
80
62
    <title>DESCRIPTION</title>
81
63
    <para>
93
75
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
94
76
      to provide comments.
95
77
    </para>
96
 
 
 
78
    
97
79
  </refsect1>
98
80
  <refsect1>
99
81
    <title>OPTIONS</title>
100
82
    
101
83
    <variablelist>
102
84
      <varlistentry>
103
 
        <term><varname>interface</varname></term>
 
85
        <term><option>interface<literal> = </literal><replaceable
 
86
        >NAME</replaceable></option></term>
104
87
        <listitem>
105
 
          <synopsis><literal>interface = </literal><replaceable
106
 
          >NAME</replaceable>
107
 
          </synopsis>
108
88
          <xi:include href="mandos-options.xml" xpointer="interface"/>
109
89
        </listitem>
110
90
      </varlistentry>
111
 
 
 
91
      
112
92
      <varlistentry>
113
 
        <term><varname>address</varname></term>
 
93
        <term><option>address<literal> = </literal><replaceable
 
94
          >ADDRESS</replaceable></option></term>
114
95
        <listitem>
115
 
          <synopsis><literal>address = </literal><replaceable
116
 
          >ADDRESS</replaceable>
117
 
          </synopsis>
118
96
          <xi:include href="mandos-options.xml" xpointer="address"/>
119
97
        </listitem>
120
98
      </varlistentry>
121
 
 
 
99
      
122
100
      <varlistentry>
123
 
        <term><varname>port</varname></term>
 
101
        <term><option>port<literal> = </literal><replaceable
 
102
        >NUMBER</replaceable></option></term>
124
103
        <listitem>
125
 
          <synopsis><literal>port = </literal><replaceable
126
 
          >NUMBER</replaceable>
127
 
          </synopsis>
128
104
          <xi:include href="mandos-options.xml" xpointer="port"/>
129
105
        </listitem>
130
106
      </varlistentry>
131
 
 
 
107
      
132
108
      <varlistentry>
133
 
        <term><varname>debug</varname></term>
134
 
        <listitem>
135
 
          <synopsis><literal>debug = </literal>{ <literal
 
109
        <term><option>debug<literal> = </literal>{ <literal
136
110
          >1</literal> | <literal>yes</literal> | <literal
137
111
          >true</literal> | <literal>on</literal> | <literal
138
112
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }
140
 
          </synopsis>
 
113
          >false</literal> | <literal>off</literal> }</option></term>
 
114
        <listitem>
141
115
          <xi:include href="mandos-options.xml" xpointer="debug"/>
142
116
        </listitem>
143
117
      </varlistentry>
144
 
 
 
118
      
145
119
      <varlistentry>
146
 
        <term><varname>priority</varname></term>
 
120
        <term><option>priority<literal> = </literal><replaceable
 
121
        >STRING</replaceable></option></term>
147
122
        <listitem>
148
 
          <synopsis><literal>priority = </literal><replaceable
149
 
          >STRING</replaceable>
150
 
          </synopsis>
151
123
          <xi:include href="mandos-options.xml" xpointer="priority"/>
152
124
        </listitem>
153
125
      </varlistentry>
154
 
 
 
126
      
155
127
      <varlistentry>
156
 
        <term><varname>servicename</varname></term>
 
128
        <term><option>servicename<literal> = </literal
 
129
        ><replaceable>NAME</replaceable></option></term>
157
130
        <listitem>
158
 
          <synopsis><literal>servicename = </literal><replaceable
159
 
          >NAME</replaceable>
160
 
          </synopsis>
161
131
          <xi:include href="mandos-options.xml"
162
132
                      xpointer="servicename"/>
163
133
        </listitem>
164
134
      </varlistentry>
165
135
      
 
136
      <varlistentry>
 
137
        <term><option>use_dbus<literal> = </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> }</option></term>
 
142
        <listitem>
 
143
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>use_ipv6<literal> = </literal>{ <literal
 
149
          >1</literal> | <literal>yes</literal> | <literal
 
150
          >true</literal> | <literal>on</literal> | <literal
 
151
          >0</literal> | <literal>no</literal> | <literal
 
152
          >false</literal> | <literal>off</literal> }</option></term>
 
153
        <listitem>
 
154
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
155
        </listitem>
 
156
      </varlistentry>
 
157
      
 
158
      <varlistentry>
 
159
        <term><option>restore<literal> = </literal>{ <literal
 
160
          >1</literal> | <literal>yes</literal> | <literal
 
161
          >true</literal> | <literal>on</literal> | <literal
 
162
          >0</literal> | <literal>no</literal> | <literal
 
163
          >false</literal> | <literal>off</literal> }</option></term>
 
164
        <listitem>
 
165
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
      
 
169
      <varlistentry>
 
170
        <term><option>statedir<literal> = </literal><replaceable
 
171
        >DIRECTORY</replaceable></option></term>
 
172
        <listitem>
 
173
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
174
        </listitem>
 
175
      </varlistentry>
 
176
      
166
177
    </variablelist>
167
178
  </refsect1>
168
179
  
178
189
    <para>
179
190
      The <literal>[DEFAULT]</literal> is necessary because the Python
180
191
      built-in module <systemitem class="library">ConfigParser</systemitem>
181
 
      requres it.
 
192
      requires it.
182
193
    </para>
183
194
  </refsect1>
184
195
  
200
211
[DEFAULT]
201
212
# A configuration example
202
213
interface = eth0
203
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
214
address = fe80::aede:48ff:fe71:f6f2
204
215
port = 1025
205
216
debug = true
206
217
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
207
218
servicename = Daena
 
219
use_dbus = False
 
220
use_ipv6 = True
 
221
restore = True
 
222
statedir = /var/lib/mandos
208
223
      </programlisting>
209
224
    </informalexample>
210
225
  </refsect1>
212
227
  <refsect1 id="see_also">
213
228
    <title>SEE ALSO</title>
214
229
    <para>
215
 
      <citerefentry>
216
 
        <refentrytitle>mandos</refentrytitle>
217
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
218
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
219
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
220
 
        <refentrytitle>gnutls_priority_init</refentrytitle>
221
 
        <manvolnum>3</manvolnum></citerefentry>
 
230
      <citerefentry><refentrytitle>intro</refentrytitle>
 
231
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
232
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
233
      ><manvolnum>3</manvolnum></citerefentry>,
 
234
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
235
      <manvolnum>8</manvolnum></citerefentry>,
 
236
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
237
      <manvolnum>5</manvolnum></citerefentry>
222
238
    </para>
223
 
 
 
239
    
224
240
    <variablelist>
225
241
      <varlistentry>
226
242
        <term>
246
262
              <para>
247
263
                The clients use IPv6 link-local addresses, which are
248
264
                immediately usable since a link-local addresses is
249
 
                automatically assigned to a network interfaces when it
 
265
                automatically assigned to a network interface when it
250
266
                is brought up.
251
267
              </para>
252
268
            </listitem>
268
284
    </variablelist>
269
285
  </refsect1>
270
286
</refentry>
 
287
<!-- Local Variables: -->
 
288
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
289
<!-- time-stamp-end: "[\"']>" -->
 
290
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
291
<!-- End: -->