/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: 2009-10-22 00:05:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091022000501-g792e99q5g1wkyet
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
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 "2012-06-23">
 
6
<!ENTITY TIMESTAMP "2009-09-17">
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>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
37
      <holder>Teddy Hogeborn</holder>
41
38
      <holder>Björn Påhlsson</holder>
42
39
    </copyright>
66
63
      ><refentrytitle>mandos</refentrytitle>
67
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
65
      The file needs to list all clients that should be able to use
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.
 
66
      the service.  All clients listed will be regarded as valid, even
 
67
      if a client was declared invalid in a previous run of the
 
68
      server.
76
69
    </para>
77
70
    <para>
78
71
      The format starts with a <literal>[<replaceable>section
108
101
    <variablelist>
109
102
      
110
103
      <varlistentry>
111
 
        <term><option>approval_delay<literal> = </literal><replaceable
112
 
        >TIME</replaceable></option></term>
113
 
        <listitem>
114
 
          <para>
115
 
            This option is <emphasis>optional</emphasis>.
116
 
          </para>
117
 
          <para>
118
 
            How long to wait for external approval before resorting to
119
 
            use the <option>approved_by_default</option> value.  The
120
 
            default is <quote>0s</quote>, i.e. not to wait.
121
 
          </para>
122
 
          <para>
123
 
            The format of <replaceable>TIME</replaceable> is the same
124
 
            as for <varname>timeout</varname> below.
125
 
          </para>
126
 
        </listitem>
127
 
      </varlistentry>
128
 
      
129
 
      <varlistentry>
130
 
        <term><option>approval_duration<literal> = </literal
131
 
        ><replaceable>TIME</replaceable></option></term>
132
 
        <listitem>
133
 
          <para>
134
 
            This option is <emphasis>optional</emphasis>.
135
 
          </para>
136
 
          <para>
137
 
            How long an external approval lasts.  The default is 1
138
 
            second.
139
 
          </para>
140
 
          <para>
141
 
            The format of <replaceable>TIME</replaceable> is the same
142
 
            as for <varname>timeout</varname> below.
143
 
          </para>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
      
147
 
      <varlistentry>
148
 
        <term><option>approved_by_default<literal> = </literal
149
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
150
 
          >true</literal> | <literal>on</literal> | <literal
151
 
          >0</literal> | <literal>no</literal> | <literal
152
 
          >false</literal> | <literal>off</literal> }</option></term>
153
 
        <listitem>
154
 
          <para>
155
 
            Whether to approve a client by default after
156
 
            the <option>approval_delay</option>.  The default
157
 
            is <quote>True</quote>.
 
104
        <term><option>timeout<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
 
106
        <listitem>
 
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
 
110
          <para>
 
111
            The timeout is how long the server will wait (for either a
 
112
            successful checker run or a client receiving its secret)
 
113
            until a client is considered invalid - that is, ineligible
 
114
            to get the data this server holds.  By default Mandos will
 
115
            use 1 hour.
 
116
          </para>
 
117
          <para>
 
118
            The <replaceable>TIME</replaceable> is specified as a
 
119
            space-separated number of values, each of which is a
 
120
            number and a one-character suffix.  The suffix must be one
 
121
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
122
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
123
            minutes, hours, and weeks, respectively.  The values are
 
124
            added together to give the total time value, so all of
 
125
            <quote><literal>330s</literal></quote>,
 
126
            <quote><literal>110s 110s 110s</literal></quote>, and
 
127
            <quote><literal>5m 30s</literal></quote> will give a value
 
128
            of five minutes and thirty seconds.
 
129
          </para>
 
130
        </listitem>
 
131
      </varlistentry>
 
132
      
 
133
      <varlistentry>
 
134
        <term><option>interval<literal> = </literal><replaceable
 
135
        >TIME</replaceable></option></term>
 
136
        <listitem>
 
137
          <para>
 
138
            This option is <emphasis>optional</emphasis>.
 
139
          </para>
 
140
          <para>
 
141
            How often to run the checker to confirm that a client is
 
142
            still up.  <emphasis>Note:</emphasis> a new checker will
 
143
            not be started if an old one is still running.  The server
 
144
            will wait for a checker to complete until the above
 
145
            <quote><varname>timeout</varname></quote> occurs, at which
 
146
            time the client will be marked invalid, and any running
 
147
            checker killed.  The default interval is 5 minutes.
 
148
          </para>
 
149
          <para>
 
150
            The format of <replaceable>TIME</replaceable> is the same
 
151
            as for <varname>timeout</varname> above.
158
152
          </para>
159
153
        </listitem>
160
154
      </varlistentry>
167
161
            This option is <emphasis>optional</emphasis>.
168
162
          </para>
169
163
          <para>
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>
 
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>
176
170
            <option>-c</option></command></quote>, so
177
171
            <varname>PATH</varname> will be searched.  The default
178
172
            value for the checker command is <quote><literal
188
182
      </varlistentry>
189
183
      
190
184
      <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>
214
185
        <term><option>fingerprint<literal> = </literal
215
186
        ><replaceable>HEXSTRING</replaceable></option></term>
216
187
        <listitem>
227
198
      </varlistentry>
228
199
      
229
200
      <varlistentry>
230
 
        <term><option><literal>host = </literal><replaceable
231
 
        >STRING</replaceable></option></term>
232
 
        <listitem>
233
 
          <para>
234
 
            This option is <emphasis>optional</emphasis>, but highly
235
 
            <emphasis>recommended</emphasis> unless the
236
 
            <option>checker</option> option is modified to a
237
 
            non-standard value without <quote>%%(host)s</quote> in it.
238
 
          </para>
239
 
          <para>
240
 
            Host name for this client.  This is not used by the server
241
 
            directly, but can be, and is by default, used by the
242
 
            checker.  See the <option>checker</option> option.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>interval<literal> = </literal><replaceable
249
 
        >TIME</replaceable></option></term>
250
 
        <listitem>
251
 
          <para>
252
 
            This option is <emphasis>optional</emphasis>.
253
 
          </para>
254
 
          <para>
255
 
            How often to run the checker to confirm that a client is
256
 
            still up.  <emphasis>Note:</emphasis> a new checker will
257
 
            not be started if an old one is still running.  The server
258
 
            will wait for a checker to complete until the below
259
 
            <quote><varname>timeout</varname></quote> occurs, at which
260
 
            time the client will be disabled, and any running checker
261
 
            killed.  The default interval is 2 minutes.
262
 
          </para>
263
 
          <para>
264
 
            The format of <replaceable>TIME</replaceable> is the same
265
 
            as for <varname>timeout</varname> below.
266
 
          </para>
267
 
        </listitem>
268
 
      </varlistentry>
269
 
      
270
 
      <varlistentry>
271
 
        <term><option>secfile<literal> = </literal><replaceable
272
 
        >FILENAME</replaceable></option></term>
273
 
        <listitem>
274
 
          <para>
275
 
            This option is only used if <option>secret</option> is not
276
 
            specified, in which case this option is
277
 
            <emphasis>required</emphasis>.
278
 
          </para>
279
 
          <para>
280
 
            Similar to the <option>secret</option>, except the secret
281
 
            data is in an external file.  The contents of the file
282
 
            should <emphasis>not</emphasis> be base64-encoded, but
283
 
            will be sent to clients verbatim.
284
 
          </para>
285
 
          <para>
286
 
            File names of the form <filename>~user/foo/bar</filename>
287
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
288
 
            are supported.
289
 
          </para>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
201
        <term><option>secret<literal> = </literal><replaceable
295
202
        >BASE64_ENCODED_DATA</replaceable></option></term>
296
203
        <listitem>
321
228
      </varlistentry>
322
229
      
323
230
      <varlistentry>
324
 
        <term><option>timeout<literal> = </literal><replaceable
325
 
        >TIME</replaceable></option></term>
 
231
        <term><option>secfile<literal> = </literal><replaceable
 
232
        >FILENAME</replaceable></option></term>
326
233
        <listitem>
327
234
          <para>
328
 
            This option is <emphasis>optional</emphasis>.
329
 
          </para>
330
 
          <para>
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.
 
235
            This option is only used if <option>secret</option> is not
 
236
            specified, in which case this option is
 
237
            <emphasis>required</emphasis>.
 
238
          </para>
 
239
          <para>
 
240
            Similar to the <option>secret</option>, except the secret
 
241
            data is in an external file.  The contents of the file
 
242
            should <emphasis>not</emphasis> be base64-encoded, but
 
243
            will be sent to clients verbatim.
 
244
          </para>
 
245
          <para>
 
246
            File names of the form <filename>~user/foo/bar</filename>
 
247
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
248
            are supported.
344
249
          </para>
345
250
        </listitem>
346
251
      </varlistentry>
347
252
      
348
253
      <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>
 
254
        <term><option><literal>host = </literal><replaceable
 
255
        >STRING</replaceable></option></term>
354
256
        <listitem>
355
257
          <para>
356
 
            Whether this client should be enabled by default.  The
357
 
            default is <quote>true</quote>.
 
258
            This option is <emphasis>optional</emphasis>, but highly
 
259
            <emphasis>recommended</emphasis> unless the
 
260
            <option>checker</option> option is modified to a
 
261
            non-standard value without <quote>%%(host)s</quote> in it.
 
262
          </para>
 
263
          <para>
 
264
            Host name for this client.  This is not used by the server
 
265
            directly, but can be, and is by default, used by the
 
266
            checker.  See the <option>checker</option> option.
358
267
          </para>
359
268
        </listitem>
360
269
      </varlistentry>
397
306
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
307
        ></quote> will be replaced by the value of the attribute
399
308
        <varname>foo</varname> of the internal
400
 
        <quote><classname>Client</classname></quote> object in the
401
 
        Mandos server.  The currently allowed values for
402
 
        <replaceable>foo</replaceable> are:
403
 
        <quote><literal>approval_delay</literal></quote>,
404
 
        <quote><literal>approval_duration</literal></quote>,
405
 
        <quote><literal>created</literal></quote>,
406
 
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>expires</literal></quote>,
408
 
        <quote><literal>fingerprint</literal></quote>,
409
 
        <quote><literal>host</literal></quote>,
410
 
        <quote><literal>interval</literal></quote>,
411
 
        <quote><literal>last_approval_request</literal></quote>,
412
 
        <quote><literal>last_checked_ok</literal></quote>,
413
 
        <quote><literal>last_enabled</literal></quote>,
414
 
        <quote><literal>name</literal></quote>,
415
 
        <quote><literal>timeout</literal></quote>, and, if using
416
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
417
 
        See the source code for details.  <emphasis role="strong"
418
 
        >Currently, <emphasis>none</emphasis> of these attributes
419
 
        except <quote><literal>host</literal></quote> are guaranteed
420
 
        to be valid in future versions.</emphasis> Therefore, please
421
 
        let the authors know of any attributes that are useful so they
422
 
        may be preserved to any new versions of this software.
 
309
        <quote><classname>Client</classname></quote> object.  See the
 
310
        source code for details, and let the authors know of any
 
311
        attributes that are useful so they may be preserved to any new
 
312
        versions of this software.
423
313
      </para>
424
314
      <para>
425
315
        Note that this means that, in order to include an actual
460
350
    <informalexample>
461
351
      <programlisting>
462
352
[DEFAULT]
463
 
timeout = PT5M
464
 
interval = PT2M
 
353
timeout = 1h
 
354
interval = 5m
465
355
checker = fping -q -- %%(host)s
466
356
 
467
357
# Client "foo"
484
374
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
485
375
        QlnHIvPzEArRQLo=
486
376
host = foo.example.org
487
 
interval = PT1M
 
377
interval = 1m
488
378
 
489
379
# Client "bar"
490
380
[bar]
491
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
492
382
secfile = /etc/mandos/bar-secret
493
 
timeout = PT15M
494
 
approved_by_default = False
495
 
approval_delay = PT30S
 
383
timeout = 15m
496
384
      </programlisting>
497
385
    </informalexample>
498
386
  </refsect1>
500
388
  <refsect1 id="see_also">
501
389
    <title>SEE ALSO</title>
502
390
    <para>
503
 
      <citerefentry><refentrytitle>intro</refentrytitle>
504
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
505
391
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
506
392
      <manvolnum>8</manvolnum></citerefentry>,
507
393
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
508
394
      <manvolnum>5</manvolnum></citerefentry>,
509
395
      <citerefentry><refentrytitle>mandos</refentrytitle>
510
 
      <manvolnum>8</manvolnum></citerefentry>,
511
 
      <citerefentry><refentrytitle>fping</refentrytitle>
512
396
      <manvolnum>8</manvolnum></citerefentry>
513
397
    </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>
528
398
  </refsect1>
529
399
</refentry>
530
400
<!-- Local Variables: -->