/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: Björn Påhlsson
  • Date: 2011-10-15 16:48:03 UTC
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 518.
  • Revision ID: belorn@fukt.bsnet.se-20111015164803-61q3hzrv91d042mb
Tags: version-1.4.1-1
* Makefile (version): Changed to "1.4.1".
* NEWS (Version 1.4.1): New entry.
* debian/changelog (1.4.1-1): - '' -

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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-31">
 
6
<!ENTITY TIMESTAMP "2011-10-10">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
35
39
      <holder>Teddy Hogeborn</holder>
36
40
      <holder>Björn Påhlsson</holder>
37
41
    </copyright>
38
42
    <xi:include href="legalnotice.xml"/>
39
43
  </refentryinfo>
40
 
 
 
44
  
41
45
  <refmeta>
42
46
    <refentrytitle>&CONFNAME;</refentrytitle>
43
47
    <manvolnum>5</manvolnum>
49
53
      Configuration file for the Mandos server
50
54
    </refpurpose>
51
55
  </refnamediv>
52
 
 
 
56
  
53
57
  <refsynopsisdiv>
54
58
    <synopsis>&CONFPATH;</synopsis>
55
59
  </refsynopsisdiv>
56
 
 
 
60
  
57
61
  <refsect1 id="description">
58
62
    <title>DESCRIPTION</title>
59
63
    <para>
61
65
      ><refentrytitle>mandos</refentrytitle>
62
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
67
      The file needs to list all clients that should be able to use
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.
 
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.
67
70
    </para>
68
71
    <para>
69
72
      The format starts with a <literal>[<replaceable>section
93
96
      start time expansion, see <xref linkend="expansion"/>.
94
97
    </para>
95
98
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
99
      Unknown options are ignored.  The used options are as follows:
97
100
    </para>
98
 
 
 
101
    
99
102
    <variablelist>
100
 
 
101
 
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
104
 
        <listitem>
105
 
          <para>
106
 
            The timeout is how long the server will wait for a
107
 
            successful checker run until a client is considered
108
 
            invalid - that is, ineligible to get the data this server
109
 
            holds.  By default Mandos will use 1 hour.
110
 
          </para>
111
 
          <para>
112
 
            The <replaceable>TIME</replaceable> is specified as a
113
 
            space-separated number of values, each of which is a
114
 
            number and a one-character suffix.  The suffix must be one
115
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
116
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
117
 
            minutes, hours, and weeks, respectively.  The values are
118
 
            added together to give the total time value, so all of
119
 
            <quote><literal>330s</literal></quote>,
120
 
            <quote><literal>110s 110s 110s</literal></quote>, and
121
 
            <quote><literal>5m 30s</literal></quote> will give a value
122
 
            of five minutes and thirty seconds.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
 
127
 
      <varlistentry>
128
 
        <term><option>interval<literal> = </literal><replaceable
129
 
        >TIME</replaceable></option></term>
130
 
        <listitem>
131
 
          <para>
132
 
            How often to run the checker to confirm that a client is
133
 
            still up.  <emphasis>Note:</emphasis> a new checker will
134
 
            not be started if an old one is still running.  The server
135
 
            will wait for a checker to complete until the above
136
 
            <quote><varname>timeout</varname></quote> occurs, at which
137
 
            time the client will be marked invalid, and any running
138
 
            checker killed.  The default interval is 5 minutes.
139
 
          </para>
140
 
          <para>
141
 
            The format of <replaceable>TIME</replaceable> is the same
142
 
            as for <varname>timeout</varname> above.
143
 
          </para>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
 
103
      
 
104
      <varlistentry>
 
105
        <term><option>approval_delay<literal> = </literal><replaceable
 
106
        >TIME</replaceable></option></term>
 
107
        <listitem>
 
108
          <para>
 
109
            This option is <emphasis>optional</emphasis>.
 
110
          </para>
 
111
          <para>
 
112
            How long to wait for external approval before resorting to
 
113
            use the <option>approved_by_default</option> value.  The
 
114
            default is <quote>0s</quote>, i.e. not to wait.
 
115
          </para>
 
116
          <para>
 
117
            The format of <replaceable>TIME</replaceable> is the same
 
118
            as for <varname>timeout</varname> below.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>
 
122
      
 
123
      <varlistentry>
 
124
        <term><option>approval_duration<literal> = </literal
 
125
        ><replaceable>TIME</replaceable></option></term>
 
126
        <listitem>
 
127
          <para>
 
128
            This option is <emphasis>optional</emphasis>.
 
129
          </para>
 
130
          <para>
 
131
            How long an external approval lasts.  The default is 1
 
132
            second.
 
133
          </para>
 
134
          <para>
 
135
            The format of <replaceable>TIME</replaceable> is the same
 
136
            as for <varname>timeout</varname> below.
 
137
          </para>
 
138
        </listitem>
 
139
      </varlistentry>
 
140
      
 
141
      <varlistentry>
 
142
        <term><option>approved_by_default<literal> = </literal
 
143
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
144
          >true</literal> | <literal>on</literal> | <literal
 
145
          >0</literal> | <literal>no</literal> | <literal
 
146
          >false</literal> | <literal>off</literal> }</option></term>
 
147
        <listitem>
 
148
          <para>
 
149
            Whether to approve a client by default after
 
150
            the <option>approval_delay</option>.  The default
 
151
            is <quote>True</quote>.
 
152
          </para>
 
153
        </listitem>
 
154
      </varlistentry>
 
155
      
147
156
      <varlistentry>
148
157
        <term><option>checker<literal> = </literal><replaceable
149
158
        >COMMAND</replaceable></option></term>
150
159
        <listitem>
151
160
          <para>
 
161
            This option is <emphasis>optional</emphasis>.
 
162
          </para>
 
163
          <para>
152
164
            This option allows you to override the default shell
153
165
            command that the server will use to check if the client is
154
166
            still up.  Any output of the command will be ignored, only
159
171
            <varname>PATH</varname> will be searched.  The default
160
172
            value for the checker command is <quote><literal
161
173
            ><command>fping</command> <option>-q</option> <option
162
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
163
175
          </para>
164
176
          <para>
165
177
            In addition to normal start time expansion, this option
170
182
      </varlistentry>
171
183
      
172
184
      <varlistentry>
 
185
        <term><option>extended_timeout<literal> = </literal><replaceable
 
186
        >TIME</replaceable></option></term>
 
187
        <listitem>
 
188
          <para>
 
189
            This option is <emphasis>optional</emphasis>.
 
190
          </para>
 
191
          <para>
 
192
            Extended timeout is an added timeout that is given once
 
193
            after a password has been sent successfully to a client.
 
194
            The timeout is by default longer than the normal timeout,
 
195
            and is used for handling the extra long downtime while a
 
196
            machine is booting up.  Time to take into consideration
 
197
            when changing this value is file system checks and quota
 
198
            checks.  The default value is 15 minutes.
 
199
          </para>
 
200
          <para>
 
201
            The format of <replaceable>TIME</replaceable> is the same
 
202
            as for <varname>timeout</varname> below.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
      
 
207
      <varlistentry>
173
208
        <term><option>fingerprint<literal> = </literal
174
209
        ><replaceable>HEXSTRING</replaceable></option></term>
175
210
        <listitem>
176
211
          <para>
 
212
            This option is <emphasis>required</emphasis>.
 
213
          </para>
 
214
          <para>
177
215
            This option sets the OpenPGP fingerprint that identifies
178
216
            the public key that clients authenticate themselves with
179
217
            through TLS.  The string needs to be in hexidecimal form,
183
221
      </varlistentry>
184
222
      
185
223
      <varlistentry>
 
224
        <term><option><literal>host = </literal><replaceable
 
225
        >STRING</replaceable></option></term>
 
226
        <listitem>
 
227
          <para>
 
228
            This option is <emphasis>optional</emphasis>, but highly
 
229
            <emphasis>recommended</emphasis> unless the
 
230
            <option>checker</option> option is modified to a
 
231
            non-standard value without <quote>%%(host)s</quote> in it.
 
232
          </para>
 
233
          <para>
 
234
            Host name for this client.  This is not used by the server
 
235
            directly, but can be, and is by default, used by the
 
236
            checker.  See the <option>checker</option> option.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>interval<literal> = </literal><replaceable
 
243
        >TIME</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            How often to run the checker to confirm that a client is
 
250
            still up.  <emphasis>Note:</emphasis> a new checker will
 
251
            not be started if an old one is still running.  The server
 
252
            will wait for a checker to complete until the below
 
253
            <quote><varname>timeout</varname></quote> occurs, at which
 
254
            time the client will be disabled, and any running checker
 
255
            killed.  The default interval is 2 minutes.
 
256
          </para>
 
257
          <para>
 
258
            The format of <replaceable>TIME</replaceable> is the same
 
259
            as for <varname>timeout</varname> below.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>secfile<literal> = </literal><replaceable
 
266
        >FILENAME</replaceable></option></term>
 
267
        <listitem>
 
268
          <para>
 
269
            This option is only used if <option>secret</option> is not
 
270
            specified, in which case this option is
 
271
            <emphasis>required</emphasis>.
 
272
          </para>
 
273
          <para>
 
274
            Similar to the <option>secret</option>, except the secret
 
275
            data is in an external file.  The contents of the file
 
276
            should <emphasis>not</emphasis> be base64-encoded, but
 
277
            will be sent to clients verbatim.
 
278
          </para>
 
279
          <para>
 
280
            File names of the form <filename>~user/foo/bar</filename>
 
281
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
282
            are supported.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
186
288
        <term><option>secret<literal> = </literal><replaceable
187
289
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
290
        <listitem>
189
291
          <para>
 
292
            If this option is not specified, the <option
 
293
            >secfile</option> option is <emphasis>required</emphasis>
 
294
            to be present.
 
295
          </para>
 
296
          <para>
190
297
            If present, this option must be set to a string of
191
298
            base64-encoded binary data.  It will be decoded and sent
192
299
            to the client matching the above
204
311
            lines is that a line beginning with white space adds to
205
312
            the value of the previous line, RFC 822-style.
206
313
          </para>
207
 
          <para>
208
 
            If this option is not specified, the <option
209
 
            >secfile</option> option is used instead, but one of them
210
 
            <emphasis>must</emphasis> be present.
211
 
          </para>
212
 
        </listitem>
213
 
      </varlistentry>
214
 
 
215
 
      <varlistentry>
216
 
        <term><option>secfile<literal> = </literal><replaceable
217
 
        >FILENAME</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Similar to the <option>secret</option>, except the secret
221
 
            data is in an external file.  The contents of the file
222
 
            should <emphasis>not</emphasis> be base64-encoded, but
223
 
            will be sent to clients verbatim.
224
 
          </para>
225
 
          <para>
226
 
            This option is only used, and <emphasis>must</emphasis> be
227
 
            present, if <option>secret</option> is not specified.
228
 
          </para>
229
 
        </listitem>
230
 
      </varlistentry>
231
 
 
232
 
      <varlistentry>
233
 
        <term><option><literal>host = </literal><replaceable
234
 
        >STRING</replaceable></option></term>
235
 
        <listitem>
236
 
          <para>
237
 
            Host name for this client.  This is not used by the server
238
 
            directly, but can be, and is by default, used by the
239
 
            checker.  See the <option>checker</option> option.
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>timeout<literal> = </literal><replaceable
 
319
        >TIME</replaceable></option></term>
 
320
        <listitem>
 
321
          <para>
 
322
            This option is <emphasis>optional</emphasis>.
 
323
          </para>
 
324
          <para>
 
325
            The timeout is how long the server will wait, after a
 
326
            successful checker run, until a client is disabled and not
 
327
            allowed to get the data this server holds.  By default
 
328
            Mandos will use 5 minutes.  See also the
 
329
            <option>extended_timeout</option> option.
 
330
          </para>
 
331
          <para>
 
332
            The <replaceable>TIME</replaceable> is specified as a
 
333
            space-separated number of values, each of which is a
 
334
            number and a one-character suffix.  The suffix must be one
 
335
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
336
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
337
            minutes, hours, and weeks, respectively.  The values are
 
338
            added together to give the total time value, so all of
 
339
            <quote><literal>330s</literal></quote>,
 
340
            <quote><literal>110s 110s 110s</literal></quote>, and
 
341
            <quote><literal>5m 30s</literal></quote> will give a value
 
342
            of five minutes and thirty seconds.
240
343
          </para>
241
344
        </listitem>
242
345
      </varlistentry>
279
382
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
383
        ></quote> will be replaced by the value of the attribute
281
384
        <varname>foo</varname> of the internal
282
 
        <quote><classname>Client</classname></quote> object.  See the
283
 
        source code for details, and let the authors know of any
284
 
        attributes that are useful so they may be preserved to any new
285
 
        versions of this software.
 
385
        <quote><classname>Client</classname></quote> object in the
 
386
        Mandos server.  The currently allowed values for
 
387
        <replaceable>foo</replaceable> are:
 
388
        <quote><literal>approval_delay</literal></quote>,
 
389
        <quote><literal>approval_duration</literal></quote>,
 
390
        <quote><literal>created</literal></quote>,
 
391
        <quote><literal>enabled</literal></quote>,
 
392
        <quote><literal>fingerprint</literal></quote>,
 
393
        <quote><literal>host</literal></quote>,
 
394
        <quote><literal>interval</literal></quote>,
 
395
        <quote><literal>last_approval_request</literal></quote>,
 
396
        <quote><literal>last_checked_ok</literal></quote>,
 
397
        <quote><literal>last_enabled</literal></quote>,
 
398
        <quote><literal>name</literal></quote>,
 
399
        <quote><literal>timeout</literal></quote>, and, if using
 
400
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
401
        See the source code for details.  <emphasis role="strong"
 
402
        >Currently, <emphasis>none</emphasis> of these attributes
 
403
        except <quote><literal>host</literal></quote> are guaranteed
 
404
        to be valid in future versions.</emphasis> Therefore, please
 
405
        let the authors know of any attributes that are useful so they
 
406
        may be preserved to any new versions of this software.
286
407
      </para>
287
408
      <para>
288
409
        Note that this means that, in order to include an actual
294
415
        mode is needed to expose an error of this kind.
295
416
      </para>
296
417
    </refsect2>
297
 
 
 
418
    
298
419
  </refsect1>
299
420
  
300
421
  <refsect1 id="files">
323
444
    <informalexample>
324
445
      <programlisting>
325
446
[DEFAULT]
326
 
timeout = 1h
327
 
interval = 5m
328
 
checker = fping -q -- %(host)s
 
447
timeout = 5m
 
448
interval = 2m
 
449
checker = fping -q -- %%(host)s
329
450
 
330
451
# Client "foo"
331
452
[foo]
354
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
476
secfile = /etc/mandos/bar-secret
356
477
timeout = 15m
357
 
 
 
478
approved_by_default = False
 
479
approval_delay = 30s
358
480
      </programlisting>
359
481
    </informalexample>
360
482
  </refsect1>
362
484
  <refsect1 id="see_also">
363
485
    <title>SEE ALSO</title>
364
486
    <para>
 
487
      <citerefentry><refentrytitle>intro</refentrytitle>
 
488
      <manvolnum>8mandos</manvolnum></citerefentry>,
365
489
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
490
      <manvolnum>8</manvolnum></citerefentry>,
367
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>