/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-08 12:03:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080908120316-rrt6r0a5yezc3q1d
* INSTALL: New file.

* mandos-keygen: Use "/etc/mandos/keys" if "/etc/keys/mandos" does not
                 exist.

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 "2010-09-26">
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>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
35
      <holder>Teddy Hogeborn</holder>
39
36
      <holder>Björn Påhlsson</holder>
40
37
    </copyright>
41
38
    <xi:include href="legalnotice.xml"/>
42
39
  </refentryinfo>
43
 
  
 
40
 
44
41
  <refmeta>
45
42
    <refentrytitle>&CONFNAME;</refentrytitle>
46
43
    <manvolnum>5</manvolnum>
52
49
      Configuration file for the Mandos server
53
50
    </refpurpose>
54
51
  </refnamediv>
55
 
  
 
52
 
56
53
  <refsynopsisdiv>
57
54
    <synopsis>&CONFPATH;</synopsis>
58
55
  </refsynopsisdiv>
59
 
  
 
56
 
60
57
  <refsect1 id="description">
61
58
    <title>DESCRIPTION</title>
62
59
    <para>
64
61
      ><refentrytitle>mandos</refentrytitle>
65
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
63
      The file needs to list all clients that should be able to use
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.
 
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.
69
67
    </para>
70
68
    <para>
71
69
      The format starts with a <literal>[<replaceable>section
97
95
    <para>
98
96
      Unknown options are ignored.  The used options are as follows:
99
97
    </para>
100
 
    
 
98
 
101
99
    <variablelist>
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
 
      
 
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
 
155
153
      <varlistentry>
156
154
        <term><option>checker<literal> = </literal><replaceable
157
155
        >COMMAND</replaceable></option></term>
170
168
            <varname>PATH</varname> will be searched.  The default
171
169
            value for the checker command is <quote><literal
172
170
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
171
            >--</option> %(host)s</literal></quote>.
174
172
          </para>
175
173
          <para>
176
174
            In addition to normal start time expansion, this option
197
195
      </varlistentry>
198
196
      
199
197
      <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>
264
198
        <term><option>secret<literal> = </literal><replaceable
265
199
        >BASE64_ENCODED_DATA</replaceable></option></term>
266
200
        <listitem>
289
223
          </para>
290
224
        </listitem>
291
225
      </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.
 
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.
318
259
          </para>
319
260
        </listitem>
320
261
      </varlistentry>
357
298
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
358
299
        ></quote> will be replaced by the value of the attribute
359
300
        <varname>foo</varname> of the internal
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.
 
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.
382
305
      </para>
383
306
      <para>
384
307
        Note that this means that, in order to include an actual
390
313
        mode is needed to expose an error of this kind.
391
314
      </para>
392
315
    </refsect2>
393
 
    
 
316
 
394
317
  </refsect1>
395
318
  
396
319
  <refsect1 id="files">
421
344
[DEFAULT]
422
345
timeout = 1h
423
346
interval = 5m
424
 
checker = fping -q -- %%(host)s
 
347
checker = fping -q -- %(host)s
425
348
 
426
349
# Client "foo"
427
350
[foo]
450
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
374
secfile = /etc/mandos/bar-secret
452
375
timeout = 15m
453
 
approved_by_default = False
454
 
approval_delay = 30s
 
376
 
455
377
      </programlisting>
456
378
    </informalexample>
457
379
  </refsect1>