/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: 2019-02-09 23:31:44 UTC
  • Revision ID: teddy@recompile.se-20190209233144-5ewmrgezdqridssj
* TODO (Use raw public keys): Remove.

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 "2011-11-26">
 
6
<!ENTITY TIMESTAMP "2019-02-09">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
 
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>
39
46
      <holder>Teddy Hogeborn</holder>
40
47
      <holder>Björn Påhlsson</holder>
41
48
    </copyright>
65
72
      ><refentrytitle>mandos</refentrytitle>
66
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
74
      The file needs to list all clients that should be able to use
68
 
      the service.  All clients listed will be regarded as enabled,
69
 
      even if a client was disabled in a previous run of the server.
 
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.
70
82
    </para>
71
83
    <para>
72
84
      The format starts with a <literal>[<replaceable>section
111
123
          <para>
112
124
            How long to wait for external approval before resorting to
113
125
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
126
            default is <quote>PT0S</quote>, i.e. not to wait.
115
127
          </para>
116
128
          <para>
117
129
            The format of <replaceable>TIME</replaceable> is the same
161
173
            This option is <emphasis>optional</emphasis>.
162
174
          </para>
163
175
          <para>
164
 
            This option allows you to override the default shell
165
 
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            run using <quote><command><filename>/bin/sh</filename>
 
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>
170
182
            <option>-c</option></command></quote>, so
171
183
            <varname>PATH</varname> will be searched.  The default
172
184
            value for the checker command is <quote><literal
173
185
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
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
193
          </para>
176
194
          <para>
177
195
            In addition to normal start time expansion, this option
214
232
          <para>
215
233
            This option sets the OpenPGP fingerprint that identifies
216
234
            the public key that clients authenticate themselves with
217
 
            through TLS.  The string needs to be in hexidecimal form,
 
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
252
            but spaces or upper/lower case are not significant.
219
253
          </para>
220
254
        </listitem>
296
330
          <para>
297
331
            If present, this option must be set to a string of
298
332
            base64-encoded binary data.  It will be decoded and sent
299
 
            to the client matching the above
300
 
            <option>fingerprint</option>.  This should, of course, be
301
 
            OpenPGP encrypted data, decryptable only by the client.
 
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.
302
336
            The program <citerefentry><refentrytitle><command
303
337
            >mandos-keygen</command></refentrytitle><manvolnum
304
338
            >8</manvolnum></citerefentry> can, using its
329
363
            <option>extended_timeout</option> option.
330
364
          </para>
331
365
          <para>
332
 
            The <replaceable>TIME</replaceable> is specified as a
333
 
            space-separated number of values, each of which is a
334
 
            number and a one-character suffix.  The suffix must be one
335
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
 
            minutes, hours, and weeks, respectively.  The values are
338
 
            added together to give the total time value, so all of
339
 
            <quote><literal>330s</literal></quote>,
340
 
            <quote><literal>110s 110s 110s</literal></quote>, and
341
 
            <quote><literal>5m 30s</literal></quote> will give a value
342
 
            of five minutes and thirty seconds.
 
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.
343
372
          </para>
344
373
        </listitem>
345
374
      </varlistentry>
403
432
        <quote><literal>approval_duration</literal></quote>,
404
433
        <quote><literal>created</literal></quote>,
405
434
        <quote><literal>enabled</literal></quote>,
 
435
        <quote><literal>expires</literal></quote>,
 
436
        <quote><literal>key_id</literal></quote>,
406
437
        <quote><literal>fingerprint</literal></quote>,
407
438
        <quote><literal>host</literal></quote>,
408
439
        <quote><literal>interval</literal></quote>,
451
482
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
452
483
      obscure.
453
484
    </para>
 
485
    <xi:include href="bugs.xml"/>
454
486
  </refsect1>
455
487
  
456
488
  <refsect1 id="example">
458
490
    <informalexample>
459
491
      <programlisting>
460
492
[DEFAULT]
461
 
timeout = 5m
462
 
interval = 2m
 
493
timeout = PT5M
 
494
interval = PT2M
463
495
checker = fping -q -- %%(host)s
464
496
 
465
497
# Client "foo"
466
498
[foo]
 
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
467
500
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
468
501
secret =
469
502
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
482
515
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
483
516
        QlnHIvPzEArRQLo=
484
517
host = foo.example.org
485
 
interval = 1m
 
518
interval = PT1M
486
519
 
487
520
# Client "bar"
488
521
[bar]
 
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
489
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
490
524
secfile = /etc/mandos/bar-secret
491
 
timeout = 15m
 
525
timeout = PT15M
492
526
approved_by_default = False
493
 
approval_delay = 30s
 
527
approval_delay = PT30S
494
528
      </programlisting>
495
529
    </informalexample>
496
530
  </refsect1>
505
539
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
506
540
      <manvolnum>5</manvolnum></citerefentry>,
507
541
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
542
      <manvolnum>8</manvolnum></citerefentry>,
 
543
      <citerefentry><refentrytitle>fping</refentrytitle>
508
544
      <manvolnum>8</manvolnum></citerefentry>
509
545
    </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>
510
560
  </refsect1>
511
561
</refentry>
512
562
<!-- Local Variables: -->