/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-03 03:33:56 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080803033356-6aemgj0g0hoz91ow
* plugins.d/mandosclient.c (pgp_packet_decrypt): Renamed variables.
                                                 On debug, show
                                                 decrypted plaintext
                                                 in hexadecimal.  Free
                                                 the GPGME data
                                                 buffers even on
                                                 errors.

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 VERSION "1.0">
5
 
<!ENTITY CONFNAME "mandos.conf">
6
 
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-29">
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn</holder>
36
 
      <holder>Björn Påhlsson</holder>
37
 
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
61
 
  </refentryinfo>
62
 
 
63
 
  <refmeta>
64
 
    <refentrytitle>&CONFNAME;</refentrytitle>
65
 
    <manvolnum>5</manvolnum>
66
 
  </refmeta>
67
 
  
68
 
  <refnamediv>
69
 
    <refname><filename>&CONFNAME;</filename></refname>
70
 
    <refpurpose>
71
 
      Configuration file for the Mandos server
72
 
    </refpurpose>
73
 
  </refnamediv>
74
 
 
75
 
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
79
 
  </refsynopsisdiv>
80
 
 
81
 
  <refsect1 id="description">
82
 
    <title>DESCRIPTION</title>
83
 
    <para>
84
 
      The file &CONFPATH; is a simple configuration file for
85
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
86
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
87
 
      startup.  The configuration file starts with <quote><literal
88
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
89
 
      any number of <quote><varname><replaceable>option</replaceable
90
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
91
 
      with continuations in the style of RFC 822.  <quote><varname
92
 
      ><replaceable>option</replaceable></varname>: <replaceable
93
 
      >value</replaceable></quote> is also accepted.  Note that
94
 
      leading whitespace is removed from values.  Lines beginning with
95
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
96
 
      to provide comments.
97
 
    </para>
98
 
 
99
 
  </refsect1>
100
 
  <refsect1>
101
 
    <title>OPTIONS</title>
102
 
    
103
 
    <variablelist>
104
 
      <varlistentry>
105
 
        <term><varname>interface</varname></term>
106
 
        <listitem>
107
 
          <synopsis><literal>interface = </literal><replaceable
108
 
          >NAME</replaceable>
109
 
          </synopsis>
110
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
111
 
        </listitem>
112
 
      </varlistentry>
113
 
 
114
 
      <varlistentry>
115
 
        <term><varname>address</varname></term>
116
 
        <listitem>
117
 
          <synopsis><literal>address = </literal><replaceable
118
 
          >ADDRESS</replaceable>
119
 
          </synopsis>
120
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
 
124
 
      <varlistentry>
125
 
        <term><varname>port</varname></term>
126
 
        <listitem>
127
 
          <synopsis><literal>port = </literal><replaceable
128
 
          >NUMBER</replaceable>
129
 
          </synopsis>
130
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
131
 
        </listitem>
132
 
      </varlistentry>
133
 
 
134
 
      <varlistentry>
135
 
        <term><varname>debug</varname></term>
136
 
        <listitem>
137
 
          <synopsis><literal>debug = </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> }
142
 
          </synopsis>
143
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
147
 
      <varlistentry>
148
 
        <term><varname>priority</varname></term>
149
 
        <listitem>
150
 
          <synopsis><literal>priority = </literal><replaceable
151
 
          >STRING</replaceable>
152
 
          </synopsis>
153
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
 
157
 
      <varlistentry>
158
 
        <term><varname>servicename</varname></term>
159
 
        <listitem>
160
 
          <synopsis><literal>servicename = </literal><replaceable
161
 
          >NAME</replaceable>
162
 
          </synopsis>
163
 
          <xi:include href="mandos-options.xml"
164
 
                      xpointer="servicename"/>
165
 
        </listitem>
166
 
      </varlistentry>
167
 
      
168
 
    </variablelist>
169
 
  </refsect1>
170
 
  
171
 
  <refsect1 id="files">
172
 
    <title>FILES</title>
173
 
    <para>
174
 
      The file described here is &CONFPATH;
175
 
    </para>
176
 
  </refsect1>
177
 
  
178
 
  <refsect1 id="bugs">
179
 
    <title>BUGS</title>
180
 
    <para>
181
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
182
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
183
 
      requres it.
184
 
    </para>
185
 
  </refsect1>
186
 
  
187
 
  <refsect1 id="example">
188
 
    <title>EXAMPLE</title>
189
 
    <informalexample>
190
 
      <para>
191
 
        No options are actually required:
192
 
      </para>
193
 
      <programlisting>
194
 
[DEFAULT]
195
 
      </programlisting>
196
 
    </informalexample>
197
 
    <informalexample>
198
 
      <para>
199
 
        An example using all the options:
200
 
      </para>
201
 
      <programlisting>
202
 
[DEFAULT]
203
 
# A configuration example
204
 
interface = eth0
205
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
206
 
port = 1025
207
 
debug = true
208
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
209
 
servicename = Daena
210
 
      </programlisting>
211
 
    </informalexample>
212
 
  </refsect1>
213
 
  
214
 
  <refsect1 id="see_also">
215
 
    <title>SEE ALSO</title>
216
 
    <para>
217
 
      <citerefentry>
218
 
        <refentrytitle>mandos</refentrytitle>
219
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
220
 
        <refentrytitle>mandos-clients.conf</refentrytitle>
221
 
        <manvolnum>5</manvolnum></citerefentry>, <citerefentry>
222
 
        <refentrytitle>gnutls_priority_init</refentrytitle>
223
 
        <manvolnum>3</manvolnum></citerefentry>
224
 
    </para>
225
 
 
226
 
    <variablelist>
227
 
      <varlistentry>
228
 
        <term>
229
 
          RFC 4291: <citetitle>IP Version 6 Addressing
230
 
          Architecture</citetitle>
231
 
        </term>
232
 
        <listitem>
233
 
          <variablelist>
234
 
            <varlistentry>
235
 
              <term>Section 2.2: <citetitle>Text Representation of
236
 
              Addresses</citetitle></term>
237
 
              <listitem><para/></listitem>
238
 
            </varlistentry>
239
 
            <varlistentry>
240
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
241
 
              Address</citetitle></term>
242
 
              <listitem><para/></listitem>
243
 
            </varlistentry>
244
 
            <varlistentry>
245
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
246
 
            Addresses</citetitle></term>
247
 
            <listitem>
248
 
              <para>
249
 
                The clients use IPv6 link-local addresses, which are
250
 
                immediately usable since a link-local addresses is
251
 
                automatically assigned to a network interfaces when it
252
 
                is brought up.
253
 
              </para>
254
 
            </listitem>
255
 
            </varlistentry>
256
 
          </variablelist>
257
 
        </listitem>
258
 
      </varlistentry>
259
 
      <varlistentry>
260
 
        <term>
261
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
262
 
        </term>
263
 
        <listitem>
264
 
          <para>
265
 
            Zeroconf is the network protocol standard used by clients
266
 
            for finding the Mandos server on the local network.
267
 
          </para>
268
 
        </listitem>
269
 
      </varlistentry>
270
 
    </variablelist>
271
 
  </refsect1>
272
 
</refentry>
273
 
<!-- Local Variables: -->
274
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
275
 
<!-- time-stamp-end: "[\"']>" -->
276
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
277
 
<!-- End: -->