/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: 2011-07-13 01:11:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110713011112-bgf3tenqq60uoyyb
* Makefile (plugins.d/mandos-client): Bug fix: Put $^ before all
                                      libraries.  Remove "$(COMMON)".
                                      Thanks to Angel Abad
                                      <angelabad@ubuntu.com>.
* initramfs-tools-script: Work around change in initramfs-tools,
                          Debian bug #633582.
* plugins.d/mandos-client.c (init_gnutls_global): Bug fix: check for
                errors from gnutls_certificate_allocate_credentials().

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-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
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
174
186
        ><replaceable>HEXSTRING</replaceable></option></term>
175
187
        <listitem>
176
188
          <para>
 
189
            This option is <emphasis>required</emphasis>.
 
190
          </para>
 
191
          <para>
177
192
            This option sets the OpenPGP fingerprint that identifies
178
193
            the public key that clients authenticate themselves with
179
194
            through TLS.  The string needs to be in hexidecimal form,
183
198
      </varlistentry>
184
199
      
185
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>
186
265
        <term><option>secret<literal> = </literal><replaceable
187
266
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
267
        <listitem>
189
268
          <para>
 
269
            If this option is not specified, the <option
 
270
            >secfile</option> option is <emphasis>required</emphasis>
 
271
            to be present.
 
272
          </para>
 
273
          <para>
190
274
            If present, this option must be set to a string of
191
275
            base64-encoded binary data.  It will be decoded and sent
192
276
            to the client matching the above
204
288
            lines is that a line beginning with white space adds to
205
289
            the value of the previous line, RFC 822-style.
206
290
          </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.
 
291
        </listitem>
 
292
      </varlistentry>
 
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.
240
319
          </para>
241
320
        </listitem>
242
321
      </varlistentry>
279
358
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
359
        ></quote> will be replaced by the value of the attribute
281
360
        <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.
 
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.
286
383
      </para>
287
384
      <para>
288
385
        Note that this means that, in order to include an actual
294
391
        mode is needed to expose an error of this kind.
295
392
      </para>
296
393
    </refsect2>
297
 
 
 
394
    
298
395
  </refsect1>
299
396
  
300
397
  <refsect1 id="files">
325
422
[DEFAULT]
326
423
timeout = 1h
327
424
interval = 5m
328
 
checker = fping -q -- %(host)s
 
425
checker = fping -q -- %%(host)s
329
426
 
330
427
# Client "foo"
331
428
[foo]
354
451
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
452
secfile = /etc/mandos/bar-secret
356
453
timeout = 15m
357
 
 
 
454
approved_by_default = False
 
455
approval_delay = 30s
358
456
      </programlisting>
359
457
    </informalexample>
360
458
  </refsect1>