/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: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2023-04-30">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-30">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
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
 
      <year>2019</year>
47
35
      <holder>Teddy Hogeborn</holder>
48
36
      <holder>Björn Påhlsson</holder>
49
37
    </copyright>
50
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
51
61
  </refentryinfo>
52
 
  
 
62
 
53
63
  <refmeta>
54
64
    <refentrytitle>&CONFNAME;</refentrytitle>
55
65
    <manvolnum>5</manvolnum>
61
71
      Configuration file for the Mandos server
62
72
    </refpurpose>
63
73
  </refnamediv>
64
 
  
 
74
 
65
75
  <refsynopsisdiv>
66
76
    <synopsis>&CONFPATH;</synopsis>
67
77
  </refsynopsisdiv>
68
 
  
 
78
 
69
79
  <refsect1 id="description">
70
80
    <title>DESCRIPTION</title>
71
81
    <para>
72
 
      The file &CONFPATH; is a configuration file for
 
82
      The file &CONFPATH; is a simple configuration file for
73
83
      <citerefentry><refentrytitle>mandos</refentrytitle>
74
84
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
75
85
      startup.  The configuration file starts with <quote><literal
83
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
84
94
      to provide comments.
85
95
    </para>
86
 
    
 
96
 
87
97
  </refsect1>
88
98
  <refsect1>
89
99
    <title>OPTIONS</title>
96
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
97
107
        </listitem>
98
108
      </varlistentry>
99
 
      
 
109
 
100
110
      <varlistentry>
101
111
        <term><option>address<literal> = </literal><replaceable
102
112
          >ADDRESS</replaceable></option></term>
104
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
105
115
        </listitem>
106
116
      </varlistentry>
107
 
      
 
117
 
108
118
      <varlistentry>
109
119
        <term><option>port<literal> = </literal><replaceable
110
120
        >NUMBER</replaceable></option></term>
112
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
113
123
        </listitem>
114
124
      </varlistentry>
115
 
      
 
125
 
116
126
      <varlistentry>
117
127
        <term><option>debug<literal> = </literal>{ <literal
118
128
          >1</literal> | <literal>yes</literal> | <literal
123
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
124
134
        </listitem>
125
135
      </varlistentry>
126
 
      
 
136
 
127
137
      <varlistentry>
128
138
        <term><option>priority<literal> = </literal><replaceable
129
139
        >STRING</replaceable></option></term>
131
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
132
142
        </listitem>
133
143
      </varlistentry>
134
 
      
 
144
 
135
145
      <varlistentry>
136
146
        <term><option>servicename<literal> = </literal
137
147
        ><replaceable>NAME</replaceable></option></term>
141
151
        </listitem>
142
152
      </varlistentry>
143
153
      
144
 
      <varlistentry>
145
 
        <term><option>use_dbus<literal> = </literal>{ <literal
146
 
          >1</literal> | <literal>yes</literal> | <literal
147
 
          >true</literal> | <literal>on</literal> | <literal
148
 
          >0</literal> | <literal>no</literal> | <literal
149
 
          >false</literal> | <literal>off</literal> }</option></term>
150
 
        <listitem>
151
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
152
 
        </listitem>
153
 
      </varlistentry>
154
 
      
155
 
      <varlistentry>
156
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
157
 
          >1</literal> | <literal>yes</literal> | <literal
158
 
          >true</literal> | <literal>on</literal> | <literal
159
 
          >0</literal> | <literal>no</literal> | <literal
160
 
          >false</literal> | <literal>off</literal> }</option></term>
161
 
        <listitem>
162
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
163
 
        </listitem>
164
 
      </varlistentry>
165
 
      
166
 
      <varlistentry>
167
 
        <term><option>restore<literal> = </literal>{ <literal
168
 
          >1</literal> | <literal>yes</literal> | <literal
169
 
          >true</literal> | <literal>on</literal> | <literal
170
 
          >0</literal> | <literal>no</literal> | <literal
171
 
          >false</literal> | <literal>off</literal> }</option></term>
172
 
        <listitem>
173
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
174
 
        </listitem>
175
 
      </varlistentry>
176
 
      
177
 
      <varlistentry>
178
 
        <term><option>statedir<literal> = </literal><replaceable
179
 
        >DIRECTORY</replaceable></option></term>
180
 
        <listitem>
181
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
182
 
        </listitem>
183
 
      </varlistentry>
184
 
      
185
 
      <varlistentry>
186
 
        <term><option>socket<literal> = </literal><replaceable
187
 
        >NUMBER</replaceable></option></term>
188
 
        <listitem>
189
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
190
 
        </listitem>
191
 
      </varlistentry>
192
 
      
193
154
    </variablelist>
194
155
  </refsect1>
195
156
  
205
166
    <para>
206
167
      The <literal>[DEFAULT]</literal> is necessary because the Python
207
168
      built-in module <systemitem class="library">ConfigParser</systemitem>
208
 
      requires it.
 
169
      requres it.
209
170
    </para>
210
 
    <xi:include href="bugs.xml"/>
211
171
  </refsect1>
212
172
  
213
173
  <refsect1 id="example">
227
187
      <programlisting>
228
188
[DEFAULT]
229
189
# A configuration example
230
 
interface = enp1s0
231
 
address = fe80::aede:48ff:fe71:f6f2
 
190
interface = eth0
 
191
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
232
192
port = 1025
233
 
debug = True
234
 
priority = SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA:!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA
 
193
debug = true
 
194
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
235
195
servicename = Daena
236
 
use_dbus = False
237
 
use_ipv6 = True
238
 
restore = True
239
 
statedir = /var/lib/mandos
240
196
      </programlisting>
241
197
    </informalexample>
242
198
  </refsect1>
244
200
  <refsect1 id="see_also">
245
201
    <title>SEE ALSO</title>
246
202
    <para>
247
 
      <citerefentry><refentrytitle>intro</refentrytitle>
248
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
249
203
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
250
204
      ><manvolnum>3</manvolnum></citerefentry>,
251
205
      <citerefentry><refentrytitle>mandos</refentrytitle>
253
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
254
208
      <manvolnum>5</manvolnum></citerefentry>
255
209
    </para>
256
 
    
 
210
 
257
211
    <variablelist>
258
212
      <varlistentry>
259
213
        <term>
279
233
              <para>
280
234
                The clients use IPv6 link-local addresses, which are
281
235
                immediately usable since a link-local addresses is
282
 
                automatically assigned to a network interface when it
 
236
                automatically assigned to a network interfaces when it
283
237
                is brought up.
284
238
              </para>
285
239
            </listitem>