/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: 2012-05-12 15:45:57 UTC
  • Revision ID: teddy@recompile.se-20120512154557-r1yzcb8su8byp4us
* mandos (Client.enable, Client.disable, ClientDBus.approve): Call
                    self.send_changedstate() after change, not before.
  (Client.disable): Bug fix: Handle disable_initiator_tag and
                    checker_initiator_tag of 0.
  (Client.init_checker): Bug fix: Remove old checker_initiator_tag and
                         disable_initiator_tag, if any.
  (Client.bump_timeout): Bug fix: Remove old disable_initiator_tag, if
                         any.
  (ClientDBus.Timeout_dbus_property): Bug fix: Use self.expires.
  (ClientHandler.handle): Bug fix: timedelta_to_milliseconds is a
                          global function, not a class method.
* mandos-monitor (MandosClientWidget._update_timer_callback_lock):
  Removed.  All users changed.
  (MandosClientWidget.last_checked_ok): Removed (unused).
  (MandosClientWidget.__init__): Don't call self.using_timer().
  (MandosClientWidget.property_changed): Removed unused version.
  (MandosClientWidget.using_timer): Stop using the counter
                                    self._update_timer_callback_lock;
                                    be strictly boolean.
  (MandosClientWidget.need_approval): Don't call self.using_timer().
  (MandosClientWidget.update): Call self.using_timer() throughout.
                               Bug fix: Never show negative timers.

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-01-01">
 
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
    </variablelist>
 
178
  </refsect1>
 
179
  
 
180
  <refsect1 id="files">
 
181
    <title>FILES</title>
 
182
    <para>
 
183
      The file described here is &CONFPATH;
 
184
    </para>
 
185
  </refsect1>
 
186
  
 
187
  <refsect1 id="bugs">
 
188
    <title>BUGS</title>
 
189
    <para>
 
190
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
191
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
192
      requires it.
 
193
    </para>
 
194
  </refsect1>
 
195
  
 
196
  <refsect1 id="example">
 
197
    <title>EXAMPLE</title>
 
198
    <informalexample>
 
199
      <para>
 
200
        No options are actually required:
 
201
      </para>
 
202
      <programlisting>
 
203
[DEFAULT]
 
204
      </programlisting>
 
205
    </informalexample>
 
206
    <informalexample>
 
207
      <para>
 
208
        An example using all the options:
 
209
      </para>
 
210
      <programlisting>
 
211
[DEFAULT]
 
212
# A configuration example
 
213
interface = eth0
 
214
address = fe80::aede:48ff:fe71:f6f2
 
215
port = 1025
 
216
debug = true
 
217
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
218
servicename = Daena
 
219
use_dbus = False
 
220
use_ipv6 = True
 
221
restore = True
 
222
statedir = /var/lib/mandos
 
223
      </programlisting>
 
224
    </informalexample>
 
225
  </refsect1>
 
226
  
 
227
  <refsect1 id="see_also">
 
228
    <title>SEE ALSO</title>
 
229
    <para>
 
230
      <citerefentry><refentrytitle>intro</refentrytitle>
 
231
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
232
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
233
      ><manvolnum>3</manvolnum></citerefentry>,
 
234
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
235
      <manvolnum>8</manvolnum></citerefentry>,
 
236
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
237
      <manvolnum>5</manvolnum></citerefentry>
 
238
    </para>
 
239
    
 
240
    <variablelist>
 
241
      <varlistentry>
 
242
        <term>
 
243
          RFC 4291: <citetitle>IP Version 6 Addressing
 
244
          Architecture</citetitle>
 
245
        </term>
 
246
        <listitem>
 
247
          <variablelist>
 
248
            <varlistentry>
 
249
              <term>Section 2.2: <citetitle>Text Representation of
 
250
              Addresses</citetitle></term>
 
251
              <listitem><para/></listitem>
 
252
            </varlistentry>
 
253
            <varlistentry>
 
254
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
255
              Address</citetitle></term>
 
256
              <listitem><para/></listitem>
 
257
            </varlistentry>
 
258
            <varlistentry>
 
259
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
260
            Addresses</citetitle></term>
 
261
            <listitem>
 
262
              <para>
 
263
                The clients use IPv6 link-local addresses, which are
 
264
                immediately usable since a link-local addresses is
 
265
                automatically assigned to a network interface when it
 
266
                is brought up.
 
267
              </para>
 
268
            </listitem>
 
269
            </varlistentry>
 
270
          </variablelist>
 
271
        </listitem>
 
272
      </varlistentry>
 
273
      <varlistentry>
 
274
        <term>
 
275
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
276
        </term>
 
277
        <listitem>
 
278
          <para>
 
279
            Zeroconf is the network protocol standard used by clients
 
280
            for finding the Mandos server on the local network.
 
281
          </para>
 
282
        </listitem>
 
283
      </varlistentry>
 
284
    </variablelist>
 
285
  </refsect1>
 
286
</refentry>
 
287
<!-- Local Variables: -->
 
288
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
289
<!-- time-stamp-end: "[\"']>" -->
 
290
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
291
<!-- End: -->