1
<?xml version='1.0' encoding='UTF-8'?>
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 OVERVIEW SYSTEM "overview.xml">
6
<!ENTITY TIMESTAMP "2015-07-20">
7
<!ENTITY % common SYSTEM "common.ent">
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
<title>&CONFNAME;</title>
13
<title>Mandos Manual</title>
13
14
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>&CONFNAME;</productname>
15
<productnumber>&VERSION;</productnumber>
15
<productname>Mandos</productname>
16
<productnumber>&version;</productnumber>
17
<date>&TIMESTAMP;</date>
18
20
<firstname>Björn</firstname>
19
21
<surname>Påhlsson</surname>
21
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
25
27
<firstname>Teddy</firstname>
26
28
<surname>Hogeborn</surname>
28
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
34
40
<holder>Teddy Hogeborn</holder>
35
41
<holder>Björn Påhlsson</holder>
39
This manual page is free software: you can redistribute it
40
and/or modify it under the terms of the GNU General Public
41
License as published by the Free Software Foundation,
42
either version 3 of the License, or (at your option) any
47
This manual page is distributed in the hope that it will
48
be useful, but WITHOUT ANY WARRANTY; without even the
49
implied warranty of MERCHANTABILITY or FITNESS FOR A
50
PARTICULAR PURPOSE. See the GNU General Public License
55
You should have received a copy of the GNU General Public
56
License along with this program; If not, see
57
<ulink url="http://www.gnu.org/licenses/"/>.
43
<xi:include href="legalnotice.xml"/>
63
47
<refentrytitle>&CONFNAME;</refentrytitle>
64
48
<manvolnum>5</manvolnum>
70
54
Configuration file for the Mandos server
59
<synopsis>&CONFPATH;</synopsis>
80
62
<refsect1 id="description">
81
63
<title>DESCRIPTION</title>
83
65
The file &CONFPATH; is a simple configuration file for
84
66
<citerefentry><refentrytitle>mandos</refentrytitle>
85
67
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
startup. The configuration file starts with
87
<quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
followed by any number of
89
<quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
entries, with continuations in the style of RFC 822.
91
<quote><varname><replaceable>option</replaceable></varname>:
92
<replaceable>value</replaceable></quote> is also accepted. Note
93
that leading whitespace is removed from values. Lines beginning
94
with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
used to provide comments.
68
startup. The configuration file starts with <quote><literal
69
>[DEFAULT]</literal></quote> on a line by itself, followed by
70
any number of <quote><varname><replaceable>option</replaceable
71
></varname>=<replaceable>value</replaceable></quote> entries,
72
with continuations in the style of RFC 822. <quote><varname
73
><replaceable>option</replaceable></varname>: <replaceable
74
>value</replaceable></quote> is also accepted. Note that
75
leading whitespace is removed from values. Lines beginning with
76
<quote>#</quote> or <quote>;</quote> are ignored and may be used
100
82
<title>OPTIONS</title>
104
<term><varname>interface</varname></term>
86
<term><option>interface<literal> = </literal><replaceable
87
>NAME</replaceable></option></term>
106
<synopsis><literal>interface = </literal><replaceable
109
89
<xi:include href="mandos-options.xml" xpointer="interface"/>
114
<term><varname>address</varname></term>
94
<term><option>address<literal> = </literal><replaceable
95
>ADDRESS</replaceable></option></term>
116
<synopsis><literal>address = </literal><replaceable
117
>ADDRESS</replaceable>
119
97
<xi:include href="mandos-options.xml" xpointer="address"/>
124
<term><varname>port</varname></term>
102
<term><option>port<literal> = </literal><replaceable
103
>NUMBER</replaceable></option></term>
126
<synopsis><literal>port = </literal><replaceable
129
105
<xi:include href="mandos-options.xml" xpointer="port"/>
134
<term><varname>debug</varname></term>
136
<synopsis><literal>debug = </literal>{ <literal
110
<term><option>debug<literal> = </literal>{ <literal
137
111
>1</literal> | <literal>yes</literal> | <literal
138
112
>true</literal> | <literal>on</literal> | <literal
139
113
>0</literal> | <literal>no</literal> | <literal
140
>false</literal> | <literal>off</literal> }
114
>false</literal> | <literal>off</literal> }</option></term>
142
116
<xi:include href="mandos-options.xml" xpointer="debug"/>
147
<term><varname>priority</varname></term>
121
<term><option>priority<literal> = </literal><replaceable
122
>STRING</replaceable></option></term>
149
<synopsis><literal>priority = </literal><replaceable
150
>PRIORITY</replaceable>
152
124
<xi:include href="mandos-options.xml" xpointer="priority"/>
157
<term><varname>servicename</varname></term>
129
<term><option>servicename<literal> = </literal
130
><replaceable>NAME</replaceable></option></term>
159
<synopsis><literal>servicename = </literal><replaceable
162
132
<xi:include href="mandos-options.xml"
163
133
xpointer="servicename"/>
138
<term><option>use_dbus<literal> = </literal>{ <literal
139
>1</literal> | <literal>yes</literal> | <literal
140
>true</literal> | <literal>on</literal> | <literal
141
>0</literal> | <literal>no</literal> | <literal
142
>false</literal> | <literal>off</literal> }</option></term>
144
<xi:include href="mandos-options.xml" xpointer="dbus"/>
149
<term><option>use_ipv6<literal> = </literal>{ <literal
150
>1</literal> | <literal>yes</literal> | <literal
151
>true</literal> | <literal>on</literal> | <literal
152
>0</literal> | <literal>no</literal> | <literal
153
>false</literal> | <literal>off</literal> }</option></term>
155
<xi:include href="mandos-options.xml" xpointer="ipv6"/>
160
<term><option>restore<literal> = </literal>{ <literal
161
>1</literal> | <literal>yes</literal> | <literal
162
>true</literal> | <literal>on</literal> | <literal
163
>0</literal> | <literal>no</literal> | <literal
164
>false</literal> | <literal>off</literal> }</option></term>
166
<xi:include href="mandos-options.xml" xpointer="restore"/>
171
<term><option>statedir<literal> = </literal><replaceable
172
>DIRECTORY</replaceable></option></term>
174
<xi:include href="mandos-options.xml" xpointer="statedir"/>
179
<term><option>socket<literal> = </literal><replaceable
180
>NUMBER</replaceable></option></term>
182
<xi:include href="mandos-options.xml" xpointer="socket"/>
202
221
# A configuration example
204
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
223
address = fe80::aede:48ff:fe71:f6f2
207
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
226
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
208
227
servicename = Daena
231
statedir = /var/lib/mandos
209
232
</programlisting>
210
233
</informalexample>
236
<refsect1 id="see_also">
237
<title>SEE ALSO</title>
239
<citerefentry><refentrytitle>intro</refentrytitle>
240
<manvolnum>8mandos</manvolnum></citerefentry>,
241
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
242
><manvolnum>3</manvolnum></citerefentry>,
243
<citerefentry><refentrytitle>mandos</refentrytitle>
244
<manvolnum>8</manvolnum></citerefentry>,
245
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
246
<manvolnum>5</manvolnum></citerefentry>
252
RFC 4291: <citetitle>IP Version 6 Addressing
253
Architecture</citetitle>
258
<term>Section 2.2: <citetitle>Text Representation of
259
Addresses</citetitle></term>
260
<listitem><para/></listitem>
263
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
264
Address</citetitle></term>
265
<listitem><para/></listitem>
268
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
269
Addresses</citetitle></term>
272
The clients use IPv6 link-local addresses, which are
273
immediately usable since a link-local addresses is
274
automatically assigned to a network interface when it
284
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
288
Zeroconf is the network protocol standard used by clients
289
for finding the Mandos server on the local network.
296
<!-- Local Variables: -->
297
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
298
<!-- time-stamp-end: "[\"']>" -->
299
<!-- time-stamp-format: "%:y-%02m-%02d" -->