/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: Björn Påhlsson
  • Date: 2011-11-24 20:17:38 UTC
  • mfrom: (505.3.10 client-network-hooks)
  • mto: This revision was merged to the branch mainline in revision 525.
  • Revision ID: belorn@fukt.bsnet.se-20111124201738-tjjpqg75110ocwdt
merge

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 "2015-07-20">
 
6
<!ENTITY TIMESTAMP "2011-10-10">
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
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
39
      <holder>Teddy Hogeborn</holder>
44
40
      <holder>Björn Påhlsson</holder>
45
41
    </copyright>
69
65
      ><refentrytitle>mandos</refentrytitle>
70
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
71
67
      The file needs to list all clients that should be able to use
72
 
      the service.  The settings in this file can be overridden by
73
 
      runtime changes to the server, which it saves across restarts.
74
 
      (See the section called <quote>PERSISTENT STATE</quote> in
75
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
77
 
      >changes</emphasis> to this file (including adding and removing
78
 
      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.
79
70
    </para>
80
71
    <para>
81
72
      The format starts with a <literal>[<replaceable>section
120
111
          <para>
121
112
            How long to wait for external approval before resorting to
122
113
            use the <option>approved_by_default</option> value.  The
123
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
124
115
          </para>
125
116
          <para>
126
117
            The format of <replaceable>TIME</replaceable> is the same
170
161
            This option is <emphasis>optional</emphasis>.
171
162
          </para>
172
163
          <para>
173
 
            This option overrides the default shell command that the
174
 
            server will use to check if the client is still up.  Any
175
 
            output of the command will be ignored, only the exit code
176
 
            is checked:  If the exit code of the command is zero, the
177
 
            client is considered up.  The command will be run using
178
 
            <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>
179
170
            <option>-c</option></command></quote>, so
180
171
            <varname>PATH</varname> will be searched.  The default
181
172
            value for the checker command is <quote><literal
182
173
            ><command>fping</command> <option>-q</option> <option
183
 
            >--</option> %%(host)s</literal></quote>.  Note that
184
 
            <command>mandos-keygen</command>, when generating output
185
 
            to be inserted into this file, normally looks for an SSH
186
 
            server on the Mandos client, and, if it find one, outputs
187
 
            a <option>checker</option> option to check for the
188
 
            client’s key fingerprint – this is more secure against
189
 
            spoofing.
 
174
            >--</option> %%(host)s</literal></quote>.
190
175
          </para>
191
176
          <para>
192
177
            In addition to normal start time expansion, this option
344
329
            <option>extended_timeout</option> option.
345
330
          </para>
346
331
          <para>
347
 
            The <replaceable>TIME</replaceable> is specified as an RFC
348
 
            3339 duration; for example
349
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
 
            one year, two months, three days, four hours, five
351
 
            minutes, and six seconds.  Some values can be omitted, see
352
 
            RFC 3339 Appendix A for details.
353
 
          </para>
354
 
        </listitem>
355
 
      </varlistentry>
356
 
      
357
 
      <varlistentry>
358
 
        <term><option>enabled<literal> = </literal>{ <literal
359
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
360
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
361
 
        >no</literal> | <literal>false</literal> | <literal
362
 
        >off</literal> }</option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            Whether this client should be enabled by default.  The
366
 
            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.
367
343
          </para>
368
344
        </listitem>
369
345
      </varlistentry>
413
389
        <quote><literal>approval_duration</literal></quote>,
414
390
        <quote><literal>created</literal></quote>,
415
391
        <quote><literal>enabled</literal></quote>,
416
 
        <quote><literal>expires</literal></quote>,
417
392
        <quote><literal>fingerprint</literal></quote>,
418
393
        <quote><literal>host</literal></quote>,
419
394
        <quote><literal>interval</literal></quote>,
469
444
    <informalexample>
470
445
      <programlisting>
471
446
[DEFAULT]
472
 
timeout = PT5M
473
 
interval = PT2M
 
447
timeout = 5m
 
448
interval = 2m
474
449
checker = fping -q -- %%(host)s
475
450
 
476
451
# Client "foo"
493
468
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
494
469
        QlnHIvPzEArRQLo=
495
470
host = foo.example.org
496
 
interval = PT1M
 
471
interval = 1m
497
472
 
498
473
# Client "bar"
499
474
[bar]
500
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
501
476
secfile = /etc/mandos/bar-secret
502
 
timeout = PT15M
 
477
timeout = 15m
503
478
approved_by_default = False
504
 
approval_delay = PT30S
 
479
approval_delay = 30s
505
480
      </programlisting>
506
481
    </informalexample>
507
482
  </refsect1>
516
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
517
492
      <manvolnum>5</manvolnum></citerefentry>,
518
493
      <citerefentry><refentrytitle>mandos</refentrytitle>
519
 
      <manvolnum>8</manvolnum></citerefentry>,
520
 
      <citerefentry><refentrytitle>fping</refentrytitle>
521
494
      <manvolnum>8</manvolnum></citerefentry>
522
495
    </para>
523
 
    <variablelist>
524
 
      <varlistentry>
525
 
        <term>
526
 
          RFC 3339: <citetitle>Date and Time on the Internet:
527
 
          Timestamps</citetitle>
528
 
        </term>
529
 
      <listitem>
530
 
        <para>
531
 
          The time intervals are in the "duration" format, as
532
 
          specified in ABNF in Appendix A of RFC 3339.
533
 
        </para>
534
 
      </listitem>
535
 
      </varlistentry>
536
 
    </variablelist>
537
496
  </refsect1>
538
497
</refentry>
539
498
<!-- Local Variables: -->