/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: 2011-07-16 00:29:19 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110716002919-r77yikuiulj42o40
* initramfs-tools-script: Abort if plugin-runner is missing.  Removed
                          workaround for Debian bug #633582; the
                          workaround required getopt, which can not be
                          guaranteed.
* plugin-runner.c (main): Work around Debian bug #633582.
* plugins.d/mandos-client.c (main): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2008-10-07">
 
6
<!ENTITY TIMESTAMP "2011-02-27">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
36
39
      <holder>Teddy Hogeborn</holder>
37
40
      <holder>Björn Påhlsson</holder>
38
41
    </copyright>
62
65
      ><refentrytitle>mandos</refentrytitle>
63
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
64
67
      The file needs to list all clients that should be able to use
65
 
      the service.  All clients listed will be regarded as valid, even
66
 
      if a client was declared invalid in a previous run of the
67
 
      server.
 
68
      the service.  All clients listed will be regarded as enabled,
 
69
      even if a client was disabled in a previous run of the server.
68
70
    </para>
69
71
    <para>
70
72
      The format starts with a <literal>[<replaceable>section
100
102
    <variablelist>
101
103
      
102
104
      <varlistentry>
103
 
        <term><option>timeout<literal> = </literal><replaceable
104
 
        >TIME</replaceable></option></term>
105
 
        <listitem>
106
 
          <para>
107
 
            This option is <emphasis>optional</emphasis>.
108
 
          </para>
109
 
          <para>
110
 
            The timeout is how long the server will wait for a
111
 
            successful checker run until a client is considered
112
 
            invalid - that is, ineligible to get the data this server
113
 
            holds.  By default Mandos will use 1 hour.
114
 
          </para>
115
 
          <para>
116
 
            The <replaceable>TIME</replaceable> is specified as a
117
 
            space-separated number of values, each of which is a
118
 
            number and a one-character suffix.  The suffix must be one
119
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
120
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
121
 
            minutes, hours, and weeks, respectively.  The values are
122
 
            added together to give the total time value, so all of
123
 
            <quote><literal>330s</literal></quote>,
124
 
            <quote><literal>110s 110s 110s</literal></quote>, and
125
 
            <quote><literal>5m 30s</literal></quote> will give a value
126
 
            of five minutes and thirty seconds.
127
 
          </para>
128
 
        </listitem>
129
 
      </varlistentry>
130
 
      
131
 
      <varlistentry>
132
 
        <term><option>interval<literal> = </literal><replaceable
133
 
        >TIME</replaceable></option></term>
134
 
        <listitem>
135
 
          <para>
136
 
            This option is <emphasis>optional</emphasis>.
137
 
          </para>
138
 
          <para>
139
 
            How often to run the checker to confirm that a client is
140
 
            still up.  <emphasis>Note:</emphasis> a new checker will
141
 
            not be started if an old one is still running.  The server
142
 
            will wait for a checker to complete until the above
143
 
            <quote><varname>timeout</varname></quote> occurs, at which
144
 
            time the client will be marked invalid, and any running
145
 
            checker killed.  The default interval is 5 minutes.
146
 
          </para>
147
 
          <para>
148
 
            The format of <replaceable>TIME</replaceable> is the same
149
 
            as for <varname>timeout</varname> above.
 
105
        <term><option>approval_delay<literal> = </literal><replaceable
 
106
        >TIME</replaceable></option></term>
 
107
        <listitem>
 
108
          <para>
 
109
            This option is <emphasis>optional</emphasis>.
 
110
          </para>
 
111
          <para>
 
112
            How long to wait for external approval before resorting to
 
113
            use the <option>approved_by_default</option> value.  The
 
114
            default is <quote>0s</quote>, i.e. not to wait.
 
115
          </para>
 
116
          <para>
 
117
            The format of <replaceable>TIME</replaceable> is the same
 
118
            as for <varname>timeout</varname> below.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
      
 
123
      <varlistentry>
 
124
        <term><option>approval_duration<literal> = </literal
 
125
        ><replaceable>TIME</replaceable></option></term>
 
126
        <listitem>
 
127
          <para>
 
128
            This option is <emphasis>optional</emphasis>.
 
129
          </para>
 
130
          <para>
 
131
            How long an external approval lasts.  The default is 1
 
132
            second.
 
133
          </para>
 
134
          <para>
 
135
            The format of <replaceable>TIME</replaceable> is the same
 
136
            as for <varname>timeout</varname> below.
 
137
          </para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
      
 
141
      <varlistentry>
 
142
        <term><option>approved_by_default<literal> = </literal
 
143
          >{ <literal >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
          <para>
 
149
            Whether to approve a client by default after
 
150
            the <option>approval_delay</option>.  The default
 
151
            is <quote>True</quote>.
150
152
          </para>
151
153
        </listitem>
152
154
      </varlistentry>
169
171
            <varname>PATH</varname> will be searched.  The default
170
172
            value for the checker command is <quote><literal
171
173
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
173
175
          </para>
174
176
          <para>
175
177
            In addition to normal start time expansion, this option
196
198
      </varlistentry>
197
199
      
198
200
      <varlistentry>
 
201
        <term><option><literal>host = </literal><replaceable
 
202
        >STRING</replaceable></option></term>
 
203
        <listitem>
 
204
          <para>
 
205
            This option is <emphasis>optional</emphasis>, but highly
 
206
            <emphasis>recommended</emphasis> unless the
 
207
            <option>checker</option> option is modified to a
 
208
            non-standard value without <quote>%%(host)s</quote> in it.
 
209
          </para>
 
210
          <para>
 
211
            Host name for this client.  This is not used by the server
 
212
            directly, but can be, and is by default, used by the
 
213
            checker.  See the <option>checker</option> option.
 
214
          </para>
 
215
        </listitem>
 
216
      </varlistentry>
 
217
      
 
218
      <varlistentry>
 
219
        <term><option>interval<literal> = </literal><replaceable
 
220
        >TIME</replaceable></option></term>
 
221
        <listitem>
 
222
          <para>
 
223
            This option is <emphasis>optional</emphasis>.
 
224
          </para>
 
225
          <para>
 
226
            How often to run the checker to confirm that a client is
 
227
            still up.  <emphasis>Note:</emphasis> a new checker will
 
228
            not be started if an old one is still running.  The server
 
229
            will wait for a checker to complete until the below
 
230
            <quote><varname>timeout</varname></quote> occurs, at which
 
231
            time the client will be disabled, and any running checker
 
232
            killed.  The default interval is 5 minutes.
 
233
          </para>
 
234
          <para>
 
235
            The format of <replaceable>TIME</replaceable> is the same
 
236
            as for <varname>timeout</varname> below.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>secfile<literal> = </literal><replaceable
 
243
        >FILENAME</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is only used if <option>secret</option> is not
 
247
            specified, in which case this option is
 
248
            <emphasis>required</emphasis>.
 
249
          </para>
 
250
          <para>
 
251
            Similar to the <option>secret</option>, except the secret
 
252
            data is in an external file.  The contents of the file
 
253
            should <emphasis>not</emphasis> be base64-encoded, but
 
254
            will be sent to clients verbatim.
 
255
          </para>
 
256
          <para>
 
257
            File names of the form <filename>~user/foo/bar</filename>
 
258
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
259
            are supported.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
199
265
        <term><option>secret<literal> = </literal><replaceable
200
266
        >BASE64_ENCODED_DATA</replaceable></option></term>
201
267
        <listitem>
226
292
      </varlistentry>
227
293
      
228
294
      <varlistentry>
229
 
        <term><option>secfile<literal> = </literal><replaceable
230
 
        >FILENAME</replaceable></option></term>
231
 
        <listitem>
232
 
          <para>
233
 
            This option is only used if <option>secret</option> is not
234
 
            specified, in which case this option is
235
 
            <emphasis>required</emphasis>.
236
 
          </para>
237
 
          <para>
238
 
            Similar to the <option>secret</option>, except the secret
239
 
            data is in an external file.  The contents of the file
240
 
            should <emphasis>not</emphasis> be base64-encoded, but
241
 
            will be sent to clients verbatim.
242
 
          </para>
243
 
          <para>
244
 
            File names of the form <filename>~user/foo/bar</filename>
245
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
246
 
            are supported.
247
 
          </para>
248
 
        </listitem>
249
 
      </varlistentry>
250
 
      
251
 
      <varlistentry>
252
 
        <term><option><literal>host = </literal><replaceable
253
 
        >STRING</replaceable></option></term>
254
 
        <listitem>
255
 
          <para>
256
 
            This option is <emphasis>optional</emphasis>, but highly
257
 
            <emphasis>recommended</emphasis> unless the
258
 
            <option>checker</option> option is modified to a
259
 
            non-standard value without <quote>%(host)s</quote> in it.
260
 
          </para>
261
 
          <para>
262
 
            Host name for this client.  This is not used by the server
263
 
            directly, but can be, and is by default, used by the
264
 
            checker.  See the <option>checker</option> option.
 
295
        <term><option>timeout<literal> = </literal><replaceable
 
296
        >TIME</replaceable></option></term>
 
297
        <listitem>
 
298
          <para>
 
299
            This option is <emphasis>optional</emphasis>.
 
300
          </para>
 
301
          <para>
 
302
            The timeout is how long the server will wait (for either a
 
303
            successful checker run or a client receiving its secret)
 
304
            until a client is disabled and not allowed to get the data
 
305
            this server holds.  By default Mandos will use 1 hour.
 
306
          </para>
 
307
          <para>
 
308
            The <replaceable>TIME</replaceable> is specified as a
 
309
            space-separated number of values, each of which is a
 
310
            number and a one-character suffix.  The suffix must be one
 
311
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
312
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
313
            minutes, hours, and weeks, respectively.  The values are
 
314
            added together to give the total time value, so all of
 
315
            <quote><literal>330s</literal></quote>,
 
316
            <quote><literal>110s 110s 110s</literal></quote>, and
 
317
            <quote><literal>5m 30s</literal></quote> will give a value
 
318
            of five minutes and thirty seconds.
265
319
          </para>
266
320
        </listitem>
267
321
      </varlistentry>
304
358
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
305
359
        ></quote> will be replaced by the value of the attribute
306
360
        <varname>foo</varname> of the internal
307
 
        <quote><classname>Client</classname></quote> object.  See the
308
 
        source code for details, and let the authors know of any
309
 
        attributes that are useful so they may be preserved to any new
310
 
        versions of this software.
 
361
        <quote><classname>Client</classname></quote> object in the
 
362
        Mandos server.  The currently allowed values for
 
363
        <replaceable>foo</replaceable> are:
 
364
        <quote><literal>approval_delay</literal></quote>,
 
365
        <quote><literal>approval_duration</literal></quote>,
 
366
        <quote><literal>created</literal></quote>,
 
367
        <quote><literal>enabled</literal></quote>,
 
368
        <quote><literal>fingerprint</literal></quote>,
 
369
        <quote><literal>host</literal></quote>,
 
370
        <quote><literal>interval</literal></quote>,
 
371
        <quote><literal>last_approval_request</literal></quote>,
 
372
        <quote><literal>last_checked_ok</literal></quote>,
 
373
        <quote><literal>last_enabled</literal></quote>,
 
374
        <quote><literal>name</literal></quote>,
 
375
        <quote><literal>timeout</literal></quote>, and, if using
 
376
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
377
        See the source code for details.  <emphasis role="strong"
 
378
        >Currently, <emphasis>none</emphasis> of these attributes
 
379
        except <quote><literal>host</literal></quote> are guaranteed
 
380
        to be valid in future versions.</emphasis> Therefore, please
 
381
        let the authors know of any attributes that are useful so they
 
382
        may be preserved to any new versions of this software.
311
383
      </para>
312
384
      <para>
313
385
        Note that this means that, in order to include an actual
350
422
[DEFAULT]
351
423
timeout = 1h
352
424
interval = 5m
353
 
checker = fping -q -- %(host)s
 
425
checker = fping -q -- %%(host)s
354
426
 
355
427
# Client "foo"
356
428
[foo]
379
451
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
452
secfile = /etc/mandos/bar-secret
381
453
timeout = 15m
 
454
approved_by_default = False
 
455
approval_delay = 30s
382
456
      </programlisting>
383
457
    </informalexample>
384
458
  </refsect1>