/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: 2012-05-27 07:30:49 UTC
  • Revision ID: teddy@recompile.se-20120527073049-f153zv8otgosqonh
* plugins.d/mandos-client.xml (EXAMPLE): Doc fix: Network interface is
                                         now automatically determined,
                                         not always "eth0".

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 "2012-05-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>
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>
 
39
      <year>2012</year>
35
40
      <holder>Teddy Hogeborn</holder>
36
41
      <holder>Björn Påhlsson</holder>
37
42
    </copyright>
38
43
    <xi:include href="legalnotice.xml"/>
39
44
  </refentryinfo>
40
 
 
 
45
  
41
46
  <refmeta>
42
47
    <refentrytitle>&CONFNAME;</refentrytitle>
43
48
    <manvolnum>5</manvolnum>
49
54
      Configuration file for the Mandos server
50
55
    </refpurpose>
51
56
  </refnamediv>
52
 
 
 
57
  
53
58
  <refsynopsisdiv>
54
59
    <synopsis>&CONFPATH;</synopsis>
55
60
  </refsynopsisdiv>
56
 
 
 
61
  
57
62
  <refsect1 id="description">
58
63
    <title>DESCRIPTION</title>
59
64
    <para>
61
66
      ><refentrytitle>mandos</refentrytitle>
62
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
68
      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.
 
69
      the service.  The settings in this file can be overridden by
 
70
      runtime changes to the server, which it saves across restarts.
 
71
      (See the section called <quote>PERSISTENT STATE</quote> in
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
73
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
74
      >changes</emphasis> to this file (including adding and removing
 
75
      clients) will, at startup, override changes done during runtime.
67
76
    </para>
68
77
    <para>
69
78
      The format starts with a <literal>[<replaceable>section
93
102
      start time expansion, see <xref linkend="expansion"/>.
94
103
    </para>
95
104
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
105
      Unknown options are ignored.  The used options are as follows:
97
106
    </para>
98
 
 
 
107
    
99
108
    <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
 
 
 
109
      
 
110
      <varlistentry>
 
111
        <term><option>approval_delay<literal> = </literal><replaceable
 
112
        >TIME</replaceable></option></term>
 
113
        <listitem>
 
114
          <para>
 
115
            This option is <emphasis>optional</emphasis>.
 
116
          </para>
 
117
          <para>
 
118
            How long to wait for external approval before resorting to
 
119
            use the <option>approved_by_default</option> value.  The
 
120
            default is <quote>0s</quote>, i.e. not to wait.
 
121
          </para>
 
122
          <para>
 
123
            The format of <replaceable>TIME</replaceable> is the same
 
124
            as for <varname>timeout</varname> below.
 
125
          </para>
 
126
        </listitem>
 
127
      </varlistentry>
 
128
      
 
129
      <varlistentry>
 
130
        <term><option>approval_duration<literal> = </literal
 
131
        ><replaceable>TIME</replaceable></option></term>
 
132
        <listitem>
 
133
          <para>
 
134
            This option is <emphasis>optional</emphasis>.
 
135
          </para>
 
136
          <para>
 
137
            How long an external approval lasts.  The default is 1
 
138
            second.
 
139
          </para>
 
140
          <para>
 
141
            The format of <replaceable>TIME</replaceable> is the same
 
142
            as for <varname>timeout</varname> below.
 
143
          </para>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>approved_by_default<literal> = </literal
 
149
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
150
          >true</literal> | <literal>on</literal> | <literal
 
151
          >0</literal> | <literal>no</literal> | <literal
 
152
          >false</literal> | <literal>off</literal> }</option></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Whether to approve a client by default after
 
156
            the <option>approval_delay</option>.  The default
 
157
            is <quote>True</quote>.
 
158
          </para>
 
159
        </listitem>
 
160
      </varlistentry>
 
161
      
147
162
      <varlistentry>
148
163
        <term><option>checker<literal> = </literal><replaceable
149
164
        >COMMAND</replaceable></option></term>
150
165
        <listitem>
151
166
          <para>
152
 
            This option allows you to override the default shell
153
 
            command that the server will use to check if the client is
154
 
            still up.  Any output of the command will be ignored, only
155
 
            the exit code is checked:  If the exit code of the command
156
 
            is zero, the client is considered up.  The command will be
157
 
            run using <quote><command><filename>/bin/sh</filename>
 
167
            This option is <emphasis>optional</emphasis>.
 
168
          </para>
 
169
          <para>
 
170
            This option overrides the default shell command that the
 
171
            server will use to check if the client is still up.  Any
 
172
            output of the command will be ignored, only the exit code
 
173
            is checked:  If the exit code of the command is zero, the
 
174
            client is considered up.  The command will be run using
 
175
            <quote><command><filename>/bin/sh</filename>
158
176
            <option>-c</option></command></quote>, so
159
177
            <varname>PATH</varname> will be searched.  The default
160
178
            value for the checker command is <quote><literal
161
179
            ><command>fping</command> <option>-q</option> <option
162
 
            >--</option> %(host)s</literal></quote>.
 
180
            >--</option> %%(host)s</literal></quote>.
163
181
          </para>
164
182
          <para>
165
183
            In addition to normal start time expansion, this option
170
188
      </varlistentry>
171
189
      
172
190
      <varlistentry>
 
191
        <term><option>extended_timeout<literal> = </literal><replaceable
 
192
        >TIME</replaceable></option></term>
 
193
        <listitem>
 
194
          <para>
 
195
            This option is <emphasis>optional</emphasis>.
 
196
          </para>
 
197
          <para>
 
198
            Extended timeout is an added timeout that is given once
 
199
            after a password has been sent successfully to a client.
 
200
            The timeout is by default longer than the normal timeout,
 
201
            and is used for handling the extra long downtime while a
 
202
            machine is booting up.  Time to take into consideration
 
203
            when changing this value is file system checks and quota
 
204
            checks.  The default value is 15 minutes.
 
205
          </para>
 
206
          <para>
 
207
            The format of <replaceable>TIME</replaceable> is the same
 
208
            as for <varname>timeout</varname> below.
 
209
          </para>
 
210
        </listitem>
 
211
      </varlistentry>
 
212
      
 
213
      <varlistentry>
173
214
        <term><option>fingerprint<literal> = </literal
174
215
        ><replaceable>HEXSTRING</replaceable></option></term>
175
216
        <listitem>
176
217
          <para>
 
218
            This option is <emphasis>required</emphasis>.
 
219
          </para>
 
220
          <para>
177
221
            This option sets the OpenPGP fingerprint that identifies
178
222
            the public key that clients authenticate themselves with
179
223
            through TLS.  The string needs to be in hexidecimal form,
183
227
      </varlistentry>
184
228
      
185
229
      <varlistentry>
 
230
        <term><option><literal>host = </literal><replaceable
 
231
        >STRING</replaceable></option></term>
 
232
        <listitem>
 
233
          <para>
 
234
            This option is <emphasis>optional</emphasis>, but highly
 
235
            <emphasis>recommended</emphasis> unless the
 
236
            <option>checker</option> option is modified to a
 
237
            non-standard value without <quote>%%(host)s</quote> in it.
 
238
          </para>
 
239
          <para>
 
240
            Host name for this client.  This is not used by the server
 
241
            directly, but can be, and is by default, used by the
 
242
            checker.  See the <option>checker</option> option.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
 
248
        <term><option>interval<literal> = </literal><replaceable
 
249
        >TIME</replaceable></option></term>
 
250
        <listitem>
 
251
          <para>
 
252
            This option is <emphasis>optional</emphasis>.
 
253
          </para>
 
254
          <para>
 
255
            How often to run the checker to confirm that a client is
 
256
            still up.  <emphasis>Note:</emphasis> a new checker will
 
257
            not be started if an old one is still running.  The server
 
258
            will wait for a checker to complete until the below
 
259
            <quote><varname>timeout</varname></quote> occurs, at which
 
260
            time the client will be disabled, and any running checker
 
261
            killed.  The default interval is 2 minutes.
 
262
          </para>
 
263
          <para>
 
264
            The format of <replaceable>TIME</replaceable> is the same
 
265
            as for <varname>timeout</varname> below.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
 
269
      
 
270
      <varlistentry>
 
271
        <term><option>secfile<literal> = </literal><replaceable
 
272
        >FILENAME</replaceable></option></term>
 
273
        <listitem>
 
274
          <para>
 
275
            This option is only used if <option>secret</option> is not
 
276
            specified, in which case this option is
 
277
            <emphasis>required</emphasis>.
 
278
          </para>
 
279
          <para>
 
280
            Similar to the <option>secret</option>, except the secret
 
281
            data is in an external file.  The contents of the file
 
282
            should <emphasis>not</emphasis> be base64-encoded, but
 
283
            will be sent to clients verbatim.
 
284
          </para>
 
285
          <para>
 
286
            File names of the form <filename>~user/foo/bar</filename>
 
287
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
288
            are supported.
 
289
          </para>
 
290
        </listitem>
 
291
      </varlistentry>
 
292
      
 
293
      <varlistentry>
186
294
        <term><option>secret<literal> = </literal><replaceable
187
295
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
296
        <listitem>
189
297
          <para>
 
298
            If this option is not specified, the <option
 
299
            >secfile</option> option is <emphasis>required</emphasis>
 
300
            to be present.
 
301
          </para>
 
302
          <para>
190
303
            If present, this option must be set to a string of
191
304
            base64-encoded binary data.  It will be decoded and sent
192
305
            to the client matching the above
204
317
            lines is that a line beginning with white space adds to
205
318
            the value of the previous line, RFC 822-style.
206
319
          </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.
 
320
        </listitem>
 
321
      </varlistentry>
 
322
      
 
323
      <varlistentry>
 
324
        <term><option>timeout<literal> = </literal><replaceable
 
325
        >TIME</replaceable></option></term>
 
326
        <listitem>
 
327
          <para>
 
328
            This option is <emphasis>optional</emphasis>.
 
329
          </para>
 
330
          <para>
 
331
            The timeout is how long the server will wait, after a
 
332
            successful checker run, until a client is disabled and not
 
333
            allowed to get the data this server holds.  By default
 
334
            Mandos will use 5 minutes.  See also the
 
335
            <option>extended_timeout</option> option.
 
336
          </para>
 
337
          <para>
 
338
            The <replaceable>TIME</replaceable> is specified as a
 
339
            space-separated number of values, each of which is a
 
340
            number and a one-character suffix.  The suffix must be one
 
341
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
342
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
343
            minutes, hours, and weeks, respectively.  The values are
 
344
            added together to give the total time value, so all of
 
345
            <quote><literal>330s</literal></quote>,
 
346
            <quote><literal>110s 110s 110s</literal></quote>, and
 
347
            <quote><literal>5m 30s</literal></quote> will give a value
 
348
            of five minutes and thirty seconds.
 
349
          </para>
 
350
        </listitem>
 
351
      </varlistentry>
 
352
      
 
353
      <varlistentry>
 
354
        <term><option>enabled<literal> = </literal>{ <literal
 
355
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
356
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
357
        >no</literal> | <literal>false</literal> | <literal
 
358
        >off</literal> }</option></term>
 
359
        <listitem>
 
360
          <para>
 
361
            Whether this client should be enabled by default.  The
 
362
            default is <quote>true</quote>.
240
363
          </para>
241
364
        </listitem>
242
365
      </varlistentry>
279
402
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
403
        ></quote> will be replaced by the value of the attribute
281
404
        <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.
 
405
        <quote><classname>Client</classname></quote> object in the
 
406
        Mandos server.  The currently allowed values for
 
407
        <replaceable>foo</replaceable> are:
 
408
        <quote><literal>approval_delay</literal></quote>,
 
409
        <quote><literal>approval_duration</literal></quote>,
 
410
        <quote><literal>created</literal></quote>,
 
411
        <quote><literal>enabled</literal></quote>,
 
412
        <quote><literal>expires</literal></quote>,
 
413
        <quote><literal>fingerprint</literal></quote>,
 
414
        <quote><literal>host</literal></quote>,
 
415
        <quote><literal>interval</literal></quote>,
 
416
        <quote><literal>last_approval_request</literal></quote>,
 
417
        <quote><literal>last_checked_ok</literal></quote>,
 
418
        <quote><literal>last_enabled</literal></quote>,
 
419
        <quote><literal>name</literal></quote>,
 
420
        <quote><literal>timeout</literal></quote>, and, if using
 
421
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
422
        See the source code for details.  <emphasis role="strong"
 
423
        >Currently, <emphasis>none</emphasis> of these attributes
 
424
        except <quote><literal>host</literal></quote> are guaranteed
 
425
        to be valid in future versions.</emphasis> Therefore, please
 
426
        let the authors know of any attributes that are useful so they
 
427
        may be preserved to any new versions of this software.
286
428
      </para>
287
429
      <para>
288
430
        Note that this means that, in order to include an actual
294
436
        mode is needed to expose an error of this kind.
295
437
      </para>
296
438
    </refsect2>
297
 
 
 
439
    
298
440
  </refsect1>
299
441
  
300
442
  <refsect1 id="files">
323
465
    <informalexample>
324
466
      <programlisting>
325
467
[DEFAULT]
326
 
timeout = 1h
327
 
interval = 5m
328
 
checker = fping -q -- %(host)s
 
468
timeout = 5m
 
469
interval = 2m
 
470
checker = fping -q -- %%(host)s
329
471
 
330
472
# Client "foo"
331
473
[foo]
354
496
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
497
secfile = /etc/mandos/bar-secret
356
498
timeout = 15m
357
 
 
 
499
approved_by_default = False
 
500
approval_delay = 30s
358
501
      </programlisting>
359
502
    </informalexample>
360
503
  </refsect1>
362
505
  <refsect1 id="see_also">
363
506
    <title>SEE ALSO</title>
364
507
    <para>
 
508
      <citerefentry><refentrytitle>intro</refentrytitle>
 
509
      <manvolnum>8mandos</manvolnum></citerefentry>,
365
510
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
511
      <manvolnum>8</manvolnum></citerefentry>,
367
512
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
368
513
      <manvolnum>5</manvolnum></citerefentry>,
369
514
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
515
      <manvolnum>8</manvolnum></citerefentry>,
 
516
      <citerefentry><refentrytitle>fping</refentrytitle>
370
517
      <manvolnum>8</manvolnum></citerefentry>
371
518
    </para>
372
519
  </refsect1>