/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

* INSTALL: Updated.

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-09-04">
 
6
<!ENTITY TIMESTAMP "2011-02-27">
 
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>
 
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
95
98
    <para>
96
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
 
            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
 
 
 
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
      
153
156
      <varlistentry>
154
157
        <term><option>checker<literal> = </literal><replaceable
155
158
        >COMMAND</replaceable></option></term>
168
171
            <varname>PATH</varname> will be searched.  The default
169
172
            value for the checker command is <quote><literal
170
173
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
172
175
          </para>
173
176
          <para>
174
177
            In addition to normal start time expansion, this option
195
198
      </varlistentry>
196
199
      
197
200
      <varlistentry>
 
201
        <term><option><literal>host = </literal><replaceable
 
202
        >STRING</replaceable></option></term>
 
203
        <listitem>
 
204
          <para>
 
205
            This option is <emphasis>optional</emphasis>, but highly
 
206
            <emphasis>recommended</emphasis> unless the
 
207
            <option>checker</option> option is modified to a
 
208
            non-standard value without <quote>%%(host)s</quote> in it.
 
209
          </para>
 
210
          <para>
 
211
            Host name for this client.  This is not used by the server
 
212
            directly, but can be, and is by default, used by the
 
213
            checker.  See the <option>checker</option> option.
 
214
          </para>
 
215
        </listitem>
 
216
      </varlistentry>
 
217
      
 
218
      <varlistentry>
 
219
        <term><option>interval<literal> = </literal><replaceable
 
220
        >TIME</replaceable></option></term>
 
221
        <listitem>
 
222
          <para>
 
223
            This option is <emphasis>optional</emphasis>.
 
224
          </para>
 
225
          <para>
 
226
            How often to run the checker to confirm that a client is
 
227
            still up.  <emphasis>Note:</emphasis> a new checker will
 
228
            not be started if an old one is still running.  The server
 
229
            will wait for a checker to complete until the below
 
230
            <quote><varname>timeout</varname></quote> occurs, at which
 
231
            time the client will be disabled, and any running checker
 
232
            killed.  The default interval is 5 minutes.
 
233
          </para>
 
234
          <para>
 
235
            The format of <replaceable>TIME</replaceable> is the same
 
236
            as for <varname>timeout</varname> below.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>secfile<literal> = </literal><replaceable
 
243
        >FILENAME</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is only used if <option>secret</option> is not
 
247
            specified, in which case this option is
 
248
            <emphasis>required</emphasis>.
 
249
          </para>
 
250
          <para>
 
251
            Similar to the <option>secret</option>, except the secret
 
252
            data is in an external file.  The contents of the file
 
253
            should <emphasis>not</emphasis> be base64-encoded, but
 
254
            will be sent to clients verbatim.
 
255
          </para>
 
256
          <para>
 
257
            File names of the form <filename>~user/foo/bar</filename>
 
258
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
259
            are supported.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
198
265
        <term><option>secret<literal> = </literal><replaceable
199
266
        >BASE64_ENCODED_DATA</replaceable></option></term>
200
267
        <listitem>
223
290
          </para>
224
291
        </listitem>
225
292
      </varlistentry>
226
 
 
227
 
      <varlistentry>
228
 
        <term><option>secfile<literal> = </literal><replaceable
229
 
        >FILENAME</replaceable></option></term>
230
 
        <listitem>
231
 
          <para>
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.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
      <varlistentry>
246
 
        <term><option><literal>host = </literal><replaceable
247
 
        >STRING</replaceable></option></term>
248
 
        <listitem>
249
 
          <para>
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.
 
293
      
 
294
      <varlistentry>
 
295
        <term><option>timeout<literal> = </literal><replaceable
 
296
        >TIME</replaceable></option></term>
 
297
        <listitem>
 
298
          <para>
 
299
            This option is <emphasis>optional</emphasis>.
 
300
          </para>
 
301
          <para>
 
302
            The timeout is how long the server will wait (for either a
 
303
            successful checker run or a client receiving its secret)
 
304
            until a client is disabled and not allowed to get the data
 
305
            this server holds.  By default Mandos will use 1 hour.
 
306
          </para>
 
307
          <para>
 
308
            The <replaceable>TIME</replaceable> is specified as a
 
309
            space-separated number of values, each of which is a
 
310
            number and a one-character suffix.  The suffix must be one
 
311
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
312
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
313
            minutes, hours, and weeks, respectively.  The values are
 
314
            added together to give the total time value, so all of
 
315
            <quote><literal>330s</literal></quote>,
 
316
            <quote><literal>110s 110s 110s</literal></quote>, and
 
317
            <quote><literal>5m 30s</literal></quote> will give a value
 
318
            of five minutes and thirty seconds.
259
319
          </para>
260
320
        </listitem>
261
321
      </varlistentry>
298
358
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
359
        ></quote> will be replaced by the value of the attribute
300
360
        <varname>foo</varname> of the internal
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.
 
361
        <quote><classname>Client</classname></quote> object in the
 
362
        Mandos server.  The currently allowed values for
 
363
        <replaceable>foo</replaceable> are:
 
364
        <quote><literal>approval_delay</literal></quote>,
 
365
        <quote><literal>approval_duration</literal></quote>,
 
366
        <quote><literal>created</literal></quote>,
 
367
        <quote><literal>enabled</literal></quote>,
 
368
        <quote><literal>fingerprint</literal></quote>,
 
369
        <quote><literal>host</literal></quote>,
 
370
        <quote><literal>interval</literal></quote>,
 
371
        <quote><literal>last_approval_request</literal></quote>,
 
372
        <quote><literal>last_checked_ok</literal></quote>,
 
373
        <quote><literal>last_enabled</literal></quote>,
 
374
        <quote><literal>name</literal></quote>,
 
375
        <quote><literal>timeout</literal></quote>, and, if using
 
376
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
377
        See the source code for details.  <emphasis role="strong"
 
378
        >Currently, <emphasis>none</emphasis> of these attributes
 
379
        except <quote><literal>host</literal></quote> are guaranteed
 
380
        to be valid in future versions.</emphasis> Therefore, please
 
381
        let the authors know of any attributes that are useful so they
 
382
        may be preserved to any new versions of this software.
305
383
      </para>
306
384
      <para>
307
385
        Note that this means that, in order to include an actual
313
391
        mode is needed to expose an error of this kind.
314
392
      </para>
315
393
    </refsect2>
316
 
 
 
394
    
317
395
  </refsect1>
318
396
  
319
397
  <refsect1 id="files">
344
422
[DEFAULT]
345
423
timeout = 1h
346
424
interval = 5m
347
 
checker = fping -q -- %(host)s
 
425
checker = fping -q -- %%(host)s
348
426
 
349
427
# Client "foo"
350
428
[foo]
373
451
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
452
secfile = /etc/mandos/bar-secret
375
453
timeout = 15m
376
 
 
 
454
approved_by_default = False
 
455
approval_delay = 30s
377
456
      </programlisting>
378
457
    </informalexample>
379
458
  </refsect1>