/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-12-29 02:44:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081229024454-nbsei556dwy5azr1
* mandos (Client.timeout, Client.interval): Changed from being a
                                            property to be a normal
                                            attribute.
  (Client._timeout, Client._interval): Removed.
  (Client._timeout_milliseconds): Changed from being an attribute to
                                  be a method "timeout_milliseconds".
                                  All users changed.
  (Client._interval_milliseconds): Changed from being an attribute to
                                   be method "interval_milliseconds".
                                   All users changed.
  (Client.__init__): Take additional "use_dbus" keyword argument.
                     Only provide D-Bus interface if "use_dbus" is
                     True.
  (Client.use_dbus): New attribute.
  (Client.dbus_object_path): Changed to only be set if "self.use_dbus"
                             is True.
  (Client.enable, Client.disable, Client.checker_callback,
  Client.bump_timeout, Client.start_checker, Client.stop_checker):
  Only emit D-Bus signals if "self.use_dbus".
  (Client.SetChecker, Client.SetHost, Client.Enable): Bug fix: Emit
                                                      D-Bus signals.
  (Client.SetInterval, Client.SetTimeout): Changed to emit D-Bus
                                           signals.

  (main): Remove deprecated "default" keyword argument to "--check"
          option.  Added new "--no-dbus" option.  Added corresponding
          "use_dbus" server configuration option.  Only provide D-Bus
          interface and emit D-Bus signals if "use_dbus".  Pass
          "use_dbus" on to Client constructor.

* mandos-options.xml ([@id="dbus"]): New option.

* mandos.conf (use_dbus): New option.

* mandos.conf.xml (OPTIONS): New option "use_dbus".
  (EXAMPLE): - '' -

* mandos.xml (SYNOPSIS): New option "--no-dbus".
  (D-BUS INTERFACE): New section.

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