/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-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
11
9
<refentry>
12
10
  <refentryinfo>
13
11
    <title>&CONFNAME;</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>&CONFNAME;</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn</holder>
 
34
      <holder>Björn Påhlsson</holder>
36
35
    </copyright>
37
36
    <legalnotice>
38
37
      <para>
67
66
  <refnamediv>
68
67
    <refname><filename>&CONFNAME;</filename></refname>
69
68
    <refpurpose>
70
 
      Configuration file for Mandos clients
 
69
      Configuration file for the Mandos server
71
70
    </refpurpose>
72
71
  </refnamediv>
73
72
 
80
79
  <refsect1 id="description">
81
80
    <title>DESCRIPTION</title>
82
81
    <para>
83
 
      The file &CONFPATH; is the configuration file for mandos where
84
 
      each client that will be abel to use the service need to be
85
 
      specified. The configuration file is looked on at the startup of
86
 
      the service, so to reenable timedout clients one need to only
87
 
      restart the server. The format starts with a section under []
88
 
      which is eather <literal>[DEFAULT]</literal> or a client
89
 
      name. Values is set through the use of VAR = VALUE pair. Values
90
 
      may not be empty.
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
 
83
      ><refentrytitle>mandos</refentrytitle>
 
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
 
85
      where each client that will be able to use the service needs to
 
86
      be listed.  All clients listed will be regarded as valid, even
 
87
      if a client was declared invalid in a previous run of the
 
88
      server.
 
89
    </para>
 
90
    <para>
 
91
      The format starts with a section under [] which is either
 
92
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
 
93
      name</replaceable>]</literal>.  Following the section is any
 
94
      number of <quote><varname><replaceable>option</replaceable
 
95
      ></varname>=<replaceable>value</replaceable></quote> entries,
 
96
      with continuations in the style of RFC 822.  <quote><varname
 
97
      ><replaceable>option</replaceable></varname>: <replaceable
 
98
      >value</replaceable></quote> is also accepted.  Note that
 
99
      leading whitespace is removed from values.  Values can contain
 
100
      format strings which refer to other values in the same section,
 
101
      or values in the <quote>DEFAULT</quote> section.  Lines
 
102
      beginning with <quote>#</quote> or <quote>;</quote> are ignored
 
103
      and may be used to provide comments.
91
104
    </para>
92
105
  </refsect1>
93
 
 
94
 
  <refsect1 id="default">
95
 
    <title>DEFAULTS</title>
 
106
  
 
107
  <refsect1 id="options">
 
108
    <title>OPTIONS</title>
96
109
    <para>
97
 
      The paramters for <literal>[DEFAULT]</literal> are:
 
110
      The possible options are:
98
111
    </para>
99
112
 
100
113
    <variablelist>
101
 
      
 
114
 
102
115
      <varlistentry>
103
 
        <term><literal>timeout</literal></term>
 
116
        <term><literal><varname>timeout</varname></literal></term>
104
117
        <listitem>
105
 
          <para>
106
 
            This option allows you to override the default timeout
107
 
            that clients will get. By default mandos will use 1hr.
 
118
          <synopsis><literal>timeout = </literal><replaceable
 
119
          >TIME</replaceable>
 
120
          </synopsis>
 
121
          <para>
 
122
            The timeout is how long the server will wait for a
 
123
            successful checker run until a client is considered
 
124
            invalid - that is, ineligible to get the data this server
 
125
            holds.  By default Mandos will use 1 hour.
 
126
          </para>
 
127
          <para>
 
128
            The <replaceable>TIME</replaceable> is specified as a
 
129
            space-separated number of values, each of which is a
 
130
            number and a one-character suffix.  The suffix must be one
 
131
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
132
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
133
            minutes, hours, and weeks, respectively.  The values are
 
134
            added together to give the total time value, so all of
 
135
            <quote><literal>330s</literal></quote>,
 
136
            <quote><literal>110s 110s 110s</literal></quote>, and
 
137
            <quote><literal>5m 30s</literal></quote> will give a value
 
138
            of five minutes and thirty seconds.
108
139
          </para>
109
140
        </listitem>
110
141
      </varlistentry>
111
142
 
112
143
      <varlistentry>
113
 
        <term><literal>interval</literal></term>
 
144
        <term><literal><varname>interval</varname></literal></term>
114
145
        <listitem>
115
 
          <para>
116
 
            This option allows you to override the default interval
117
 
            used between checkups for disconnected clients. By default
118
 
            mandos will use 5m.
 
146
          <synopsis><literal>interval = </literal><replaceable
 
147
          >TIME</replaceable>
 
148
          </synopsis>
 
149
          <para>
 
150
            How often to run the checker to confirm that a client is
 
151
            still up.  <emphasis>Note:</emphasis> a new checker will
 
152
            not be started if an old one is still running.  The server
 
153
            will wait for a checker to complete until the above
 
154
            <quote><varname>timeout</varname></quote> occurs, at which
 
155
            time the client will be marked invalid, and any running
 
156
            checker killed.  The default interval is 5 minutes.
 
157
          </para>
 
158
          <para>
 
159
            The format of <replaceable>TIME</replaceable> is the same
 
160
            as for <varname>timeout</varname> above.
119
161
          </para>
120
162
        </listitem>
121
163
      </varlistentry>      
131
173
        </listitem>
132
174
      </varlistentry>
133
175
      
134
 
    </variablelist>
135
 
  </refsect1>
136
 
 
137
 
  <refsect1 id="clients">
138
 
    <title>CLIENTS</title>
139
 
    <para>
140
 
      The paramters for clients are:
141
 
    </para>
142
 
 
143
 
    <variablelist>
144
 
      
145
176
      <varlistentry>
146
177
        <term><literal>fingerprint</literal></term>
147
178
        <listitem>
204
235
      
205
236
    </variablelist>
206
237
  </refsect1>  
 
238
  
 
239
  <refsect1 id="expansion">
 
240
    <title>EXPANSION</title>
 
241
    <para>
 
242
      There are two forms of expansion: Start time expansion and
 
243
      runtime expansion.
 
244
    </para>
 
245
    <refsect2>
 
246
      <title>START TIME EXPANSION</title>
 
247
      <para>
 
248
        Any string in an option value of the form
 
249
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
 
250
        ></quote> will be replaced by the value of the option
 
251
        <varname>foo</varname> either in the same section, or, if it
 
252
        does not exist there, the <literal>[DEFAULT]</literal>
 
253
        section.  This is done at start time, when the configuration
 
254
        file is read.
 
255
      </para>
 
256
      <para>
 
257
        Note that this means that, in order to include an actual
 
258
        percent character (<quote>%</quote>) in an option value, two
 
259
        percent characters in a row (<quote>%%</quote>) must be
 
260
        entered.
 
261
      </para>
 
262
    </refsect2>
 
263
    <refsect2>
 
264
      <title>RUNTIME EXPANSION</title>
 
265
      <para>
 
266
        This is currently only done for the <varname>checker</varname>
 
267
        option.
 
268
      </para>
 
269
      <para>
 
270
        Any string in an option value of the form
 
271
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
 
272
        ></quote> will be replaced by the value of the attribute
 
273
        <varname>foo</varname> of the internal
 
274
        <quote><classname>Client</classname></quote> object.  See the
 
275
        source code for details, and let the authors know of any
 
276
        attributes that are useful so they may be preserved to any new
 
277
        versions of this software.
 
278
      </para>
 
279
      <para>
 
280
        Note that this means that, in order to include an actual
 
281
        percent character (<quote>%</quote>) in a
 
282
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
283
        percent characters in a row (<quote>%%%%</quote>) must be
 
284
        entered.  Also, a bad format here will lead to an immediate
 
285
        but <emphasis>silent</emphasis> run-time fatal exit; debug
 
286
        mode is needed to track down an error of this kind.
 
287
      </para>
 
288
    </refsect2>
207
289
 
208
 
  <refsect1 id="examples">
209
 
    <title>EXAMPLES</title>
 
290
  </refsect1>  
 
291
  
 
292
  <refsect1 id="files">
 
293
    <title>FILES</title>
 
294
    <para>
 
295
      The file described here is &CONFPATH;
 
296
    </para>
 
297
  </refsect1>
 
298
  
 
299
  <refsect1 id="bugs">
 
300
    <title>BUGS</title>
 
301
    <para>
 
302
      The format for specifying times for <varname>timeout</varname>
 
303
      and <varname>interval</varname> is not very good.
 
304
    </para>
 
305
    <para>
 
306
      The difference between
 
307
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
 
308
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
 
309
      obscure.
 
310
    </para>
 
311
  </refsect1>
 
312
  
 
313
  <refsect1 id="example">
 
314
    <title>EXAMPLE</title>
210
315
    <informalexample>
211
316
      <programlisting>
212
317
[DEFAULT]
214
319
interval = 5m
215
320
checker = fping -q -- %%(host)s
216
321
 
217
 
[example_client]
 
322
# Client "foo"
 
323
[foo]
218
324
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
219
 
 
220
325
secret =
221
326
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
222
327
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
234
339
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
235
340
        QlnHIvPzEArRQLo=
236
341
        =iHhv
237
 
 
238
 
host = localhost
 
342
host = foo.example.org
239
343
interval = 5m
 
344
 
 
345
# Client "bar"
 
346
[bar]
 
347
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
 
348
secfile = /etc/mandos/bar-secret.txt.asc
 
349
 
240
350
      </programlisting>
241
351
    </informalexample>
242
352
  </refsect1>  
243
 
  
244
 
  <refsect1 id="files">
245
 
    <title>FILES</title>
246
 
    <para>
247
 
      The file described here is &CONFPATH;
248
 
    </para>
249
 
  </refsect1>
 
353
 
250
354
</refentry>