/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: 2016-02-21 13:00:15 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160221130015-b32z5wnkw9swjg2s
mandos: Remove unused import and an errant space character.

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">
5
4
<!ENTITY CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2015-07-20">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
35
43
      <holder>Teddy Hogeborn</holder>
36
44
      <holder>Björn Påhlsson</holder>
37
45
    </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>
 
46
    <xi:include href="legalnotice.xml"/>
61
47
  </refentryinfo>
62
 
 
 
48
  
63
49
  <refmeta>
64
50
    <refentrytitle>&CONFNAME;</refentrytitle>
65
51
    <manvolnum>5</manvolnum>
71
57
      Configuration file for the Mandos server
72
58
    </refpurpose>
73
59
  </refnamediv>
74
 
 
 
60
  
75
61
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
62
    <synopsis>&CONFPATH;</synopsis>
79
63
  </refsynopsisdiv>
80
 
 
 
64
  
81
65
  <refsect1 id="description">
82
66
    <title>DESCRIPTION</title>
83
67
    <para>
95
79
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
96
80
      to provide comments.
97
81
    </para>
98
 
 
 
82
    
99
83
  </refsect1>
100
84
  <refsect1>
101
85
    <title>OPTIONS</title>
102
86
    
103
87
    <variablelist>
104
88
      <varlistentry>
105
 
        <term><varname>interface</varname></term>
 
89
        <term><option>interface<literal> = </literal><replaceable
 
90
        >NAME</replaceable></option></term>
106
91
        <listitem>
107
 
          <synopsis><literal>interface = </literal><replaceable
108
 
          >NAME</replaceable>
109
 
          </synopsis>
110
92
          <xi:include href="mandos-options.xml" xpointer="interface"/>
111
93
        </listitem>
112
94
      </varlistentry>
113
 
 
 
95
      
114
96
      <varlistentry>
115
 
        <term><varname>address</varname></term>
 
97
        <term><option>address<literal> = </literal><replaceable
 
98
          >ADDRESS</replaceable></option></term>
116
99
        <listitem>
117
 
          <synopsis><literal>address = </literal><replaceable
118
 
          >ADDRESS</replaceable>
119
 
          </synopsis>
120
100
          <xi:include href="mandos-options.xml" xpointer="address"/>
121
101
        </listitem>
122
102
      </varlistentry>
123
 
 
 
103
      
124
104
      <varlistentry>
125
 
        <term><varname>port</varname></term>
 
105
        <term><option>port<literal> = </literal><replaceable
 
106
        >NUMBER</replaceable></option></term>
126
107
        <listitem>
127
 
          <synopsis><literal>port = </literal><replaceable
128
 
          >NUMBER</replaceable>
129
 
          </synopsis>
130
108
          <xi:include href="mandos-options.xml" xpointer="port"/>
131
109
        </listitem>
132
110
      </varlistentry>
133
 
 
 
111
      
134
112
      <varlistentry>
135
 
        <term><varname>debug</varname></term>
136
 
        <listitem>
137
 
          <synopsis><literal>debug = </literal>{ <literal
 
113
        <term><option>debug<literal> = </literal>{ <literal
138
114
          >1</literal> | <literal>yes</literal> | <literal
139
115
          >true</literal> | <literal>on</literal> | <literal
140
116
          >0</literal> | <literal>no</literal> | <literal
141
 
          >false</literal> | <literal>off</literal> }
142
 
          </synopsis>
 
117
          >false</literal> | <literal>off</literal> }</option></term>
 
118
        <listitem>
143
119
          <xi:include href="mandos-options.xml" xpointer="debug"/>
144
120
        </listitem>
145
121
      </varlistentry>
146
 
 
 
122
      
147
123
      <varlistentry>
148
 
        <term><varname>priority</varname></term>
 
124
        <term><option>priority<literal> = </literal><replaceable
 
125
        >STRING</replaceable></option></term>
149
126
        <listitem>
150
 
          <synopsis><literal>priority = </literal><replaceable
151
 
          >STRING</replaceable>
152
 
          </synopsis>
153
127
          <xi:include href="mandos-options.xml" xpointer="priority"/>
154
128
        </listitem>
155
129
      </varlistentry>
156
 
 
 
130
      
157
131
      <varlistentry>
158
 
        <term><varname>servicename</varname></term>
 
132
        <term><option>servicename<literal> = </literal
 
133
        ><replaceable>NAME</replaceable></option></term>
159
134
        <listitem>
160
 
          <synopsis><literal>servicename = </literal><replaceable
161
 
          >NAME</replaceable>
162
 
          </synopsis>
163
135
          <xi:include href="mandos-options.xml"
164
136
                      xpointer="servicename"/>
165
137
        </listitem>
166
138
      </varlistentry>
167
139
      
 
140
      <varlistentry>
 
141
        <term><option>use_dbus<literal> = </literal>{ <literal
 
142
          >1</literal> | <literal>yes</literal> | <literal
 
143
          >true</literal> | <literal>on</literal> | <literal
 
144
          >0</literal> | <literal>no</literal> | <literal
 
145
          >false</literal> | <literal>off</literal> }</option></term>
 
146
        <listitem>
 
147
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
148
        </listitem>
 
149
      </varlistentry>
 
150
      
 
151
      <varlistentry>
 
152
        <term><option>use_ipv6<literal> = </literal>{ <literal
 
153
          >1</literal> | <literal>yes</literal> | <literal
 
154
          >true</literal> | <literal>on</literal> | <literal
 
155
          >0</literal> | <literal>no</literal> | <literal
 
156
          >false</literal> | <literal>off</literal> }</option></term>
 
157
        <listitem>
 
158
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
159
        </listitem>
 
160
      </varlistentry>
 
161
      
 
162
      <varlistentry>
 
163
        <term><option>restore<literal> = </literal>{ <literal
 
164
          >1</literal> | <literal>yes</literal> | <literal
 
165
          >true</literal> | <literal>on</literal> | <literal
 
166
          >0</literal> | <literal>no</literal> | <literal
 
167
          >false</literal> | <literal>off</literal> }</option></term>
 
168
        <listitem>
 
169
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
170
        </listitem>
 
171
      </varlistentry>
 
172
      
 
173
      <varlistentry>
 
174
        <term><option>statedir<literal> = </literal><replaceable
 
175
        >DIRECTORY</replaceable></option></term>
 
176
        <listitem>
 
177
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
178
        </listitem>
 
179
      </varlistentry>
 
180
      
 
181
      <varlistentry>
 
182
        <term><option>socket<literal> = </literal><replaceable
 
183
        >NUMBER</replaceable></option></term>
 
184
        <listitem>
 
185
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
186
        </listitem>
 
187
      </varlistentry>
 
188
      
168
189
    </variablelist>
169
190
  </refsect1>
170
191
  
180
201
    <para>
181
202
      The <literal>[DEFAULT]</literal> is necessary because the Python
182
203
      built-in module <systemitem class="library">ConfigParser</systemitem>
183
 
      requres it.
 
204
      requires it.
184
205
    </para>
185
206
  </refsect1>
186
207
  
202
223
[DEFAULT]
203
224
# A configuration example
204
225
interface = eth0
205
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
226
address = fe80::aede:48ff:fe71:f6f2
206
227
port = 1025
207
 
debug = true
208
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
228
debug = True
 
229
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
209
230
servicename = Daena
 
231
use_dbus = False
 
232
use_ipv6 = True
 
233
restore = True
 
234
statedir = /var/lib/mandos
210
235
      </programlisting>
211
236
    </informalexample>
212
237
  </refsect1>
214
239
  <refsect1 id="see_also">
215
240
    <title>SEE ALSO</title>
216
241
    <para>
 
242
      <citerefentry><refentrytitle>intro</refentrytitle>
 
243
      <manvolnum>8mandos</manvolnum></citerefentry>,
217
244
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
218
245
      ><manvolnum>3</manvolnum></citerefentry>,
219
246
      <citerefentry><refentrytitle>mandos</refentrytitle>
221
248
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
222
249
      <manvolnum>5</manvolnum></citerefentry>
223
250
    </para>
224
 
 
 
251
    
225
252
    <variablelist>
226
253
      <varlistentry>
227
254
        <term>
247
274
              <para>
248
275
                The clients use IPv6 link-local addresses, which are
249
276
                immediately usable since a link-local addresses is
250
 
                automatically assigned to a network interfaces when it
 
277
                automatically assigned to a network interface when it
251
278
                is brought up.
252
279
              </para>
253
280
            </listitem>