/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 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
8
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
9
7
]>
10
8
 
11
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
11
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>&CONFNAME;</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn</holder>
 
34
      <holder>Björn Påhlsson</holder>
36
35
    </copyright>
37
36
    <legalnotice>
38
37
      <para>
67
66
  <refnamediv>
68
67
    <refname><filename>&CONFNAME;</filename></refname>
69
68
    <refpurpose>
70
 
      Configuration file for Mandos
 
69
      Configuration file for the Mandos server
71
70
    </refpurpose>
72
71
  </refnamediv>
73
72
 
80
79
  <refsect1 id="description">
81
80
    <title>DESCRIPTION</title>
82
81
    <para>
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
 
 
 
82
      The file &CONFPATH; is a simple configuration file for
 
83
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
84
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
 
85
      startup.  The configuration file starts with <quote><literal
 
86
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
87
      any number of <quote><varname><replaceable>option</replaceable
 
88
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
89
      with continuations in the style of RFC 822.  <quote><varname
 
90
      ><replaceable>option</replaceable></varname>: <replaceable
 
91
      >value</replaceable></quote> is also accepted.  Note that
 
92
      leading whitespace is removed from values.  Lines beginning with
 
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
94
      to provide comments.
 
95
    </para>
 
96
 
 
97
  </refsect1>
 
98
  <refsect1>
 
99
    <title>OPTIONS</title>
 
100
    
93
101
    <variablelist>
94
102
      <varlistentry>
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>
 
103
        <term><varname>interface</varname></term>
 
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >IF</replaceable>
 
107
          </synopsis>
 
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
 
 
112
      <varlistentry>
 
113
        <term><varname>address</varname></term>
 
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
 
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
 
 
122
      <varlistentry>
 
123
        <term><varname>port</varname></term>
 
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >PORT</replaceable>
 
127
          </synopsis>
 
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
129
        </listitem>
 
130
      </varlistentry>
 
131
 
 
132
      <varlistentry>
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </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> }
 
140
          </synopsis>
 
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
142
        </listitem>
 
143
      </varlistentry>
 
144
 
 
145
      <varlistentry>
 
146
        <term><varname>priority</varname></term>
 
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >PRIORITY</replaceable>
 
150
          </synopsis>
 
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
152
        </listitem>
 
153
      </varlistentry>
 
154
 
 
155
      <varlistentry>
 
156
        <term><varname>servicename</varname></term>
 
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
 
161
          <xi:include href="mandos-options.xml"
 
162
                      xpointer="servicename"/>
161
163
        </listitem>
162
164
      </varlistentry>
163
165
      
164
166
    </variablelist>
165
167
  </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>  
182
168
  
183
169
  <refsect1 id="files">
184
170
    <title>FILES</title>
186
172
      The file described here is &CONFPATH;
187
173
    </para>
188
174
  </refsect1>
 
175
  
 
176
  <refsect1 id="bugs">
 
177
    <title>BUGS</title>
 
178
    <para>
 
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
181
      requres it.
 
182
    </para>
 
183
  </refsect1>
 
184
  
 
185
  <refsect1 id="example">
 
186
    <title>EXAMPLE</title>
 
187
    <informalexample>
 
188
      <para>
 
189
        No options are actually required:
 
190
      </para>
 
191
      <programlisting>
 
192
[DEFAULT]
 
193
      </programlisting>
 
194
    </informalexample>
 
195
    <informalexample>
 
196
      <para>
 
197
        An example using all the options:
 
198
      </para>
 
199
      <programlisting>
 
200
[DEFAULT]
 
201
# A configuration example
 
202
interface = eth0
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
204
port = 1025
 
205
debug = true
 
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
207
servicename = Daena
 
208
      </programlisting>
 
209
    </informalexample>
 
210
  </refsect1>
 
211
  
 
212
  <refsect1 id="see_also">
 
213
    <title>SEE ALSO</title>
 
214
    <para>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>
 
220
    </para>
 
221
  </refsect1>
189
222
</refentry>