/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 recompile
  • Date: 2020-02-05 20:32:33 UTC
  • Revision ID: teddy@recompile.se-20200205203233-450ojm36jseglq4m
Server: Stagger checker runs when creating clients

To avoid checkers for all clients all running at the same time
periodically, schedule every initially scheduled future checker to run
at a time in the future a random amount of the interval, from the
current time.

* mandos (Client.init_checker): Schedule the first scheduled future
  run of a checker to be a randomly chosen amount of this client's
  "interval" (instead of a full interval).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
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 "2012-01-01">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
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
      <year>2016</year>
 
44
      <year>2017</year>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
40
47
      <holder>Teddy Hogeborn</holder>
41
48
      <holder>Björn Påhlsson</holder>
42
49
    </copyright>
66
73
      ><refentrytitle>mandos</refentrytitle>
67
74
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
75
      The file needs to list all clients that should be able to use
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.
 
76
      the service.  The settings in this file can be overridden by
 
77
      runtime changes to the server, which it saves across restarts.
 
78
      (See the section called <quote>PERSISTENT STATE</quote> in
 
79
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
80
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
81
      >changes</emphasis> to this file (including adding and removing
 
82
      clients) will, at startup, override changes done during runtime.
71
83
    </para>
72
84
    <para>
73
85
      The format starts with a <literal>[<replaceable>section
112
124
          <para>
113
125
            How long to wait for external approval before resorting to
114
126
            use the <option>approved_by_default</option> value.  The
115
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
116
128
          </para>
117
129
          <para>
118
130
            The format of <replaceable>TIME</replaceable> is the same
162
174
            This option is <emphasis>optional</emphasis>.
163
175
          </para>
164
176
          <para>
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>
 
177
            This option overrides the default shell command that the
 
178
            server will use to check if the client is still up.  Any
 
179
            output of the command will be ignored, only the exit code
 
180
            is checked:  If the exit code of the command is zero, the
 
181
            client is considered up.  The command will be run using
 
182
            <quote><command><filename>/bin/sh</filename>
171
183
            <option>-c</option></command></quote>, so
172
184
            <varname>PATH</varname> will be searched.  The default
173
185
            value for the checker command is <quote><literal
174
186
            ><command>fping</command> <option>-q</option> <option
175
 
            >--</option> %%(host)s</literal></quote>.
 
187
            >--</option> %%(host)s</literal></quote>.  Note that
 
188
            <command>mandos-keygen</command>, when generating output
 
189
            to be inserted into this file, normally looks for an SSH
 
190
            server on the Mandos client, and, if it finds one, outputs
 
191
            a <option>checker</option> option to check for the
 
192
            client’s SSH key fingerprint – this is more secure against
 
193
            spoofing.
176
194
          </para>
177
195
          <para>
178
196
            In addition to normal start time expansion, this option
215
233
          <para>
216
234
            This option sets the OpenPGP fingerprint that identifies
217
235
            the public key that clients authenticate themselves with
218
 
            through TLS.  The string needs to be in hexidecimal form,
 
236
            through TLS.  The string needs to be in hexadecimal form,
 
237
            but spaces or upper/lower case are not significant.
 
238
          </para>
 
239
        </listitem>
 
240
      </varlistentry>
 
241
      
 
242
      <varlistentry>
 
243
        <term><option>key_id<literal> = </literal
 
244
        ><replaceable>HEXSTRING</replaceable></option></term>
 
245
        <listitem>
 
246
          <para>
 
247
            This option is <emphasis>optional</emphasis>.
 
248
          </para>
 
249
          <para>
 
250
            This option sets the certificate key ID that identifies
 
251
            the public key that clients authenticate themselves with
 
252
            through TLS.  The string needs to be in hexadecimal form,
219
253
            but spaces or upper/lower case are not significant.
220
254
          </para>
221
255
        </listitem>
297
331
          <para>
298
332
            If present, this option must be set to a string of
299
333
            base64-encoded binary data.  It will be decoded and sent
300
 
            to the client matching the above
301
 
            <option>fingerprint</option>.  This should, of course, be
302
 
            OpenPGP encrypted data, decryptable only by the client.
 
334
            to the client matching the above <option>key_id</option>
 
335
            or <option>fingerprint</option>.  This should, of course,
 
336
            be OpenPGP encrypted data, decryptable only by the client.
303
337
            The program <citerefentry><refentrytitle><command
304
338
            >mandos-keygen</command></refentrytitle><manvolnum
305
339
            >8</manvolnum></citerefentry> can, using its
330
364
            <option>extended_timeout</option> option.
331
365
          </para>
332
366
          <para>
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.
 
367
            The <replaceable>TIME</replaceable> is specified as an RFC
 
368
            3339 duration; for example
 
369
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
370
            one year, two months, three days, four hours, five
 
371
            minutes, and six seconds.  Some values can be omitted, see
 
372
            RFC 3339 Appendix A for details.
344
373
          </para>
345
374
        </listitem>
346
375
      </varlistentry>
404
433
        <quote><literal>approval_duration</literal></quote>,
405
434
        <quote><literal>created</literal></quote>,
406
435
        <quote><literal>enabled</literal></quote>,
 
436
        <quote><literal>expires</literal></quote>,
 
437
        <quote><literal>key_id</literal></quote>,
407
438
        <quote><literal>fingerprint</literal></quote>,
408
439
        <quote><literal>host</literal></quote>,
409
440
        <quote><literal>interval</literal></quote>,
452
483
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
453
484
      obscure.
454
485
    </para>
 
486
    <xi:include href="bugs.xml"/>
455
487
  </refsect1>
456
488
  
457
489
  <refsect1 id="example">
459
491
    <informalexample>
460
492
      <programlisting>
461
493
[DEFAULT]
462
 
timeout = 5m
463
 
interval = 2m
 
494
timeout = PT5M
 
495
interval = PT2M
464
496
checker = fping -q -- %%(host)s
465
497
 
466
498
# Client "foo"
467
499
[foo]
 
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
468
501
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
469
502
secret =
470
503
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
483
516
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
484
517
        QlnHIvPzEArRQLo=
485
518
host = foo.example.org
486
 
interval = 1m
 
519
interval = PT1M
487
520
 
488
521
# Client "bar"
489
522
[bar]
 
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
490
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
491
525
secfile = /etc/mandos/bar-secret
492
 
timeout = 15m
 
526
timeout = PT15M
493
527
approved_by_default = False
494
 
approval_delay = 30s
 
528
approval_delay = PT30S
495
529
      </programlisting>
496
530
    </informalexample>
497
531
  </refsect1>
506
540
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
507
541
      <manvolnum>5</manvolnum></citerefentry>,
508
542
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
543
      <manvolnum>8</manvolnum></citerefentry>,
 
544
      <citerefentry><refentrytitle>fping</refentrytitle>
509
545
      <manvolnum>8</manvolnum></citerefentry>
510
546
    </para>
 
547
    <variablelist>
 
548
      <varlistentry>
 
549
        <term>
 
550
          RFC 3339: <citetitle>Date and Time on the Internet:
 
551
          Timestamps</citetitle>
 
552
        </term>
 
553
      <listitem>
 
554
        <para>
 
555
          The time intervals are in the "duration" format, as
 
556
          specified in ABNF in Appendix A of RFC 3339.
 
557
        </para>
 
558
      </listitem>
 
559
      </varlistentry>
 
560
    </variablelist>
511
561
  </refsect1>
512
562
</refentry>
513
563
<!-- Local Variables: -->