/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: Björn Påhlsson
  • Date: 2008-09-03 21:18:05 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 153.
  • Revision ID: belorn@braxen-20080903211805-2evlp1ooipx0rr8f
added some comments about security

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