/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

Show diffs side-by-side

added added

removed removed

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