/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: 2010-09-26 18:32:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100926183258-n31ux2r8d06m1hi1
Update copyright year to "2010" wherever appropriate.

* DBUS-API: Added copyright and license statement.
* README: Mention new "plymouth" plugin.
* debian/control: Depend on python-2.6 or python-multiprocessing.
* debian/mandos-client.README.Debian: Update info about DEVICE setting
                                      of initramfs.conf.
* mandos-ctl: Added copyright and license statement.
* mandos-monitor: - '' -
* plugins.d/plymouth.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 "2014-06-22">
 
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
117
110
          <para>
118
111
            How long to wait for external approval before resorting to
119
112
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
113
            default is <quote>0s</quote>, i.e. not to wait.
121
114
          </para>
122
115
          <para>
123
116
            The format of <replaceable>TIME</replaceable> is the same
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
179
172
            ><command>fping</command> <option>-q</option> <option
180
 
            >--</option> %%(host)s</literal></quote>.  Note that
181
 
            <command>mandos-keygen</command>, when generating output
182
 
            to be inserted into this file, normally looks for an SSH
183
 
            server on the Mandos client, and, if it find one, outputs
184
 
            a <option>checker</option> option to check for the
185
 
            client’s key fingerprint – this is more secure against
186
 
            spoofing.
 
173
            >--</option> %%(host)s</literal></quote>.
187
174
          </para>
188
175
          <para>
189
176
            In addition to normal start time expansion, this option
194
181
      </varlistentry>
195
182
      
196
183
      <varlistentry>
197
 
        <term><option>extended_timeout<literal> = </literal><replaceable
198
 
        >TIME</replaceable></option></term>
199
 
        <listitem>
200
 
          <para>
201
 
            This option is <emphasis>optional</emphasis>.
202
 
          </para>
203
 
          <para>
204
 
            Extended timeout is an added timeout that is given once
205
 
            after a password has been sent successfully to a client.
206
 
            The timeout is by default longer than the normal timeout,
207
 
            and is used for handling the extra long downtime while a
208
 
            machine is booting up.  Time to take into consideration
209
 
            when changing this value is file system checks and quota
210
 
            checks.  The default value is 15 minutes.
211
 
          </para>
212
 
          <para>
213
 
            The format of <replaceable>TIME</replaceable> is the same
214
 
            as for <varname>timeout</varname> below.
215
 
          </para>
216
 
        </listitem>
217
 
      </varlistentry>
218
 
      
219
 
      <varlistentry>
220
184
        <term><option>fingerprint<literal> = </literal
221
185
        ><replaceable>HEXSTRING</replaceable></option></term>
222
186
        <listitem>
264
228
            will wait for a checker to complete until the below
265
229
            <quote><varname>timeout</varname></quote> occurs, at which
266
230
            time the client will be disabled, and any running checker
267
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
268
232
          </para>
269
233
          <para>
270
234
            The format of <replaceable>TIME</replaceable> is the same
334
298
            This option is <emphasis>optional</emphasis>.
335
299
          </para>
336
300
          <para>
337
 
            The timeout is how long the server will wait, after a
338
 
            successful checker run, until a client is disabled and not
339
 
            allowed to get the data this server holds.  By default
340
 
            Mandos will use 5 minutes.  See also the
341
 
            <option>extended_timeout</option> option.
342
 
          </para>
343
 
          <para>
344
 
            The <replaceable>TIME</replaceable> is specified as an RFC
345
 
            3339 duration; for example
346
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
347
 
            one year, two months, three days, four hours, five
348
 
            minutes, and six seconds.  Some values can be omitted, see
349
 
            RFC 3339 Appendix A for details.
350
 
          </para>
351
 
        </listitem>
352
 
      </varlistentry>
353
 
      
354
 
      <varlistentry>
355
 
        <term><option>enabled<literal> = </literal>{ <literal
356
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
357
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
358
 
        >no</literal> | <literal>false</literal> | <literal
359
 
        >off</literal> }</option></term>
360
 
        <listitem>
361
 
          <para>
362
 
            Whether this client should be enabled by default.  The
363
 
            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.
364
318
          </para>
365
319
        </listitem>
366
320
      </varlistentry>
403
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
404
358
        ></quote> will be replaced by the value of the attribute
405
359
        <varname>foo</varname> of the internal
406
 
        <quote><classname>Client</classname></quote> object in the
407
 
        Mandos server.  The currently allowed values for
408
 
        <replaceable>foo</replaceable> are:
409
 
        <quote><literal>approval_delay</literal></quote>,
410
 
        <quote><literal>approval_duration</literal></quote>,
411
 
        <quote><literal>created</literal></quote>,
412
 
        <quote><literal>enabled</literal></quote>,
413
 
        <quote><literal>expires</literal></quote>,
414
 
        <quote><literal>fingerprint</literal></quote>,
415
 
        <quote><literal>host</literal></quote>,
416
 
        <quote><literal>interval</literal></quote>,
417
 
        <quote><literal>last_approval_request</literal></quote>,
418
 
        <quote><literal>last_checked_ok</literal></quote>,
419
 
        <quote><literal>last_enabled</literal></quote>,
420
 
        <quote><literal>name</literal></quote>,
421
 
        <quote><literal>timeout</literal></quote>, and, if using
422
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
423
 
        See the source code for details.  <emphasis role="strong"
424
 
        >Currently, <emphasis>none</emphasis> of these attributes
425
 
        except <quote><literal>host</literal></quote> are guaranteed
426
 
        to be valid in future versions.</emphasis> Therefore, please
427
 
        let the authors know of any attributes that are useful so they
428
 
        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.
429
364
      </para>
430
365
      <para>
431
366
        Note that this means that, in order to include an actual
466
401
    <informalexample>
467
402
      <programlisting>
468
403
[DEFAULT]
469
 
timeout = PT5M
470
 
interval = PT2M
 
404
timeout = 1h
 
405
interval = 5m
471
406
checker = fping -q -- %%(host)s
472
407
 
473
408
# Client "foo"
490
425
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
491
426
        QlnHIvPzEArRQLo=
492
427
host = foo.example.org
493
 
interval = PT1M
 
428
interval = 1m
494
429
 
495
430
# Client "bar"
496
431
[bar]
497
432
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
498
433
secfile = /etc/mandos/bar-secret
499
 
timeout = PT15M
 
434
timeout = 15m
500
435
approved_by_default = False
501
 
approval_delay = PT30S
 
436
approval_delay = 30s
502
437
      </programlisting>
503
438
    </informalexample>
504
439
  </refsect1>
506
441
  <refsect1 id="see_also">
507
442
    <title>SEE ALSO</title>
508
443
    <para>
509
 
      <citerefentry><refentrytitle>intro</refentrytitle>
510
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
511
444
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
512
445
      <manvolnum>8</manvolnum></citerefentry>,
513
446
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
447
      <manvolnum>5</manvolnum></citerefentry>,
515
448
      <citerefentry><refentrytitle>mandos</refentrytitle>
516
 
      <manvolnum>8</manvolnum></citerefentry>,
517
 
      <citerefentry><refentrytitle>fping</refentrytitle>
518
449
      <manvolnum>8</manvolnum></citerefentry>
519
450
    </para>
520
 
    <variablelist>
521
 
      <varlistentry>
522
 
        <term>
523
 
          RFC 3339: <citetitle>Date and Time on the Internet:
524
 
          Timestamps</citetitle>
525
 
        </term>
526
 
      <listitem>
527
 
        <para>
528
 
          The time intervals are in the "duration" format, as
529
 
          specified in ABNF in Appendix A of RFC 3339.
530
 
        </para>
531
 
      </listitem>
532
 
      </varlistentry>
533
 
    </variablelist>
534
451
  </refsect1>
535
452
</refentry>
536
453
<!-- Local Variables: -->