/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-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

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 "2012-06-23">
 
6
<!ENTITY TIMESTAMP "2011-02-27">
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>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
39
 
      <year>2012</year>
40
39
      <holder>Teddy Hogeborn</holder>
41
40
      <holder>Björn Påhlsson</holder>
42
41
    </copyright>
66
65
      ><refentrytitle>mandos</refentrytitle>
67
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
67
      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.
 
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.
76
70
    </para>
77
71
    <para>
78
72
      The format starts with a <literal>[<replaceable>section
167
161
            This option is <emphasis>optional</emphasis>.
168
162
          </para>
169
163
          <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>
 
164
            This option allows you to override the default shell
 
165
            command that the server will use to check if the client is
 
166
            still up.  Any output of the command will be ignored, only
 
167
            the exit code is checked:  If the exit code of the command
 
168
            is zero, the client is considered up.  The command will be
 
169
            run using <quote><command><filename>/bin/sh</filename>
176
170
            <option>-c</option></command></quote>, so
177
171
            <varname>PATH</varname> will be searched.  The default
178
172
            value for the checker command is <quote><literal
188
182
      </varlistentry>
189
183
      
190
184
      <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
185
        <term><option>fingerprint<literal> = </literal
215
186
        ><replaceable>HEXSTRING</replaceable></option></term>
216
187
        <listitem>
258
229
            will wait for a checker to complete until the below
259
230
            <quote><varname>timeout</varname></quote> occurs, at which
260
231
            time the client will be disabled, and any running checker
261
 
            killed.  The default interval is 2 minutes.
 
232
            killed.  The default interval is 5 minutes.
262
233
          </para>
263
234
          <para>
264
235
            The format of <replaceable>TIME</replaceable> is the same
328
299
            This option is <emphasis>optional</emphasis>.
329
300
          </para>
330
301
          <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>.
 
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.
358
319
          </para>
359
320
        </listitem>
360
321
      </varlistentry>
404
365
        <quote><literal>approval_duration</literal></quote>,
405
366
        <quote><literal>created</literal></quote>,
406
367
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>expires</literal></quote>,
408
368
        <quote><literal>fingerprint</literal></quote>,
409
369
        <quote><literal>host</literal></quote>,
410
370
        <quote><literal>interval</literal></quote>,
460
420
    <informalexample>
461
421
      <programlisting>
462
422
[DEFAULT]
463
 
timeout = PT5M
464
 
interval = PT2M
 
423
timeout = 1h
 
424
interval = 5m
465
425
checker = fping -q -- %%(host)s
466
426
 
467
427
# Client "foo"
484
444
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
445
        QlnHIvPzEArRQLo=
486
446
host = foo.example.org
487
 
interval = PT1M
 
447
interval = 1m
488
448
 
489
449
# Client "bar"
490
450
[bar]
491
451
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
452
secfile = /etc/mandos/bar-secret
493
 
timeout = PT15M
 
453
timeout = 15m
494
454
approved_by_default = False
495
 
approval_delay = PT30S
 
455
approval_delay = 30s
496
456
      </programlisting>
497
457
    </informalexample>
498
458
  </refsect1>
500
460
  <refsect1 id="see_also">
501
461
    <title>SEE ALSO</title>
502
462
    <para>
503
 
      <citerefentry><refentrytitle>intro</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
505
463
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
506
464
      <manvolnum>8</manvolnum></citerefentry>,
507
465
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
466
      <manvolnum>5</manvolnum></citerefentry>,
509
467
      <citerefentry><refentrytitle>mandos</refentrytitle>
510
 
      <manvolnum>8</manvolnum></citerefentry>,
511
 
      <citerefentry><refentrytitle>fping</refentrytitle>
512
468
      <manvolnum>8</manvolnum></citerefentry>
513
469
    </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
470
  </refsect1>
529
471
</refentry>
530
472
<!-- Local Variables: -->