/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: 2012-01-01 01:16:15 UTC
  • Revision ID: teddy@recompile.se-20120101011615-1jzyuxbw1z4700a3
* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2012-01-01">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
39
39
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
40
      <holder>Teddy Hogeborn</holder>
44
41
      <holder>Björn Påhlsson</holder>
45
42
    </copyright>
69
66
      ><refentrytitle>mandos</refentrytitle>
70
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
71
68
      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.
 
69
      the service.  All clients listed will be regarded as enabled,
 
70
      even if a client was disabled in a previous run of the server.
79
71
    </para>
80
72
    <para>
81
73
      The format starts with a <literal>[<replaceable>section
120
112
          <para>
121
113
            How long to wait for external approval before resorting to
122
114
            use the <option>approved_by_default</option> value.  The
123
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
115
            default is <quote>0s</quote>, i.e. not to wait.
124
116
          </para>
125
117
          <para>
126
118
            The format of <replaceable>TIME</replaceable> is the same
170
162
            This option is <emphasis>optional</emphasis>.
171
163
          </para>
172
164
          <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>
 
165
            This option allows you to override the default shell
 
166
            command that the server will use to check if the client is
 
167
            still up.  Any output of the command will be ignored, only
 
168
            the exit code is checked:  If the exit code of the command
 
169
            is zero, the client is considered up.  The command will be
 
170
            run using <quote><command><filename>/bin/sh</filename>
179
171
            <option>-c</option></command></quote>, so
180
172
            <varname>PATH</varname> will be searched.  The default
181
173
            value for the checker command is <quote><literal
182
174
            ><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.
 
175
            >--</option> %%(host)s</literal></quote>.
190
176
          </para>
191
177
          <para>
192
178
            In addition to normal start time expansion, this option
344
330
            <option>extended_timeout</option> option.
345
331
          </para>
346
332
          <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.
 
333
            The <replaceable>TIME</replaceable> is specified as a
 
334
            space-separated number of values, each of which is a
 
335
            number and a one-character suffix.  The suffix must be one
 
336
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
337
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
338
            minutes, hours, and weeks, respectively.  The values are
 
339
            added together to give the total time value, so all of
 
340
            <quote><literal>330s</literal></quote>,
 
341
            <quote><literal>110s 110s 110s</literal></quote>, and
 
342
            <quote><literal>5m 30s</literal></quote> will give a value
 
343
            of five minutes and thirty seconds.
353
344
          </para>
354
345
        </listitem>
355
346
      </varlistentry>
413
404
        <quote><literal>approval_duration</literal></quote>,
414
405
        <quote><literal>created</literal></quote>,
415
406
        <quote><literal>enabled</literal></quote>,
416
 
        <quote><literal>expires</literal></quote>,
417
407
        <quote><literal>fingerprint</literal></quote>,
418
408
        <quote><literal>host</literal></quote>,
419
409
        <quote><literal>interval</literal></quote>,
469
459
    <informalexample>
470
460
      <programlisting>
471
461
[DEFAULT]
472
 
timeout = PT5M
473
 
interval = PT2M
 
462
timeout = 5m
 
463
interval = 2m
474
464
checker = fping -q -- %%(host)s
475
465
 
476
466
# Client "foo"
493
483
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
494
484
        QlnHIvPzEArRQLo=
495
485
host = foo.example.org
496
 
interval = PT1M
 
486
interval = 1m
497
487
 
498
488
# Client "bar"
499
489
[bar]
500
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
501
491
secfile = /etc/mandos/bar-secret
502
 
timeout = PT15M
 
492
timeout = 15m
503
493
approved_by_default = False
504
 
approval_delay = PT30S
 
494
approval_delay = 30s
505
495
      </programlisting>
506
496
    </informalexample>
507
497
  </refsect1>
516
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
517
507
      <manvolnum>5</manvolnum></citerefentry>,
518
508
      <citerefentry><refentrytitle>mandos</refentrytitle>
519
 
      <manvolnum>8</manvolnum></citerefentry>,
520
 
      <citerefentry><refentrytitle>fping</refentrytitle>
521
509
      <manvolnum>8</manvolnum></citerefentry>
522
510
    </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
511
  </refsect1>
538
512
</refentry>
539
513
<!-- Local Variables: -->