/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: 2008-09-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2012-01-01">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-09-04">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
35
      <holder>Teddy Hogeborn</holder>
41
36
      <holder>Björn Påhlsson</holder>
42
37
    </copyright>
43
38
    <xi:include href="legalnotice.xml"/>
44
39
  </refentryinfo>
45
 
  
 
40
 
46
41
  <refmeta>
47
42
    <refentrytitle>&CONFNAME;</refentrytitle>
48
43
    <manvolnum>5</manvolnum>
54
49
      Configuration file for the Mandos server
55
50
    </refpurpose>
56
51
  </refnamediv>
57
 
  
 
52
 
58
53
  <refsynopsisdiv>
59
54
    <synopsis>&CONFPATH;</synopsis>
60
55
  </refsynopsisdiv>
61
 
  
 
56
 
62
57
  <refsect1 id="description">
63
58
    <title>DESCRIPTION</title>
64
59
    <para>
66
61
      ><refentrytitle>mandos</refentrytitle>
67
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
68
63
      The file needs to list all clients that should be able to use
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.
 
64
      the service.  All clients listed will be regarded as valid, even
 
65
      if a client was declared invalid in a previous run of the
 
66
      server.
71
67
    </para>
72
68
    <para>
73
69
      The format starts with a <literal>[<replaceable>section
99
95
    <para>
100
96
      Unknown options are ignored.  The used options are as follows:
101
97
    </para>
102
 
    
 
98
 
103
99
    <variablelist>
104
 
      
105
 
      <varlistentry>
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>.
153
 
          </para>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
      
 
100
 
 
101
      <varlistentry>
 
102
        <term><option>timeout<literal> = </literal><replaceable
 
103
        >TIME</replaceable></option></term>
 
104
        <listitem>
 
105
          <para>
 
106
            This option is <emphasis>optional</emphasis>.
 
107
          </para>
 
108
          <para>
 
109
            The timeout is how long the server will wait for a
 
110
            successful checker run until a client is considered
 
111
            invalid - that is, ineligible to get the data this server
 
112
            holds.  By default Mandos will use 1 hour.
 
113
          </para>
 
114
          <para>
 
115
            The <replaceable>TIME</replaceable> is specified as a
 
116
            space-separated number of values, each of which is a
 
117
            number and a one-character suffix.  The suffix must be one
 
118
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
119
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
120
            minutes, hours, and weeks, respectively.  The values are
 
121
            added together to give the total time value, so all of
 
122
            <quote><literal>330s</literal></quote>,
 
123
            <quote><literal>110s 110s 110s</literal></quote>, and
 
124
            <quote><literal>5m 30s</literal></quote> will give a value
 
125
            of five minutes and thirty seconds.
 
126
          </para>
 
127
        </listitem>
 
128
      </varlistentry>
 
129
 
 
130
      <varlistentry>
 
131
        <term><option>interval<literal> = </literal><replaceable
 
132
        >TIME</replaceable></option></term>
 
133
        <listitem>
 
134
          <para>
 
135
            This option is <emphasis>optional</emphasis>.
 
136
          </para>
 
137
          <para>
 
138
            How often to run the checker to confirm that a client is
 
139
            still up.  <emphasis>Note:</emphasis> a new checker will
 
140
            not be started if an old one is still running.  The server
 
141
            will wait for a checker to complete until the above
 
142
            <quote><varname>timeout</varname></quote> occurs, at which
 
143
            time the client will be marked invalid, and any running
 
144
            checker killed.  The default interval is 5 minutes.
 
145
          </para>
 
146
          <para>
 
147
            The format of <replaceable>TIME</replaceable> is the same
 
148
            as for <varname>timeout</varname> above.
 
149
          </para>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
 
157
153
      <varlistentry>
158
154
        <term><option>checker<literal> = </literal><replaceable
159
155
        >COMMAND</replaceable></option></term>
172
168
            <varname>PATH</varname> will be searched.  The default
173
169
            value for the checker command is <quote><literal
174
170
            ><command>fping</command> <option>-q</option> <option
175
 
            >--</option> %%(host)s</literal></quote>.
 
171
            >--</option> %(host)s</literal></quote>.
176
172
          </para>
177
173
          <para>
178
174
            In addition to normal start time expansion, this option
183
179
      </varlistentry>
184
180
      
185
181
      <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>
209
182
        <term><option>fingerprint<literal> = </literal
210
183
        ><replaceable>HEXSTRING</replaceable></option></term>
211
184
        <listitem>
222
195
      </varlistentry>
223
196
      
224
197
      <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>
289
198
        <term><option>secret<literal> = </literal><replaceable
290
199
        >BASE64_ENCODED_DATA</replaceable></option></term>
291
200
        <listitem>
314
223
          </para>
315
224
        </listitem>
316
225
      </varlistentry>
317
 
      
 
226
 
318
227
      <varlistentry>
319
 
        <term><option>timeout<literal> = </literal><replaceable
320
 
        >TIME</replaceable></option></term>
 
228
        <term><option>secfile<literal> = </literal><replaceable
 
229
        >FILENAME</replaceable></option></term>
321
230
        <listitem>
322
231
          <para>
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.
 
232
            This option is only used if <option>secret</option> is not
 
233
            specified, in which case this option is
 
234
            <emphasis>required</emphasis>.
 
235
          </para>
 
236
          <para>
 
237
            Similar to the <option>secret</option>, except the secret
 
238
            data is in an external file.  The contents of the file
 
239
            should <emphasis>not</emphasis> be base64-encoded, but
 
240
            will be sent to clients verbatim.
344
241
          </para>
345
242
        </listitem>
346
243
      </varlistentry>
347
 
      
 
244
 
348
245
      <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>
 
246
        <term><option><literal>host = </literal><replaceable
 
247
        >STRING</replaceable></option></term>
354
248
        <listitem>
355
249
          <para>
356
 
            Whether this client should be enabled by default.  The
357
 
            default is <quote>true</quote>.
 
250
            This option is <emphasis>optional</emphasis>, but highly
 
251
            <emphasis>recommended</emphasis> unless the
 
252
            <option>checker</option> option is modified to a
 
253
            non-standard value without <quote>%(host)s</quote> in it.
 
254
          </para>
 
255
          <para>
 
256
            Host name for this client.  This is not used by the server
 
257
            directly, but can be, and is by default, used by the
 
258
            checker.  See the <option>checker</option> option.
358
259
          </para>
359
260
        </listitem>
360
261
      </varlistentry>
397
298
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
299
        ></quote> will be replaced by the value of the attribute
399
300
        <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>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.
 
301
        <quote><classname>Client</classname></quote> object.  See the
 
302
        source code for details, and let the authors know of any
 
303
        attributes that are useful so they may be preserved to any new
 
304
        versions of this software.
422
305
      </para>
423
306
      <para>
424
307
        Note that this means that, in order to include an actual
430
313
        mode is needed to expose an error of this kind.
431
314
      </para>
432
315
    </refsect2>
433
 
    
 
316
 
434
317
  </refsect1>
435
318
  
436
319
  <refsect1 id="files">
459
342
    <informalexample>
460
343
      <programlisting>
461
344
[DEFAULT]
462
 
timeout = 5m
463
 
interval = 2m
464
 
checker = fping -q -- %%(host)s
 
345
timeout = 1h
 
346
interval = 5m
 
347
checker = fping -q -- %(host)s
465
348
 
466
349
# Client "foo"
467
350
[foo]
490
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
491
374
secfile = /etc/mandos/bar-secret
492
375
timeout = 15m
493
 
approved_by_default = False
494
 
approval_delay = 30s
 
376
 
495
377
      </programlisting>
496
378
    </informalexample>
497
379
  </refsect1>
499
381
  <refsect1 id="see_also">
500
382
    <title>SEE ALSO</title>
501
383
    <para>
502
 
      <citerefentry><refentrytitle>intro</refentrytitle>
503
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
504
384
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
505
385
      <manvolnum>8</manvolnum></citerefentry>,
506
386
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>