/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 at recompile
  • Date: 2020-02-09 03:38:33 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200209033833-2la1pujrnv2m0so4
Use reallocarray() if available, or check for overflow

* dracut-module/password-agent.c (add_to_queue): Check for overflow.
  (test_add_to_queue_overflow): New test.
* plugin-runner.c (add_to_char_array, main): Use reallocarray().
* plugins.d/plymouth.c (exec_and_wait): - '' -

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 "2010-09-26">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
 
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>
38
47
      <holder>Teddy Hogeborn</holder>
39
48
      <holder>Björn Påhlsson</holder>
40
49
    </copyright>
64
73
      ><refentrytitle>mandos</refentrytitle>
65
74
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
75
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      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.
69
83
    </para>
70
84
    <para>
71
85
      The format starts with a <literal>[<replaceable>section
110
124
          <para>
111
125
            How long to wait for external approval before resorting to
112
126
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
114
128
          </para>
115
129
          <para>
116
130
            The format of <replaceable>TIME</replaceable> is the same
160
174
            This option is <emphasis>optional</emphasis>.
161
175
          </para>
162
176
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            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>
169
183
            <option>-c</option></command></quote>, so
170
184
            <varname>PATH</varname> will be searched.  The default
171
185
            value for the checker command is <quote><literal
172
186
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</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.
174
194
          </para>
175
195
          <para>
176
196
            In addition to normal start time expansion, this option
181
201
      </varlistentry>
182
202
      
183
203
      <varlistentry>
 
204
        <term><option>extended_timeout<literal> = </literal><replaceable
 
205
        >TIME</replaceable></option></term>
 
206
        <listitem>
 
207
          <para>
 
208
            This option is <emphasis>optional</emphasis>.
 
209
          </para>
 
210
          <para>
 
211
            Extended timeout is an added timeout that is given once
 
212
            after a password has been sent successfully to a client.
 
213
            The timeout is by default longer than the normal timeout,
 
214
            and is used for handling the extra long downtime while a
 
215
            machine is booting up.  Time to take into consideration
 
216
            when changing this value is file system checks and quota
 
217
            checks.  The default value is 15 minutes.
 
218
          </para>
 
219
          <para>
 
220
            The format of <replaceable>TIME</replaceable> is the same
 
221
            as for <varname>timeout</varname> below.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
      
 
226
      <varlistentry>
184
227
        <term><option>fingerprint<literal> = </literal
185
228
        ><replaceable>HEXSTRING</replaceable></option></term>
186
229
        <listitem>
190
233
          <para>
191
234
            This option sets the OpenPGP fingerprint that identifies
192
235
            the public key that clients authenticate themselves with
193
 
            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,
194
253
            but spaces or upper/lower case are not significant.
195
254
          </para>
196
255
        </listitem>
228
287
            will wait for a checker to complete until the below
229
288
            <quote><varname>timeout</varname></quote> occurs, at which
230
289
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
290
            killed.  The default interval is 2 minutes.
232
291
          </para>
233
292
          <para>
234
293
            The format of <replaceable>TIME</replaceable> is the same
272
331
          <para>
273
332
            If present, this option must be set to a string of
274
333
            base64-encoded binary data.  It will be decoded and sent
275
 
            to the client matching the above
276
 
            <option>fingerprint</option>.  This should, of course, be
277
 
            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.
278
337
            The program <citerefentry><refentrytitle><command
279
338
            >mandos-keygen</command></refentrytitle><manvolnum
280
339
            >8</manvolnum></citerefentry> can, using its
298
357
            This option is <emphasis>optional</emphasis>.
299
358
          </para>
300
359
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
305
 
          </para>
306
 
          <para>
307
 
            The <replaceable>TIME</replaceable> is specified as a
308
 
            space-separated number of values, each of which is a
309
 
            number and a one-character suffix.  The suffix must be one
310
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
312
 
            minutes, hours, and weeks, respectively.  The values are
313
 
            added together to give the total time value, so all of
314
 
            <quote><literal>330s</literal></quote>,
315
 
            <quote><literal>110s 110s 110s</literal></quote>, and
316
 
            <quote><literal>5m 30s</literal></quote> will give a value
317
 
            of five minutes and thirty seconds.
 
360
            The timeout is how long the server will wait, after a
 
361
            successful checker run, until a client is disabled and not
 
362
            allowed to get the data this server holds.  By default
 
363
            Mandos will use 5 minutes.  See also the
 
364
            <option>extended_timeout</option> option.
 
365
          </para>
 
366
          <para>
 
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>.
318
387
          </para>
319
388
        </listitem>
320
389
      </varlistentry>
364
433
        <quote><literal>approval_duration</literal></quote>,
365
434
        <quote><literal>created</literal></quote>,
366
435
        <quote><literal>enabled</literal></quote>,
 
436
        <quote><literal>expires</literal></quote>,
 
437
        <quote><literal>key_id</literal></quote>,
367
438
        <quote><literal>fingerprint</literal></quote>,
368
439
        <quote><literal>host</literal></quote>,
369
440
        <quote><literal>interval</literal></quote>,
412
483
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
413
484
      obscure.
414
485
    </para>
 
486
    <xi:include href="bugs.xml"/>
415
487
  </refsect1>
416
488
  
417
489
  <refsect1 id="example">
419
491
    <informalexample>
420
492
      <programlisting>
421
493
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
494
timeout = PT5M
 
495
interval = PT2M
424
496
checker = fping -q -- %%(host)s
425
497
 
426
498
# Client "foo"
427
499
[foo]
 
500
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
428
501
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
429
502
secret =
430
503
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
443
516
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
444
517
        QlnHIvPzEArRQLo=
445
518
host = foo.example.org
446
 
interval = 1m
 
519
interval = PT1M
447
520
 
448
521
# Client "bar"
449
522
[bar]
 
523
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
450
524
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
525
secfile = /etc/mandos/bar-secret
452
 
timeout = 15m
 
526
timeout = PT15M
453
527
approved_by_default = False
454
 
approval_delay = 30s
 
528
approval_delay = PT30S
455
529
      </programlisting>
456
530
    </informalexample>
457
531
  </refsect1>
459
533
  <refsect1 id="see_also">
460
534
    <title>SEE ALSO</title>
461
535
    <para>
 
536
      <citerefentry><refentrytitle>intro</refentrytitle>
 
537
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
538
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
539
      <manvolnum>8</manvolnum></citerefentry>,
464
540
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
541
      <manvolnum>5</manvolnum></citerefentry>,
466
542
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
543
      <manvolnum>8</manvolnum></citerefentry>,
 
544
      <citerefentry><refentrytitle>fping</refentrytitle>
467
545
      <manvolnum>8</manvolnum></citerefentry>
468
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>
469
561
  </refsect1>
470
562
</refentry>
471
563
<!-- Local Variables: -->