/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-06-17 12:23:31 UTC
  • Revision ID: teddy@recompile.se-20120617122331-2drpu9t1jnmxzdhs
* plugins.d/mandos-client.c: Comment changes

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 "2019-02-09">
 
6
<!ENTITY TIMESTAMP "2012-05-27">
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
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
123
117
          <para>
124
118
            How long to wait for external approval before resorting to
125
119
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
120
            default is <quote>0s</quote>, i.e. not to wait.
127
121
          </para>
128
122
          <para>
129
123
            The format of <replaceable>TIME</replaceable> is the same
183
177
            <varname>PATH</varname> will be searched.  The default
184
178
            value for the checker command is <quote><literal
185
179
            ><command>fping</command> <option>-q</option> <option
186
 
            >--</option> %%(host)s</literal></quote>.  Note that
187
 
            <command>mandos-keygen</command>, when generating output
188
 
            to be inserted into this file, normally looks for an SSH
189
 
            server on the Mandos client, and, if it finds one, outputs
190
 
            a <option>checker</option> option to check for the
191
 
            client’s SSH key fingerprint – this is more secure against
192
 
            spoofing.
 
180
            >--</option> %%(host)s</literal></quote>.
193
181
          </para>
194
182
          <para>
195
183
            In addition to normal start time expansion, this option
232
220
          <para>
233
221
            This option sets the OpenPGP fingerprint that identifies
234
222
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
236
 
            but spaces or upper/lower case are not significant.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
 
        <term><option>key_id<literal> = </literal
243
 
        ><replaceable>HEXSTRING</replaceable></option></term>
244
 
        <listitem>
245
 
          <para>
246
 
            This option is <emphasis>optional</emphasis>.
247
 
          </para>
248
 
          <para>
249
 
            This option sets the certificate key ID that identifies
250
 
            the public key that clients authenticate themselves with
251
 
            through TLS.  The string needs to be in hexadecimal form,
 
223
            through TLS.  The string needs to be in hexidecimal form,
252
224
            but spaces or upper/lower case are not significant.
253
225
          </para>
254
226
        </listitem>
330
302
          <para>
331
303
            If present, this option must be set to a string of
332
304
            base64-encoded binary data.  It will be decoded and sent
333
 
            to the client matching the above <option>key_id</option>
334
 
            or <option>fingerprint</option>.  This should, of course,
335
 
            be OpenPGP encrypted data, decryptable only by the client.
 
305
            to the client matching the above
 
306
            <option>fingerprint</option>.  This should, of course, be
 
307
            OpenPGP encrypted data, decryptable only by the client.
336
308
            The program <citerefentry><refentrytitle><command
337
309
            >mandos-keygen</command></refentrytitle><manvolnum
338
310
            >8</manvolnum></citerefentry> can, using its
363
335
            <option>extended_timeout</option> option.
364
336
          </para>
365
337
          <para>
366
 
            The <replaceable>TIME</replaceable> is specified as an RFC
367
 
            3339 duration; for example
368
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
369
 
            one year, two months, three days, four hours, five
370
 
            minutes, and six seconds.  Some values can be omitted, see
371
 
            RFC 3339 Appendix A for details.
 
338
            The <replaceable>TIME</replaceable> is specified as a
 
339
            space-separated number of values, each of which is a
 
340
            number and a one-character suffix.  The suffix must be one
 
341
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
342
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
343
            minutes, hours, and weeks, respectively.  The values are
 
344
            added together to give the total time value, so all of
 
345
            <quote><literal>330s</literal></quote>,
 
346
            <quote><literal>110s 110s 110s</literal></quote>, and
 
347
            <quote><literal>5m 30s</literal></quote> will give a value
 
348
            of five minutes and thirty seconds.
372
349
          </para>
373
350
        </listitem>
374
351
      </varlistentry>
433
410
        <quote><literal>created</literal></quote>,
434
411
        <quote><literal>enabled</literal></quote>,
435
412
        <quote><literal>expires</literal></quote>,
436
 
        <quote><literal>key_id</literal></quote>,
437
413
        <quote><literal>fingerprint</literal></quote>,
438
414
        <quote><literal>host</literal></quote>,
439
415
        <quote><literal>interval</literal></quote>,
482
458
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
483
459
      obscure.
484
460
    </para>
485
 
    <xi:include href="bugs.xml"/>
486
461
  </refsect1>
487
462
  
488
463
  <refsect1 id="example">
490
465
    <informalexample>
491
466
      <programlisting>
492
467
[DEFAULT]
493
 
timeout = PT5M
494
 
interval = PT2M
 
468
timeout = 5m
 
469
interval = 2m
495
470
checker = fping -q -- %%(host)s
496
471
 
497
472
# Client "foo"
498
473
[foo]
499
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
500
474
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
501
475
secret =
502
476
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
515
489
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
516
490
        QlnHIvPzEArRQLo=
517
491
host = foo.example.org
518
 
interval = PT1M
 
492
interval = 1m
519
493
 
520
494
# Client "bar"
521
495
[bar]
522
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
523
496
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
524
497
secfile = /etc/mandos/bar-secret
525
 
timeout = PT15M
 
498
timeout = 15m
526
499
approved_by_default = False
527
 
approval_delay = PT30S
 
500
approval_delay = 30s
528
501
      </programlisting>
529
502
    </informalexample>
530
503
  </refsect1>
543
516
      <citerefentry><refentrytitle>fping</refentrytitle>
544
517
      <manvolnum>8</manvolnum></citerefentry>
545
518
    </para>
546
 
    <variablelist>
547
 
      <varlistentry>
548
 
        <term>
549
 
          RFC 3339: <citetitle>Date and Time on the Internet:
550
 
          Timestamps</citetitle>
551
 
        </term>
552
 
      <listitem>
553
 
        <para>
554
 
          The time intervals are in the "duration" format, as
555
 
          specified in ABNF in Appendix A of RFC 3339.
556
 
        </para>
557
 
      </listitem>
558
 
      </varlistentry>
559
 
    </variablelist>
560
519
  </refsect1>
561
520
</refentry>
562
521
<!-- Local Variables: -->