/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: 2011-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

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-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
40
      <holder>Teddy Hogeborn</holder>
47
41
      <holder>Björn Påhlsson</holder>
48
42
    </copyright>
72
66
      ><refentrytitle>mandos</refentrytitle>
73
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
68
      The file needs to list all clients that should be able to use
75
 
      the service.  The settings in this file can be overridden by
76
 
      runtime changes to the server, which it saves across restarts.
77
 
      (See the section called <quote>PERSISTENT STATE</quote> in
78
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
79
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
80
 
      >changes</emphasis> to this file (including adding and removing
81
 
      clients) will, at startup, override changes done during runtime.
 
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.
82
71
    </para>
83
72
    <para>
84
73
      The format starts with a <literal>[<replaceable>section
123
112
          <para>
124
113
            How long to wait for external approval before resorting to
125
114
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
115
            default is <quote>0s</quote>, i.e. not to wait.
127
116
          </para>
128
117
          <para>
129
118
            The format of <replaceable>TIME</replaceable> is the same
173
162
            This option is <emphasis>optional</emphasis>.
174
163
          </para>
175
164
          <para>
176
 
            This option overrides the default shell command that the
177
 
            server will use to check if the client is still up.  Any
178
 
            output of the command will be ignored, only the exit code
179
 
            is checked:  If the exit code of the command is zero, the
180
 
            client is considered up.  The command will be run using
181
 
            <quote><command><filename>/bin/sh</filename>
 
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>
182
171
            <option>-c</option></command></quote>, so
183
172
            <varname>PATH</varname> will be searched.  The default
184
173
            value for the checker command is <quote><literal
185
174
            ><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 find one, outputs
190
 
            a <option>checker</option> option to check for the
191
 
            client’s key fingerprint – this is more secure against
192
 
            spoofing.
 
175
            >--</option> %%(host)s</literal></quote>.
193
176
          </para>
194
177
          <para>
195
178
            In addition to normal start time expansion, this option
232
215
          <para>
233
216
            This option sets the OpenPGP fingerprint that identifies
234
217
            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,
 
218
            through TLS.  The string needs to be in hexidecimal form,
252
219
            but spaces or upper/lower case are not significant.
253
220
          </para>
254
221
        </listitem>
330
297
          <para>
331
298
            If present, this option must be set to a string of
332
299
            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.
 
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.
336
303
            The program <citerefentry><refentrytitle><command
337
304
            >mandos-keygen</command></refentrytitle><manvolnum
338
305
            >8</manvolnum></citerefentry> can, using its
363
330
            <option>extended_timeout</option> option.
364
331
          </para>
365
332
          <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.
 
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.
372
344
          </para>
373
345
        </listitem>
374
346
      </varlistentry>
432
404
        <quote><literal>approval_duration</literal></quote>,
433
405
        <quote><literal>created</literal></quote>,
434
406
        <quote><literal>enabled</literal></quote>,
435
 
        <quote><literal>expires</literal></quote>,
436
 
        <quote><literal>key_id</literal></quote>,
437
407
        <quote><literal>fingerprint</literal></quote>,
438
408
        <quote><literal>host</literal></quote>,
439
409
        <quote><literal>interval</literal></quote>,
482
452
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
483
453
      obscure.
484
454
    </para>
485
 
    <xi:include href="bugs.xml"/>
486
455
  </refsect1>
487
456
  
488
457
  <refsect1 id="example">
490
459
    <informalexample>
491
460
      <programlisting>
492
461
[DEFAULT]
493
 
timeout = PT5M
494
 
interval = PT2M
 
462
timeout = 5m
 
463
interval = 2m
495
464
checker = fping -q -- %%(host)s
496
465
 
497
466
# Client "foo"
498
467
[foo]
499
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
500
468
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
501
469
secret =
502
470
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
515
483
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
516
484
        QlnHIvPzEArRQLo=
517
485
host = foo.example.org
518
 
interval = PT1M
 
486
interval = 1m
519
487
 
520
488
# Client "bar"
521
489
[bar]
522
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
523
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
524
491
secfile = /etc/mandos/bar-secret
525
 
timeout = PT15M
 
492
timeout = 15m
526
493
approved_by_default = False
527
 
approval_delay = PT30S
 
494
approval_delay = 30s
528
495
      </programlisting>
529
496
    </informalexample>
530
497
  </refsect1>
539
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
507
      <manvolnum>5</manvolnum></citerefentry>,
541
508
      <citerefentry><refentrytitle>mandos</refentrytitle>
542
 
      <manvolnum>8</manvolnum></citerefentry>,
543
 
      <citerefentry><refentrytitle>fping</refentrytitle>
544
509
      <manvolnum>8</manvolnum></citerefentry>
545
510
    </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
511
  </refsect1>
561
512
</refentry>
562
513
<!-- Local Variables: -->