/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: 2024-11-03 16:55:01 UTC
  • Revision ID: teddy@recompile.se-20241103165501-40sj3hxiuw20jbaa
initramfs-unpack: Support initramfs images compressed with zstd

initramfs-unpack: Also support initramfs images compressed with the
new compression method zstd.

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 "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>
117
124
          <para>
118
125
            How long to wait for external approval before resorting to
119
126
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
121
128
          </para>
122
129
          <para>
123
130
            The format of <replaceable>TIME</replaceable> is the same
167
174
            This option is <emphasis>optional</emphasis>.
168
175
          </para>
169
176
          <para>
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>
 
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>
176
183
            <option>-c</option></command></quote>, so
177
184
            <varname>PATH</varname> will be searched.  The default
178
185
            value for the checker command is <quote><literal
179
186
            ><command>fping</command> <option>-q</option> <option
180
 
            >--</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.
181
194
          </para>
182
195
          <para>
183
196
            In addition to normal start time expansion, this option
215
228
        ><replaceable>HEXSTRING</replaceable></option></term>
216
229
        <listitem>
217
230
          <para>
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.
 
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.
225
260
          </para>
226
261
        </listitem>
227
262
      </varlistentry>
302
337
          <para>
303
338
            If present, this option must be set to a string of
304
339
            base64-encoded binary data.  It will be decoded and sent
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.
 
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.
308
343
            The program <citerefentry><refentrytitle><command
309
344
            >mandos-keygen</command></refentrytitle><manvolnum
310
345
            >8</manvolnum></citerefentry> can, using its
335
370
            <option>extended_timeout</option> option.
336
371
          </para>
337
372
          <para>
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
            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.
349
379
          </para>
350
380
        </listitem>
351
381
      </varlistentry>
409
439
        <quote><literal>approval_duration</literal></quote>,
410
440
        <quote><literal>created</literal></quote>,
411
441
        <quote><literal>enabled</literal></quote>,
 
442
        <quote><literal>expires</literal></quote>,
 
443
        <quote><literal>key_id</literal></quote>,
412
444
        <quote><literal>fingerprint</literal></quote>,
413
445
        <quote><literal>host</literal></quote>,
414
446
        <quote><literal>interval</literal></quote>,
457
489
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
458
490
      obscure.
459
491
    </para>
 
492
    <xi:include href="bugs.xml"/>
460
493
  </refsect1>
461
494
  
462
495
  <refsect1 id="example">
464
497
    <informalexample>
465
498
      <programlisting>
466
499
[DEFAULT]
467
 
timeout = 5m
468
 
interval = 2m
 
500
timeout = PT5M
 
501
interval = PT2M
469
502
checker = fping -q -- %%(host)s
470
503
 
471
504
# Client "foo"
472
505
[foo]
 
506
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
473
507
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
474
508
secret =
475
509
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
488
522
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
489
523
        QlnHIvPzEArRQLo=
490
524
host = foo.example.org
491
 
interval = 1m
 
525
interval = PT1M
492
526
 
493
527
# Client "bar"
494
528
[bar]
 
529
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
495
530
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
496
531
secfile = /etc/mandos/bar-secret
497
 
timeout = 15m
 
532
timeout = PT15M
498
533
approved_by_default = False
499
 
approval_delay = 30s
 
534
approval_delay = PT30S
500
535
      </programlisting>
501
536
    </informalexample>
502
537
  </refsect1>
511
546
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
512
547
      <manvolnum>5</manvolnum></citerefentry>,
513
548
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
549
      <manvolnum>8</manvolnum></citerefentry>,
 
550
      <citerefentry><refentrytitle>fping</refentrytitle>
514
551
      <manvolnum>8</manvolnum></citerefentry>
515
552
    </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>
516
567
  </refsect1>
517
568
</refentry>
518
569
<!-- Local Variables: -->