/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

Added configuration files support for mandos-client
Removed plus argument support for mandos-client

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY CONFNAME "mandos.conf">
6
8
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-29">
8
9
]>
9
10
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
11
12
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
 
13
    <title>&CONFNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&CONFNAME;</productname>
15
16
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
17
    <authorgroup>
18
18
      <author>
19
19
        <firstname>Björn</firstname>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn</holder>
36
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
37
36
    </copyright>
38
37
    <legalnotice>
39
38
      <para>
68
67
  <refnamediv>
69
68
    <refname><filename>&CONFNAME;</filename></refname>
70
69
    <refpurpose>
71
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos
72
71
    </refpurpose>
73
72
  </refnamediv>
74
73
 
81
80
  <refsect1 id="description">
82
81
    <title>DESCRIPTION</title>
83
82
    <para>
84
 
      The file &CONFPATH; is a simple configuration file for
85
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
86
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
87
 
      startup.  The configuration file starts with <quote><literal
88
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
89
 
      any number of <quote><varname><replaceable>option</replaceable
90
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
91
 
      with continuations in the style of RFC 822.  <quote><varname
92
 
      ><replaceable>option</replaceable></varname>: <replaceable
93
 
      >value</replaceable></quote> is also accepted.  Note that
94
 
      leading whitespace is removed from values.  Lines beginning with
95
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
96
 
      to provide comments.
97
 
    </para>
98
 
 
99
 
  </refsect1>
100
 
  <refsect1>
101
 
    <title>OPTIONS</title>
102
 
    
 
83
      The file &CONFPATH; is a simple configuration file for mandos
 
84
      and is looked on at startup of the service. The configuration
 
85
      file must start with <literal>[server]</literal>. The format for
 
86
      the rest is a simple VAR = VALUE pair. Values may not be empty.
 
87
    </para>
 
88
 
 
89
    <para>
 
90
      The paramters are:
 
91
    </para>
 
92
 
103
93
    <variablelist>
104
94
      <varlistentry>
105
 
        <term><varname>interface</varname></term>
106
 
        <listitem>
107
 
          <synopsis><literal>interface = </literal><replaceable
108
 
          >NAME</replaceable>
109
 
          </synopsis>
110
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
111
 
        </listitem>
112
 
      </varlistentry>
113
 
 
114
 
      <varlistentry>
115
 
        <term><varname>address</varname></term>
116
 
        <listitem>
117
 
          <synopsis><literal>address = </literal><replaceable
118
 
          >ADDRESS</replaceable>
119
 
          </synopsis>
120
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
 
124
 
      <varlistentry>
125
 
        <term><varname>port</varname></term>
126
 
        <listitem>
127
 
          <synopsis><literal>port = </literal><replaceable
128
 
          >NUMBER</replaceable>
129
 
          </synopsis>
130
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
131
 
        </listitem>
132
 
      </varlistentry>
133
 
 
134
 
      <varlistentry>
135
 
        <term><varname>debug</varname></term>
136
 
        <listitem>
137
 
          <synopsis><literal>debug = </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> }
142
 
          </synopsis>
143
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
147
 
      <varlistentry>
148
 
        <term><varname>priority</varname></term>
149
 
        <listitem>
150
 
          <synopsis><literal>priority = </literal><replaceable
151
 
          >STRING</replaceable>
152
 
          </synopsis>
153
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
 
157
 
      <varlistentry>
158
 
        <term><varname>servicename</varname></term>
159
 
        <listitem>
160
 
          <synopsis><literal>servicename = </literal><replaceable
161
 
          >NAME</replaceable>
162
 
          </synopsis>
163
 
          <xi:include href="mandos-options.xml"
164
 
                      xpointer="servicename"/>
 
95
        <term><literal>interface</literal></term>
 
96
        <listitem>
 
97
          <para>
 
98
            This option allows you to override the default network
 
99
            interfaces. By default mandos will not bind to any
 
100
            specific interface but instead use default avahi-server
 
101
            behaviour.
 
102
          </para>
 
103
        </listitem>
 
104
      </varlistentry>
 
105
 
 
106
      <varlistentry>
 
107
        <term><literal>address</literal></term>
 
108
        <listitem>
 
109
          <para>
 
110
            This option allows you to override the default network
 
111
            address. By default mandos will not bind to any
 
112
            specific address but instead use default avahi-server
 
113
            behaviour.
 
114
          </para>
 
115
        </listitem>
 
116
      </varlistentry>      
 
117
 
 
118
      <varlistentry>
 
119
        <term><literal>port</literal></term>
 
120
        <listitem>
 
121
          <para>
 
122
            This option allows you to override the default port to
 
123
            listen on. By default mandos will not specify any specific
 
124
            port and instead use a random port given by the OS from
 
125
            the use of INADDR_ANY.
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><literal>debug</literal></term>
 
132
        <listitem>
 
133
          <para>
 
134
            This option allows you to modify debug mode with a true/false
 
135
            boolean value. By default is debug set to <literal>false</literal>.
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>      
 
139
 
 
140
      <varlistentry>
 
141
        <term><literal>priority</literal></term>
 
142
        <listitem>
 
143
          <para>
 
144
            This option allows you to override the default gnutls
 
145
            priority that will be used in gnutls session. See
 
146
            <citerefentry><refentrytitle>gnutls_priority_init
 
147
            </refentrytitle><manvolnum>3</manvolnum></citerefentry>for
 
148
            more information on gnutls priority strings.
 
149
          </para>         
 
150
        </listitem>
 
151
      </varlistentry>
 
152
 
 
153
      <varlistentry>
 
154
        <term><literal>servicename</literal></term>
 
155
        <listitem>
 
156
          <para>
 
157
            This option allows you to override the default Zeroconf
 
158
            service name use to announce mandos as a avahi service. By
 
159
            default mandos will use "Mandos".
 
160
          </para>
165
161
        </listitem>
166
162
      </varlistentry>
167
163
      
168
164
    </variablelist>
169
165
  </refsect1>
 
166
 
 
167
  <refsect1 id="examples">
 
168
    <title>EXAMPLES</title>
 
169
    <informalexample>
 
170
      <programlisting>
 
171
        [server]
 
172
        # A configuration example
 
173
        interface = eth0 
 
174
        address = 2001:DB8:
 
175
        port = 1025 
 
176
        debug = true 
 
177
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
178
        servicename = Mandos
 
179
      </programlisting>
 
180
    </informalexample>
 
181
  </refsect1>  
170
182
  
171
183
  <refsect1 id="files">
172
184
    <title>FILES</title>
174
186
      The file described here is &CONFPATH;
175
187
    </para>
176
188
  </refsect1>
177
 
  
178
 
  <refsect1 id="bugs">
179
 
    <title>BUGS</title>
180
 
    <para>
181
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
182
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
183
 
      requres it.
184
 
    </para>
185
 
  </refsect1>
186
 
  
187
 
  <refsect1 id="example">
188
 
    <title>EXAMPLE</title>
189
 
    <informalexample>
190
 
      <para>
191
 
        No options are actually required:
192
 
      </para>
193
 
      <programlisting>
194
 
[DEFAULT]
195
 
      </programlisting>
196
 
    </informalexample>
197
 
    <informalexample>
198
 
      <para>
199
 
        An example using all the options:
200
 
      </para>
201
 
      <programlisting>
202
 
[DEFAULT]
203
 
# A configuration example
204
 
interface = eth0
205
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
206
 
port = 1025
207
 
debug = true
208
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
209
 
servicename = Daena
210
 
      </programlisting>
211
 
    </informalexample>
212
 
  </refsect1>
213
 
  
214
 
  <refsect1 id="see_also">
215
 
    <title>SEE ALSO</title>
216
 
    <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>
224
 
    </para>
225
 
 
226
 
    <variablelist>
227
 
      <varlistentry>
228
 
        <term>
229
 
          RFC 4291: <citetitle>IP Version 6 Addressing
230
 
          Architecture</citetitle>
231
 
        </term>
232
 
        <listitem>
233
 
          <variablelist>
234
 
            <varlistentry>
235
 
              <term>Section 2.2: <citetitle>Text Representation of
236
 
              Addresses</citetitle></term>
237
 
              <listitem><para/></listitem>
238
 
            </varlistentry>
239
 
            <varlistentry>
240
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
241
 
              Address</citetitle></term>
242
 
              <listitem><para/></listitem>
243
 
            </varlistentry>
244
 
            <varlistentry>
245
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
246
 
            Addresses</citetitle></term>
247
 
            <listitem>
248
 
              <para>
249
 
                The clients use IPv6 link-local addresses, which are
250
 
                immediately usable since a link-local addresses is
251
 
                automatically assigned to a network interfaces when it
252
 
                is brought up.
253
 
              </para>
254
 
            </listitem>
255
 
            </varlistentry>
256
 
          </variablelist>
257
 
        </listitem>
258
 
      </varlistentry>
259
 
      <varlistentry>
260
 
        <term>
261
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
262
 
        </term>
263
 
        <listitem>
264
 
          <para>
265
 
            Zeroconf is the network protocol standard used by clients
266
 
            for finding the Mandos server on the local network.
267
 
          </para>
268
 
        </listitem>
269
 
      </varlistentry>
270
 
    </variablelist>
271
 
  </refsect1>
272
189
</refentry>
273
 
<!-- Local Variables: -->
274
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
275
 
<!-- time-stamp-end: "[\"']>" -->
276
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
277
 
<!-- End: -->