/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-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 "2016-02-28">
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>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
33
      <holder>Teddy Hogeborn</holder>
45
34
      <holder>Björn Påhlsson</holder>
46
35
    </copyright>
47
 
    <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>
48
59
  </refentryinfo>
49
 
  
 
60
 
50
61
  <refmeta>
51
62
    <refentrytitle>&CONFNAME;</refentrytitle>
52
63
    <manvolnum>5</manvolnum>
58
69
      Configuration file for the Mandos server
59
70
    </refpurpose>
60
71
  </refnamediv>
61
 
  
 
72
 
62
73
  <refsynopsisdiv>
63
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
64
77
  </refsynopsisdiv>
65
 
  
 
78
 
66
79
  <refsect1 id="description">
67
80
    <title>DESCRIPTION</title>
68
81
    <para>
80
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
81
94
      to provide comments.
82
95
    </para>
83
 
    
 
96
 
84
97
  </refsect1>
85
98
  <refsect1>
86
99
    <title>OPTIONS</title>
87
100
    
88
101
    <variablelist>
89
102
      <varlistentry>
90
 
        <term><option>interface<literal> = </literal><replaceable
91
 
        >NAME</replaceable></option></term>
 
103
        <term><varname>interface</varname></term>
92
104
        <listitem>
 
105
          <synopsis><literal>interface = </literal><replaceable
 
106
          >NAME</replaceable>
 
107
          </synopsis>
93
108
          <xi:include href="mandos-options.xml" xpointer="interface"/>
94
109
        </listitem>
95
110
      </varlistentry>
96
 
      
 
111
 
97
112
      <varlistentry>
98
 
        <term><option>address<literal> = </literal><replaceable
99
 
          >ADDRESS</replaceable></option></term>
 
113
        <term><varname>address</varname></term>
100
114
        <listitem>
 
115
          <synopsis><literal>address = </literal><replaceable
 
116
          >ADDRESS</replaceable>
 
117
          </synopsis>
101
118
          <xi:include href="mandos-options.xml" xpointer="address"/>
102
119
        </listitem>
103
120
      </varlistentry>
104
 
      
 
121
 
105
122
      <varlistentry>
106
 
        <term><option>port<literal> = </literal><replaceable
107
 
        >NUMBER</replaceable></option></term>
 
123
        <term><varname>port</varname></term>
108
124
        <listitem>
 
125
          <synopsis><literal>port = </literal><replaceable
 
126
          >NUMBER</replaceable>
 
127
          </synopsis>
109
128
          <xi:include href="mandos-options.xml" xpointer="port"/>
110
129
        </listitem>
111
130
      </varlistentry>
112
 
      
 
131
 
113
132
      <varlistentry>
114
 
        <term><option>debug<literal> = </literal>{ <literal
 
133
        <term><varname>debug</varname></term>
 
134
        <listitem>
 
135
          <synopsis><literal>debug = </literal>{ <literal
115
136
          >1</literal> | <literal>yes</literal> | <literal
116
137
          >true</literal> | <literal>on</literal> | <literal
117
138
          >0</literal> | <literal>no</literal> | <literal
118
 
          >false</literal> | <literal>off</literal> }</option></term>
119
 
        <listitem>
 
139
          >false</literal> | <literal>off</literal> }
 
140
          </synopsis>
120
141
          <xi:include href="mandos-options.xml" xpointer="debug"/>
121
142
        </listitem>
122
143
      </varlistentry>
123
 
      
 
144
 
124
145
      <varlistentry>
125
 
        <term><option>priority<literal> = </literal><replaceable
126
 
        >STRING</replaceable></option></term>
 
146
        <term><varname>priority</varname></term>
127
147
        <listitem>
 
148
          <synopsis><literal>priority = </literal><replaceable
 
149
          >STRING</replaceable>
 
150
          </synopsis>
128
151
          <xi:include href="mandos-options.xml" xpointer="priority"/>
129
152
        </listitem>
130
153
      </varlistentry>
131
 
      
 
154
 
132
155
      <varlistentry>
133
 
        <term><option>servicename<literal> = </literal
134
 
        ><replaceable>NAME</replaceable></option></term>
 
156
        <term><varname>servicename</varname></term>
135
157
        <listitem>
 
158
          <synopsis><literal>servicename = </literal><replaceable
 
159
          >NAME</replaceable>
 
160
          </synopsis>
136
161
          <xi:include href="mandos-options.xml"
137
162
                      xpointer="servicename"/>
138
163
        </listitem>
139
164
      </varlistentry>
140
165
      
141
 
      <varlistentry>
142
 
        <term><option>use_dbus<literal> = </literal>{ <literal
143
 
          >1</literal> | <literal>yes</literal> | <literal
144
 
          >true</literal> | <literal>on</literal> | <literal
145
 
          >0</literal> | <literal>no</literal> | <literal
146
 
          >false</literal> | <literal>off</literal> }</option></term>
147
 
        <listitem>
148
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
149
 
        </listitem>
150
 
      </varlistentry>
151
 
      
152
 
      <varlistentry>
153
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
154
 
          >1</literal> | <literal>yes</literal> | <literal
155
 
          >true</literal> | <literal>on</literal> | <literal
156
 
          >0</literal> | <literal>no</literal> | <literal
157
 
          >false</literal> | <literal>off</literal> }</option></term>
158
 
        <listitem>
159
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
160
 
        </listitem>
161
 
      </varlistentry>
162
 
      
163
 
      <varlistentry>
164
 
        <term><option>restore<literal> = </literal>{ <literal
165
 
          >1</literal> | <literal>yes</literal> | <literal
166
 
          >true</literal> | <literal>on</literal> | <literal
167
 
          >0</literal> | <literal>no</literal> | <literal
168
 
          >false</literal> | <literal>off</literal> }</option></term>
169
 
        <listitem>
170
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      
174
 
      <varlistentry>
175
 
        <term><option>statedir<literal> = </literal><replaceable
176
 
        >DIRECTORY</replaceable></option></term>
177
 
        <listitem>
178
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
179
 
        </listitem>
180
 
      </varlistentry>
181
 
      
182
 
      <varlistentry>
183
 
        <term><option>socket<literal> = </literal><replaceable
184
 
        >NUMBER</replaceable></option></term>
185
 
        <listitem>
186
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
166
    </variablelist>
191
167
  </refsect1>
192
168
  
202
178
    <para>
203
179
      The <literal>[DEFAULT]</literal> is necessary because the Python
204
180
      built-in module <systemitem class="library">ConfigParser</systemitem>
205
 
      requires it.
 
181
      requres it.
206
182
    </para>
207
183
  </refsect1>
208
184
  
224
200
[DEFAULT]
225
201
# A configuration example
226
202
interface = eth0
227
 
address = fe80::aede:48ff:fe71:f6f2
 
203
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
228
204
port = 1025
229
 
debug = True
230
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
205
debug = true
 
206
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
231
207
servicename = Daena
232
 
use_dbus = False
233
 
use_ipv6 = True
234
 
restore = True
235
 
statedir = /var/lib/mandos
236
208
      </programlisting>
237
209
    </informalexample>
238
210
  </refsect1>
240
212
  <refsect1 id="see_also">
241
213
    <title>SEE ALSO</title>
242
214
    <para>
243
 
      <citerefentry><refentrytitle>intro</refentrytitle>
244
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
245
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
246
 
      ><manvolnum>3</manvolnum></citerefentry>,
247
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
248
 
      <manvolnum>8</manvolnum></citerefentry>,
249
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
250
 
      <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>
251
222
    </para>
252
 
    
 
223
 
253
224
    <variablelist>
254
225
      <varlistentry>
255
226
        <term>
275
246
              <para>
276
247
                The clients use IPv6 link-local addresses, which are
277
248
                immediately usable since a link-local addresses is
278
 
                automatically assigned to a network interface when it
 
249
                automatically assigned to a network interfaces when it
279
250
                is brought up.
280
251
              </para>
281
252
            </listitem>
297
268
    </variablelist>
298
269
  </refsect1>
299
270
</refentry>
300
 
<!-- Local Variables: -->
301
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
302
 
<!-- time-stamp-end: "[\"']>" -->
303
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
304
 
<!-- End: -->