/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: 2008-08-20 00:35:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820003541-zxymabnc6yfj8y7t
* mandos-keygen.xml (SEE ALSO): Remove "and".

* mandos.conf.xml (SEE ALSO): New section.

* mandos.xml (SEE ALSO): Changed man page references to a comma-
                         separated list, as per man-pages(7).  Added
                         reference to sh(1).

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