/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: 2017-08-20 13:50:57 UTC
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
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-09-04">
 
6
<!ENTITY TIMESTAMP "2017-02-23">
 
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>
 
43
      <year>2016</year>
 
44
      <year>2017</year>
35
45
      <holder>Teddy Hogeborn</holder>
36
46
      <holder>Björn Påhlsson</holder>
37
47
    </copyright>
38
48
    <xi:include href="legalnotice.xml"/>
39
49
  </refentryinfo>
40
 
 
 
50
  
41
51
  <refmeta>
42
52
    <refentrytitle>&CONFNAME;</refentrytitle>
43
53
    <manvolnum>5</manvolnum>
49
59
      Configuration file for the Mandos server
50
60
    </refpurpose>
51
61
  </refnamediv>
52
 
 
 
62
  
53
63
  <refsynopsisdiv>
54
64
    <synopsis>&CONFPATH;</synopsis>
55
65
  </refsynopsisdiv>
56
 
 
 
66
  
57
67
  <refsect1 id="description">
58
68
    <title>DESCRIPTION</title>
59
69
    <para>
71
81
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
82
      to provide comments.
73
83
    </para>
74
 
 
 
84
    
75
85
  </refsect1>
76
86
  <refsect1>
77
87
    <title>OPTIONS</title>
84
94
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
95
        </listitem>
86
96
      </varlistentry>
87
 
 
 
97
      
88
98
      <varlistentry>
89
99
        <term><option>address<literal> = </literal><replaceable
90
100
          >ADDRESS</replaceable></option></term>
92
102
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
103
        </listitem>
94
104
      </varlistentry>
95
 
 
 
105
      
96
106
      <varlistentry>
97
107
        <term><option>port<literal> = </literal><replaceable
98
108
        >NUMBER</replaceable></option></term>
100
110
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
111
        </listitem>
102
112
      </varlistentry>
103
 
 
 
113
      
104
114
      <varlistentry>
105
115
        <term><option>debug<literal> = </literal>{ <literal
106
116
          >1</literal> | <literal>yes</literal> | <literal
111
121
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
122
        </listitem>
113
123
      </varlistentry>
114
 
 
 
124
      
115
125
      <varlistentry>
116
126
        <term><option>priority<literal> = </literal><replaceable
117
127
        >STRING</replaceable></option></term>
119
129
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
130
        </listitem>
121
131
      </varlistentry>
122
 
 
 
132
      
123
133
      <varlistentry>
124
134
        <term><option>servicename<literal> = </literal
125
135
        ><replaceable>NAME</replaceable></option></term>
129
139
        </listitem>
130
140
      </varlistentry>
131
141
      
 
142
      <varlistentry>
 
143
        <term><option>use_dbus<literal> = </literal>{ <literal
 
144
          >1</literal> | <literal>yes</literal> | <literal
 
145
          >true</literal> | <literal>on</literal> | <literal
 
146
          >0</literal> | <literal>no</literal> | <literal
 
147
          >false</literal> | <literal>off</literal> }</option></term>
 
148
        <listitem>
 
149
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
      
 
153
      <varlistentry>
 
154
        <term><option>use_ipv6<literal> = </literal>{ <literal
 
155
          >1</literal> | <literal>yes</literal> | <literal
 
156
          >true</literal> | <literal>on</literal> | <literal
 
157
          >0</literal> | <literal>no</literal> | <literal
 
158
          >false</literal> | <literal>off</literal> }</option></term>
 
159
        <listitem>
 
160
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
 
161
        </listitem>
 
162
      </varlistentry>
 
163
      
 
164
      <varlistentry>
 
165
        <term><option>restore<literal> = </literal>{ <literal
 
166
          >1</literal> | <literal>yes</literal> | <literal
 
167
          >true</literal> | <literal>on</literal> | <literal
 
168
          >0</literal> | <literal>no</literal> | <literal
 
169
          >false</literal> | <literal>off</literal> }</option></term>
 
170
        <listitem>
 
171
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
172
        </listitem>
 
173
      </varlistentry>
 
174
      
 
175
      <varlistentry>
 
176
        <term><option>statedir<literal> = </literal><replaceable
 
177
        >DIRECTORY</replaceable></option></term>
 
178
        <listitem>
 
179
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
 
180
        </listitem>
 
181
      </varlistentry>
 
182
      
 
183
      <varlistentry>
 
184
        <term><option>socket<literal> = </literal><replaceable
 
185
        >NUMBER</replaceable></option></term>
 
186
        <listitem>
 
187
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
188
        </listitem>
 
189
      </varlistentry>
 
190
      
132
191
    </variablelist>
133
192
  </refsect1>
134
193
  
146
205
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
206
      requires it.
148
207
    </para>
 
208
    <xi:include href="bugs.xml"/>
149
209
  </refsect1>
150
210
  
151
211
  <refsect1 id="example">
166
226
[DEFAULT]
167
227
# A configuration example
168
228
interface = eth0
169
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
229
address = fe80::aede:48ff:fe71:f6f2
170
230
port = 1025
171
 
debug = true
172
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
231
debug = True
 
232
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
173
233
servicename = Daena
 
234
use_dbus = False
 
235
use_ipv6 = True
 
236
restore = True
 
237
statedir = /var/lib/mandos
174
238
      </programlisting>
175
239
    </informalexample>
176
240
  </refsect1>
178
242
  <refsect1 id="see_also">
179
243
    <title>SEE ALSO</title>
180
244
    <para>
 
245
      <citerefentry><refentrytitle>intro</refentrytitle>
 
246
      <manvolnum>8mandos</manvolnum></citerefentry>,
181
247
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
248
      ><manvolnum>3</manvolnum></citerefentry>,
183
249
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
251
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
252
      <manvolnum>5</manvolnum></citerefentry>
187
253
    </para>
188
 
 
 
254
    
189
255
    <variablelist>
190
256
      <varlistentry>
191
257
        <term>
211
277
              <para>
212
278
                The clients use IPv6 link-local addresses, which are
213
279
                immediately usable since a link-local addresses is
214
 
                automatically assigned to a network interfaces when it
 
280
                automatically assigned to a network interface when it
215
281
                is brought up.
216
282
              </para>
217
283
            </listitem>