/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

* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2009-01-08">
 
6
<!ENTITY TIMESTAMP "2012-01-01">
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>
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>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
63
66
      ><refentrytitle>mandos</refentrytitle>
64
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
68
      The file needs to list all clients that should be able to use
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.
 
69
      the service.  All clients listed will be regarded as enabled,
 
70
      even if a client was disabled in a previous run of the server.
69
71
    </para>
70
72
    <para>
71
73
      The format starts with a <literal>[<replaceable>section
101
103
    <variablelist>
102
104
      
103
105
      <varlistentry>
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 a
112
 
            successful checker run until a client is considered
113
 
            invalid - that is, ineligible to get the data this server
114
 
            holds.  By default Mandos will use 1 hour.
115
 
          </para>
116
 
          <para>
117
 
            The <replaceable>TIME</replaceable> is specified as a
118
 
            space-separated number of values, each of which is a
119
 
            number and a one-character suffix.  The suffix must be one
120
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
122
 
            minutes, hours, and weeks, respectively.  The values are
123
 
            added together to give the total time value, so all of
124
 
            <quote><literal>330s</literal></quote>,
125
 
            <quote><literal>110s 110s 110s</literal></quote>, and
126
 
            <quote><literal>5m 30s</literal></quote> will give a value
127
 
            of five minutes and thirty seconds.
128
 
          </para>
129
 
        </listitem>
130
 
      </varlistentry>
131
 
      
132
 
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
135
 
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
139
 
          <para>
140
 
            How often to run the checker to confirm that a client is
141
 
            still up.  <emphasis>Note:</emphasis> a new checker will
142
 
            not be started if an old one is still running.  The server
143
 
            will wait for a checker to complete until the above
144
 
            <quote><varname>timeout</varname></quote> occurs, at which
145
 
            time the client will be marked invalid, and any running
146
 
            checker killed.  The default interval is 5 minutes.
147
 
          </para>
148
 
          <para>
149
 
            The format of <replaceable>TIME</replaceable> is the same
150
 
            as for <varname>timeout</varname> above.
 
106
        <term><option>approval_delay<literal> = </literal><replaceable
 
107
        >TIME</replaceable></option></term>
 
108
        <listitem>
 
109
          <para>
 
110
            This option is <emphasis>optional</emphasis>.
 
111
          </para>
 
112
          <para>
 
113
            How long to wait for external approval before resorting to
 
114
            use the <option>approved_by_default</option> value.  The
 
115
            default is <quote>0s</quote>, i.e. not to wait.
 
116
          </para>
 
117
          <para>
 
118
            The format of <replaceable>TIME</replaceable> is the same
 
119
            as for <varname>timeout</varname> below.
 
120
          </para>
 
121
        </listitem>
 
122
      </varlistentry>
 
123
      
 
124
      <varlistentry>
 
125
        <term><option>approval_duration<literal> = </literal
 
126
        ><replaceable>TIME</replaceable></option></term>
 
127
        <listitem>
 
128
          <para>
 
129
            This option is <emphasis>optional</emphasis>.
 
130
          </para>
 
131
          <para>
 
132
            How long an external approval lasts.  The default is 1
 
133
            second.
 
134
          </para>
 
135
          <para>
 
136
            The format of <replaceable>TIME</replaceable> is the same
 
137
            as for <varname>timeout</varname> below.
 
138
          </para>
 
139
        </listitem>
 
140
      </varlistentry>
 
141
      
 
142
      <varlistentry>
 
143
        <term><option>approved_by_default<literal> = </literal
 
144
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
145
          >true</literal> | <literal>on</literal> | <literal
 
146
          >0</literal> | <literal>no</literal> | <literal
 
147
          >false</literal> | <literal>off</literal> }</option></term>
 
148
        <listitem>
 
149
          <para>
 
150
            Whether to approve a client by default after
 
151
            the <option>approval_delay</option>.  The default
 
152
            is <quote>True</quote>.
151
153
          </para>
152
154
        </listitem>
153
155
      </varlistentry>
181
183
      </varlistentry>
182
184
      
183
185
      <varlistentry>
 
186
        <term><option>extended_timeout<literal> = </literal><replaceable
 
187
        >TIME</replaceable></option></term>
 
188
        <listitem>
 
189
          <para>
 
190
            This option is <emphasis>optional</emphasis>.
 
191
          </para>
 
192
          <para>
 
193
            Extended timeout is an added timeout that is given once
 
194
            after a password has been sent successfully to a client.
 
195
            The timeout is by default longer than the normal timeout,
 
196
            and is used for handling the extra long downtime while a
 
197
            machine is booting up.  Time to take into consideration
 
198
            when changing this value is file system checks and quota
 
199
            checks.  The default value is 15 minutes.
 
200
          </para>
 
201
          <para>
 
202
            The format of <replaceable>TIME</replaceable> is the same
 
203
            as for <varname>timeout</varname> below.
 
204
          </para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      
 
208
      <varlistentry>
184
209
        <term><option>fingerprint<literal> = </literal
185
210
        ><replaceable>HEXSTRING</replaceable></option></term>
186
211
        <listitem>
197
222
      </varlistentry>
198
223
      
199
224
      <varlistentry>
 
225
        <term><option><literal>host = </literal><replaceable
 
226
        >STRING</replaceable></option></term>
 
227
        <listitem>
 
228
          <para>
 
229
            This option is <emphasis>optional</emphasis>, but highly
 
230
            <emphasis>recommended</emphasis> unless the
 
231
            <option>checker</option> option is modified to a
 
232
            non-standard value without <quote>%%(host)s</quote> in it.
 
233
          </para>
 
234
          <para>
 
235
            Host name for this client.  This is not used by the server
 
236
            directly, but can be, and is by default, used by the
 
237
            checker.  See the <option>checker</option> option.
 
238
          </para>
 
239
        </listitem>
 
240
      </varlistentry>
 
241
      
 
242
      <varlistentry>
 
243
        <term><option>interval<literal> = </literal><replaceable
 
244
        >TIME</replaceable></option></term>
 
245
        <listitem>
 
246
          <para>
 
247
            This option is <emphasis>optional</emphasis>.
 
248
          </para>
 
249
          <para>
 
250
            How often to run the checker to confirm that a client is
 
251
            still up.  <emphasis>Note:</emphasis> a new checker will
 
252
            not be started if an old one is still running.  The server
 
253
            will wait for a checker to complete until the below
 
254
            <quote><varname>timeout</varname></quote> occurs, at which
 
255
            time the client will be disabled, and any running checker
 
256
            killed.  The default interval is 2 minutes.
 
257
          </para>
 
258
          <para>
 
259
            The format of <replaceable>TIME</replaceable> is the same
 
260
            as for <varname>timeout</varname> below.
 
261
          </para>
 
262
        </listitem>
 
263
      </varlistentry>
 
264
      
 
265
      <varlistentry>
 
266
        <term><option>secfile<literal> = </literal><replaceable
 
267
        >FILENAME</replaceable></option></term>
 
268
        <listitem>
 
269
          <para>
 
270
            This option is only used if <option>secret</option> is not
 
271
            specified, in which case this option is
 
272
            <emphasis>required</emphasis>.
 
273
          </para>
 
274
          <para>
 
275
            Similar to the <option>secret</option>, except the secret
 
276
            data is in an external file.  The contents of the file
 
277
            should <emphasis>not</emphasis> be base64-encoded, but
 
278
            will be sent to clients verbatim.
 
279
          </para>
 
280
          <para>
 
281
            File names of the form <filename>~user/foo/bar</filename>
 
282
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
283
            are supported.
 
284
          </para>
 
285
        </listitem>
 
286
      </varlistentry>
 
287
      
 
288
      <varlistentry>
200
289
        <term><option>secret<literal> = </literal><replaceable
201
290
        >BASE64_ENCODED_DATA</replaceable></option></term>
202
291
        <listitem>
227
316
      </varlistentry>
228
317
      
229
318
      <varlistentry>
230
 
        <term><option>secfile<literal> = </literal><replaceable
231
 
        >FILENAME</replaceable></option></term>
 
319
        <term><option>timeout<literal> = </literal><replaceable
 
320
        >TIME</replaceable></option></term>
232
321
        <listitem>
233
322
          <para>
234
 
            This option is only used if <option>secret</option> is not
235
 
            specified, in which case this option is
236
 
            <emphasis>required</emphasis>.
237
 
          </para>
238
 
          <para>
239
 
            Similar to the <option>secret</option>, except the secret
240
 
            data is in an external file.  The contents of the file
241
 
            should <emphasis>not</emphasis> be base64-encoded, but
242
 
            will be sent to clients verbatim.
243
 
          </para>
244
 
          <para>
245
 
            File names of the form <filename>~user/foo/bar</filename>
246
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
 
            are supported.
 
323
            This option is <emphasis>optional</emphasis>.
 
324
          </para>
 
325
          <para>
 
326
            The timeout is how long the server will wait, after a
 
327
            successful checker run, until a client is disabled and not
 
328
            allowed to get the data this server holds.  By default
 
329
            Mandos will use 5 minutes.  See also the
 
330
            <option>extended_timeout</option> option.
 
331
          </para>
 
332
          <para>
 
333
            The <replaceable>TIME</replaceable> is specified as a
 
334
            space-separated number of values, each of which is a
 
335
            number and a one-character suffix.  The suffix must be one
 
336
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
337
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
338
            minutes, hours, and weeks, respectively.  The values are
 
339
            added together to give the total time value, so all of
 
340
            <quote><literal>330s</literal></quote>,
 
341
            <quote><literal>110s 110s 110s</literal></quote>, and
 
342
            <quote><literal>5m 30s</literal></quote> will give a value
 
343
            of five minutes and thirty seconds.
248
344
          </para>
249
345
        </listitem>
250
346
      </varlistentry>
251
347
      
252
348
      <varlistentry>
253
 
        <term><option><literal>host = </literal><replaceable
254
 
        >STRING</replaceable></option></term>
 
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>
255
354
        <listitem>
256
355
          <para>
257
 
            This option is <emphasis>optional</emphasis>, but highly
258
 
            <emphasis>recommended</emphasis> unless the
259
 
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%(host)s</quote> in it.
261
 
          </para>
262
 
          <para>
263
 
            Host name for this client.  This is not used by the server
264
 
            directly, but can be, and is by default, used by the
265
 
            checker.  See the <option>checker</option> option.
 
356
            Whether this client should be enabled by default.  The
 
357
            default is <quote>true</quote>.
266
358
          </para>
267
359
        </listitem>
268
360
      </varlistentry>
305
397
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
306
398
        ></quote> will be replaced by the value of the attribute
307
399
        <varname>foo</varname> of the internal
308
 
        <quote><classname>Client</classname></quote> object.  See the
309
 
        source code for details, and let the authors know of any
310
 
        attributes that are useful so they may be preserved to any new
311
 
        versions of this software.
 
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>fingerprint</literal></quote>,
 
408
        <quote><literal>host</literal></quote>,
 
409
        <quote><literal>interval</literal></quote>,
 
410
        <quote><literal>last_approval_request</literal></quote>,
 
411
        <quote><literal>last_checked_ok</literal></quote>,
 
412
        <quote><literal>last_enabled</literal></quote>,
 
413
        <quote><literal>name</literal></quote>,
 
414
        <quote><literal>timeout</literal></quote>, and, if using
 
415
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
416
        See the source code for details.  <emphasis role="strong"
 
417
        >Currently, <emphasis>none</emphasis> of these attributes
 
418
        except <quote><literal>host</literal></quote> are guaranteed
 
419
        to be valid in future versions.</emphasis> Therefore, please
 
420
        let the authors know of any attributes that are useful so they
 
421
        may be preserved to any new versions of this software.
312
422
      </para>
313
423
      <para>
314
424
        Note that this means that, in order to include an actual
349
459
    <informalexample>
350
460
      <programlisting>
351
461
[DEFAULT]
352
 
timeout = 1h
353
 
interval = 5m
 
462
timeout = 5m
 
463
interval = 2m
354
464
checker = fping -q -- %%(host)s
355
465
 
356
466
# Client "foo"
380
490
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
491
secfile = /etc/mandos/bar-secret
382
492
timeout = 15m
 
493
approved_by_default = False
 
494
approval_delay = 30s
383
495
      </programlisting>
384
496
    </informalexample>
385
497
  </refsect1>
387
499
  <refsect1 id="see_also">
388
500
    <title>SEE ALSO</title>
389
501
    <para>
 
502
      <citerefentry><refentrytitle>intro</refentrytitle>
 
503
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
504
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
505
      <manvolnum>8</manvolnum></citerefentry>,
392
506
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>