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

Update copyright year to "2010" wherever appropriate.

* plugin-runner.c: - '' -
* plugins.d/mandos-client.c: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2012-06-23">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
38
      <holder>Teddy Hogeborn</holder>
41
39
      <holder>Björn Påhlsson</holder>
42
40
    </copyright>
66
64
      ><refentrytitle>mandos</refentrytitle>
67
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
66
      The file needs to list all clients that should be able to use
69
 
      the service.  The settings in this file can be overridden by
70
 
      runtime changes to the server, which it saves across restarts.
71
 
      (See the section called <quote>PERSISTENT STATE</quote> in
72
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
73
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
74
 
      >changes</emphasis> to this file (including adding and removing
75
 
      clients) will, at startup, override changes done during runtime.
 
67
      the service.  All clients listed will be regarded as enabled,
 
68
      even if a client was disabled in a previous run of the server.
76
69
    </para>
77
70
    <para>
78
71
      The format starts with a <literal>[<replaceable>section
167
160
            This option is <emphasis>optional</emphasis>.
168
161
          </para>
169
162
          <para>
170
 
            This option overrides the default shell command that the
171
 
            server will use to check if the client is still up.  Any
172
 
            output of the command will be ignored, only the exit code
173
 
            is checked:  If the exit code of the command is zero, the
174
 
            client is considered up.  The command will be run using
175
 
            <quote><command><filename>/bin/sh</filename>
 
163
            This option allows you to override the default shell
 
164
            command that the server will use to check if the client is
 
165
            still up.  Any output of the command will be ignored, only
 
166
            the exit code is checked:  If the exit code of the command
 
167
            is zero, the client is considered up.  The command will be
 
168
            run using <quote><command><filename>/bin/sh</filename>
176
169
            <option>-c</option></command></quote>, so
177
170
            <varname>PATH</varname> will be searched.  The default
178
171
            value for the checker command is <quote><literal
188
181
      </varlistentry>
189
182
      
190
183
      <varlistentry>
191
 
        <term><option>extended_timeout<literal> = </literal><replaceable
192
 
        >TIME</replaceable></option></term>
193
 
        <listitem>
194
 
          <para>
195
 
            This option is <emphasis>optional</emphasis>.
196
 
          </para>
197
 
          <para>
198
 
            Extended timeout is an added timeout that is given once
199
 
            after a password has been sent successfully to a client.
200
 
            The timeout is by default longer than the normal timeout,
201
 
            and is used for handling the extra long downtime while a
202
 
            machine is booting up.  Time to take into consideration
203
 
            when changing this value is file system checks and quota
204
 
            checks.  The default value is 15 minutes.
205
 
          </para>
206
 
          <para>
207
 
            The format of <replaceable>TIME</replaceable> is the same
208
 
            as for <varname>timeout</varname> below.
209
 
          </para>
210
 
        </listitem>
211
 
      </varlistentry>
212
 
      
213
 
      <varlistentry>
214
184
        <term><option>fingerprint<literal> = </literal
215
185
        ><replaceable>HEXSTRING</replaceable></option></term>
216
186
        <listitem>
258
228
            will wait for a checker to complete until the below
259
229
            <quote><varname>timeout</varname></quote> occurs, at which
260
230
            time the client will be disabled, and any running checker
261
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
262
232
          </para>
263
233
          <para>
264
234
            The format of <replaceable>TIME</replaceable> is the same
328
298
            This option is <emphasis>optional</emphasis>.
329
299
          </para>
330
300
          <para>
331
 
            The timeout is how long the server will wait, after a
332
 
            successful checker run, until a client is disabled and not
333
 
            allowed to get the data this server holds.  By default
334
 
            Mandos will use 5 minutes.  See also the
335
 
            <option>extended_timeout</option> option.
336
 
          </para>
337
 
          <para>
338
 
            The <replaceable>TIME</replaceable> is specified as an RFC
339
 
            3339 duration; for example
340
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
341
 
            one year, two months, three days, four hours, five
342
 
            minutes, and six seconds.  Some values can be omitted, see
343
 
            RFC 3339 Appendix A for details.
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
 
      
348
 
      <varlistentry>
349
 
        <term><option>enabled<literal> = </literal>{ <literal
350
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
351
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
352
 
        >no</literal> | <literal>false</literal> | <literal
353
 
        >off</literal> }</option></term>
354
 
        <listitem>
355
 
          <para>
356
 
            Whether this client should be enabled by default.  The
357
 
            default is <quote>true</quote>.
 
301
            The timeout is how long the server will wait (for either a
 
302
            successful checker run or a client receiving its secret)
 
303
            until a client is disabled and not allowed to get the data
 
304
            this server holds.  By default Mandos will use 1 hour.
 
305
          </para>
 
306
          <para>
 
307
            The <replaceable>TIME</replaceable> is specified as a
 
308
            space-separated number of values, each of which is a
 
309
            number and a one-character suffix.  The suffix must be one
 
310
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
311
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
312
            minutes, hours, and weeks, respectively.  The values are
 
313
            added together to give the total time value, so all of
 
314
            <quote><literal>330s</literal></quote>,
 
315
            <quote><literal>110s 110s 110s</literal></quote>, and
 
316
            <quote><literal>5m 30s</literal></quote> will give a value
 
317
            of five minutes and thirty seconds.
358
318
          </para>
359
319
        </listitem>
360
320
      </varlistentry>
397
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
358
        ></quote> will be replaced by the value of the attribute
399
359
        <varname>foo</varname> of the internal
400
 
        <quote><classname>Client</classname></quote> object in the
401
 
        Mandos server.  The currently allowed values for
402
 
        <replaceable>foo</replaceable> are:
403
 
        <quote><literal>approval_delay</literal></quote>,
404
 
        <quote><literal>approval_duration</literal></quote>,
405
 
        <quote><literal>created</literal></quote>,
406
 
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>expires</literal></quote>,
408
 
        <quote><literal>fingerprint</literal></quote>,
409
 
        <quote><literal>host</literal></quote>,
410
 
        <quote><literal>interval</literal></quote>,
411
 
        <quote><literal>last_approval_request</literal></quote>,
412
 
        <quote><literal>last_checked_ok</literal></quote>,
413
 
        <quote><literal>last_enabled</literal></quote>,
414
 
        <quote><literal>name</literal></quote>,
415
 
        <quote><literal>timeout</literal></quote>, and, if using
416
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
417
 
        See the source code for details.  <emphasis role="strong"
418
 
        >Currently, <emphasis>none</emphasis> of these attributes
419
 
        except <quote><literal>host</literal></quote> are guaranteed
420
 
        to be valid in future versions.</emphasis> Therefore, please
421
 
        let the authors know of any attributes that are useful so they
422
 
        may be preserved to any new versions of this software.
 
360
        <quote><classname>Client</classname></quote> object.  See the
 
361
        source code for details, and let the authors know of any
 
362
        attributes that are useful so they may be preserved to any new
 
363
        versions of this software.
423
364
      </para>
424
365
      <para>
425
366
        Note that this means that, in order to include an actual
460
401
    <informalexample>
461
402
      <programlisting>
462
403
[DEFAULT]
463
 
timeout = PT5M
464
 
interval = PT2M
 
404
timeout = 1h
 
405
interval = 5m
465
406
checker = fping -q -- %%(host)s
466
407
 
467
408
# Client "foo"
484
425
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
426
        QlnHIvPzEArRQLo=
486
427
host = foo.example.org
487
 
interval = PT1M
 
428
interval = 1m
488
429
 
489
430
# Client "bar"
490
431
[bar]
491
432
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
433
secfile = /etc/mandos/bar-secret
493
 
timeout = PT15M
 
434
timeout = 15m
494
435
approved_by_default = False
495
 
approval_delay = PT30S
 
436
approval_delay = 30s
496
437
      </programlisting>
497
438
    </informalexample>
498
439
  </refsect1>
500
441
  <refsect1 id="see_also">
501
442
    <title>SEE ALSO</title>
502
443
    <para>
503
 
      <citerefentry><refentrytitle>intro</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
505
444
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
506
445
      <manvolnum>8</manvolnum></citerefentry>,
507
446
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
447
      <manvolnum>5</manvolnum></citerefentry>,
509
448
      <citerefentry><refentrytitle>mandos</refentrytitle>
510
 
      <manvolnum>8</manvolnum></citerefentry>,
511
 
      <citerefentry><refentrytitle>fping</refentrytitle>
512
449
      <manvolnum>8</manvolnum></citerefentry>
513
450
    </para>
514
 
    <variablelist>
515
 
      <varlistentry>
516
 
        <term>
517
 
          RFC 3339: <citetitle>Date and Time on the Internet:
518
 
          Timestamps</citetitle>
519
 
        </term>
520
 
      <listitem>
521
 
        <para>
522
 
          The time intervals are in the "duration" format, as
523
 
          specified in ABNF in Appendix A of RFC 3339.
524
 
        </para>
525
 
      </listitem>
526
 
      </varlistentry>
527
 
    </variablelist>
528
451
  </refsect1>
529
452
</refentry>
530
453
<!-- Local Variables: -->