/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-08-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2012-01-01">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
21
18
        <surname>Påhlsson</surname>
22
19
        <address>
23
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
24
21
        </address>
25
22
      </author>
26
23
      <author>
27
24
        <firstname>Teddy</firstname>
28
25
        <surname>Hogeborn</surname>
29
26
        <address>
30
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
31
28
        </address>
32
29
      </author>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
33
      <holder>Teddy Hogeborn</holder>
40
34
      <holder>Björn Påhlsson</holder>
41
35
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
43
59
  </refentryinfo>
44
 
  
 
60
 
45
61
  <refmeta>
46
62
    <refentrytitle>&CONFNAME;</refentrytitle>
47
63
    <manvolnum>5</manvolnum>
53
69
      Configuration file for the Mandos server
54
70
    </refpurpose>
55
71
  </refnamediv>
56
 
  
 
72
 
57
73
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
59
77
  </refsynopsisdiv>
60
 
  
 
78
 
61
79
  <refsect1 id="description">
62
80
    <title>DESCRIPTION</title>
63
81
    <para>
75
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
76
94
      to provide comments.
77
95
    </para>
78
 
    
 
96
 
79
97
  </refsect1>
80
98
  <refsect1>
81
99
    <title>OPTIONS</title>
82
100
    
83
101
    <variablelist>
84
102
      <varlistentry>
85
 
        <term><option>interface<literal> = </literal><replaceable
86
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
87
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
88
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
89
109
        </listitem>
90
110
      </varlistentry>
91
 
      
 
111
 
92
112
      <varlistentry>
93
 
        <term><option>address<literal> = </literal><replaceable
94
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
95
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
96
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
97
119
        </listitem>
98
120
      </varlistentry>
99
 
      
 
121
 
100
122
      <varlistentry>
101
 
        <term><option>port<literal> = </literal><replaceable
102
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
103
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
104
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
105
129
        </listitem>
106
130
      </varlistentry>
107
 
      
 
131
 
108
132
      <varlistentry>
109
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
110
136
          >1</literal> | <literal>yes</literal> | <literal
111
137
          >true</literal> | <literal>on</literal> | <literal
112
138
          >0</literal> | <literal>no</literal> | <literal
113
 
          >false</literal> | <literal>off</literal> }</option></term>
114
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
115
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
116
142
        </listitem>
117
143
      </varlistentry>
118
 
      
 
144
 
119
145
      <varlistentry>
120
 
        <term><option>priority<literal> = </literal><replaceable
121
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
122
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
123
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
124
152
        </listitem>
125
153
      </varlistentry>
126
 
      
 
154
 
127
155
      <varlistentry>
128
 
        <term><option>servicename<literal> = </literal
129
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
130
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
131
161
          <xi:include href="mandos-options.xml"
132
162
                      xpointer="servicename"/>
133
163
        </listitem>
134
164
      </varlistentry>
135
165
      
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
166
    </variablelist>
178
167
  </refsect1>
179
168
  
189
178
    <para>
190
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
191
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
192
 
      requires it.
 
181
      requres it.
193
182
    </para>
194
183
  </refsect1>
195
184
  
211
200
[DEFAULT]
212
201
# A configuration example
213
202
interface = eth0
214
 
address = fe80::aede:48ff:fe71:f6f2
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
215
204
port = 1025
216
205
debug = true
217
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
218
207
servicename = Daena
219
 
use_dbus = False
220
 
use_ipv6 = True
221
 
restore = True
222
 
statedir = /var/lib/mandos
223
208
      </programlisting>
224
209
    </informalexample>
225
210
  </refsect1>
227
212
  <refsect1 id="see_also">
228
213
    <title>SEE ALSO</title>
229
214
    <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>
 
215
      <citerefentry>
 
216
        <refentrytitle>mandos</refentrytitle>
 
217
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
218
        <refentrytitle>mandos-clients.conf</refentrytitle>
 
219
        <manvolnum>5</manvolnum></citerefentry>
238
220
    </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
221
  </refsect1>
286
222
</refentry>
287
 
<!-- Local Variables: -->
288
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
289
 
<!-- time-stamp-end: "[\"']>" -->
290
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
291
 
<!-- End: -->