/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: 2014-03-06 02:26:04 UTC
  • Revision ID: teddy@recompile.se-20140306022604-4uc43taz25cflgi3
Bug fix: Free all memory and give better messages when memory is full.

* plugin-runner.c (add_to_char_array): Bug fix: If realloc fails, do
                                       not change old array pointer.
  (add_environment): Bug fix: If realloc fails, do not change old
                     environment pointer.  Also rename "e" to "envdef"
                     for clarity.
  (main): Bug fix: If realloc fails, do not change old pointers.  Also
          wrap "#pragma GCC" with "#ifdef ___GNUC___".
* plugins.d/mandos-client.c (incbuffer): Bug fix: if realloc fails,
                                         free old buffer.
  (run_network_hooks): Moved variables "directory" and "ret" to their
                       innermost possible scope.
  (take_down_interface): Moved variables "sd", "ret_errno", and
                         "ret_setflags" to their innermost possible
                         scope.
  (main): Removed variable "interfaces_hooks_size".  Also, if argz_add
          fails when adding all found interfaces, the error message
          will now be correct.  Also print error message if, after
          having taken up an interface, argz_add fails to add
          interface to list of interfaces to be taken down.
* plugins.d/mandos-client.xml (OPTIONS): Explain better what "none"
                                         means as argument to
                                         "--interface" by negating
                                         sense.
* plugins.d/password-prompt.c (fprintf_plus): Removed (unused).

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 "2013-10-15">
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>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
64
66
      ><refentrytitle>mandos</refentrytitle>
65
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
68
      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.
 
69
      the service.  The settings in this file can be overridden by
 
70
      runtime changes to the server, which it saves across restarts.
 
71
      (See the section called <quote>PERSISTENT STATE</quote> in
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
73
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
74
      >changes</emphasis> to this file (including adding and removing
 
75
      clients) will, at startup, override changes done during runtime.
69
76
    </para>
70
77
    <para>
71
78
      The format starts with a <literal>[<replaceable>section
110
117
          <para>
111
118
            How long to wait for external approval before resorting to
112
119
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
 
120
            default is <quote>PT0S</quote>, i.e. not to wait.
114
121
          </para>
115
122
          <para>
116
123
            The format of <replaceable>TIME</replaceable> is the same
160
167
            This option is <emphasis>optional</emphasis>.
161
168
          </para>
162
169
          <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>
 
170
            This option overrides the default shell command that the
 
171
            server will use to check if the client is still up.  Any
 
172
            output of the command will be ignored, only the exit code
 
173
            is checked:  If the exit code of the command is zero, the
 
174
            client is considered up.  The command will be run using
 
175
            <quote><command><filename>/bin/sh</filename>
169
176
            <option>-c</option></command></quote>, so
170
177
            <varname>PATH</varname> will be searched.  The default
171
178
            value for the checker command is <quote><literal
181
188
      </varlistentry>
182
189
      
183
190
      <varlistentry>
 
191
        <term><option>extended_timeout<literal> = </literal><replaceable
 
192
        >TIME</replaceable></option></term>
 
193
        <listitem>
 
194
          <para>
 
195
            This option is <emphasis>optional</emphasis>.
 
196
          </para>
 
197
          <para>
 
198
            Extended timeout is an added timeout that is given once
 
199
            after a password has been sent successfully to a client.
 
200
            The timeout is by default longer than the normal timeout,
 
201
            and is used for handling the extra long downtime while a
 
202
            machine is booting up.  Time to take into consideration
 
203
            when changing this value is file system checks and quota
 
204
            checks.  The default value is 15 minutes.
 
205
          </para>
 
206
          <para>
 
207
            The format of <replaceable>TIME</replaceable> is the same
 
208
            as for <varname>timeout</varname> below.
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
184
214
        <term><option>fingerprint<literal> = </literal
185
215
        ><replaceable>HEXSTRING</replaceable></option></term>
186
216
        <listitem>
228
258
            will wait for a checker to complete until the below
229
259
            <quote><varname>timeout</varname></quote> occurs, at which
230
260
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
261
            killed.  The default interval is 2 minutes.
232
262
          </para>
233
263
          <para>
234
264
            The format of <replaceable>TIME</replaceable> is the same
298
328
            This option is <emphasis>optional</emphasis>.
299
329
          </para>
300
330
          <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.
 
331
            The timeout is how long the server will wait, after a
 
332
            successful checker run, until a client is disabled and not
 
333
            allowed to get the data this server holds.  By default
 
334
            Mandos will use 5 minutes.  See also the
 
335
            <option>extended_timeout</option> option.
 
336
          </para>
 
337
          <para>
 
338
            The <replaceable>TIME</replaceable> is specified as an RFC
 
339
            3339 duration; for example
 
340
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
341
            one year, two months, three days, four hours, five
 
342
            minutes, and six seconds.  Some values can be omitted, see
 
343
            RFC 3339 Appendix A for details.
 
344
          </para>
 
345
        </listitem>
 
346
      </varlistentry>
 
347
      
 
348
      <varlistentry>
 
349
        <term><option>enabled<literal> = </literal>{ <literal
 
350
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
351
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
352
        >no</literal> | <literal>false</literal> | <literal
 
353
        >off</literal> }</option></term>
 
354
        <listitem>
 
355
          <para>
 
356
            Whether this client should be enabled by default.  The
 
357
            default is <quote>true</quote>.
318
358
          </para>
319
359
        </listitem>
320
360
      </varlistentry>
364
404
        <quote><literal>approval_duration</literal></quote>,
365
405
        <quote><literal>created</literal></quote>,
366
406
        <quote><literal>enabled</literal></quote>,
 
407
        <quote><literal>expires</literal></quote>,
367
408
        <quote><literal>fingerprint</literal></quote>,
368
409
        <quote><literal>host</literal></quote>,
369
410
        <quote><literal>interval</literal></quote>,
419
460
    <informalexample>
420
461
      <programlisting>
421
462
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
463
timeout = PT5M
 
464
interval = PT2M
424
465
checker = fping -q -- %%(host)s
425
466
 
426
467
# Client "foo"
443
484
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
444
485
        QlnHIvPzEArRQLo=
445
486
host = foo.example.org
446
 
interval = 1m
 
487
interval = PT1M
447
488
 
448
489
# Client "bar"
449
490
[bar]
450
491
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
492
secfile = /etc/mandos/bar-secret
452
 
timeout = 15m
 
493
timeout = PT15M
453
494
approved_by_default = False
454
 
approval_delay = 30s
 
495
approval_delay = PT30S
455
496
      </programlisting>
456
497
    </informalexample>
457
498
  </refsect1>
459
500
  <refsect1 id="see_also">
460
501
    <title>SEE ALSO</title>
461
502
    <para>
 
503
      <citerefentry><refentrytitle>intro</refentrytitle>
 
504
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
505
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
506
      <manvolnum>8</manvolnum></citerefentry>,
464
507
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
508
      <manvolnum>5</manvolnum></citerefentry>,
466
509
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
510
      <manvolnum>8</manvolnum></citerefentry>,
 
511
      <citerefentry><refentrytitle>fping</refentrytitle>
467
512
      <manvolnum>8</manvolnum></citerefentry>
468
513
    </para>
 
514
    <variablelist>
 
515
      <varlistentry>
 
516
        <term>
 
517
          RFC 3339: <citetitle>Date and Time on the Internet:
 
518
          Timestamps</citetitle>
 
519
        </term>
 
520
      <listitem>
 
521
        <para>
 
522
          The time intervals are in the "duration" format, as
 
523
          specified in ABNF in Appendix A of RFC 3339.
 
524
        </para>
 
525
      </listitem>
 
526
      </varlistentry>
 
527
    </variablelist>
469
528
  </refsect1>
470
529
</refentry>
471
530
<!-- Local Variables: -->