/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: 2010-10-02 17:41:05 UTC
  • mto: (24.1.169 mandos)
  • mto: This revision was merged to the branch mainline in revision 453.
  • Revision ID: teddy@fukt.bsnet.se-20101002174105-xfqa0j8y1puvedo3
* debian/source/format: New; contains "3.0 (quilt)".

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 "2010-09-26">
 
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>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
35
38
      <holder>Teddy Hogeborn</holder>
36
39
      <holder>Björn Påhlsson</holder>
37
40
    </copyright>
38
41
    <xi:include href="legalnotice.xml"/>
39
42
  </refentryinfo>
40
 
 
 
43
  
41
44
  <refmeta>
42
45
    <refentrytitle>&CONFNAME;</refentrytitle>
43
46
    <manvolnum>5</manvolnum>
49
52
      Configuration file for the Mandos server
50
53
    </refpurpose>
51
54
  </refnamediv>
52
 
 
 
55
  
53
56
  <refsynopsisdiv>
54
57
    <synopsis>&CONFPATH;</synopsis>
55
58
  </refsynopsisdiv>
56
 
 
 
59
  
57
60
  <refsect1 id="description">
58
61
    <title>DESCRIPTION</title>
59
62
    <para>
61
64
      ><refentrytitle>mandos</refentrytitle>
62
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
66
      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.
 
67
      the service.  All clients listed will be regarded as enabled,
 
68
      even if a client was disabled in a previous run of the server.
67
69
    </para>
68
70
    <para>
69
71
      The format starts with a <literal>[<replaceable>section
93
95
      start time expansion, see <xref linkend="expansion"/>.
94
96
    </para>
95
97
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
98
      Unknown options are ignored.  The used options are as follows:
97
99
    </para>
98
 
 
 
100
    
99
101
    <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
 
 
 
102
      
 
103
      <varlistentry>
 
104
        <term><option>approval_delay<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
 
106
        <listitem>
 
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
 
110
          <para>
 
111
            How long to wait for external approval before resorting to
 
112
            use the <option>approved_by_default</option> value.  The
 
113
            default is <quote>0s</quote>, i.e. not to wait.
 
114
          </para>
 
115
          <para>
 
116
            The format of <replaceable>TIME</replaceable> is the same
 
117
            as for <varname>timeout</varname> below.
 
118
          </para>
 
119
        </listitem>
 
120
      </varlistentry>
 
121
      
 
122
      <varlistentry>
 
123
        <term><option>approval_duration<literal> = </literal
 
124
        ><replaceable>TIME</replaceable></option></term>
 
125
        <listitem>
 
126
          <para>
 
127
            This option is <emphasis>optional</emphasis>.
 
128
          </para>
 
129
          <para>
 
130
            How long an external approval lasts.  The default is 1
 
131
            second.
 
132
          </para>
 
133
          <para>
 
134
            The format of <replaceable>TIME</replaceable> is the same
 
135
            as for <varname>timeout</varname> below.
 
136
          </para>
 
137
        </listitem>
 
138
      </varlistentry>
 
139
      
 
140
      <varlistentry>
 
141
        <term><option>approved_by_default<literal> = </literal
 
142
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
143
          >true</literal> | <literal>on</literal> | <literal
 
144
          >0</literal> | <literal>no</literal> | <literal
 
145
          >false</literal> | <literal>off</literal> }</option></term>
 
146
        <listitem>
 
147
          <para>
 
148
            Whether to approve a client by default after
 
149
            the <option>approval_delay</option>.  The default
 
150
            is <quote>True</quote>.
 
151
          </para>
 
152
        </listitem>
 
153
      </varlistentry>
 
154
      
147
155
      <varlistentry>
148
156
        <term><option>checker<literal> = </literal><replaceable
149
157
        >COMMAND</replaceable></option></term>
150
158
        <listitem>
151
159
          <para>
 
160
            This option is <emphasis>optional</emphasis>.
 
161
          </para>
 
162
          <para>
152
163
            This option allows you to override the default shell
153
164
            command that the server will use to check if the client is
154
165
            still up.  Any output of the command will be ignored, only
159
170
            <varname>PATH</varname> will be searched.  The default
160
171
            value for the checker command is <quote><literal
161
172
            ><command>fping</command> <option>-q</option> <option
162
 
            >--</option> %(host)s</literal></quote>.
 
173
            >--</option> %%(host)s</literal></quote>.
163
174
          </para>
164
175
          <para>
165
176
            In addition to normal start time expansion, this option
174
185
        ><replaceable>HEXSTRING</replaceable></option></term>
175
186
        <listitem>
176
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
 
190
          <para>
177
191
            This option sets the OpenPGP fingerprint that identifies
178
192
            the public key that clients authenticate themselves with
179
193
            through TLS.  The string needs to be in hexidecimal form,
183
197
      </varlistentry>
184
198
      
185
199
      <varlistentry>
 
200
        <term><option><literal>host = </literal><replaceable
 
201
        >STRING</replaceable></option></term>
 
202
        <listitem>
 
203
          <para>
 
204
            This option is <emphasis>optional</emphasis>, but highly
 
205
            <emphasis>recommended</emphasis> unless the
 
206
            <option>checker</option> option is modified to a
 
207
            non-standard value without <quote>%%(host)s</quote> in it.
 
208
          </para>
 
209
          <para>
 
210
            Host name for this client.  This is not used by the server
 
211
            directly, but can be, and is by default, used by the
 
212
            checker.  See the <option>checker</option> option.
 
213
          </para>
 
214
        </listitem>
 
215
      </varlistentry>
 
216
      
 
217
      <varlistentry>
 
218
        <term><option>interval<literal> = </literal><replaceable
 
219
        >TIME</replaceable></option></term>
 
220
        <listitem>
 
221
          <para>
 
222
            This option is <emphasis>optional</emphasis>.
 
223
          </para>
 
224
          <para>
 
225
            How often to run the checker to confirm that a client is
 
226
            still up.  <emphasis>Note:</emphasis> a new checker will
 
227
            not be started if an old one is still running.  The server
 
228
            will wait for a checker to complete until the below
 
229
            <quote><varname>timeout</varname></quote> occurs, at which
 
230
            time the client will be disabled, and any running checker
 
231
            killed.  The default interval is 5 minutes.
 
232
          </para>
 
233
          <para>
 
234
            The format of <replaceable>TIME</replaceable> is the same
 
235
            as for <varname>timeout</varname> below.
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><option>secfile<literal> = </literal><replaceable
 
242
        >FILENAME</replaceable></option></term>
 
243
        <listitem>
 
244
          <para>
 
245
            This option is only used if <option>secret</option> is not
 
246
            specified, in which case this option is
 
247
            <emphasis>required</emphasis>.
 
248
          </para>
 
249
          <para>
 
250
            Similar to the <option>secret</option>, except the secret
 
251
            data is in an external file.  The contents of the file
 
252
            should <emphasis>not</emphasis> be base64-encoded, but
 
253
            will be sent to clients verbatim.
 
254
          </para>
 
255
          <para>
 
256
            File names of the form <filename>~user/foo/bar</filename>
 
257
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
258
            are supported.
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
 
262
      
 
263
      <varlistentry>
186
264
        <term><option>secret<literal> = </literal><replaceable
187
265
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
266
        <listitem>
189
267
          <para>
 
268
            If this option is not specified, the <option
 
269
            >secfile</option> option is <emphasis>required</emphasis>
 
270
            to be present.
 
271
          </para>
 
272
          <para>
190
273
            If present, this option must be set to a string of
191
274
            base64-encoded binary data.  It will be decoded and sent
192
275
            to the client matching the above
204
287
            lines is that a line beginning with white space adds to
205
288
            the value of the previous line, RFC 822-style.
206
289
          </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.
 
290
        </listitem>
 
291
      </varlistentry>
 
292
      
 
293
      <varlistentry>
 
294
        <term><option>timeout<literal> = </literal><replaceable
 
295
        >TIME</replaceable></option></term>
 
296
        <listitem>
 
297
          <para>
 
298
            This option is <emphasis>optional</emphasis>.
 
299
          </para>
 
300
          <para>
 
301
            The timeout is how long the server will wait (for either a
 
302
            successful checker run or a client receiving its secret)
 
303
            until a client is disabled and not allowed to get the data
 
304
            this server holds.  By default Mandos will use 1 hour.
 
305
          </para>
 
306
          <para>
 
307
            The <replaceable>TIME</replaceable> is specified as a
 
308
            space-separated number of values, each of which is a
 
309
            number and a one-character suffix.  The suffix must be one
 
310
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
311
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
312
            minutes, hours, and weeks, respectively.  The values are
 
313
            added together to give the total time value, so all of
 
314
            <quote><literal>330s</literal></quote>,
 
315
            <quote><literal>110s 110s 110s</literal></quote>, and
 
316
            <quote><literal>5m 30s</literal></quote> will give a value
 
317
            of five minutes and thirty seconds.
240
318
          </para>
241
319
        </listitem>
242
320
      </varlistentry>
279
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
358
        ></quote> will be replaced by the value of the attribute
281
359
        <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.
 
360
        <quote><classname>Client</classname></quote> object in the
 
361
        Mandos server.  The currently allowed values for
 
362
        <replaceable>foo</replaceable> are:
 
363
        <quote><literal>approval_delay</literal></quote>,
 
364
        <quote><literal>approval_duration</literal></quote>,
 
365
        <quote><literal>created</literal></quote>,
 
366
        <quote><literal>enabled</literal></quote>,
 
367
        <quote><literal>fingerprint</literal></quote>,
 
368
        <quote><literal>host</literal></quote>,
 
369
        <quote><literal>interval</literal></quote>,
 
370
        <quote><literal>last_approval_request</literal></quote>,
 
371
        <quote><literal>last_checked_ok</literal></quote>,
 
372
        <quote><literal>last_enabled</literal></quote>,
 
373
        <quote><literal>name</literal></quote>,
 
374
        <quote><literal>timeout</literal></quote>, and, if using
 
375
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
376
        See the source code for details.  <emphasis role="strong"
 
377
        >Currently, <emphasis>none</emphasis> of these attributes
 
378
        except <quote><literal>host</literal></quote> are guaranteed
 
379
        to be valid in future versions.</emphasis> Therefore, please
 
380
        let the authors know of any attributes that are useful so they
 
381
        may be preserved to any new versions of this software.
286
382
      </para>
287
383
      <para>
288
384
        Note that this means that, in order to include an actual
294
390
        mode is needed to expose an error of this kind.
295
391
      </para>
296
392
    </refsect2>
297
 
 
 
393
    
298
394
  </refsect1>
299
395
  
300
396
  <refsect1 id="files">
325
421
[DEFAULT]
326
422
timeout = 1h
327
423
interval = 5m
328
 
checker = fping -q -- %(host)s
 
424
checker = fping -q -- %%(host)s
329
425
 
330
426
# Client "foo"
331
427
[foo]
354
450
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
451
secfile = /etc/mandos/bar-secret
356
452
timeout = 15m
357
 
 
 
453
approved_by_default = False
 
454
approval_delay = 30s
358
455
      </programlisting>
359
456
    </informalexample>
360
457
  </refsect1>