/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-24 07:42:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824074214-odju7g3115le171c
* mandos-keygen: Bug fix: Recognize new options --subtype and
                 --sublength.  New option "--password" which prompts
                 for and encrypts a password with an already existing
                 key.

* mandos-keygen.xml (SYNOPSIS): Added separate synopsis for
                                "--password" option.
  (DESCRIPTION): Added text about password creation.
  (OPTIONS): Document default value for "--dir" option.  Document new
             "--password" option.

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