/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: 2015-08-10 19:10:26 UTC
  • mfrom: (787 trunk)
  • mto: This revision was merged to the branch mainline in revision 788.
  • Revision ID: teddy@recompile.se-20150810191026-0jss9yy8t6o6pl39
Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-08-31">
 
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
46
    <xi:include href="legalnotice.xml"/>
39
47
  </refentryinfo>
40
 
 
 
48
  
41
49
  <refmeta>
42
50
    <refentrytitle>&CONFNAME;</refentrytitle>
43
51
    <manvolnum>5</manvolnum>
49
57
      Configuration file for the Mandos server
50
58
    </refpurpose>
51
59
  </refnamediv>
52
 
 
 
60
  
53
61
  <refsynopsisdiv>
54
62
    <synopsis>&CONFPATH;</synopsis>
55
63
  </refsynopsisdiv>
56
 
 
 
64
  
57
65
  <refsect1 id="description">
58
66
    <title>DESCRIPTION</title>
59
67
    <para>
71
79
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
80
      to provide comments.
73
81
    </para>
74
 
 
 
82
    
75
83
  </refsect1>
76
84
  <refsect1>
77
85
    <title>OPTIONS</title>
84
92
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
93
        </listitem>
86
94
      </varlistentry>
87
 
 
 
95
      
88
96
      <varlistentry>
89
97
        <term><option>address<literal> = </literal><replaceable
90
98
          >ADDRESS</replaceable></option></term>
92
100
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
101
        </listitem>
94
102
      </varlistentry>
95
 
 
 
103
      
96
104
      <varlistentry>
97
105
        <term><option>port<literal> = </literal><replaceable
98
106
        >NUMBER</replaceable></option></term>
100
108
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
109
        </listitem>
102
110
      </varlistentry>
103
 
 
 
111
      
104
112
      <varlistentry>
105
113
        <term><option>debug<literal> = </literal>{ <literal
106
114
          >1</literal> | <literal>yes</literal> | <literal
111
119
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
120
        </listitem>
113
121
      </varlistentry>
114
 
 
 
122
      
115
123
      <varlistentry>
116
124
        <term><option>priority<literal> = </literal><replaceable
117
125
        >STRING</replaceable></option></term>
119
127
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
128
        </listitem>
121
129
      </varlistentry>
122
 
 
 
130
      
123
131
      <varlistentry>
124
132
        <term><option>servicename<literal> = </literal
125
133
        ><replaceable>NAME</replaceable></option></term>
129
137
        </listitem>
130
138
      </varlistentry>
131
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
      
132
189
    </variablelist>
133
190
  </refsect1>
134
191
  
144
201
    <para>
145
202
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
203
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requres it.
 
204
      requires it.
148
205
    </para>
149
206
  </refsect1>
150
207
  
166
223
[DEFAULT]
167
224
# A configuration example
168
225
interface = eth0
169
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
226
address = fe80::aede:48ff:fe71:f6f2
170
227
port = 1025
171
 
debug = true
172
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
 
228
debug = True
 
229
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
173
230
servicename = Daena
 
231
use_dbus = False
 
232
use_ipv6 = True
 
233
restore = True
 
234
statedir = /var/lib/mandos
174
235
      </programlisting>
175
236
    </informalexample>
176
237
  </refsect1>
178
239
  <refsect1 id="see_also">
179
240
    <title>SEE ALSO</title>
180
241
    <para>
 
242
      <citerefentry><refentrytitle>intro</refentrytitle>
 
243
      <manvolnum>8mandos</manvolnum></citerefentry>,
181
244
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
245
      ><manvolnum>3</manvolnum></citerefentry>,
183
246
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
248
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
249
      <manvolnum>5</manvolnum></citerefentry>
187
250
    </para>
188
 
 
 
251
    
189
252
    <variablelist>
190
253
      <varlistentry>
191
254
        <term>
211
274
              <para>
212
275
                The clients use IPv6 link-local addresses, which are
213
276
                immediately usable since a link-local addresses is
214
 
                automatically assigned to a network interfaces when it
 
277
                automatically assigned to a network interface when it
215
278
                is brought up.
216
279
              </para>
217
280
            </listitem>