/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 at bsnet
  • Date: 2010-09-27 16:27:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927162713-jucnyd63612ximvw
* mandos-monitor: Change key for removing a client from "r" to "R".

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 "2018-02-08">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
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@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.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
38
      <holder>Teddy Hogeborn</holder>
47
39
      <holder>Björn Påhlsson</holder>
48
40
    </copyright>
72
64
      ><refentrytitle>mandos</refentrytitle>
73
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
66
      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.
 
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.
82
69
    </para>
83
70
    <para>
84
71
      The format starts with a <literal>[<replaceable>section
123
110
          <para>
124
111
            How long to wait for external approval before resorting to
125
112
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
113
            default is <quote>0s</quote>, i.e. not to wait.
127
114
          </para>
128
115
          <para>
129
116
            The format of <replaceable>TIME</replaceable> is the same
173
160
            This option is <emphasis>optional</emphasis>.
174
161
          </para>
175
162
          <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>
 
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>
182
169
            <option>-c</option></command></quote>, so
183
170
            <varname>PATH</varname> will be searched.  The default
184
171
            value for the checker command is <quote><literal
185
172
            ><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.
 
173
            >--</option> %%(host)s</literal></quote>.
193
174
          </para>
194
175
          <para>
195
176
            In addition to normal start time expansion, this option
200
181
      </varlistentry>
201
182
      
202
183
      <varlistentry>
203
 
        <term><option>extended_timeout<literal> = </literal><replaceable
204
 
        >TIME</replaceable></option></term>
205
 
        <listitem>
206
 
          <para>
207
 
            This option is <emphasis>optional</emphasis>.
208
 
          </para>
209
 
          <para>
210
 
            Extended timeout is an added timeout that is given once
211
 
            after a password has been sent successfully to a client.
212
 
            The timeout is by default longer than the normal timeout,
213
 
            and is used for handling the extra long downtime while a
214
 
            machine is booting up.  Time to take into consideration
215
 
            when changing this value is file system checks and quota
216
 
            checks.  The default value is 15 minutes.
217
 
          </para>
218
 
          <para>
219
 
            The format of <replaceable>TIME</replaceable> is the same
220
 
            as for <varname>timeout</varname> below.
221
 
          </para>
222
 
        </listitem>
223
 
      </varlistentry>
224
 
      
225
 
      <varlistentry>
226
184
        <term><option>fingerprint<literal> = </literal
227
185
        ><replaceable>HEXSTRING</replaceable></option></term>
228
186
        <listitem>
232
190
          <para>
233
191
            This option sets the OpenPGP fingerprint that identifies
234
192
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
 
193
            through TLS.  The string needs to be in hexidecimal form,
236
194
            but spaces or upper/lower case are not significant.
237
195
          </para>
238
196
        </listitem>
270
228
            will wait for a checker to complete until the below
271
229
            <quote><varname>timeout</varname></quote> occurs, at which
272
230
            time the client will be disabled, and any running checker
273
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
274
232
          </para>
275
233
          <para>
276
234
            The format of <replaceable>TIME</replaceable> is the same
340
298
            This option is <emphasis>optional</emphasis>.
341
299
          </para>
342
300
          <para>
343
 
            The timeout is how long the server will wait, after a
344
 
            successful checker run, until a client is disabled and not
345
 
            allowed to get the data this server holds.  By default
346
 
            Mandos will use 5 minutes.  See also the
347
 
            <option>extended_timeout</option> option.
348
 
          </para>
349
 
          <para>
350
 
            The <replaceable>TIME</replaceable> is specified as an RFC
351
 
            3339 duration; for example
352
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
 
            one year, two months, three days, four hours, five
354
 
            minutes, and six seconds.  Some values can be omitted, see
355
 
            RFC 3339 Appendix A for details.
356
 
          </para>
357
 
        </listitem>
358
 
      </varlistentry>
359
 
      
360
 
      <varlistentry>
361
 
        <term><option>enabled<literal> = </literal>{ <literal
362
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
363
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
364
 
        >no</literal> | <literal>false</literal> | <literal
365
 
        >off</literal> }</option></term>
366
 
        <listitem>
367
 
          <para>
368
 
            Whether this client should be enabled by default.  The
369
 
            default is <quote>true</quote>.
 
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.
370
318
          </para>
371
319
        </listitem>
372
320
      </varlistentry>
409
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
358
        ></quote> will be replaced by the value of the attribute
411
359
        <varname>foo</varname> of the internal
412
 
        <quote><classname>Client</classname></quote> object in the
413
 
        Mandos server.  The currently allowed values for
414
 
        <replaceable>foo</replaceable> are:
415
 
        <quote><literal>approval_delay</literal></quote>,
416
 
        <quote><literal>approval_duration</literal></quote>,
417
 
        <quote><literal>created</literal></quote>,
418
 
        <quote><literal>enabled</literal></quote>,
419
 
        <quote><literal>expires</literal></quote>,
420
 
        <quote><literal>fingerprint</literal></quote>,
421
 
        <quote><literal>host</literal></quote>,
422
 
        <quote><literal>interval</literal></quote>,
423
 
        <quote><literal>last_approval_request</literal></quote>,
424
 
        <quote><literal>last_checked_ok</literal></quote>,
425
 
        <quote><literal>last_enabled</literal></quote>,
426
 
        <quote><literal>name</literal></quote>,
427
 
        <quote><literal>timeout</literal></quote>, and, if using
428
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
 
        See the source code for details.  <emphasis role="strong"
430
 
        >Currently, <emphasis>none</emphasis> of these attributes
431
 
        except <quote><literal>host</literal></quote> are guaranteed
432
 
        to be valid in future versions.</emphasis> Therefore, please
433
 
        let the authors know of any attributes that are useful so they
434
 
        may be preserved to any new versions of this software.
 
360
        <quote><classname>Client</classname></quote> object.  See the
 
361
        source code for details, and let the authors know of any
 
362
        attributes that are useful so they may be preserved to any new
 
363
        versions of this software.
435
364
      </para>
436
365
      <para>
437
366
        Note that this means that, in order to include an actual
465
394
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
466
395
      obscure.
467
396
    </para>
468
 
    <xi:include href="bugs.xml"/>
469
397
  </refsect1>
470
398
  
471
399
  <refsect1 id="example">
473
401
    <informalexample>
474
402
      <programlisting>
475
403
[DEFAULT]
476
 
timeout = PT5M
477
 
interval = PT2M
 
404
timeout = 1h
 
405
interval = 5m
478
406
checker = fping -q -- %%(host)s
479
407
 
480
408
# Client "foo"
497
425
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
426
        QlnHIvPzEArRQLo=
499
427
host = foo.example.org
500
 
interval = PT1M
 
428
interval = 1m
501
429
 
502
430
# Client "bar"
503
431
[bar]
504
432
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
505
433
secfile = /etc/mandos/bar-secret
506
 
timeout = PT15M
 
434
timeout = 15m
507
435
approved_by_default = False
508
 
approval_delay = PT30S
 
436
approval_delay = 30s
509
437
      </programlisting>
510
438
    </informalexample>
511
439
  </refsect1>
513
441
  <refsect1 id="see_also">
514
442
    <title>SEE ALSO</title>
515
443
    <para>
516
 
      <citerefentry><refentrytitle>intro</refentrytitle>
517
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
518
444
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
445
      <manvolnum>8</manvolnum></citerefentry>,
520
446
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
447
      <manvolnum>5</manvolnum></citerefentry>,
522
448
      <citerefentry><refentrytitle>mandos</refentrytitle>
523
 
      <manvolnum>8</manvolnum></citerefentry>,
524
 
      <citerefentry><refentrytitle>fping</refentrytitle>
525
449
      <manvolnum>8</manvolnum></citerefentry>
526
450
    </para>
527
 
    <variablelist>
528
 
      <varlistentry>
529
 
        <term>
530
 
          RFC 3339: <citetitle>Date and Time on the Internet:
531
 
          Timestamps</citetitle>
532
 
        </term>
533
 
      <listitem>
534
 
        <para>
535
 
          The time intervals are in the "duration" format, as
536
 
          specified in ABNF in Appendix A of RFC 3339.
537
 
        </para>
538
 
      </listitem>
539
 
      </varlistentry>
540
 
    </variablelist>
541
451
  </refsect1>
542
452
</refentry>
543
453
<!-- Local Variables: -->