/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 20:47:06 UTC
  • mfrom: (550 trunk)
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 551.
  • Revision ID: teddy@recompile.se-20120101204706-0lhdhlrhkrkwjekv
Merge from trunk.

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-10">
 
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
 
      <year>2016</year>
44
 
      <year>2017</year>
45
 
      <year>2018</year>
46
 
      <year>2019</year>
47
40
      <holder>Teddy Hogeborn</holder>
48
41
      <holder>Björn Påhlsson</holder>
49
42
    </copyright>
124
117
          <para>
125
118
            How long to wait for external approval before resorting to
126
119
            use the <option>approved_by_default</option> value.  The
127
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
120
            default is <quote>0s</quote>, i.e. not to wait.
128
121
          </para>
129
122
          <para>
130
123
            The format of <replaceable>TIME</replaceable> is the same
174
167
            This option is <emphasis>optional</emphasis>.
175
168
          </para>
176
169
          <para>
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>
 
170
            This option allows you to override the default shell
 
171
            command that the server will use to check if the client is
 
172
            still up.  Any output of the command will be ignored, only
 
173
            the exit code is checked:  If the exit code of the command
 
174
            is zero, the client is considered up.  The command will be
 
175
            run using <quote><command><filename>/bin/sh</filename>
183
176
            <option>-c</option></command></quote>, so
184
177
            <varname>PATH</varname> will be searched.  The default
185
178
            value for the checker command is <quote><literal
186
179
            ><command>fping</command> <option>-q</option> <option
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.
 
180
            >--</option> %%(host)s</literal></quote>.
194
181
          </para>
195
182
          <para>
196
183
            In addition to normal start time expansion, this option
233
220
          <para>
234
221
            This option sets the OpenPGP fingerprint that identifies
235
222
            the public key that clients authenticate themselves with
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,
 
223
            through TLS.  The string needs to be in hexidecimal form,
253
224
            but spaces or upper/lower case are not significant.
254
225
          </para>
255
226
        </listitem>
331
302
          <para>
332
303
            If present, this option must be set to a string of
333
304
            base64-encoded binary data.  It will be decoded and sent
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.
 
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.
337
308
            The program <citerefentry><refentrytitle><command
338
309
            >mandos-keygen</command></refentrytitle><manvolnum
339
310
            >8</manvolnum></citerefentry> can, using its
364
335
            <option>extended_timeout</option> option.
365
336
          </para>
366
337
          <para>
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.
 
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.
373
349
          </para>
374
350
        </listitem>
375
351
      </varlistentry>
433
409
        <quote><literal>approval_duration</literal></quote>,
434
410
        <quote><literal>created</literal></quote>,
435
411
        <quote><literal>enabled</literal></quote>,
436
 
        <quote><literal>expires</literal></quote>,
437
 
        <quote><literal>key_id</literal></quote>,
438
412
        <quote><literal>fingerprint</literal></quote>,
439
413
        <quote><literal>host</literal></quote>,
440
414
        <quote><literal>interval</literal></quote>,
483
457
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
484
458
      obscure.
485
459
    </para>
486
 
    <xi:include href="bugs.xml"/>
487
460
  </refsect1>
488
461
  
489
462
  <refsect1 id="example">
491
464
    <informalexample>
492
465
      <programlisting>
493
466
[DEFAULT]
494
 
timeout = PT5M
495
 
interval = PT2M
 
467
timeout = 5m
 
468
interval = 2m
496
469
checker = fping -q -- %%(host)s
497
470
 
498
471
# Client "foo"
499
472
[foo]
500
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
501
473
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
502
474
secret =
503
475
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
516
488
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
517
489
        QlnHIvPzEArRQLo=
518
490
host = foo.example.org
519
 
interval = PT1M
 
491
interval = 1m
520
492
 
521
493
# Client "bar"
522
494
[bar]
523
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
524
495
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
525
496
secfile = /etc/mandos/bar-secret
526
 
timeout = PT15M
 
497
timeout = 15m
527
498
approved_by_default = False
528
 
approval_delay = PT30S
 
499
approval_delay = 30s
529
500
      </programlisting>
530
501
    </informalexample>
531
502
  </refsect1>
540
511
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
541
512
      <manvolnum>5</manvolnum></citerefentry>,
542
513
      <citerefentry><refentrytitle>mandos</refentrytitle>
543
 
      <manvolnum>8</manvolnum></citerefentry>,
544
 
      <citerefentry><refentrytitle>fping</refentrytitle>
545
514
      <manvolnum>8</manvolnum></citerefentry>
546
515
    </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>
561
516
  </refsect1>
562
517
</refentry>
563
518
<!-- Local Variables: -->