/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 at bsnet
  • Date: 2011-12-23 20:00:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20111223200052-nehnjfy0fogvm4ii
* mandos (initlogger): Take new "debug" argument; all callers changed.
                       Only add console logger in debug mode.
  (main/cleanup): Remove temp file on failure.

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 "2016-06-23">
 
6
<!ENTITY TIMESTAMP "2011-11-26">
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
 
      <year>2016</year>
44
39
      <holder>Teddy Hogeborn</holder>
45
40
      <holder>Björn Påhlsson</holder>
46
41
    </copyright>
70
65
      ><refentrytitle>mandos</refentrytitle>
71
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
67
      The file needs to list all clients that should be able to use
73
 
      the service.  The settings in this file can be overridden by
74
 
      runtime changes to the server, which it saves across restarts.
75
 
      (See the section called <quote>PERSISTENT STATE</quote> in
76
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
77
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
78
 
      >changes</emphasis> to this file (including adding and removing
79
 
      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.
80
70
    </para>
81
71
    <para>
82
72
      The format starts with a <literal>[<replaceable>section
121
111
          <para>
122
112
            How long to wait for external approval before resorting to
123
113
            use the <option>approved_by_default</option> value.  The
124
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
125
115
          </para>
126
116
          <para>
127
117
            The format of <replaceable>TIME</replaceable> is the same
171
161
            This option is <emphasis>optional</emphasis>.
172
162
          </para>
173
163
          <para>
174
 
            This option overrides the default shell command that the
175
 
            server will use to check if the client is still up.  Any
176
 
            output of the command will be ignored, only the exit code
177
 
            is checked:  If the exit code of the command is zero, the
178
 
            client is considered up.  The command will be run using
179
 
            <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>
180
170
            <option>-c</option></command></quote>, so
181
171
            <varname>PATH</varname> will be searched.  The default
182
172
            value for the checker command is <quote><literal
183
173
            ><command>fping</command> <option>-q</option> <option
184
 
            >--</option> %%(host)s</literal></quote>.  Note that
185
 
            <command>mandos-keygen</command>, when generating output
186
 
            to be inserted into this file, normally looks for an SSH
187
 
            server on the Mandos client, and, if it find one, outputs
188
 
            a <option>checker</option> option to check for the
189
 
            client’s key fingerprint – this is more secure against
190
 
            spoofing.
 
174
            >--</option> %%(host)s</literal></quote>.
191
175
          </para>
192
176
          <para>
193
177
            In addition to normal start time expansion, this option
230
214
          <para>
231
215
            This option sets the OpenPGP fingerprint that identifies
232
216
            the public key that clients authenticate themselves with
233
 
            through TLS.  The string needs to be in hexadecimal form,
 
217
            through TLS.  The string needs to be in hexidecimal form,
234
218
            but spaces or upper/lower case are not significant.
235
219
          </para>
236
220
        </listitem>
345
329
            <option>extended_timeout</option> option.
346
330
          </para>
347
331
          <para>
348
 
            The <replaceable>TIME</replaceable> is specified as an RFC
349
 
            3339 duration; for example
350
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
351
 
            one year, two months, three days, four hours, five
352
 
            minutes, and six seconds.  Some values can be omitted, see
353
 
            RFC 3339 Appendix A for details.
 
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.
354
343
          </para>
355
344
        </listitem>
356
345
      </varlistentry>
414
403
        <quote><literal>approval_duration</literal></quote>,
415
404
        <quote><literal>created</literal></quote>,
416
405
        <quote><literal>enabled</literal></quote>,
417
 
        <quote><literal>expires</literal></quote>,
418
406
        <quote><literal>fingerprint</literal></quote>,
419
407
        <quote><literal>host</literal></quote>,
420
408
        <quote><literal>interval</literal></quote>,
463
451
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
464
452
      obscure.
465
453
    </para>
466
 
    <xi:include href="bugs.xml"/>
467
454
  </refsect1>
468
455
  
469
456
  <refsect1 id="example">
471
458
    <informalexample>
472
459
      <programlisting>
473
460
[DEFAULT]
474
 
timeout = PT5M
475
 
interval = PT2M
 
461
timeout = 5m
 
462
interval = 2m
476
463
checker = fping -q -- %%(host)s
477
464
 
478
465
# Client "foo"
495
482
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
496
483
        QlnHIvPzEArRQLo=
497
484
host = foo.example.org
498
 
interval = PT1M
 
485
interval = 1m
499
486
 
500
487
# Client "bar"
501
488
[bar]
502
489
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
503
490
secfile = /etc/mandos/bar-secret
504
 
timeout = PT15M
 
491
timeout = 15m
505
492
approved_by_default = False
506
 
approval_delay = PT30S
 
493
approval_delay = 30s
507
494
      </programlisting>
508
495
    </informalexample>
509
496
  </refsect1>
518
505
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
519
506
      <manvolnum>5</manvolnum></citerefentry>,
520
507
      <citerefentry><refentrytitle>mandos</refentrytitle>
521
 
      <manvolnum>8</manvolnum></citerefentry>,
522
 
      <citerefentry><refentrytitle>fping</refentrytitle>
523
508
      <manvolnum>8</manvolnum></citerefentry>
524
509
    </para>
525
 
    <variablelist>
526
 
      <varlistentry>
527
 
        <term>
528
 
          RFC 3339: <citetitle>Date and Time on the Internet:
529
 
          Timestamps</citetitle>
530
 
        </term>
531
 
      <listitem>
532
 
        <para>
533
 
          The time intervals are in the "duration" format, as
534
 
          specified in ABNF in Appendix A of RFC 3339.
535
 
        </para>
536
 
      </listitem>
537
 
      </varlistentry>
538
 
    </variablelist>
539
510
  </refsect1>
540
511
</refentry>
541
512
<!-- Local Variables: -->