/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-16 03:29:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080816032908-ihw7c05r2mnyk389
Add feature to specify custom environment variables for plugins.

* plugin-runner.c (plugin): New members "environ" and "envc" to
                            contain possible custom environment.
  (getplugin): Return NULL on failure instead of doing exit(); all
               callers changed.
  (add_to_char_array): New helper function for "add_argument" and
                       "add_environment".
  (addargument): Renamed to "add_argument".  Return bool.  Call
                 "add_to_char_array" to actually do things.
  (add_environment): New; analogous to "add_argument".
  (addcustomargument): Renamed to "add_to_argv" to avoid confusion
                       with "add_argument".
  (main): New options "--global-envs" and "--envs-for" to specify
          custom environment for plugins.  Print environment for
          plugins in debug mode.  Use asprintf instead of strcpy and
          strcat.  Use execve() for plugins with custom environments.
          Free environment for plugin when freeing plugin list.

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 "2012-05-26">
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>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <holder>Teddy Hogeborn</holder>
40
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; 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>
50
67
  <refnamediv>
51
68
    <refname><filename>&CONFNAME;</filename></refname>
52
69
    <refpurpose>
53
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos
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
 
      The file &CONFPATH; is a simple configuration file for
65
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
66
 
      <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.
77
 
    </para>
78
 
    
79
 
  </refsect1>
80
 
  <refsect1>
81
 
    <title>OPTIONS</title>
82
 
    
 
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
 
83
93
    <variablelist>
84
94
      <varlistentry>
85
 
        <term><option>interface<literal> = </literal><replaceable
86
 
        >NAME</replaceable></option></term>
87
 
        <listitem>
88
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
89
 
        </listitem>
90
 
      </varlistentry>
91
 
      
92
 
      <varlistentry>
93
 
        <term><option>address<literal> = </literal><replaceable
94
 
          >ADDRESS</replaceable></option></term>
95
 
        <listitem>
96
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
97
 
        </listitem>
98
 
      </varlistentry>
99
 
      
100
 
      <varlistentry>
101
 
        <term><option>port<literal> = </literal><replaceable
102
 
        >NUMBER</replaceable></option></term>
103
 
        <listitem>
104
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
105
 
        </listitem>
106
 
      </varlistentry>
107
 
      
108
 
      <varlistentry>
109
 
        <term><option>debug<literal> = </literal>{ <literal
110
 
          >1</literal> | <literal>yes</literal> | <literal
111
 
          >true</literal> | <literal>on</literal> | <literal
112
 
          >0</literal> | <literal>no</literal> | <literal
113
 
          >false</literal> | <literal>off</literal> }</option></term>
114
 
        <listitem>
115
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
116
 
        </listitem>
117
 
      </varlistentry>
118
 
      
119
 
      <varlistentry>
120
 
        <term><option>priority<literal> = </literal><replaceable
121
 
        >STRING</replaceable></option></term>
122
 
        <listitem>
123
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
      
127
 
      <varlistentry>
128
 
        <term><option>servicename<literal> = </literal
129
 
        ><replaceable>NAME</replaceable></option></term>
130
 
        <listitem>
131
 
          <xi:include href="mandos-options.xml"
132
 
                      xpointer="servicename"/>
133
 
        </listitem>
134
 
      </varlistentry>
135
 
      
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"/>
 
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>
182
161
        </listitem>
183
162
      </varlistentry>
184
163
      
185
164
    </variablelist>
186
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>  
187
182
  
188
183
  <refsect1 id="files">
189
184
    <title>FILES</title>
191
186
      The file described here is &CONFPATH;
192
187
    </para>
193
188
  </refsect1>
194
 
  
195
 
  <refsect1 id="bugs">
196
 
    <title>BUGS</title>
197
 
    <para>
198
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
199
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
200
 
      requires it.
201
 
    </para>
202
 
  </refsect1>
203
 
  
204
 
  <refsect1 id="example">
205
 
    <title>EXAMPLE</title>
206
 
    <informalexample>
207
 
      <para>
208
 
        No options are actually required:
209
 
      </para>
210
 
      <programlisting>
211
 
[DEFAULT]
212
 
      </programlisting>
213
 
    </informalexample>
214
 
    <informalexample>
215
 
      <para>
216
 
        An example using all the options:
217
 
      </para>
218
 
      <programlisting>
219
 
[DEFAULT]
220
 
# A configuration example
221
 
interface = eth0
222
 
address = fe80::aede:48ff:fe71:f6f2
223
 
port = 1025
224
 
debug = true
225
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
226
 
servicename = Daena
227
 
use_dbus = False
228
 
use_ipv6 = True
229
 
restore = True
230
 
statedir = /var/lib/mandos
231
 
      </programlisting>
232
 
    </informalexample>
233
 
  </refsect1>
234
 
  
235
 
  <refsect1 id="see_also">
236
 
    <title>SEE ALSO</title>
237
 
    <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>
246
 
    </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
 
  </refsect1>
294
189
</refentry>
295
 
<!-- Local Variables: -->
296
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
297
 
<!-- time-stamp-end: "[\"']>" -->
298
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
299
 
<!-- End: -->