/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: 2014-07-25 22:44:20 UTC
  • mto: This revision was merged to the branch mainline in revision 724.
  • Revision ID: teddy@recompile.se-20140725224420-4a5ct2ptt0hsc92z
Require Python 2.7.

This is in preparation for the eventual move to Python 3, which will
happen as soon as all Python modules required by Mandos are available.
The mandos-ctl and mandos-monitor programs are already portable
between Python 2.6 and Python 3 without changes; this change will
bring the requirement up to Python 2.7.

* INSTALL (Prerequisites/Libraries/Mandos Server): Document
                                                   requirement of
                                                   Python 2.7; remove
                                                   Python-argparse
                                                   which is in the
                                                   Python 2.7 standard
                                                   library.
* debian/control (Source: mandos/Build-Depends-Indep): Depend on
                                                       exactly the
                                                       python2.7
                                                       package and all
                                                       the Python 2.7
                                                       versions of the
                                                       python modules.
  (Package: mandos/Depends): - '' - but still depend on python (<=2.7)
                            and the generic versions of the Python
                            modules; this is for mandos-ctl and
                            mandos-monitor, both of which are
                            compatible with Python 3, and use
                            #!/usr/bin/python.
* mandos: Use #!/usr/bin/python2.7 instead of #!/usr/bin/python.

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