/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-04-09 20:09:51 UTC
  • mto: This revision was merged to the branch mainline in revision 1100.
  • Revision ID: teddy@recompile.se-20190409200951-zgdjfh0mftlqz8pn
Tags: version-1.8.4-1
* Makefile (version): Change to 1.8.4.
* NEWS (Version 1.8.4): Add new entry.
* debian/changelog (1.8.4-1): - '' -

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-10-10">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
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>
 
46
      <year>2019</year>
39
47
      <holder>Teddy Hogeborn</holder>
40
48
      <holder>Björn Påhlsson</holder>
41
49
    </copyright>
65
73
      ><refentrytitle>mandos</refentrytitle>
66
74
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
75
      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.
 
76
      the service.  The settings in this file can be overridden by
 
77
      runtime changes to the server, which it saves across restarts.
 
78
      (See the section called <quote>PERSISTENT STATE</quote> in
 
79
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
80
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
81
      >changes</emphasis> to this file (including adding and removing
 
82
      clients) will, at startup, override changes done during runtime.
70
83
    </para>
71
84
    <para>
72
85
      The format starts with a <literal>[<replaceable>section
111
124
          <para>
112
125
            How long to wait for external approval before resorting to
113
126
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
115
128
          </para>
116
129
          <para>
117
130
            The format of <replaceable>TIME</replaceable> is the same
161
174
            This option is <emphasis>optional</emphasis>.
162
175
          </para>
163
176
          <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>
 
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
183
            <option>-c</option></command></quote>, so
171
184
            <varname>PATH</varname> will be searched.  The default
172
185
            value for the checker command is <quote><literal
173
186
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</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.
175
194
          </para>
176
195
          <para>
177
196
            In addition to normal start time expansion, this option
214
233
          <para>
215
234
            This option sets the OpenPGP fingerprint that identifies
216
235
            the public key that clients authenticate themselves with
217
 
            through TLS.  The string needs to be in hexidecimal form,
 
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,
218
253
            but spaces or upper/lower case are not significant.
219
254
          </para>
220
255
        </listitem>
296
331
          <para>
297
332
            If present, this option must be set to a string of
298
333
            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.
 
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.
302
337
            The program <citerefentry><refentrytitle><command
303
338
            >mandos-keygen</command></refentrytitle><manvolnum
304
339
            >8</manvolnum></citerefentry> can, using its
329
364
            <option>extended_timeout</option> option.
330
365
          </para>
331
366
          <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.
 
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.
 
373
          </para>
 
374
        </listitem>
 
375
      </varlistentry>
 
376
      
 
377
      <varlistentry>
 
378
        <term><option>enabled<literal> = </literal>{ <literal
 
379
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
380
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
381
        >no</literal> | <literal>false</literal> | <literal
 
382
        >off</literal> }</option></term>
 
383
        <listitem>
 
384
          <para>
 
385
            Whether this client should be enabled by default.  The
 
386
            default is <quote>true</quote>.
343
387
          </para>
344
388
        </listitem>
345
389
      </varlistentry>
389
433
        <quote><literal>approval_duration</literal></quote>,
390
434
        <quote><literal>created</literal></quote>,
391
435
        <quote><literal>enabled</literal></quote>,
 
436
        <quote><literal>expires</literal></quote>,
 
437
        <quote><literal>key_id</literal></quote>,
392
438
        <quote><literal>fingerprint</literal></quote>,
393
439
        <quote><literal>host</literal></quote>,
394
440
        <quote><literal>interval</literal></quote>,
437
483
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
438
484
      obscure.
439
485
    </para>
 
486
    <xi:include href="bugs.xml"/>
440
487
  </refsect1>
441
488
  
442
489
  <refsect1 id="example">
444
491
    <informalexample>
445
492
      <programlisting>
446
493
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
494
timeout = PT5M
 
495
interval = PT2M
449
496
checker = fping -q -- %%(host)s
450
497
 
451
498
# Client "foo"
452
499
[foo]
 
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
453
501
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
454
502
secret =
455
503
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
468
516
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
517
        QlnHIvPzEArRQLo=
470
518
host = foo.example.org
471
 
interval = 1m
 
519
interval = PT1M
472
520
 
473
521
# Client "bar"
474
522
[bar]
 
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
475
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
476
525
secfile = /etc/mandos/bar-secret
477
 
timeout = 15m
 
526
timeout = PT15M
478
527
approved_by_default = False
479
 
approval_delay = 30s
 
528
approval_delay = PT30S
480
529
      </programlisting>
481
530
    </informalexample>
482
531
  </refsect1>
491
540
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
541
      <manvolnum>5</manvolnum></citerefentry>,
493
542
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
543
      <manvolnum>8</manvolnum></citerefentry>,
 
544
      <citerefentry><refentrytitle>fping</refentrytitle>
494
545
      <manvolnum>8</manvolnum></citerefentry>
495
546
    </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>
496
561
  </refsect1>
497
562
</refentry>
498
563
<!-- Local Variables: -->