/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: 2011-03-17 18:14:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110317181434-si1m0l8q5fakzgjx
* DBUS-API: Fix grammar.

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 "2015-07-20">
 
6
<!ENTITY TIMESTAMP "2011-02-27">
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>
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
39
      <holder>Teddy Hogeborn</holder>
44
40
      <holder>Björn Påhlsson</holder>
45
41
    </copyright>
69
65
      ><refentrytitle>mandos</refentrytitle>
70
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
71
67
      The file needs to list all clients that should be able to use
72
 
      the service.  The settings in this file can be overridden by
73
 
      runtime changes to the server, which it saves across restarts.
74
 
      (See the section called <quote>PERSISTENT STATE</quote> in
75
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
76
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
77
 
      >changes</emphasis> to this file (including adding and removing
78
 
      clients) will, at startup, override changes done during runtime.
 
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.
79
70
    </para>
80
71
    <para>
81
72
      The format starts with a <literal>[<replaceable>section
120
111
          <para>
121
112
            How long to wait for external approval before resorting to
122
113
            use the <option>approved_by_default</option> value.  The
123
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
124
115
          </para>
125
116
          <para>
126
117
            The format of <replaceable>TIME</replaceable> is the same
170
161
            This option is <emphasis>optional</emphasis>.
171
162
          </para>
172
163
          <para>
173
 
            This option overrides the default shell command that the
174
 
            server will use to check if the client is still up.  Any
175
 
            output of the command will be ignored, only the exit code
176
 
            is checked:  If the exit code of the command is zero, the
177
 
            client is considered up.  The command will be run using
178
 
            <quote><command><filename>/bin/sh</filename>
 
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>
179
170
            <option>-c</option></command></quote>, so
180
171
            <varname>PATH</varname> will be searched.  The default
181
172
            value for the checker command is <quote><literal
182
173
            ><command>fping</command> <option>-q</option> <option
183
 
            >--</option> %%(host)s</literal></quote>.  Note that
184
 
            <command>mandos-keygen</command>, when generating output
185
 
            to be inserted into this file, normally looks for an SSH
186
 
            server on the Mandos client, and, if it find one, outputs
187
 
            a <option>checker</option> option to check for the
188
 
            client’s key fingerprint – this is more secure against
189
 
            spoofing.
 
174
            >--</option> %%(host)s</literal></quote>.
190
175
          </para>
191
176
          <para>
192
177
            In addition to normal start time expansion, this option
197
182
      </varlistentry>
198
183
      
199
184
      <varlistentry>
200
 
        <term><option>extended_timeout<literal> = </literal><replaceable
201
 
        >TIME</replaceable></option></term>
202
 
        <listitem>
203
 
          <para>
204
 
            This option is <emphasis>optional</emphasis>.
205
 
          </para>
206
 
          <para>
207
 
            Extended timeout is an added timeout that is given once
208
 
            after a password has been sent successfully to a client.
209
 
            The timeout is by default longer than the normal timeout,
210
 
            and is used for handling the extra long downtime while a
211
 
            machine is booting up.  Time to take into consideration
212
 
            when changing this value is file system checks and quota
213
 
            checks.  The default value is 15 minutes.
214
 
          </para>
215
 
          <para>
216
 
            The format of <replaceable>TIME</replaceable> is the same
217
 
            as for <varname>timeout</varname> below.
218
 
          </para>
219
 
        </listitem>
220
 
      </varlistentry>
221
 
      
222
 
      <varlistentry>
223
185
        <term><option>fingerprint<literal> = </literal
224
186
        ><replaceable>HEXSTRING</replaceable></option></term>
225
187
        <listitem>
267
229
            will wait for a checker to complete until the below
268
230
            <quote><varname>timeout</varname></quote> occurs, at which
269
231
            time the client will be disabled, and any running checker
270
 
            killed.  The default interval is 2 minutes.
 
232
            killed.  The default interval is 5 minutes.
271
233
          </para>
272
234
          <para>
273
235
            The format of <replaceable>TIME</replaceable> is the same
337
299
            This option is <emphasis>optional</emphasis>.
338
300
          </para>
339
301
          <para>
340
 
            The timeout is how long the server will wait, after a
341
 
            successful checker run, until a client is disabled and not
342
 
            allowed to get the data this server holds.  By default
343
 
            Mandos will use 5 minutes.  See also the
344
 
            <option>extended_timeout</option> option.
345
 
          </para>
346
 
          <para>
347
 
            The <replaceable>TIME</replaceable> is specified as an RFC
348
 
            3339 duration; for example
349
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
350
 
            one year, two months, three days, four hours, five
351
 
            minutes, and six seconds.  Some values can be omitted, see
352
 
            RFC 3339 Appendix A for details.
353
 
          </para>
354
 
        </listitem>
355
 
      </varlistentry>
356
 
      
357
 
      <varlistentry>
358
 
        <term><option>enabled<literal> = </literal>{ <literal
359
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
360
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
361
 
        >no</literal> | <literal>false</literal> | <literal
362
 
        >off</literal> }</option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            Whether this client should be enabled by default.  The
366
 
            default is <quote>true</quote>.
 
302
            The timeout is how long the server will wait (for either a
 
303
            successful checker run or a client receiving its secret)
 
304
            until a client is disabled and not allowed to get the data
 
305
            this server holds.  By default Mandos will use 1 hour.
 
306
          </para>
 
307
          <para>
 
308
            The <replaceable>TIME</replaceable> is specified as a
 
309
            space-separated number of values, each of which is a
 
310
            number and a one-character suffix.  The suffix must be one
 
311
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
312
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
313
            minutes, hours, and weeks, respectively.  The values are
 
314
            added together to give the total time value, so all of
 
315
            <quote><literal>330s</literal></quote>,
 
316
            <quote><literal>110s 110s 110s</literal></quote>, and
 
317
            <quote><literal>5m 30s</literal></quote> will give a value
 
318
            of five minutes and thirty seconds.
367
319
          </para>
368
320
        </listitem>
369
321
      </varlistentry>
413
365
        <quote><literal>approval_duration</literal></quote>,
414
366
        <quote><literal>created</literal></quote>,
415
367
        <quote><literal>enabled</literal></quote>,
416
 
        <quote><literal>expires</literal></quote>,
417
368
        <quote><literal>fingerprint</literal></quote>,
418
369
        <quote><literal>host</literal></quote>,
419
370
        <quote><literal>interval</literal></quote>,
469
420
    <informalexample>
470
421
      <programlisting>
471
422
[DEFAULT]
472
 
timeout = PT5M
473
 
interval = PT2M
 
423
timeout = 1h
 
424
interval = 5m
474
425
checker = fping -q -- %%(host)s
475
426
 
476
427
# Client "foo"
493
444
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
494
445
        QlnHIvPzEArRQLo=
495
446
host = foo.example.org
496
 
interval = PT1M
 
447
interval = 1m
497
448
 
498
449
# Client "bar"
499
450
[bar]
500
451
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
501
452
secfile = /etc/mandos/bar-secret
502
 
timeout = PT15M
 
453
timeout = 15m
503
454
approved_by_default = False
504
 
approval_delay = PT30S
 
455
approval_delay = 30s
505
456
      </programlisting>
506
457
    </informalexample>
507
458
  </refsect1>
509
460
  <refsect1 id="see_also">
510
461
    <title>SEE ALSO</title>
511
462
    <para>
512
 
      <citerefentry><refentrytitle>intro</refentrytitle>
513
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
514
463
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
515
464
      <manvolnum>8</manvolnum></citerefentry>,
516
465
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
517
466
      <manvolnum>5</manvolnum></citerefentry>,
518
467
      <citerefentry><refentrytitle>mandos</refentrytitle>
519
 
      <manvolnum>8</manvolnum></citerefentry>,
520
 
      <citerefentry><refentrytitle>fping</refentrytitle>
521
468
      <manvolnum>8</manvolnum></citerefentry>
522
469
    </para>
523
 
    <variablelist>
524
 
      <varlistentry>
525
 
        <term>
526
 
          RFC 3339: <citetitle>Date and Time on the Internet:
527
 
          Timestamps</citetitle>
528
 
        </term>
529
 
      <listitem>
530
 
        <para>
531
 
          The time intervals are in the "duration" format, as
532
 
          specified in ABNF in Appendix A of RFC 3339.
533
 
        </para>
534
 
      </listitem>
535
 
      </varlistentry>
536
 
    </variablelist>
537
470
  </refsect1>
538
471
</refentry>
539
472
<!-- Local Variables: -->