/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:
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 "2011-10-03">
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
 
      <holder>Teddy Hogeborn</holder>
39
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
40
36
    </copyright>
41
 
    <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>
42
60
  </refentryinfo>
43
 
  
 
61
 
44
62
  <refmeta>
45
63
    <refentrytitle>&CONFNAME;</refentrytitle>
46
64
    <manvolnum>5</manvolnum>
49
67
  <refnamediv>
50
68
    <refname><filename>&CONFNAME;</filename></refname>
51
69
    <refpurpose>
52
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos
53
71
    </refpurpose>
54
72
  </refnamediv>
55
 
  
 
73
 
56
74
  <refsynopsisdiv>
57
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
58
78
  </refsynopsisdiv>
59
 
  
 
79
 
60
80
  <refsect1 id="description">
61
81
    <title>DESCRIPTION</title>
62
82
    <para>
63
 
      The file &CONFPATH; is a simple configuration file for
64
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
65
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
66
 
      startup.  The configuration file starts with <quote><literal
67
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
68
 
      any number of <quote><varname><replaceable>option</replaceable
69
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
70
 
      with continuations in the style of RFC 822.  <quote><varname
71
 
      ><replaceable>option</replaceable></varname>: <replaceable
72
 
      >value</replaceable></quote> is also accepted.  Note that
73
 
      leading whitespace is removed from values.  Lines beginning with
74
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
75
 
      to provide comments.
76
 
    </para>
77
 
    
78
 
  </refsect1>
79
 
  <refsect1>
80
 
    <title>OPTIONS</title>
81
 
    
 
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
93
    <variablelist>
83
94
      <varlistentry>
84
 
        <term><option>interface<literal> = </literal><replaceable
85
 
        >NAME</replaceable></option></term>
86
 
        <listitem>
87
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
88
 
        </listitem>
89
 
      </varlistentry>
90
 
      
91
 
      <varlistentry>
92
 
        <term><option>address<literal> = </literal><replaceable
93
 
          >ADDRESS</replaceable></option></term>
94
 
        <listitem>
95
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
96
 
        </listitem>
97
 
      </varlistentry>
98
 
      
99
 
      <varlistentry>
100
 
        <term><option>port<literal> = </literal><replaceable
101
 
        >NUMBER</replaceable></option></term>
102
 
        <listitem>
103
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
104
 
        </listitem>
105
 
      </varlistentry>
106
 
      
107
 
      <varlistentry>
108
 
        <term><option>debug<literal> = </literal>{ <literal
109
 
          >1</literal> | <literal>yes</literal> | <literal
110
 
          >true</literal> | <literal>on</literal> | <literal
111
 
          >0</literal> | <literal>no</literal> | <literal
112
 
          >false</literal> | <literal>off</literal> }</option></term>
113
 
        <listitem>
114
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
115
 
        </listitem>
116
 
      </varlistentry>
117
 
      
118
 
      <varlistentry>
119
 
        <term><option>priority<literal> = </literal><replaceable
120
 
        >STRING</replaceable></option></term>
121
 
        <listitem>
122
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
123
 
        </listitem>
124
 
      </varlistentry>
125
 
      
126
 
      <varlistentry>
127
 
        <term><option>servicename<literal> = </literal
128
 
        ><replaceable>NAME</replaceable></option></term>
129
 
        <listitem>
130
 
          <xi:include href="mandos-options.xml"
131
 
                      xpointer="servicename"/>
132
 
        </listitem>
133
 
      </varlistentry>
134
 
      
135
 
      <varlistentry>
136
 
        <term><option>use_dbus<literal> = </literal>{ <literal
137
 
          >1</literal> | <literal>yes</literal> | <literal
138
 
          >true</literal> | <literal>on</literal> | <literal
139
 
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }</option></term>
141
 
        <listitem>
142
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
143
 
        </listitem>
144
 
      </varlistentry>
145
 
      
146
 
      <varlistentry>
147
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
148
 
          >1</literal> | <literal>yes</literal> | <literal
149
 
          >true</literal> | <literal>on</literal> | <literal
150
 
          >0</literal> | <literal>no</literal> | <literal
151
 
          >false</literal> | <literal>off</literal> }</option></term>
152
 
        <listitem>
153
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
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>
154
161
        </listitem>
155
162
      </varlistentry>
156
163
      
157
164
    </variablelist>
158
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>  
159
182
  
160
183
  <refsect1 id="files">
161
184
    <title>FILES</title>
163
186
      The file described here is &CONFPATH;
164
187
    </para>
165
188
  </refsect1>
166
 
  
167
 
  <refsect1 id="bugs">
168
 
    <title>BUGS</title>
169
 
    <para>
170
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
171
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
172
 
      requires it.
173
 
    </para>
174
 
  </refsect1>
175
 
  
176
 
  <refsect1 id="example">
177
 
    <title>EXAMPLE</title>
178
 
    <informalexample>
179
 
      <para>
180
 
        No options are actually required:
181
 
      </para>
182
 
      <programlisting>
183
 
[DEFAULT]
184
 
      </programlisting>
185
 
    </informalexample>
186
 
    <informalexample>
187
 
      <para>
188
 
        An example using all the options:
189
 
      </para>
190
 
      <programlisting>
191
 
[DEFAULT]
192
 
# A configuration example
193
 
interface = eth0
194
 
address = fe80::aede:48ff:fe71:f6f2
195
 
port = 1025
196
 
debug = true
197
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
198
 
servicename = Daena
199
 
use_dbus = False
200
 
use_ipv6 = True
201
 
      </programlisting>
202
 
    </informalexample>
203
 
  </refsect1>
204
 
  
205
 
  <refsect1 id="see_also">
206
 
    <title>SEE ALSO</title>
207
 
    <para>
208
 
      <citerefentry><refentrytitle>intro</refentrytitle>
209
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
210
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
211
 
      ><manvolnum>3</manvolnum></citerefentry>,
212
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
213
 
      <manvolnum>8</manvolnum></citerefentry>,
214
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
215
 
      <manvolnum>5</manvolnum></citerefentry>
216
 
    </para>
217
 
    
218
 
    <variablelist>
219
 
      <varlistentry>
220
 
        <term>
221
 
          RFC 4291: <citetitle>IP Version 6 Addressing
222
 
          Architecture</citetitle>
223
 
        </term>
224
 
        <listitem>
225
 
          <variablelist>
226
 
            <varlistentry>
227
 
              <term>Section 2.2: <citetitle>Text Representation of
228
 
              Addresses</citetitle></term>
229
 
              <listitem><para/></listitem>
230
 
            </varlistentry>
231
 
            <varlistentry>
232
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
233
 
              Address</citetitle></term>
234
 
              <listitem><para/></listitem>
235
 
            </varlistentry>
236
 
            <varlistentry>
237
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
238
 
            Addresses</citetitle></term>
239
 
            <listitem>
240
 
              <para>
241
 
                The clients use IPv6 link-local addresses, which are
242
 
                immediately usable since a link-local addresses is
243
 
                automatically assigned to a network interface when it
244
 
                is brought up.
245
 
              </para>
246
 
            </listitem>
247
 
            </varlistentry>
248
 
          </variablelist>
249
 
        </listitem>
250
 
      </varlistentry>
251
 
      <varlistentry>
252
 
        <term>
253
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
254
 
        </term>
255
 
        <listitem>
256
 
          <para>
257
 
            Zeroconf is the network protocol standard used by clients
258
 
            for finding the Mandos server on the local network.
259
 
          </para>
260
 
        </listitem>
261
 
      </varlistentry>
262
 
    </variablelist>
263
 
  </refsect1>
264
189
</refentry>
265
 
<!-- Local Variables: -->
266
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
267
 
<!-- time-stamp-end: "[\"']>" -->
268
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
269
 
<!-- End: -->