/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

mandos-client
        Better error handling for failing to start plugins
        Handle fork errors
password-request
        correct exit routine

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
<?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" [
 
6
<!ENTITY VERSION "1.0">
4
7
<!ENTITY CONFNAME "mandos.conf">
5
8
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2008-09-30">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
9
]>
10
10
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
12
12
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <title>&CONFNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&CONFNAME;</productname>
 
16
    <productnumber>&VERSION;</productnumber>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; 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>
47
67
  <refnamediv>
48
68
    <refname><filename>&CONFNAME;</filename></refname>
49
69
    <refpurpose>
50
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos
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
 
      The file &CONFPATH; is a simple configuration file for
62
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
63
 
      <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
 
    
 
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
 
80
93
    <variablelist>
81
94
      <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"/>
 
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>
130
161
        </listitem>
131
162
      </varlistentry>
132
163
      
133
164
    </variablelist>
134
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>  
135
182
  
136
183
  <refsect1 id="files">
137
184
    <title>FILES</title>
139
186
      The file described here is &CONFPATH;
140
187
    </para>
141
188
  </refsect1>
142
 
  
143
 
  <refsect1 id="bugs">
144
 
    <title>BUGS</title>
145
 
    <para>
146
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
147
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
148
 
      requires it.
149
 
    </para>
150
 
  </refsect1>
151
 
  
152
 
  <refsect1 id="example">
153
 
    <title>EXAMPLE</title>
154
 
    <informalexample>
155
 
      <para>
156
 
        No options are actually required:
157
 
      </para>
158
 
      <programlisting>
159
 
[DEFAULT]
160
 
      </programlisting>
161
 
    </informalexample>
162
 
    <informalexample>
163
 
      <para>
164
 
        An example using all the options:
165
 
      </para>
166
 
      <programlisting>
167
 
[DEFAULT]
168
 
# A configuration example
169
 
interface = eth0
170
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
171
 
port = 1025
172
 
debug = true
173
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
174
 
servicename = Daena
175
 
      </programlisting>
176
 
    </informalexample>
177
 
  </refsect1>
178
 
  
179
 
  <refsect1 id="see_also">
180
 
    <title>SEE ALSO</title>
181
 
    <para>
182
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
183
 
      ><manvolnum>3</manvolnum></citerefentry>,
184
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
 
      <manvolnum>8</manvolnum></citerefentry>,
186
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
187
 
      <manvolnum>5</manvolnum></citerefentry>
188
 
    </para>
189
 
    
190
 
    <variablelist>
191
 
      <varlistentry>
192
 
        <term>
193
 
          RFC 4291: <citetitle>IP Version 6 Addressing
194
 
          Architecture</citetitle>
195
 
        </term>
196
 
        <listitem>
197
 
          <variablelist>
198
 
            <varlistentry>
199
 
              <term>Section 2.2: <citetitle>Text Representation of
200
 
              Addresses</citetitle></term>
201
 
              <listitem><para/></listitem>
202
 
            </varlistentry>
203
 
            <varlistentry>
204
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
205
 
              Address</citetitle></term>
206
 
              <listitem><para/></listitem>
207
 
            </varlistentry>
208
 
            <varlistentry>
209
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
210
 
            Addresses</citetitle></term>
211
 
            <listitem>
212
 
              <para>
213
 
                The clients use IPv6 link-local addresses, which are
214
 
                immediately usable since a link-local addresses is
215
 
                automatically assigned to a network interfaces when it
216
 
                is brought up.
217
 
              </para>
218
 
            </listitem>
219
 
            </varlistentry>
220
 
          </variablelist>
221
 
        </listitem>
222
 
      </varlistentry>
223
 
      <varlistentry>
224
 
        <term>
225
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
226
 
        </term>
227
 
        <listitem>
228
 
          <para>
229
 
            Zeroconf is the network protocol standard used by clients
230
 
            for finding the Mandos server on the local network.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
    </variablelist>
235
 
  </refsect1>
236
189
</refentry>
237
 
<!-- Local Variables: -->
238
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
239
 
<!-- time-stamp-end: "[\"']>" -->
240
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
241
 
<!-- End: -->