/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-07-20 06:33:48 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080720063348-jscgy5p0itrgvlo8
* mandos-clients.conf ([foo]): Uncommented.
  ([foo]/secret): New.
  ([foo]/secfile): Commented out.
  ([foo]/checker): Changed to "fping -q -- %%(fqdn)s".
  ([foo]/timeout): New.

* server.py: New modeline for Python and Emacs.  Set a logging format.
  (Client.__init__): Bug fix: Choose either the value from the options
                     object or pass the argument through string_to_delta
                     for both "timeout" and "interval".
  (Client.checker_callback): Bug fix: Do not log spurious "Checker for
                             <foo> failed" messages.
  (Client.start_checker): Moved "Starting checker" log message down to
                          just before actually starting the subprocess.
                          Do not redirect the subprocesses' stdout to a
                          pipe.
  (peer_certificate, fingerprint): Added docstrings.
  (entry_group_state_changed): Call "killme()" instead of
                               "main_loop.quit()".
  (daemon, killme): New functions.
  (exitstatus, main_loop_started): New global variables.
  (__main__): Removed the "--cert", "--key", "--ca", and "--crl"
              options.  Removed the sleep command from the default
              checker.  Add a console logger in debug mode.  Call
              "killme()" instead of "main_loop.quit()" when there are no
              more clients.  Call "daemon()" if not in debug mode.
              Register "cleanup()" to run at exit.  Ignore some
              signals.  Catch DBusException to detect another running
              server and exit cleanly.  Exit with "exitstatus".
  (cleanup): New function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY CONFNAME "mandos.conf">
5
 
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2012-05-26">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
 
]>
10
 
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
18
 
    <authorgroup>
19
 
      <author>
20
 
        <firstname>Björn</firstname>
21
 
        <surname>Påhlsson</surname>
22
 
        <address>
23
 
          <email>belorn@recompile.se</email>
24
 
        </address>
25
 
      </author>
26
 
      <author>
27
 
        <firstname>Teddy</firstname>
28
 
        <surname>Hogeborn</surname>
29
 
        <address>
30
 
          <email>teddy@recompile.se</email>
31
 
        </address>
32
 
      </author>
33
 
    </authorgroup>
34
 
    <copyright>
35
 
      <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>
41
 
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
43
 
  </refentryinfo>
44
 
  
45
 
  <refmeta>
46
 
    <refentrytitle>&CONFNAME;</refentrytitle>
47
 
    <manvolnum>5</manvolnum>
48
 
  </refmeta>
49
 
  
50
 
  <refnamediv>
51
 
    <refname><filename>&CONFNAME;</filename></refname>
52
 
    <refpurpose>
53
 
      Configuration file for the Mandos server
54
 
    </refpurpose>
55
 
  </refnamediv>
56
 
  
57
 
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
59
 
  </refsynopsisdiv>
60
 
  
61
 
  <refsect1 id="description">
62
 
    <title>DESCRIPTION</title>
63
 
    <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
 
    <variablelist>
84
 
      <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"/>
182
 
        </listitem>
183
 
      </varlistentry>
184
 
      
185
 
    </variablelist>
186
 
  </refsect1>
187
 
  
188
 
  <refsect1 id="files">
189
 
    <title>FILES</title>
190
 
    <para>
191
 
      The file described here is &CONFPATH;
192
 
    </para>
193
 
  </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
 
</refentry>
295
 
<!-- Local Variables: -->
296
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
297
 
<!-- time-stamp-end: "[\"']>" -->
298
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
299
 
<!-- End: -->