/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: Teddy Hogeborn
  • Date: 2018-08-15 09:26:02 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 368.
  • Revision ID: teddy@recompile.se-20180815092602-xoyb5s6gf8376i7u
http://bugs.debian.org/894495
mandos-client: Set system clock if necessary

* plugins.d/mandos-client.c (init_gpgme/import_key): If the system
  clock is not set, or set to january 1970, set the system clock to
  the more plausible value that is the mtime of the key file.  This is
  required by GnuPG to be able to import the keys.  (We can't pass the
  --ignore-time-conflict or the --ignore-valid-from options though
  GPGME.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
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
 
<!ENTITY VERSION "1.0">
7
4
<!ENTITY CONFNAME "mandos.conf">
8
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
9
9
]>
10
10
 
11
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
12
  <refentryinfo>
13
 
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>&CONFNAME;</productname>
16
 
    <productnumber>&VERSION;</productnumber>
 
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>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
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
      <holder>Teddy Hogeborn</holder>
 
47
      <holder>Björn Påhlsson</holder>
36
48
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
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
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
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
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
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/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
49
    <xi:include href="legalnotice.xml"/>
60
50
  </refentryinfo>
61
 
 
 
51
  
62
52
  <refmeta>
63
53
    <refentrytitle>&CONFNAME;</refentrytitle>
64
54
    <manvolnum>5</manvolnum>
67
57
  <refnamediv>
68
58
    <refname><filename>&CONFNAME;</filename></refname>
69
59
    <refpurpose>
70
 
      Configuration file for Mandos
 
60
      Configuration file for the Mandos server
71
61
    </refpurpose>
72
62
  </refnamediv>
73
 
 
 
63
  
74
64
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
65
    <synopsis>&CONFPATH;</synopsis>
78
66
  </refsynopsisdiv>
79
 
 
 
67
  
80
68
  <refsect1 id="description">
81
69
    <title>DESCRIPTION</title>
82
70
    <para>
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.
87
 
    </para>
88
 
 
89
 
    <para>
90
 
      The paramters are:
91
 
    </para>
92
 
 
 
71
      The file &CONFPATH; is a simple configuration file for
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
73
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
 
74
      startup.  The configuration file starts with <quote><literal
 
75
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
76
      any number of <quote><varname><replaceable>option</replaceable
 
77
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
78
      with continuations in the style of RFC 822.  <quote><varname
 
79
      ><replaceable>option</replaceable></varname>: <replaceable
 
80
      >value</replaceable></quote> is also accepted.  Note that
 
81
      leading whitespace is removed from values.  Lines beginning with
 
82
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
83
      to provide comments.
 
84
    </para>
 
85
    
 
86
  </refsect1>
 
87
  <refsect1>
 
88
    <title>OPTIONS</title>
 
89
    
93
90
    <variablelist>
94
91
      <varlistentry>
95
 
        <term><literal>interface</literal></term>
96
 
        <listitem>
97
 
          <para>
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
101
 
            behaviour.
102
 
          </para>
103
 
        </listitem>
104
 
      </varlistentry>
105
 
 
106
 
      <varlistentry>
107
 
        <term><literal>address</literal></term>
108
 
        <listitem>
109
 
          <para>
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
113
 
            behaviour.
114
 
          </para>
115
 
        </listitem>
116
 
      </varlistentry>      
117
 
 
118
 
      <varlistentry>
119
 
        <term><literal>port</literal></term>
120
 
        <listitem>
121
 
          <para>
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.
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>
129
 
 
130
 
      <varlistentry>
131
 
        <term><literal>debug</literal></term>
132
 
        <listitem>
133
 
          <para>
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>.
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>      
139
 
 
140
 
      <varlistentry>
141
 
        <term><literal>priority</literal></term>
142
 
        <listitem>
143
 
          <para>
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.
149
 
          </para>         
150
 
        </listitem>
151
 
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal>servicename</literal></term>
155
 
        <listitem>
156
 
          <para>
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".
160
 
          </para>
 
92
        <term><option>interface<literal> = </literal><replaceable
 
93
        >NAME</replaceable></option></term>
 
94
        <listitem>
 
95
          <xi:include href="mandos-options.xml" xpointer="interface"/>
 
96
        </listitem>
 
97
      </varlistentry>
 
98
      
 
99
      <varlistentry>
 
100
        <term><option>address<literal> = </literal><replaceable
 
101
          >ADDRESS</replaceable></option></term>
 
102
        <listitem>
 
103
          <xi:include href="mandos-options.xml" xpointer="address"/>
 
104
        </listitem>
 
105
      </varlistentry>
 
106
      
 
107
      <varlistentry>
 
108
        <term><option>port<literal> = </literal><replaceable
 
109
        >NUMBER</replaceable></option></term>
 
110
        <listitem>
 
111
          <xi:include href="mandos-options.xml" xpointer="port"/>
 
112
        </listitem>
 
113
      </varlistentry>
 
114
      
 
115
      <varlistentry>
 
116
        <term><option>debug<literal> = </literal>{ <literal
 
117
          >1</literal> | <literal>yes</literal> | <literal
 
118
          >true</literal> | <literal>on</literal> | <literal
 
119
          >0</literal> | <literal>no</literal> | <literal
 
120
          >false</literal> | <literal>off</literal> }</option></term>
 
121
        <listitem>
 
122
          <xi:include href="mandos-options.xml" xpointer="debug"/>
 
123
        </listitem>
 
124
      </varlistentry>
 
125
      
 
126
      <varlistentry>
 
127
        <term><option>priority<literal> = </literal><replaceable
 
128
        >STRING</replaceable></option></term>
 
129
        <listitem>
 
130
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
      <varlistentry>
 
135
        <term><option>servicename<literal> = </literal
 
136
        ><replaceable>NAME</replaceable></option></term>
 
137
        <listitem>
 
138
          <xi:include href="mandos-options.xml"
 
139
                      xpointer="servicename"/>
 
140
        </listitem>
 
141
      </varlistentry>
 
142
      
 
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"/>
161
189
        </listitem>
162
190
      </varlistentry>
163
191
      
164
192
    </variablelist>
165
193
  </refsect1>
166
 
 
167
 
  <refsect1 id="examples">
168
 
    <title>EXAMPLES</title>
169
 
    <informalexample>
170
 
      <programlisting>
171
 
        [server]
172
 
        # A configuration example
173
 
        interface = eth0 
174
 
        address = 2001:DB8:
175
 
        port = 1025 
176
 
        debug = true 
177
 
        priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
178
 
        servicename = Mandos
179
 
      </programlisting>
180
 
    </informalexample>
181
 
  </refsect1>  
182
194
  
183
195
  <refsect1 id="files">
184
196
    <title>FILES</title>
186
198
      The file described here is &CONFPATH;
187
199
    </para>
188
200
  </refsect1>
 
201
  
 
202
  <refsect1 id="bugs">
 
203
    <title>BUGS</title>
 
204
    <para>
 
205
      The <literal>[DEFAULT]</literal> is necessary because the Python
 
206
      built-in module <systemitem class="library">ConfigParser</systemitem>
 
207
      requires it.
 
208
    </para>
 
209
    <xi:include href="bugs.xml"/>
 
210
  </refsect1>
 
211
  
 
212
  <refsect1 id="example">
 
213
    <title>EXAMPLE</title>
 
214
    <informalexample>
 
215
      <para>
 
216
        No options are actually required:
 
217
      </para>
 
218
      <programlisting>
 
219
[DEFAULT]
 
220
      </programlisting>
 
221
    </informalexample>
 
222
    <informalexample>
 
223
      <para>
 
224
        An example using all the options:
 
225
      </para>
 
226
      <programlisting>
 
227
[DEFAULT]
 
228
# A configuration example
 
229
interface = eth0
 
230
address = fe80::aede:48ff:fe71:f6f2
 
231
port = 1025
 
232
debug = True
 
233
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
234
servicename = Daena
 
235
use_dbus = False
 
236
use_ipv6 = True
 
237
restore = True
 
238
statedir = /var/lib/mandos
 
239
      </programlisting>
 
240
    </informalexample>
 
241
  </refsect1>
 
242
  
 
243
  <refsect1 id="see_also">
 
244
    <title>SEE ALSO</title>
 
245
    <para>
 
246
      <citerefentry><refentrytitle>intro</refentrytitle>
 
247
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
248
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
249
      ><manvolnum>3</manvolnum></citerefentry>,
 
250
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
251
      <manvolnum>8</manvolnum></citerefentry>,
 
252
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
253
      <manvolnum>5</manvolnum></citerefentry>
 
254
    </para>
 
255
    
 
256
    <variablelist>
 
257
      <varlistentry>
 
258
        <term>
 
259
          RFC 4291: <citetitle>IP Version 6 Addressing
 
260
          Architecture</citetitle>
 
261
        </term>
 
262
        <listitem>
 
263
          <variablelist>
 
264
            <varlistentry>
 
265
              <term>Section 2.2: <citetitle>Text Representation of
 
266
              Addresses</citetitle></term>
 
267
              <listitem><para/></listitem>
 
268
            </varlistentry>
 
269
            <varlistentry>
 
270
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
271
              Address</citetitle></term>
 
272
              <listitem><para/></listitem>
 
273
            </varlistentry>
 
274
            <varlistentry>
 
275
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
276
            Addresses</citetitle></term>
 
277
            <listitem>
 
278
              <para>
 
279
                The clients use IPv6 link-local addresses, which are
 
280
                immediately usable since a link-local addresses is
 
281
                automatically assigned to a network interface when it
 
282
                is brought up.
 
283
              </para>
 
284
            </listitem>
 
285
            </varlistentry>
 
286
          </variablelist>
 
287
        </listitem>
 
288
      </varlistentry>
 
289
      <varlistentry>
 
290
        <term>
 
291
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
292
        </term>
 
293
        <listitem>
 
294
          <para>
 
295
            Zeroconf is the network protocol standard used by clients
 
296
            for finding the Mandos server on the local network.
 
297
          </para>
 
298
        </listitem>
 
299
      </varlistentry>
 
300
    </variablelist>
 
301
  </refsect1>
189
302
</refentry>
 
303
<!-- Local Variables: -->
 
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
305
<!-- time-stamp-end: "[\"']>" -->
 
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
307
<!-- End: -->