/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: Björn Påhlsson
  • Date: 2011-06-19 20:25:38 UTC
  • mto: This revision was merged to the branch mainline in revision 485.
  • Revision ID: belorn@fukt.bsnet.se-20110619202538-0js072v8fso12u07
prepended mandos plugin to error messages in each plugin. Added a better way in TODO.

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 TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2009-02-25">
 
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>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
40
    <xi:include href="legalnotice.xml"/>
61
41
  </refentryinfo>
62
 
 
 
42
  
63
43
  <refmeta>
64
44
    <refentrytitle>&CONFNAME;</refentrytitle>
65
45
    <manvolnum>5</manvolnum>
71
51
      Configuration file for the Mandos server
72
52
    </refpurpose>
73
53
  </refnamediv>
74
 
 
 
54
  
75
55
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
79
57
  </refsynopsisdiv>
80
 
 
 
58
  
81
59
  <refsect1 id="description">
82
60
    <title>DESCRIPTION</title>
83
61
    <para>
95
73
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
96
74
      to provide comments.
97
75
    </para>
98
 
 
 
76
    
99
77
  </refsect1>
100
78
  <refsect1>
101
79
    <title>OPTIONS</title>
102
80
    
103
81
    <variablelist>
104
82
      <varlistentry>
105
 
        <term><varname>interface</varname></term>
 
83
        <term><option>interface<literal> = </literal><replaceable
 
84
        >NAME</replaceable></option></term>
106
85
        <listitem>
107
 
          <synopsis><literal>interface = </literal><replaceable
108
 
          >NAME</replaceable>
109
 
          </synopsis>
110
86
          <xi:include href="mandos-options.xml" xpointer="interface"/>
111
87
        </listitem>
112
88
      </varlistentry>
113
 
 
 
89
      
114
90
      <varlistentry>
115
 
        <term><varname>address</varname></term>
 
91
        <term><option>address<literal> = </literal><replaceable
 
92
          >ADDRESS</replaceable></option></term>
116
93
        <listitem>
117
 
          <synopsis><literal>address = </literal><replaceable
118
 
          >ADDRESS</replaceable>
119
 
          </synopsis>
120
94
          <xi:include href="mandos-options.xml" xpointer="address"/>
121
95
        </listitem>
122
96
      </varlistentry>
123
 
 
 
97
      
124
98
      <varlistentry>
125
 
        <term><varname>port</varname></term>
 
99
        <term><option>port<literal> = </literal><replaceable
 
100
        >NUMBER</replaceable></option></term>
126
101
        <listitem>
127
 
          <synopsis><literal>port = </literal><replaceable
128
 
          >NUMBER</replaceable>
129
 
          </synopsis>
130
102
          <xi:include href="mandos-options.xml" xpointer="port"/>
131
103
        </listitem>
132
104
      </varlistentry>
133
 
 
 
105
      
134
106
      <varlistentry>
135
 
        <term><varname>debug</varname></term>
136
 
        <listitem>
137
 
          <synopsis><literal>debug = </literal>{ <literal
 
107
        <term><option>debug<literal> = </literal>{ <literal
138
108
          >1</literal> | <literal>yes</literal> | <literal
139
109
          >true</literal> | <literal>on</literal> | <literal
140
110
          >0</literal> | <literal>no</literal> | <literal
141
 
          >false</literal> | <literal>off</literal> }
142
 
          </synopsis>
 
111
          >false</literal> | <literal>off</literal> }</option></term>
 
112
        <listitem>
143
113
          <xi:include href="mandos-options.xml" xpointer="debug"/>
144
114
        </listitem>
145
115
      </varlistentry>
146
 
 
 
116
      
147
117
      <varlistentry>
148
 
        <term><varname>priority</varname></term>
 
118
        <term><option>priority<literal> = </literal><replaceable
 
119
        >STRING</replaceable></option></term>
149
120
        <listitem>
150
 
          <synopsis><literal>priority = </literal><replaceable
151
 
          >STRING</replaceable>
152
 
          </synopsis>
153
121
          <xi:include href="mandos-options.xml" xpointer="priority"/>
154
122
        </listitem>
155
123
      </varlistentry>
156
 
 
 
124
      
157
125
      <varlistentry>
158
 
        <term><varname>servicename</varname></term>
 
126
        <term><option>servicename<literal> = </literal
 
127
        ><replaceable>NAME</replaceable></option></term>
159
128
        <listitem>
160
 
          <synopsis><literal>servicename = </literal><replaceable
161
 
          >NAME</replaceable>
162
 
          </synopsis>
163
129
          <xi:include href="mandos-options.xml"
164
130
                      xpointer="servicename"/>
165
131
        </listitem>
166
132
      </varlistentry>
167
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
      
168
156
    </variablelist>
169
157
  </refsect1>
170
158
  
180
168
    <para>
181
169
      The <literal>[DEFAULT]</literal> is necessary because the Python
182
170
      built-in module <systemitem class="library">ConfigParser</systemitem>
183
 
      requres it.
 
171
      requires it.
184
172
    </para>
185
173
  </refsect1>
186
174
  
202
190
[DEFAULT]
203
191
# A configuration example
204
192
interface = eth0
205
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
193
address = fe80::aede:48ff:fe71:f6f2
206
194
port = 1025
207
195
debug = true
208
196
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
209
197
servicename = Daena
 
198
use_dbus = False
 
199
use_ipv6 = True
210
200
      </programlisting>
211
201
    </informalexample>
212
202
  </refsect1>
214
204
  <refsect1 id="see_also">
215
205
    <title>SEE ALSO</title>
216
206
    <para>
217
 
      <citerefentry>
218
 
        <refentrytitle>mandos</refentrytitle>
219
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
220
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
221
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
222
 
        <refentrytitle>gnutls_priority_init</refentrytitle>
223
 
        <manvolnum>3</manvolnum></citerefentry>
 
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>
224
213
    </para>
225
 
 
 
214
    
226
215
    <variablelist>
227
216
      <varlistentry>
228
217
        <term>
248
237
              <para>
249
238
                The clients use IPv6 link-local addresses, which are
250
239
                immediately usable since a link-local addresses is
251
 
                automatically assigned to a network interfaces when it
 
240
                automatically assigned to a network interface when it
252
241
                is brought up.
253
242
              </para>
254
243
            </listitem>