/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-10-09 16:38:18 UTC
  • mfrom: (513 trunk)
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 514.
  • Revision ID: teddy@recompile.se-20111009163818-ihb35bqq0iat18k2
Merge from trunk.

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 "2011-10-03">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
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
117
111
          <para>
118
112
            How long to wait for external approval before resorting to
119
113
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
121
115
          </para>
122
116
          <para>
123
117
            The format of <replaceable>TIME</replaceable> is the same
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
179
173
            ><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.
 
174
            >--</option> %%(host)s</literal></quote>.
187
175
          </para>
188
176
          <para>
189
177
            In addition to normal start time expansion, this option
202
190
          </para>
203
191
          <para>
204
192
            Extended timeout is an added timeout that is given once
205
 
            after a password has been sent successfully to a client.
 
193
            after a password has been sent sucessfully to a client.
206
194
            The timeout is by default longer than the normal timeout,
207
195
            and is used for handling the extra long downtime while a
208
196
            machine is booting up.  Time to take into consideration
341
329
            <option>extended_timeout</option> option.
342
330
          </para>
343
331
          <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>.
 
332
            The <replaceable>TIME</replaceable> is specified as a
 
333
            space-separated number of values, each of which is a
 
334
            number and a one-character suffix.  The suffix must be one
 
335
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
336
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
337
            minutes, hours, and weeks, respectively.  The values are
 
338
            added together to give the total time value, so all of
 
339
            <quote><literal>330s</literal></quote>,
 
340
            <quote><literal>110s 110s 110s</literal></quote>, and
 
341
            <quote><literal>5m 30s</literal></quote> will give a value
 
342
            of five minutes and thirty seconds.
364
343
          </para>
365
344
        </listitem>
366
345
      </varlistentry>
410
389
        <quote><literal>approval_duration</literal></quote>,
411
390
        <quote><literal>created</literal></quote>,
412
391
        <quote><literal>enabled</literal></quote>,
413
 
        <quote><literal>expires</literal></quote>,
414
392
        <quote><literal>fingerprint</literal></quote>,
415
393
        <quote><literal>host</literal></quote>,
416
394
        <quote><literal>interval</literal></quote>,
466
444
    <informalexample>
467
445
      <programlisting>
468
446
[DEFAULT]
469
 
timeout = PT5M
470
 
interval = PT2M
 
447
timeout = 5m
 
448
interval = 2m
471
449
checker = fping -q -- %%(host)s
472
450
 
473
451
# Client "foo"
490
468
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
491
469
        QlnHIvPzEArRQLo=
492
470
host = foo.example.org
493
 
interval = PT1M
 
471
interval = 1m
494
472
 
495
473
# Client "bar"
496
474
[bar]
497
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
498
476
secfile = /etc/mandos/bar-secret
499
 
timeout = PT15M
 
477
timeout = 15m
500
478
approved_by_default = False
501
 
approval_delay = PT30S
 
479
approval_delay = 30s
502
480
      </programlisting>
503
481
    </informalexample>
504
482
  </refsect1>
513
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
514
492
      <manvolnum>5</manvolnum></citerefentry>,
515
493
      <citerefentry><refentrytitle>mandos</refentrytitle>
516
 
      <manvolnum>8</manvolnum></citerefentry>,
517
 
      <citerefentry><refentrytitle>fping</refentrytitle>
518
494
      <manvolnum>8</manvolnum></citerefentry>
519
495
    </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
496
  </refsect1>
535
497
</refentry>
536
498
<!-- Local Variables: -->