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
- browse files at revision 78
- compare with another revision
- download diff
- download tarball
- view history from revision 78
- 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.
* 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.
- files added:
- network-protocol.txt
- files removed:
- .bzrignore
- files modified:
- Makefile
added
removed
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-30">
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 & 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
75
74
<refsynopsisdiv>
76
<synopsis>&CONFPATH;</synopsis>
75
<synopsis>
76
&CONFPATH;
77
</synopsis>
77
78
</refsynopsisdiv>
78
79
79
80
<refsect1 id="description">
80
81
<title>DESCRIPTION</title>
81
82
<para>
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
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
101
93
<variablelist>
102
94
<varlistentry>
103
<term><option>interface<literal> = </literal><replaceable
104
>NAME</replaceable></option></term>
105
<listitem>
106
<xi:include href="mandos-options.xml" xpointer="interface"/>
107
</listitem>
108
</varlistentry>
109
110
<varlistentry>
111
<term><option>address<literal> = </literal><replaceable
112
>ADDRESS</replaceable></option></term>
113
<listitem>
114
<xi:include href="mandos-options.xml" xpointer="address"/>
115
</listitem>
116
</varlistentry>
117
118
<varlistentry>
119
<term><option>port<literal> = </literal><replaceable
120
>NUMBER</replaceable></option></term>
121
<listitem>
122
<xi:include href="mandos-options.xml" xpointer="port"/>
123
</listitem>
124
</varlistentry>
125
126
<varlistentry>
127
<term><option>debug<literal> = </literal>{ <literal
128
>1</literal> | <literal>yes</literal> | <literal
129
>true</literal> | <literal>on</literal> | <literal
130
>0</literal> | <literal>no</literal> | <literal
131
>false</literal> | <literal>off</literal> }</option></term>
132
<listitem>
133
<xi:include href="mandos-options.xml" xpointer="debug"/>
134
</listitem>
135
</varlistentry>
136
137
<varlistentry>
138
<term><option>priority<literal> = </literal><replaceable
139
>STRING</replaceable></option></term>
140
<listitem>
141
<xi:include href="mandos-options.xml" xpointer="priority"/>
142
</listitem>
143
</varlistentry>
144
145
<varlistentry>
146
<term><option>servicename<literal> = </literal
147
><replaceable>NAME</replaceable></option></term>
148
<listitem>
149
<xi:include href="mandos-options.xml"
150
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>
151
161
</listitem>
152
162
</varlistentry>
153
163
154
164
</variablelist>
155
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>
156
182
157
183
<refsect1 id="files">
158
184
<title>FILES</title>
160
186
The file described here is &CONFPATH;
161
187
</para>
162
188
</refsect1>
163
164
<refsect1 id="bugs">
165
<title>BUGS</title>
166
<para>
167
The <literal>[DEFAULT]</literal> is necessary because the Python
168
built-in module <systemitem class="library">ConfigParser</systemitem>
169
requres it.
170
</para>
171
</refsect1>
172
173
<refsect1 id="example">
174
<title>EXAMPLE</title>
175
<informalexample>
176
<para>
177
No options are actually required:
178
</para>
179
<programlisting>
180
[DEFAULT]
181
</programlisting>
182
</informalexample>
183
<informalexample>
184
<para>
185
An example using all the options:
186
</para>
187
<programlisting>
188
[DEFAULT]
189
# A configuration example
190
interface = eth0
191
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
192
port = 1025
193
debug = true
194
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
195
servicename = Daena
196
</programlisting>
197
</informalexample>
198
</refsect1>
199
200
<refsect1 id="see_also">
201
<title>SEE ALSO</title>
202
<para>
203
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
204
><manvolnum>3</manvolnum></citerefentry>,
205
<citerefentry><refentrytitle>mandos</refentrytitle>
206
<manvolnum>8</manvolnum></citerefentry>,
207
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
208
<manvolnum>5</manvolnum></citerefentry>
209
</para>
210
211
<variablelist>
212
<varlistentry>
213
<term>
214
RFC 4291: <citetitle>IP Version 6 Addressing
215
Architecture</citetitle>
216
</term>
217
<listitem>
218
<variablelist>
219
<varlistentry>
220
<term>Section 2.2: <citetitle>Text Representation of
221
Addresses</citetitle></term>
222
<listitem><para/></listitem>
223
</varlistentry>
224
<varlistentry>
225
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
226
Address</citetitle></term>
227
<listitem><para/></listitem>
228
</varlistentry>
229
<varlistentry>
230
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
231
Addresses</citetitle></term>
232
<listitem>
233
<para>
234
The clients use IPv6 link-local addresses, which are
235
immediately usable since a link-local addresses is
236
automatically assigned to a network interfaces when it
237
is brought up.
238
</para>
239
</listitem>
240
</varlistentry>
241
</variablelist>
242
</listitem>
243
</varlistentry>
244
<varlistentry>
245
<term>
246
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
247
</term>
248
<listitem>
249
<para>
250
Zeroconf is the network protocol standard used by clients
251
for finding the Mandos server on the local network.
252
</para>
253
</listitem>
254
</varlistentry>
255
</variablelist>
256
</refsect1>
257
189
</refentry>
258
<!-- Local Variables: -->
259
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
260
<!-- time-stamp-end: "[\"']>" -->
261
<!-- time-stamp-format: "%:y-%02m-%02d" -->
262
<!-- End: -->
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0