/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

  • Committer: Björn Påhlsson
  • Date: 2010-04-04 23:45:04 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 270.
  • Revision ID: belorn@braxen-20100404234504-s5llsmdwp540s1a9
The IPC pipes are now file objects, not file descriptors:
* mandos (ClientDBus.CheckedOK): Reorder to group methods, signals and
                                 properties together.
  (ClientHandler.handle,
  ForkingMixInWithPipes.process_request,
  ForkingMixInWithPipes.add_pipe_fds,
  MandosServer.add_pipe_fds): IPC pipes are now file objects, not FDs.
  (MandosServer.handle_ipc): - '' -  Take additional argument "sender"
                             containing the client IPC file object;
                             all callers changed.

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 "2012-01-01">
 
6
<!ENTITY TIMESTAMP "2009-12-09">
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 enabled,
 
67
      even if a client was disabled in a previous run of the server.
76
68
    </para>
77
69
    <para>
78
70
      The format starts with a <literal>[<replaceable>section
108
100
    <variablelist>
109
101
      
110
102
      <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>.
 
103
        <term><option>timeout<literal> = </literal><replaceable
 
104
        >TIME</replaceable></option></term>
 
105
        <listitem>
 
106
          <para>
 
107
            This option is <emphasis>optional</emphasis>.
 
108
          </para>
 
109
          <para>
 
110
            The timeout is how long the server will wait (for either a
 
111
            successful checker run or a client receiving its secret)
 
112
            until a client is disabled and not allowed to get the data
 
113
            this server holds.  By default Mandos will use 1 hour.
 
114
          </para>
 
115
          <para>
 
116
            The <replaceable>TIME</replaceable> is specified as a
 
117
            space-separated number of values, each of which is a
 
118
            number and a one-character suffix.  The suffix must be one
 
119
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
120
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
121
            minutes, hours, and weeks, respectively.  The values are
 
122
            added together to give the total time value, so all of
 
123
            <quote><literal>330s</literal></quote>,
 
124
            <quote><literal>110s 110s 110s</literal></quote>, and
 
125
            <quote><literal>5m 30s</literal></quote> will give a value
 
126
            of five minutes and thirty seconds.
 
127
          </para>
 
128
        </listitem>
 
129
      </varlistentry>
 
130
      
 
131
      <varlistentry>
 
132
        <term><option>interval<literal> = </literal><replaceable
 
133
        >TIME</replaceable></option></term>
 
134
        <listitem>
 
135
          <para>
 
136
            This option is <emphasis>optional</emphasis>.
 
137
          </para>
 
138
          <para>
 
139
            How often to run the checker to confirm that a client is
 
140
            still up.  <emphasis>Note:</emphasis> a new checker will
 
141
            not be started if an old one is still running.  The server
 
142
            will wait for a checker to complete until the above
 
143
            <quote><varname>timeout</varname></quote> occurs, at which
 
144
            time the client will be disabled, and any running checker
 
145
            killed.  The default interval is 5 minutes.
 
146
          </para>
 
147
          <para>
 
148
            The format of <replaceable>TIME</replaceable> is the same
 
149
            as for <varname>timeout</varname> above.
158
150
          </para>
159
151
        </listitem>
160
152
      </varlistentry>
188
180
      </varlistentry>
189
181
      
190
182
      <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
183
        <term><option>fingerprint<literal> = </literal
215
184
        ><replaceable>HEXSTRING</replaceable></option></term>
216
185
        <listitem>
227
196
      </varlistentry>
228
197
      
229
198
      <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
199
        <term><option>secret<literal> = </literal><replaceable
295
200
        >BASE64_ENCODED_DATA</replaceable></option></term>
296
201
        <listitem>
321
226
      </varlistentry>
322
227
      
323
228
      <varlistentry>
324
 
        <term><option>timeout<literal> = </literal><replaceable
325
 
        >TIME</replaceable></option></term>
 
229
        <term><option>secfile<literal> = </literal><replaceable
 
230
        >FILENAME</replaceable></option></term>
326
231
        <listitem>
327
232
          <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 a
339
 
            space-separated number of values, each of which is a
340
 
            number and a one-character suffix.  The suffix must be one
341
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
342
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
343
 
            minutes, hours, and weeks, respectively.  The values are
344
 
            added together to give the total time value, so all of
345
 
            <quote><literal>330s</literal></quote>,
346
 
            <quote><literal>110s 110s 110s</literal></quote>, and
347
 
            <quote><literal>5m 30s</literal></quote> will give a value
348
 
            of five minutes and thirty seconds.
 
233
            This option is only used if <option>secret</option> is not
 
234
            specified, in which case this option is
 
235
            <emphasis>required</emphasis>.
 
236
          </para>
 
237
          <para>
 
238
            Similar to the <option>secret</option>, except the secret
 
239
            data is in an external file.  The contents of the file
 
240
            should <emphasis>not</emphasis> be base64-encoded, but
 
241
            will be sent to clients verbatim.
 
242
          </para>
 
243
          <para>
 
244
            File names of the form <filename>~user/foo/bar</filename>
 
245
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
246
            are supported.
349
247
          </para>
350
248
        </listitem>
351
249
      </varlistentry>
352
250
      
353
251
      <varlistentry>
354
 
        <term><option>enabled<literal> = </literal>{ <literal
355
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
356
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
357
 
        >no</literal> | <literal>false</literal> | <literal
358
 
        >off</literal> }</option></term>
 
252
        <term><option><literal>host = </literal><replaceable
 
253
        >STRING</replaceable></option></term>
359
254
        <listitem>
360
255
          <para>
361
 
            Whether this client should be enabled by default.  The
362
 
            default is <quote>true</quote>.
 
256
            This option is <emphasis>optional</emphasis>, but highly
 
257
            <emphasis>recommended</emphasis> unless the
 
258
            <option>checker</option> option is modified to a
 
259
            non-standard value without <quote>%%(host)s</quote> in it.
 
260
          </para>
 
261
          <para>
 
262
            Host name for this client.  This is not used by the server
 
263
            directly, but can be, and is by default, used by the
 
264
            checker.  See the <option>checker</option> option.
363
265
          </para>
364
266
        </listitem>
365
267
      </varlistentry>
402
304
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
403
305
        ></quote> will be replaced by the value of the attribute
404
306
        <varname>foo</varname> of the internal
405
 
        <quote><classname>Client</classname></quote> object in the
406
 
        Mandos server.  The currently allowed values for
407
 
        <replaceable>foo</replaceable> are:
408
 
        <quote><literal>approval_delay</literal></quote>,
409
 
        <quote><literal>approval_duration</literal></quote>,
410
 
        <quote><literal>created</literal></quote>,
411
 
        <quote><literal>enabled</literal></quote>,
412
 
        <quote><literal>fingerprint</literal></quote>,
413
 
        <quote><literal>host</literal></quote>,
414
 
        <quote><literal>interval</literal></quote>,
415
 
        <quote><literal>last_approval_request</literal></quote>,
416
 
        <quote><literal>last_checked_ok</literal></quote>,
417
 
        <quote><literal>last_enabled</literal></quote>,
418
 
        <quote><literal>name</literal></quote>,
419
 
        <quote><literal>timeout</literal></quote>, and, if using
420
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
421
 
        See the source code for details.  <emphasis role="strong"
422
 
        >Currently, <emphasis>none</emphasis> of these attributes
423
 
        except <quote><literal>host</literal></quote> are guaranteed
424
 
        to be valid in future versions.</emphasis> Therefore, please
425
 
        let the authors know of any attributes that are useful so they
426
 
        may be preserved to any new versions of this software.
 
307
        <quote><classname>Client</classname></quote> object.  See the
 
308
        source code for details, and let the authors know of any
 
309
        attributes that are useful so they may be preserved to any new
 
310
        versions of this software.
427
311
      </para>
428
312
      <para>
429
313
        Note that this means that, in order to include an actual
464
348
    <informalexample>
465
349
      <programlisting>
466
350
[DEFAULT]
467
 
timeout = 5m
468
 
interval = 2m
 
351
timeout = 1h
 
352
interval = 5m
469
353
checker = fping -q -- %%(host)s
470
354
 
471
355
# Client "foo"
495
379
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
496
380
secfile = /etc/mandos/bar-secret
497
381
timeout = 15m
498
 
approved_by_default = False
499
 
approval_delay = 30s
500
382
      </programlisting>
501
383
    </informalexample>
502
384
  </refsect1>
504
386
  <refsect1 id="see_also">
505
387
    <title>SEE ALSO</title>
506
388
    <para>
507
 
      <citerefentry><refentrytitle>intro</refentrytitle>
508
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
509
389
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
510
390
      <manvolnum>8</manvolnum></citerefentry>,
511
391
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>