/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2012-05-12 19:56:55 UTC
  • mfrom: (297.1.2 nmu)
  • Revision ID: teddy@recompile.se-20120512195655-cy7w8ts3l9p22l3z
Tags: version-1.5.3-1.2
Merge NMU change

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
228
215
        ><replaceable>HEXSTRING</replaceable></option></term>
229
216
        <listitem>
230
217
          <para>
231
 
            This option is <emphasis>required</emphasis> if the
232
 
            <option>key_id</option> is not set, and
233
 
            <emphasis>optional</emphasis> otherwise.
234
 
          </para>
235
 
          <para>
236
 
            This option sets the OpenPGP fingerprint that (before
237
 
            GnuTLS 3.6.0) identified the public key that clients
238
 
            authenticate themselves with through TLS.  The string
239
 
            needs to be in hexadecimal form, but spaces or upper/lower
240
 
            case are not significant.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
      
245
 
      <varlistentry>
246
 
        <term><option>key_id<literal> = </literal
247
 
        ><replaceable>HEXSTRING</replaceable></option></term>
248
 
        <listitem>
249
 
          <para>
250
 
            This option is <emphasis>required</emphasis> if the
251
 
            <option>fingerprint</option> is not set, and
252
 
            <emphasis>optional</emphasis> otherwise.
253
 
          </para>
254
 
          <para>
255
 
            This option sets the certificate key ID that (with GnuTLS
256
 
            3.6.6 or later) identifies the public key that clients
257
 
            authenticate themselves with through TLS.  The string
258
 
            needs to be in hexadecimal form, but spaces or upper/lower
259
 
            case are not significant.
 
218
            This option is <emphasis>required</emphasis>.
 
219
          </para>
 
220
          <para>
 
221
            This option sets the OpenPGP fingerprint that identifies
 
222
            the public key that clients authenticate themselves with
 
223
            through TLS.  The string needs to be in hexidecimal form,
 
224
            but spaces or upper/lower case are not significant.
260
225
          </para>
261
226
        </listitem>
262
227
      </varlistentry>
337
302
          <para>
338
303
            If present, this option must be set to a string of
339
304
            base64-encoded binary data.  It will be decoded and sent
340
 
            to the client matching the above <option>key_id</option>
341
 
            or <option>fingerprint</option>.  This should, of course,
342
 
            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.
343
308
            The program <citerefentry><refentrytitle><command
344
309
            >mandos-keygen</command></refentrytitle><manvolnum
345
310
            >8</manvolnum></citerefentry> can, using its
370
335
            <option>extended_timeout</option> option.
371
336
          </para>
372
337
          <para>
373
 
            The <replaceable>TIME</replaceable> is specified as an RFC
374
 
            3339 duration; for example
375
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
376
 
            one year, two months, three days, four hours, five
377
 
            minutes, and six seconds.  Some values can be omitted, see
378
 
            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.
379
349
          </para>
380
350
        </listitem>
381
351
      </varlistentry>
439
409
        <quote><literal>approval_duration</literal></quote>,
440
410
        <quote><literal>created</literal></quote>,
441
411
        <quote><literal>enabled</literal></quote>,
442
 
        <quote><literal>expires</literal></quote>,
443
 
        <quote><literal>key_id</literal></quote>,
444
412
        <quote><literal>fingerprint</literal></quote>,
445
413
        <quote><literal>host</literal></quote>,
446
414
        <quote><literal>interval</literal></quote>,
489
457
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
490
458
      obscure.
491
459
    </para>
492
 
    <xi:include href="bugs.xml"/>
493
460
  </refsect1>
494
461
  
495
462
  <refsect1 id="example">
497
464
    <informalexample>
498
465
      <programlisting>
499
466
[DEFAULT]
500
 
timeout = PT5M
501
 
interval = PT2M
 
467
timeout = 5m
 
468
interval = 2m
502
469
checker = fping -q -- %%(host)s
503
470
 
504
471
# Client "foo"
505
472
[foo]
506
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
507
473
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
508
474
secret =
509
475
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
522
488
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
523
489
        QlnHIvPzEArRQLo=
524
490
host = foo.example.org
525
 
interval = PT1M
 
491
interval = 1m
526
492
 
527
493
# Client "bar"
528
494
[bar]
529
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
530
495
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
531
496
secfile = /etc/mandos/bar-secret
532
 
timeout = PT15M
 
497
timeout = 15m
533
498
approved_by_default = False
534
 
approval_delay = PT30S
 
499
approval_delay = 30s
535
500
      </programlisting>
536
501
    </informalexample>
537
502
  </refsect1>
546
511
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
547
512
      <manvolnum>5</manvolnum></citerefentry>,
548
513
      <citerefentry><refentrytitle>mandos</refentrytitle>
549
 
      <manvolnum>8</manvolnum></citerefentry>,
550
 
      <citerefentry><refentrytitle>fping</refentrytitle>
551
514
      <manvolnum>8</manvolnum></citerefentry>
552
515
    </para>
553
 
    <variablelist>
554
 
      <varlistentry>
555
 
        <term>
556
 
          RFC 3339: <citetitle>Date and Time on the Internet:
557
 
          Timestamps</citetitle>
558
 
        </term>
559
 
      <listitem>
560
 
        <para>
561
 
          The time intervals are in the "duration" format, as
562
 
          specified in ABNF in Appendix A of RFC 3339.
563
 
        </para>
564
 
      </listitem>
565
 
      </varlistentry>
566
 
    </variablelist>
567
516
  </refsect1>
568
517
</refentry>
569
518
<!-- Local Variables: -->