/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

removed old/unspecified todo's

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