1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY CONFNAME "mandos.conf">
8
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
<!ENTITY TIMESTAMP "2008-09-12">
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
<title>&CONFNAME;</title>
14
<!-- NWalsh's docbook scripts use this to generate the footer: -->
15
<productname>&CONFNAME;</productname>
12
<title>Mandos Manual</title>
13
<!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
<productname>Mandos</productname>
16
15
<productnumber>&VERSION;</productnumber>
16
<date>&TIMESTAMP;</date>
19
19
<firstname>Björn</firstname>
35
<holder>Teddy Hogeborn & Björn Påhlsson</holder>
35
<holder>Teddy Hogeborn</holder>
36
<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/"/>.
38
<xi:include href="legalnotice.xml"/>
63
42
<refentrytitle>&CONFNAME;</refentrytitle>
64
43
<manvolnum>5</manvolnum>
68
47
<refname><filename>&CONFNAME;</filename></refname>
70
Configuration file for Mandos
49
Configuration file for the Mandos server
54
<synopsis>&CONFPATH;</synopsis>
80
57
<refsect1 id="description">
81
58
<title>DESCRIPTION</title>
83
The file &CONFPATH; is a simple configuration file for mandos
84
and is looked on at startup of the service. The configuration
85
file must start with <literal>[server]</literal>. The format for
86
the rest is a simple VAR = VALUE pair. Values may not be empty.
60
The file &CONFPATH; is a simple configuration file for
61
<citerefentry><refentrytitle>mandos</refentrytitle>
62
<manvolnum>8</manvolnum></citerefentry>, and is read by it at
63
startup. The configuration file starts with <quote><literal
64
>[DEFAULT]</literal></quote> on a line by itself, followed by
65
any number of <quote><varname><replaceable>option</replaceable
66
></varname>=<replaceable>value</replaceable></quote> entries,
67
with continuations in the style of RFC 822. <quote><varname
68
><replaceable>option</replaceable></varname>: <replaceable
69
>value</replaceable></quote> is also accepted. Note that
70
leading whitespace is removed from values. Lines beginning with
71
<quote>#</quote> or <quote>;</quote> are ignored and may be used
77
<title>OPTIONS</title>
95
<term><literal>interface</literal></term>
98
This option allows you to override the default network
99
interfaces. By default mandos will not bind to any
100
specific interface but instead use default avahi-server
107
<term><literal>address</literal></term>
110
This option allows you to override the default network
111
address. By default mandos will not bind to any
112
specific address but instead use default avahi-server
119
<term><literal>port</literal></term>
122
This option allows you to override the default port to
123
listen on. By default mandos will not specify any specific
124
port and instead use a random port given by the OS from
125
the use of INADDR_ANY.
131
<term><literal>debug</literal></term>
134
This option allows you to modify debug mode with a true/false
135
boolean value. By default is debug set to <literal>false</literal>.
141
<term><literal>priority</literal></term>
144
This option allows you to override the default gnutls
145
priority that will be used in gnutls session. See
146
<citerefentry><refentrytitle>gnutls_priority_init
147
</refentrytitle><manvolnum>3</manvolnum></citerefentry>for
148
more information on gnutls priority strings.
154
<term><literal>servicename</literal></term>
157
This option allows you to override the default Zeroconf
158
service name use to announce mandos as a avahi service. By
159
default mandos will use "Mandos".
81
<term><option>interface<literal> = </literal><replaceable
82
>NAME</replaceable></option></term>
84
<xi:include href="mandos-options.xml" xpointer="interface"/>
89
<term><option>address<literal> = </literal><replaceable
90
>ADDRESS</replaceable></option></term>
92
<xi:include href="mandos-options.xml" xpointer="address"/>
97
<term><option>port<literal> = </literal><replaceable
98
>NUMBER</replaceable></option></term>
100
<xi:include href="mandos-options.xml" xpointer="port"/>
105
<term><option>debug<literal> = </literal>{ <literal
106
>1</literal> | <literal>yes</literal> | <literal
107
>true</literal> | <literal>on</literal> | <literal
108
>0</literal> | <literal>no</literal> | <literal
109
>false</literal> | <literal>off</literal> }</option></term>
111
<xi:include href="mandos-options.xml" xpointer="debug"/>
116
<term><option>priority<literal> = </literal><replaceable
117
>STRING</replaceable></option></term>
119
<xi:include href="mandos-options.xml" xpointer="priority"/>
124
<term><option>servicename<literal> = </literal
125
><replaceable>NAME</replaceable></option></term>
127
<xi:include href="mandos-options.xml"
128
xpointer="servicename"/>
167
<refsect1 id="examples">
168
<title>EXAMPLES</title>
172
# A configuration example
177
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
183
135
<refsect1 id="files">
184
136
<title>FILES</title>
186
138
The file described here is &CONFPATH;
145
The <literal>[DEFAULT]</literal> is necessary because the Python
146
built-in module <systemitem class="library">ConfigParser</systemitem>
151
<refsect1 id="example">
152
<title>EXAMPLE</title>
155
No options are actually required:
163
An example using all the options:
167
# A configuration example
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
178
<refsect1 id="see_also">
179
<title>SEE ALSO</title>
181
<citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
><manvolnum>3</manvolnum></citerefentry>,
183
<citerefentry><refentrytitle>mandos</refentrytitle>
184
<manvolnum>8</manvolnum></citerefentry>,
185
<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
<manvolnum>5</manvolnum></citerefentry>
192
RFC 4291: <citetitle>IP Version 6 Addressing
193
Architecture</citetitle>
198
<term>Section 2.2: <citetitle>Text Representation of
199
Addresses</citetitle></term>
200
<listitem><para/></listitem>
203
<term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
204
Address</citetitle></term>
205
<listitem><para/></listitem>
208
<term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
209
Addresses</citetitle></term>
212
The clients use IPv6 link-local addresses, which are
213
immediately usable since a link-local addresses is
214
automatically assigned to a network interfaces when it
224
<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
228
Zeroconf is the network protocol standard used by clients
229
for finding the Mandos server on the local network.
236
<!-- Local Variables: -->
237
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
238
<!-- time-stamp-end: "[\"']>" -->
239
<!-- time-stamp-format: "%:y-%02m-%02d" -->
added
removed
mandos.conf.xml
