/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

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