/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-09-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

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
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-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2010-09-25">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-09-04">
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>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
38
    <xi:include href="legalnotice.xml"/>
41
39
  </refentryinfo>
42
 
  
 
40
 
43
41
  <refmeta>
44
42
    <refentrytitle>&CONFNAME;</refentrytitle>
45
43
    <manvolnum>5</manvolnum>
51
49
      Configuration file for the Mandos server
52
50
    </refpurpose>
53
51
  </refnamediv>
54
 
  
 
52
 
55
53
  <refsynopsisdiv>
56
54
    <synopsis>&CONFPATH;</synopsis>
57
55
  </refsynopsisdiv>
58
 
  
 
56
 
59
57
  <refsect1 id="description">
60
58
    <title>DESCRIPTION</title>
61
59
    <para>
63
61
      ><refentrytitle>mandos</refentrytitle>
64
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
63
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
64
      the service.  All clients listed will be regarded as valid, even
 
65
      if a client was declared invalid in a previous run of the
 
66
      server.
68
67
    </para>
69
68
    <para>
70
69
      The format starts with a <literal>[<replaceable>section
96
95
    <para>
97
96
      Unknown options are ignored.  The used options are as follows:
98
97
    </para>
99
 
    
 
98
 
100
99
    <variablelist>
101
 
      
102
 
      <varlistentry>
103
 
        <term><option>approval_delay<literal> = </literal><replaceable
104
 
        >TIME</replaceable></option></term>
105
 
        <listitem>
106
 
          <para>
107
 
            This option is <emphasis>optional</emphasis>.
108
 
          </para>
109
 
          <para>
110
 
            How long to wait for external approval before resorting to
111
 
            use the <option>approved_by_default</option> value.  The
112
 
            default is <quote>0s</quote>, i.e. not to wait.
113
 
          </para>
114
 
          <para>
115
 
            The format of <replaceable>TIME</replaceable> is the same
116
 
            as for <varname>timeout</varname> below.
117
 
          </para>
118
 
        </listitem>
119
 
      </varlistentry>
120
 
      
121
 
      <varlistentry>
122
 
        <term><option>approval_duration<literal> = </literal
123
 
        ><replaceable>TIME</replaceable></option></term>
124
 
        <listitem>
125
 
          <para>
126
 
            This option is <emphasis>optional</emphasis>.
127
 
          </para>
128
 
          <para>
129
 
            How long an external approval lasts.  The default is 1
130
 
            second.
131
 
          </para>
132
 
          <para>
133
 
            The format of <replaceable>TIME</replaceable> is the same
134
 
            as for <varname>timeout</varname> below.
135
 
          </para>
136
 
        </listitem>
137
 
      </varlistentry>
138
 
      
139
 
      <varlistentry>
140
 
        <term><option>approved_by_default<literal> = </literal
141
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
142
 
          >true</literal> | <literal>on</literal> | <literal
143
 
          >0</literal> | <literal>no</literal> | <literal
144
 
          >false</literal> | <literal>off</literal> }</option></term>
145
 
        <listitem>
146
 
          <para>
147
 
            Whether to approve a client by default after
148
 
            the <option>approval_delay</option>.  The default
149
 
            is <quote>True</quote>.
150
 
          </para>
151
 
        </listitem>
152
 
      </varlistentry>
153
 
      
 
100
 
 
101
      <varlistentry>
 
102
        <term><option>timeout<literal> = </literal><replaceable
 
103
        >TIME</replaceable></option></term>
 
104
        <listitem>
 
105
          <para>
 
106
            This option is <emphasis>optional</emphasis>.
 
107
          </para>
 
108
          <para>
 
109
            The timeout is how long the server will wait for a
 
110
            successful checker run until a client is considered
 
111
            invalid - that is, ineligible to get the data this server
 
112
            holds.  By default Mandos will use 1 hour.
 
113
          </para>
 
114
          <para>
 
115
            The <replaceable>TIME</replaceable> is specified as a
 
116
            space-separated number of values, each of which is a
 
117
            number and a one-character suffix.  The suffix must be one
 
118
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
119
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
120
            minutes, hours, and weeks, respectively.  The values are
 
121
            added together to give the total time value, so all of
 
122
            <quote><literal>330s</literal></quote>,
 
123
            <quote><literal>110s 110s 110s</literal></quote>, and
 
124
            <quote><literal>5m 30s</literal></quote> will give a value
 
125
            of five minutes and thirty seconds.
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><option>interval<literal> = </literal><replaceable
 
132
        >TIME</replaceable></option></term>
 
133
        <listitem>
 
134
          <para>
 
135
            This option is <emphasis>optional</emphasis>.
 
136
          </para>
 
137
          <para>
 
138
            How often to run the checker to confirm that a client is
 
139
            still up.  <emphasis>Note:</emphasis> a new checker will
 
140
            not be started if an old one is still running.  The server
 
141
            will wait for a checker to complete until the above
 
142
            <quote><varname>timeout</varname></quote> occurs, at which
 
143
            time the client will be marked invalid, and any running
 
144
            checker killed.  The default interval is 5 minutes.
 
145
          </para>
 
146
          <para>
 
147
            The format of <replaceable>TIME</replaceable> is the same
 
148
            as for <varname>timeout</varname> above.
 
149
          </para>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
 
154
153
      <varlistentry>
155
154
        <term><option>checker<literal> = </literal><replaceable
156
155
        >COMMAND</replaceable></option></term>
169
168
            <varname>PATH</varname> will be searched.  The default
170
169
            value for the checker command is <quote><literal
171
170
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
171
            >--</option> %(host)s</literal></quote>.
173
172
          </para>
174
173
          <para>
175
174
            In addition to normal start time expansion, this option
196
195
      </varlistentry>
197
196
      
198
197
      <varlistentry>
199
 
        <term><option><literal>host = </literal><replaceable
200
 
        >STRING</replaceable></option></term>
201
 
        <listitem>
202
 
          <para>
203
 
            This option is <emphasis>optional</emphasis>, but highly
204
 
            <emphasis>recommended</emphasis> unless the
205
 
            <option>checker</option> option is modified to a
206
 
            non-standard value without <quote>%%(host)s</quote> in it.
207
 
          </para>
208
 
          <para>
209
 
            Host name for this client.  This is not used by the server
210
 
            directly, but can be, and is by default, used by the
211
 
            checker.  See the <option>checker</option> option.
212
 
          </para>
213
 
        </listitem>
214
 
      </varlistentry>
215
 
      
216
 
      <varlistentry>
217
 
        <term><option>interval<literal> = </literal><replaceable
218
 
        >TIME</replaceable></option></term>
219
 
        <listitem>
220
 
          <para>
221
 
            This option is <emphasis>optional</emphasis>.
222
 
          </para>
223
 
          <para>
224
 
            How often to run the checker to confirm that a client is
225
 
            still up.  <emphasis>Note:</emphasis> a new checker will
226
 
            not be started if an old one is still running.  The server
227
 
            will wait for a checker to complete until the below
228
 
            <quote><varname>timeout</varname></quote> occurs, at which
229
 
            time the client will be disabled, and any running checker
230
 
            killed.  The default interval is 5 minutes.
231
 
          </para>
232
 
          <para>
233
 
            The format of <replaceable>TIME</replaceable> is the same
234
 
            as for <varname>timeout</varname> below.
235
 
          </para>
236
 
        </listitem>
237
 
      </varlistentry>
238
 
      
239
 
      <varlistentry>
240
 
        <term><option>secfile<literal> = </literal><replaceable
241
 
        >FILENAME</replaceable></option></term>
242
 
        <listitem>
243
 
          <para>
244
 
            This option is only used if <option>secret</option> is not
245
 
            specified, in which case this option is
246
 
            <emphasis>required</emphasis>.
247
 
          </para>
248
 
          <para>
249
 
            Similar to the <option>secret</option>, except the secret
250
 
            data is in an external file.  The contents of the file
251
 
            should <emphasis>not</emphasis> be base64-encoded, but
252
 
            will be sent to clients verbatim.
253
 
          </para>
254
 
          <para>
255
 
            File names of the form <filename>~user/foo/bar</filename>
256
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
257
 
            are supported.
258
 
          </para>
259
 
        </listitem>
260
 
      </varlistentry>
261
 
      
262
 
      <varlistentry>
263
198
        <term><option>secret<literal> = </literal><replaceable
264
199
        >BASE64_ENCODED_DATA</replaceable></option></term>
265
200
        <listitem>
288
223
          </para>
289
224
        </listitem>
290
225
      </varlistentry>
291
 
      
292
 
      <varlistentry>
293
 
        <term><option>timeout<literal> = </literal><replaceable
294
 
        >TIME</replaceable></option></term>
295
 
        <listitem>
296
 
          <para>
297
 
            This option is <emphasis>optional</emphasis>.
298
 
          </para>
299
 
          <para>
300
 
            The timeout is how long the server will wait (for either a
301
 
            successful checker run or a client receiving its secret)
302
 
            until a client is disabled and not allowed to get the data
303
 
            this server holds.  By default Mandos will use 1 hour.
304
 
          </para>
305
 
          <para>
306
 
            The <replaceable>TIME</replaceable> is specified as a
307
 
            space-separated number of values, each of which is a
308
 
            number and a one-character suffix.  The suffix must be one
309
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
311
 
            minutes, hours, and weeks, respectively.  The values are
312
 
            added together to give the total time value, so all of
313
 
            <quote><literal>330s</literal></quote>,
314
 
            <quote><literal>110s 110s 110s</literal></quote>, and
315
 
            <quote><literal>5m 30s</literal></quote> will give a value
316
 
            of five minutes and thirty seconds.
 
226
 
 
227
      <varlistentry>
 
228
        <term><option>secfile<literal> = </literal><replaceable
 
229
        >FILENAME</replaceable></option></term>
 
230
        <listitem>
 
231
          <para>
 
232
            This option is only used if <option>secret</option> is not
 
233
            specified, in which case this option is
 
234
            <emphasis>required</emphasis>.
 
235
          </para>
 
236
          <para>
 
237
            Similar to the <option>secret</option>, except the secret
 
238
            data is in an external file.  The contents of the file
 
239
            should <emphasis>not</emphasis> be base64-encoded, but
 
240
            will be sent to clients verbatim.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
 
 
245
      <varlistentry>
 
246
        <term><option><literal>host = </literal><replaceable
 
247
        >STRING</replaceable></option></term>
 
248
        <listitem>
 
249
          <para>
 
250
            This option is <emphasis>optional</emphasis>, but highly
 
251
            <emphasis>recommended</emphasis> unless the
 
252
            <option>checker</option> option is modified to a
 
253
            non-standard value without <quote>%(host)s</quote> in it.
 
254
          </para>
 
255
          <para>
 
256
            Host name for this client.  This is not used by the server
 
257
            directly, but can be, and is by default, used by the
 
258
            checker.  See the <option>checker</option> option.
317
259
          </para>
318
260
        </listitem>
319
261
      </varlistentry>
371
313
        mode is needed to expose an error of this kind.
372
314
      </para>
373
315
    </refsect2>
374
 
    
 
316
 
375
317
  </refsect1>
376
318
  
377
319
  <refsect1 id="files">
402
344
[DEFAULT]
403
345
timeout = 1h
404
346
interval = 5m
405
 
checker = fping -q -- %%(host)s
 
347
checker = fping -q -- %(host)s
406
348
 
407
349
# Client "foo"
408
350
[foo]
431
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
432
374
secfile = /etc/mandos/bar-secret
433
375
timeout = 15m
434
 
approved_by_default = False
435
 
approval_delay = 30s
 
376
 
436
377
      </programlisting>
437
378
    </informalexample>
438
379
  </refsect1>