1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY CONFNAME "mandos.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
<!ENTITY TIMESTAMP "2012-01-01">
7
<!ENTITY % common SYSTEM "common.ent">
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
<title>Mandos Manual</title>
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
20
<firstname>Björn</firstname>
21
<surname>Påhlsson</surname>
23
<email>belorn@recompile.se</email>
27
<firstname>Teddy</firstname>
28
<surname>Hogeborn</surname>
30
<email>teddy@recompile.se</email>
39
<holder>Teddy Hogeborn</holder>
40
<holder>Björn Påhlsson</holder>
42
<xi:include href="legalnotice.xml"/>
46
<refentrytitle>&CONFNAME;</refentrytitle>
47
<manvolnum>5</manvolnum>
51
<refname><filename>&CONFNAME;</filename></refname>
53
Configuration file for the Mandos server
58
<synopsis>&CONFPATH;</synopsis>
61
<refsect1 id="description">
62
<title>DESCRIPTION</title>
64
The file &CONFPATH; is a simple configuration file for
65
<citerefentry><refentrytitle>mandos</refentrytitle>
66
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
67
startup. The configuration file starts with <quote><literal
68
>[DEFAULT]</literal></quote> on a line by itself, followed by
69
any number of <quote><varname><replaceable>option</replaceable
70
></varname>=<replaceable>value</replaceable></quote> entries,
71
with continuations in the style of RFC 822. <quote><varname
72
><replaceable>option</replaceable></varname>: <replaceable
73
>value</replaceable></quote> is also accepted. Note that
74
leading whitespace is removed from values. Lines beginning with
75
<quote>#</quote> or <quote>;</quote> are ignored and may be used
81
<title>OPTIONS</title>
85
<term><option>interface<literal> = </literal><replaceable
86
>NAME</replaceable></option></term>
88
<xi:include href="mandos-options.xml" xpointer="interface"/>
93
<term><option>address<literal> = </literal><replaceable
94
>ADDRESS</replaceable></option></term>
96
<xi:include href="mandos-options.xml" xpointer="address"/>
101
<term><option>port<literal> = </literal><replaceable
102
>NUMBER</replaceable></option></term>
104
<xi:include href="mandos-options.xml" xpointer="port"/>
109
<term><option>debug<literal> = </literal>{ <literal
110
>1</literal> | <literal>yes</literal> | <literal
111
>true</literal> | <literal>on</literal> | <literal
112
>0</literal> | <literal>no</literal> | <literal
113
>false</literal> | <literal>off</literal> }</option></term>
115
<xi:include href="mandos-options.xml" xpointer="debug"/>
120
<term><option>priority<literal> = </literal><replaceable
121
>STRING</replaceable></option></term>
123
<xi:include href="mandos-options.xml" xpointer="priority"/>
128
<term><option>servicename<literal> = </literal
129
><replaceable>NAME</replaceable></option></term>
131
<xi:include href="mandos-options.xml"
132
xpointer="servicename"/>
137
<term><option>use_dbus<literal> = </literal>{ <literal
138
>1</literal> | <literal>yes</literal> | <literal
139
>true</literal> | <literal>on</literal> | <literal
140
>0</literal> | <literal>no</literal> | <literal
141
>false</literal> | <literal>off</literal> }</option></term>
143
<xi:include href="mandos-options.xml" xpointer="dbus"/>
148
<term><option>use_ipv6<literal> = </literal>{ <literal
149
>1</literal> | <literal>yes</literal> | <literal
150
>true</literal> | <literal>on</literal> | <literal
151
>0</literal> | <literal>no</literal> | <literal
152
>false</literal> | <literal>off</literal> }</option></term>
154
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
159
<term><option>restore<literal> = </literal>{ <literal
160
>1</literal> | <literal>yes</literal> | <literal
161
>true</literal> | <literal>on</literal> | <literal
162
>0</literal> | <literal>no</literal> | <literal
163
>false</literal> | <literal>off</literal> }</option></term>
165
<xi:include href="mandos-options.xml" xpointer="restore"/>
170
<term><option>statedir<literal> = </literal><replaceable
171
>DIRECTORY</replaceable></option></term>
173
<xi:include href="mandos-options.xml" xpointer="statedir"/>
180
<refsect1 id="files">
183
The file described here is &CONFPATH;
190
The <literal>[DEFAULT]</literal> is necessary because the Python
191
built-in module <systemitem class="library">ConfigParser</systemitem>
196
<refsect1 id="example">
197
<title>EXAMPLE</title>
200
No options are actually required:
208
An example using all the options:
212
# A configuration example
214
address = fe80::aede:48ff:fe71:f6f2
217
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
222
statedir = /var/lib/mandos
227
<refsect1 id="see_also">
228
<title>SEE ALSO</title>
230
<citerefentry><refentrytitle>intro</refentrytitle>
231
<manvolnum>8mandos</manvolnum></citerefentry>,
232
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
233
><manvolnum>3</manvolnum></citerefentry>,
234
<citerefentry><refentrytitle>mandos</refentrytitle>
235
<manvolnum>8</manvolnum></citerefentry>,
236
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
237
<manvolnum>5</manvolnum></citerefentry>
243
RFC 4291: <citetitle>IP Version 6 Addressing
244
Architecture</citetitle>
249
<term>Section 2.2: <citetitle>Text Representation of
250
Addresses</citetitle></term>
251
<listitem><para/></listitem>
254
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
255
Address</citetitle></term>
256
<listitem><para/></listitem>
259
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
260
Addresses</citetitle></term>
263
The clients use IPv6 link-local addresses, which are
264
immediately usable since a link-local addresses is
265
automatically assigned to a network interface when it
275
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
279
Zeroconf is the network protocol standard used by clients
280
for finding the Mandos server on the local network.
287
<!-- Local Variables: -->
288
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
289
<!-- time-stamp-end: "[\"']>" -->
290
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
