/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

* plugins.d/mandos-client.c (main): Use remove() instead of unlink(),
                                    and use it on everything in the
                                    temporary directory, not just
                                    files.

* plugins.d/mandos-client.xml (DESCRIPTION): Better wording.
  (OPTIONS): For the "--interface" option, document the unsuitability
             of pseudo-interfaces which will not exist in the initrd.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
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 "2009-01-04">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
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>
16
18
    <authorgroup>
17
19
      <author>
18
20
        <firstname>Björn</firstname>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
 
36
      <year>2009</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </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>
 
40
    <xi:include href="legalnotice.xml"/>
60
41
  </refentryinfo>
61
 
 
 
42
  
62
43
  <refmeta>
63
44
    <refentrytitle>&CONFNAME;</refentrytitle>
64
45
    <manvolnum>5</manvolnum>
70
51
      Configuration file for the Mandos server
71
52
    </refpurpose>
72
53
  </refnamediv>
73
 
 
 
54
  
74
55
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
78
57
  </refsynopsisdiv>
79
 
 
 
58
  
80
59
  <refsect1 id="description">
81
60
    <title>DESCRIPTION</title>
82
61
    <para>
83
62
      The file &CONFPATH; is a simple configuration file for
84
63
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
64
      <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.
 
65
      startup.  The configuration file starts with <quote><literal
 
66
      >[DEFAULT]</literal></quote> on a line by itself, followed by
 
67
      any number of <quote><varname><replaceable>option</replaceable
 
68
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
69
      with continuations in the style of RFC 822.  <quote><varname
 
70
      ><replaceable>option</replaceable></varname>: <replaceable
 
71
      >value</replaceable></quote> is also accepted.  Note that
 
72
      leading whitespace is removed from values.  Lines beginning with
 
73
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
 
74
      to provide comments.
96
75
    </para>
97
 
 
 
76
    
98
77
  </refsect1>
99
78
  <refsect1>
100
79
    <title>OPTIONS</title>
101
80
    
102
81
    <variablelist>
103
82
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
 
83
        <term><option>interface<literal> = </literal><replaceable
 
84
        >NAME</replaceable></option></term>
105
85
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
108
 
          </synopsis>
109
86
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
87
        </listitem>
111
88
      </varlistentry>
112
 
 
 
89
      
113
90
      <varlistentry>
114
 
        <term><varname>address</varname></term>
 
91
        <term><option>address<literal> = </literal><replaceable
 
92
          >ADDRESS</replaceable></option></term>
115
93
        <listitem>
116
 
          <synopsis><literal>address = </literal><replaceable
117
 
          >ADDRESS</replaceable>
118
 
          </synopsis>
119
94
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
95
        </listitem>
121
96
      </varlistentry>
122
 
 
 
97
      
123
98
      <varlistentry>
124
 
        <term><varname>port</varname></term>
 
99
        <term><option>port<literal> = </literal><replaceable
 
100
        >NUMBER</replaceable></option></term>
125
101
        <listitem>
126
 
          <synopsis><literal>port = </literal><replaceable
127
 
          >PORT</replaceable>
128
 
          </synopsis>
129
102
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
103
        </listitem>
131
104
      </varlistentry>
132
 
 
 
105
      
133
106
      <varlistentry>
134
 
        <term><varname>debug</varname></term>
135
 
        <listitem>
136
 
          <synopsis><literal>debug = </literal>{ <literal
 
107
        <term><option>debug<literal> = </literal>{ <literal
137
108
          >1</literal> | <literal>yes</literal> | <literal
138
109
          >true</literal> | <literal>on</literal> | <literal
139
110
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }
141
 
          </synopsis>
 
111
          >false</literal> | <literal>off</literal> }</option></term>
 
112
        <listitem>
142
113
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
114
        </listitem>
144
115
      </varlistentry>
145
 
 
 
116
      
146
117
      <varlistentry>
147
 
        <term><varname>priority</varname></term>
 
118
        <term><option>priority<literal> = </literal><replaceable
 
119
        >STRING</replaceable></option></term>
148
120
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
151
 
          </synopsis>
152
121
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
122
        </listitem>
154
123
      </varlistentry>
155
 
 
 
124
      
156
125
      <varlistentry>
157
 
        <term><varname>servicename</varname></term>
 
126
        <term><option>servicename<literal> = </literal
 
127
        ><replaceable>NAME</replaceable></option></term>
158
128
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
129
          <xi:include href="mandos-options.xml"
163
130
                      xpointer="servicename"/>
164
131
        </listitem>
165
132
      </varlistentry>
166
133
      
 
134
      <varlistentry>
 
135
        <term><option>use_dbus<literal> = </literal>{ <literal
 
136
          >1</literal> | <literal>yes</literal> | <literal
 
137
          >true</literal> | <literal>on</literal> | <literal
 
138
          >0</literal> | <literal>no</literal> | <literal
 
139
          >false</literal> | <literal>off</literal> }</option></term>
 
140
        <listitem>
 
141
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
142
        </listitem>
 
143
      </varlistentry>
 
144
      
167
145
    </variablelist>
168
146
  </refsect1>
169
147
  
179
157
    <para>
180
158
      The <literal>[DEFAULT]</literal> is necessary because the Python
181
159
      built-in module <systemitem class="library">ConfigParser</systemitem>
182
 
      requres it.
 
160
      requires it.
183
161
    </para>
184
162
  </refsect1>
185
163
  
206
184
debug = true
207
185
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
208
186
servicename = Daena
 
187
use_dbus = False
209
188
      </programlisting>
210
189
    </informalexample>
211
190
  </refsect1>
 
191
  
 
192
  <refsect1 id="see_also">
 
193
    <title>SEE ALSO</title>
 
194
    <para>
 
195
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
 
196
      ><manvolnum>3</manvolnum></citerefentry>,
 
197
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
198
      <manvolnum>8</manvolnum></citerefentry>,
 
199
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
200
      <manvolnum>5</manvolnum></citerefentry>
 
201
    </para>
 
202
    
 
203
    <variablelist>
 
204
      <varlistentry>
 
205
        <term>
 
206
          RFC 4291: <citetitle>IP Version 6 Addressing
 
207
          Architecture</citetitle>
 
208
        </term>
 
209
        <listitem>
 
210
          <variablelist>
 
211
            <varlistentry>
 
212
              <term>Section 2.2: <citetitle>Text Representation of
 
213
              Addresses</citetitle></term>
 
214
              <listitem><para/></listitem>
 
215
            </varlistentry>
 
216
            <varlistentry>
 
217
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
 
218
              Address</citetitle></term>
 
219
              <listitem><para/></listitem>
 
220
            </varlistentry>
 
221
            <varlistentry>
 
222
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
 
223
            Addresses</citetitle></term>
 
224
            <listitem>
 
225
              <para>
 
226
                The clients use IPv6 link-local addresses, which are
 
227
                immediately usable since a link-local addresses is
 
228
                automatically assigned to a network interfaces when it
 
229
                is brought up.
 
230
              </para>
 
231
            </listitem>
 
232
            </varlistentry>
 
233
          </variablelist>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
      <varlistentry>
 
237
        <term>
 
238
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
 
239
        </term>
 
240
        <listitem>
 
241
          <para>
 
242
            Zeroconf is the network protocol standard used by clients
 
243
            for finding the Mandos server on the local network.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
    </variablelist>
 
248
  </refsect1>
212
249
</refentry>
 
250
<!-- Local Variables: -->
 
251
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
252
<!-- time-stamp-end: "[\"']>" -->
 
253
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
254
<!-- End: -->