/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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 "2008-12-28">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
8
]>
10
9
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
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>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
 
    <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>
40
60
  </refentryinfo>
41
 
  
 
61
 
42
62
  <refmeta>
43
63
    <refentrytitle>&CONFNAME;</refentrytitle>
44
64
    <manvolnum>5</manvolnum>
50
70
      Configuration file for the Mandos server
51
71
    </refpurpose>
52
72
  </refnamediv>
53
 
  
 
73
 
54
74
  <refsynopsisdiv>
55
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
56
78
  </refsynopsisdiv>
57
 
  
 
79
 
58
80
  <refsect1 id="description">
59
81
    <title>DESCRIPTION</title>
60
82
    <para>
61
83
      The file &CONFPATH; is a simple configuration file for
62
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
63
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
64
 
      startup.  The configuration file starts with <quote><literal
65
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
66
 
      any number of <quote><varname><replaceable>option</replaceable
67
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
68
 
      with continuations in the style of RFC 822.  <quote><varname
69
 
      ><replaceable>option</replaceable></varname>: <replaceable
70
 
      >value</replaceable></quote> is also accepted.  Note that
71
 
      leading whitespace is removed from values.  Lines beginning with
72
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
73
 
      to provide comments.
74
 
    </para>
75
 
    
76
 
  </refsect1>
77
 
  <refsect1>
78
 
    <title>OPTIONS</title>
79
 
    
 
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.
 
96
    </para>
 
97
 
 
98
    <para>
 
99
      The options are:
 
100
    </para>
 
101
 
80
102
    <variablelist>
81
103
      <varlistentry>
82
 
        <term><option>interface<literal> = </literal><replaceable
83
 
        >NAME</replaceable></option></term>
84
 
        <listitem>
85
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
86
 
        </listitem>
87
 
      </varlistentry>
88
 
      
89
 
      <varlistentry>
90
 
        <term><option>address<literal> = </literal><replaceable
91
 
          >ADDRESS</replaceable></option></term>
92
 
        <listitem>
93
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
94
 
        </listitem>
95
 
      </varlistentry>
96
 
      
97
 
      <varlistentry>
98
 
        <term><option>port<literal> = </literal><replaceable
99
 
        >NUMBER</replaceable></option></term>
100
 
        <listitem>
101
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
102
 
        </listitem>
103
 
      </varlistentry>
104
 
      
105
 
      <varlistentry>
106
 
        <term><option>debug<literal> = </literal>{ <literal
107
 
          >1</literal> | <literal>yes</literal> | <literal
108
 
          >true</literal> | <literal>on</literal> | <literal
109
 
          >0</literal> | <literal>no</literal> | <literal
110
 
          >false</literal> | <literal>off</literal> }</option></term>
111
 
        <listitem>
112
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
113
 
        </listitem>
114
 
      </varlistentry>
115
 
      
116
 
      <varlistentry>
117
 
        <term><option>priority<literal> = </literal><replaceable
118
 
        >STRING</replaceable></option></term>
119
 
        <listitem>
120
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
      
124
 
      <varlistentry>
125
 
        <term><option>servicename<literal> = </literal
126
 
        ><replaceable>NAME</replaceable></option></term>
127
 
        <listitem>
128
 
          <xi:include href="mandos-options.xml"
129
 
                      xpointer="servicename"/>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
      
133
 
      <varlistentry>
134
 
        <term><option>use_dbus<literal> = </literal>{ <literal
135
 
          >1</literal> | <literal>yes</literal> | <literal
136
 
          >true</literal> | <literal>on</literal> | <literal
137
 
          >0</literal> | <literal>no</literal> | <literal
138
 
          >false</literal> | <literal>off</literal> }</option></term>
139
 
        <listitem>
140
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
104
        <term><literal><varname>interface</varname></literal></term>
 
105
        <listitem>
 
106
          <para>
 
107
            This option allows you to override the default network
 
108
            interfaces. By default mandos will not bind to any
 
109
            specific interface but instead use default avahi-server
 
110
            behaviour.
 
111
          </para>
 
112
        </listitem>
 
113
      </varlistentry>
 
114
 
 
115
      <varlistentry>
 
116
        <term><literal><varname>address</varname></literal></term>
 
117
        <listitem>
 
118
          <para>
 
119
            This option allows you to override the default network
 
120
            address. By default mandos will not bind to any
 
121
            specific address but instead use default avahi-server
 
122
            behaviour.
 
123
          </para>
 
124
        </listitem>
 
125
      </varlistentry>      
 
126
 
 
127
      <varlistentry>
 
128
        <term><literal><varname>port</varname></literal></term>
 
129
        <listitem>
 
130
          <para>
 
131
            This option allows you to override the default port to
 
132
            listen on. By default mandos will not specify any specific
 
133
            port and instead use a random port given by the OS from
 
134
            the use of INADDR_ANY.
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
 
 
139
      <varlistentry>
 
140
        <term><literal><varname>debug</varname></literal></term>
 
141
        <listitem>
 
142
          <para>
 
143
            This option allows you to modify debug mode with a true/false
 
144
            boolean value. By default is debug set to <literal>false</literal>.
 
145
          </para>
 
146
        </listitem>
 
147
      </varlistentry>      
 
148
 
 
149
      <varlistentry>
 
150
        <term><literal><varname>priority</varname></literal></term>
 
151
        <listitem>
 
152
          <para>
 
153
            This option allows you to override the default gnutls
 
154
            priority that will be used in gnutls session. See
 
155
            <citerefentry><refentrytitle>gnutls_priority_init
 
156
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
 
157
            more information on gnutls priority strings.
 
158
          </para>         
 
159
        </listitem>
 
160
      </varlistentry>
 
161
 
 
162
      <varlistentry>
 
163
        <term><literal><varname>servicename</varname></literal></term>
 
164
        <listitem>
 
165
          <para>
 
166
            This option allows you to override the default Zeroconf
 
167
            service name use to announce mandos as a avahi service. By
 
168
            default mandos will use "Mandos".
 
169
          </para>
141
170
        </listitem>
142
171
      </varlistentry>
143
172
      
144
173
    </variablelist>
145
174
  </refsect1>
 
175
 
 
176
  <refsect1 id="examples">
 
177
    <title>EXAMPLES</title>
 
178
    <informalexample>
 
179
      <programlisting>
 
180
        [server]
 
181
        # A configuration example
 
182
        interface = eth0 
 
183
        address = 2001:DB8:
 
184
        port = 1025 
 
185
        debug = true 
 
186
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
187
        servicename = Mandos
 
188
      </programlisting>
 
189
    </informalexample>
 
190
  </refsect1>  
146
191
  
147
192
  <refsect1 id="files">
148
193
    <title>FILES</title>
150
195
      The file described here is &CONFPATH;
151
196
    </para>
152
197
  </refsect1>
153
 
  
154
 
  <refsect1 id="bugs">
155
 
    <title>BUGS</title>
156
 
    <para>
157
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
158
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
159
 
      requires it.
160
 
    </para>
161
 
  </refsect1>
162
 
  
163
 
  <refsect1 id="example">
164
 
    <title>EXAMPLE</title>
165
 
    <informalexample>
166
 
      <para>
167
 
        No options are actually required:
168
 
      </para>
169
 
      <programlisting>
170
 
[DEFAULT]
171
 
      </programlisting>
172
 
    </informalexample>
173
 
    <informalexample>
174
 
      <para>
175
 
        An example using all the options:
176
 
      </para>
177
 
      <programlisting>
178
 
[DEFAULT]
179
 
# A configuration example
180
 
interface = eth0
181
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
182
 
port = 1025
183
 
debug = true
184
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
185
 
servicename = Daena
186
 
use_dbus = False
187
 
      </programlisting>
188
 
    </informalexample>
189
 
  </refsect1>
190
 
  
191
 
  <refsect1 id="see_also">
192
 
    <title>SEE ALSO</title>
193
 
    <para>
194
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
195
 
      ><manvolnum>3</manvolnum></citerefentry>,
196
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
197
 
      <manvolnum>8</manvolnum></citerefentry>,
198
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
199
 
      <manvolnum>5</manvolnum></citerefentry>
200
 
    </para>
201
 
    
202
 
    <variablelist>
203
 
      <varlistentry>
204
 
        <term>
205
 
          RFC 4291: <citetitle>IP Version 6 Addressing
206
 
          Architecture</citetitle>
207
 
        </term>
208
 
        <listitem>
209
 
          <variablelist>
210
 
            <varlistentry>
211
 
              <term>Section 2.2: <citetitle>Text Representation of
212
 
              Addresses</citetitle></term>
213
 
              <listitem><para/></listitem>
214
 
            </varlistentry>
215
 
            <varlistentry>
216
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
217
 
              Address</citetitle></term>
218
 
              <listitem><para/></listitem>
219
 
            </varlistentry>
220
 
            <varlistentry>
221
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
222
 
            Addresses</citetitle></term>
223
 
            <listitem>
224
 
              <para>
225
 
                The clients use IPv6 link-local addresses, which are
226
 
                immediately usable since a link-local addresses is
227
 
                automatically assigned to a network interfaces when it
228
 
                is brought up.
229
 
              </para>
230
 
            </listitem>
231
 
            </varlistentry>
232
 
          </variablelist>
233
 
        </listitem>
234
 
      </varlistentry>
235
 
      <varlistentry>
236
 
        <term>
237
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
238
 
        </term>
239
 
        <listitem>
240
 
          <para>
241
 
            Zeroconf is the network protocol standard used by clients
242
 
            for finding the Mandos server on the local network.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
    </variablelist>
247
 
  </refsect1>
248
198
</refentry>
249
 
<!-- Local Variables: -->
250
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
251
 
<!-- time-stamp-end: "[\"']>" -->
252
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
253
 
<!-- End: -->