/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-07-19 18:43:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080719184324-iwhoa5in75xa0u2u
* mandos-clients.conf ([foo]/dn, [foo]/password, [braxen_client]/dn,
                       [braxen_client]/password): Removed.
  ([foo]/fingerprint, [braxen_client]/fingerprint): New.
  ([foo]/checker): New.
  ([foo]/secfile): New.
  ([braxen_client]/secret): New.

* server.py: New "--debug" option to set debug flag.  Removed "cert",
             "key", "ca", "crl", and "cred" variables.  Added default
             value for "checker" config file setting.  Do not pass
             credentials to IPv6_TCPServer constructor.
  (debug): New global debug flag.  Used by most debugging output code.
  (Client.__init__): Keyword argument "dn" replaced by "fingerprint",
                     "password" renamed to "secret", and "passfile"
                     renamed to "secfile".  New keyword argument
                     "checker". All callers changed.
  (Client.dn): Removed.
  (Client.fingerprint): New.
  (Client.password): Renamed to "secret"; all users changed.
  (Client.passfile): Renamed to "secfile"; all users changed.
  (Client.timeout, Client.interval): Changed to be properties; now
                                     automatically updates the
                                     "_timeout_milliseconds" and
                                     "_interval_milliseconds" values.
  (Client.timeout_milliseconds): Renamed to "_timeout_milliseconds".
  (Client.interval_milliseconds): Renamed to "_interval_milliseconds".
  (Client.check_command): New.
  (Client.start_checker): Use the new "check_command" attribute.
  (peer_certificate, fingerprint): New functions.

  (tcp_handler.handle): Use ClientSession with empty credentials
                        object instead of ServerSession.  Set gnutls
                        priority string.  Do not verify peer.  Use
                        fingerprint instead of DN when searching for
                        clients.  Bug fix: Loop sending data so even large
                        secret data strings are sent.
  (IPv6_TCPServer.credentials): Removed.
  (if_nametoindex): Do not import ctypes since that is now imported
                    globally.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY CONFNAME "mandos.conf">
6
 
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-30">
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
 
    <authorgroup>
18
 
      <author>
19
 
        <firstname>Björn</firstname>
20
 
        <surname>Påhlsson</surname>
21
 
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
23
 
        </address>
24
 
      </author>
25
 
      <author>
26
 
        <firstname>Teddy</firstname>
27
 
        <surname>Hogeborn</surname>
28
 
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
30
 
        </address>
31
 
      </author>
32
 
    </authorgroup>
33
 
    <copyright>
34
 
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn</holder>
36
 
      <holder>Björn Påhlsson</holder>
37
 
    </copyright>
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>
61
 
  </refentryinfo>
62
 
 
63
 
  <refmeta>
64
 
    <refentrytitle>&CONFNAME;</refentrytitle>
65
 
    <manvolnum>5</manvolnum>
66
 
  </refmeta>
67
 
  
68
 
  <refnamediv>
69
 
    <refname><filename>&CONFNAME;</filename></refname>
70
 
    <refpurpose>
71
 
      Configuration file for the Mandos server
72
 
    </refpurpose>
73
 
  </refnamediv>
74
 
 
75
 
  <refsynopsisdiv>
76
 
    <synopsis>&CONFPATH;</synopsis>
77
 
  </refsynopsisdiv>
78
 
 
79
 
  <refsect1 id="description">
80
 
    <title>DESCRIPTION</title>
81
 
    <para>
82
 
      The file &CONFPATH; is a simple configuration file for
83
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
85
 
      startup.  The configuration file starts with <quote><literal
86
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
87
 
      any number of <quote><varname><replaceable>option</replaceable
88
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
89
 
      with continuations in the style of RFC 822.  <quote><varname
90
 
      ><replaceable>option</replaceable></varname>: <replaceable
91
 
      >value</replaceable></quote> is also accepted.  Note that
92
 
      leading whitespace is removed from values.  Lines beginning with
93
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
94
 
      to provide comments.
95
 
    </para>
96
 
 
97
 
  </refsect1>
98
 
  <refsect1>
99
 
    <title>OPTIONS</title>
100
 
    
101
 
    <variablelist>
102
 
      <varlistentry>
103
 
        <term><option>interface<literal> = </literal><replaceable
104
 
        >NAME</replaceable></option></term>
105
 
        <listitem>
106
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
107
 
        </listitem>
108
 
      </varlistentry>
109
 
 
110
 
      <varlistentry>
111
 
        <term><option>address<literal> = </literal><replaceable
112
 
          >ADDRESS</replaceable></option></term>
113
 
        <listitem>
114
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
115
 
        </listitem>
116
 
      </varlistentry>
117
 
 
118
 
      <varlistentry>
119
 
        <term><option>port<literal> = </literal><replaceable
120
 
        >NUMBER</replaceable></option></term>
121
 
        <listitem>
122
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
123
 
        </listitem>
124
 
      </varlistentry>
125
 
 
126
 
      <varlistentry>
127
 
        <term><option>debug<literal> = </literal>{ <literal
128
 
          >1</literal> | <literal>yes</literal> | <literal
129
 
          >true</literal> | <literal>on</literal> | <literal
130
 
          >0</literal> | <literal>no</literal> | <literal
131
 
          >false</literal> | <literal>off</literal> }</option></term>
132
 
        <listitem>
133
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
134
 
        </listitem>
135
 
      </varlistentry>
136
 
 
137
 
      <varlistentry>
138
 
        <term><option>priority<literal> = </literal><replaceable
139
 
        >STRING</replaceable></option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
 
145
 
      <varlistentry>
146
 
        <term><option>servicename<literal> = </literal
147
 
        ><replaceable>NAME</replaceable></option></term>
148
 
        <listitem>
149
 
          <xi:include href="mandos-options.xml"
150
 
                      xpointer="servicename"/>
151
 
        </listitem>
152
 
      </varlistentry>
153
 
      
154
 
    </variablelist>
155
 
  </refsect1>
156
 
  
157
 
  <refsect1 id="files">
158
 
    <title>FILES</title>
159
 
    <para>
160
 
      The file described here is &CONFPATH;
161
 
    </para>
162
 
  </refsect1>
163
 
  
164
 
  <refsect1 id="bugs">
165
 
    <title>BUGS</title>
166
 
    <para>
167
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
168
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
169
 
      requres it.
170
 
    </para>
171
 
  </refsect1>
172
 
  
173
 
  <refsect1 id="example">
174
 
    <title>EXAMPLE</title>
175
 
    <informalexample>
176
 
      <para>
177
 
        No options are actually required:
178
 
      </para>
179
 
      <programlisting>
180
 
[DEFAULT]
181
 
      </programlisting>
182
 
    </informalexample>
183
 
    <informalexample>
184
 
      <para>
185
 
        An example using all the options:
186
 
      </para>
187
 
      <programlisting>
188
 
[DEFAULT]
189
 
# A configuration example
190
 
interface = eth0
191
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
192
 
port = 1025
193
 
debug = true
194
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
195
 
servicename = Daena
196
 
      </programlisting>
197
 
    </informalexample>
198
 
  </refsect1>
199
 
  
200
 
  <refsect1 id="see_also">
201
 
    <title>SEE ALSO</title>
202
 
    <para>
203
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
204
 
      ><manvolnum>3</manvolnum></citerefentry>,
205
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
206
 
      <manvolnum>8</manvolnum></citerefentry>,
207
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
208
 
      <manvolnum>5</manvolnum></citerefentry>
209
 
    </para>
210
 
 
211
 
    <variablelist>
212
 
      <varlistentry>
213
 
        <term>
214
 
          RFC 4291: <citetitle>IP Version 6 Addressing
215
 
          Architecture</citetitle>
216
 
        </term>
217
 
        <listitem>
218
 
          <variablelist>
219
 
            <varlistentry>
220
 
              <term>Section 2.2: <citetitle>Text Representation of
221
 
              Addresses</citetitle></term>
222
 
              <listitem><para/></listitem>
223
 
            </varlistentry>
224
 
            <varlistentry>
225
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
226
 
              Address</citetitle></term>
227
 
              <listitem><para/></listitem>
228
 
            </varlistentry>
229
 
            <varlistentry>
230
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
231
 
            Addresses</citetitle></term>
232
 
            <listitem>
233
 
              <para>
234
 
                The clients use IPv6 link-local addresses, which are
235
 
                immediately usable since a link-local addresses is
236
 
                automatically assigned to a network interfaces when it
237
 
                is brought up.
238
 
              </para>
239
 
            </listitem>
240
 
            </varlistentry>
241
 
          </variablelist>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
      <varlistentry>
245
 
        <term>
246
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
247
 
        </term>
248
 
        <listitem>
249
 
          <para>
250
 
            Zeroconf is the network protocol standard used by clients
251
 
            for finding the Mandos server on the local network.
252
 
          </para>
253
 
        </listitem>
254
 
      </varlistentry>
255
 
    </variablelist>
256
 
  </refsect1>
257
 
</refentry>
258
 
<!-- Local Variables: -->
259
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
260
 
<!-- time-stamp-end: "[\"']>" -->
261
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
262
 
<!-- End: -->