/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

Merge from trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
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>">
 
6
<!ENTITY TIMESTAMP "2011-10-03">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
18
21
        <surname>Påhlsson</surname>
19
22
        <address>
20
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
21
24
        </address>
22
25
      </author>
23
26
      <author>
24
27
        <firstname>Teddy</firstname>
25
28
        <surname>Hogeborn</surname>
26
29
        <address>
27
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
28
31
        </address>
29
32
      </author>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
 
38
      <year>2011</year>
33
39
      <holder>Teddy Hogeborn</holder>
34
40
      <holder>Björn Påhlsson</holder>
35
41
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
42
    <xi:include href="legalnotice.xml"/>
59
43
  </refentryinfo>
60
 
 
 
44
  
61
45
  <refmeta>
62
46
    <refentrytitle>&CONFNAME;</refentrytitle>
63
47
    <manvolnum>5</manvolnum>
69
53
      Configuration file for the Mandos server
70
54
    </refpurpose>
71
55
  </refnamediv>
72
 
 
 
56
  
73
57
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
58
    <synopsis>&CONFPATH;</synopsis>
77
59
  </refsynopsisdiv>
78
 
 
 
60
  
79
61
  <refsect1 id="description">
80
62
    <title>DESCRIPTION</title>
81
63
    <para>
83
65
      ><refentrytitle>mandos</refentrytitle>
84
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
67
      The file needs to list all clients that should be able to use
86
 
      the service.  All clients listed will be regarded as valid, even
87
 
      if a client was declared invalid in a previous run of the
88
 
      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.
89
70
    </para>
90
71
    <para>
91
72
      The format starts with a <literal>[<replaceable>section
115
96
      start time expansion, see <xref linkend="expansion"/>.
116
97
    </para>
117
98
    <para>
118
 
      Uknown options are ignored.  The used options are as follows:
 
99
      Unknown options are ignored.  The used options are as follows:
119
100
    </para>
120
 
 
 
101
    
121
102
    <variablelist>
122
 
 
123
 
      <varlistentry>
124
 
        <term><literal><varname>timeout</varname></literal></term>
125
 
        <listitem>
126
 
          <synopsis><literal>timeout = </literal><replaceable
127
 
          >TIME</replaceable>
128
 
          </synopsis>
129
 
          <para>
130
 
            The timeout is how long the server will wait for a
131
 
            successful checker run until a client is considered
132
 
            invalid - that is, ineligible to get the data this server
133
 
            holds.  By default Mandos will use 1 hour.
134
 
          </para>
135
 
          <para>
136
 
            The <replaceable>TIME</replaceable> is specified as a
137
 
            space-separated number of values, each of which is a
138
 
            number and a one-character suffix.  The suffix must be one
139
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
140
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
141
 
            minutes, hours, and weeks, respectively.  The values are
142
 
            added together to give the total time value, so all of
143
 
            <quote><literal>330s</literal></quote>,
144
 
            <quote><literal>110s 110s 110s</literal></quote>, and
145
 
            <quote><literal>5m 30s</literal></quote> will give a value
146
 
            of five minutes and thirty seconds.
147
 
          </para>
148
 
        </listitem>
149
 
      </varlistentry>
150
 
 
151
 
      <varlistentry>
152
 
        <term><literal><varname>interval</varname></literal></term>
153
 
        <listitem>
154
 
          <synopsis><literal>interval = </literal><replaceable
155
 
          >TIME</replaceable>
156
 
          </synopsis>
157
 
          <para>
158
 
            How often to run the checker to confirm that a client is
159
 
            still up.  <emphasis>Note:</emphasis> a new checker will
160
 
            not be started if an old one is still running.  The server
161
 
            will wait for a checker to complete until the above
162
 
            <quote><varname>timeout</varname></quote> occurs, at which
163
 
            time the client will be marked invalid, and any running
164
 
            checker killed.  The default interval is 5 minutes.
165
 
          </para>
166
 
          <para>
167
 
            The format of <replaceable>TIME</replaceable> is the same
168
 
            as for <varname>timeout</varname> above.
169
 
          </para>
170
 
        </listitem>
171
 
      </varlistentry>      
172
 
 
173
 
      <varlistentry>
174
 
        <term><literal>checker</literal></term>
175
 
        <listitem>
176
 
          <synopsis><literal>checker = </literal><replaceable
177
 
          >COMMAND</replaceable>
178
 
          </synopsis>
 
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
      
 
156
      <varlistentry>
 
157
        <term><option>checker<literal> = </literal><replaceable
 
158
        >COMMAND</replaceable></option></term>
 
159
        <listitem>
 
160
          <para>
 
161
            This option is <emphasis>optional</emphasis>.
 
162
          </para>
179
163
          <para>
180
164
            This option allows you to override the default shell
181
165
            command that the server will use to check if the client is
187
171
            <varname>PATH</varname> will be searched.  The default
188
172
            value for the checker command is <quote><literal
189
173
            ><command>fping</command> <option>-q</option> <option
190
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
191
175
          </para>
192
176
          <para>
193
177
            In addition to normal start time expansion, this option
198
182
      </varlistentry>
199
183
      
200
184
      <varlistentry>
201
 
        <term><literal>fingerprint</literal></term>
202
 
        <listitem>
203
 
          <synopsis><literal>fingerprint = </literal><replaceable
204
 
          >HEXSTRING</replaceable>
205
 
          </synopsis>
 
185
        <term><option>extended_timeout<literal> = </literal><replaceable
 
186
        >TIME</replaceable></option></term>
 
187
        <listitem>
 
188
          <para>
 
189
            This option is <emphasis>optional</emphasis>.
 
190
          </para>
 
191
          <para>
 
192
            Extended timeout is an added timeout that is given once
 
193
            after a password has been sent sucessfully to a client.
 
194
            The timeout is by default longer than the normal timeout,
 
195
            and is used for handling the extra long downtime while a
 
196
            machine is booting up.  Time to take into consideration
 
197
            when changing this value is file system checks and quota
 
198
            checks.  The default value is 15 minutes.
 
199
          </para>
 
200
          <para>
 
201
            The format of <replaceable>TIME</replaceable> is the same
 
202
            as for <varname>timeout</varname> below.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
      
 
207
      <varlistentry>
 
208
        <term><option>fingerprint<literal> = </literal
 
209
        ><replaceable>HEXSTRING</replaceable></option></term>
 
210
        <listitem>
 
211
          <para>
 
212
            This option is <emphasis>required</emphasis>.
 
213
          </para>
206
214
          <para>
207
215
            This option sets the OpenPGP fingerprint that identifies
208
216
            the public key that clients authenticate themselves with
213
221
      </varlistentry>
214
222
      
215
223
      <varlistentry>
216
 
        <term><literal>secret</literal></term>
217
 
        <listitem>
218
 
          <synopsis><literal>secret = </literal><replaceable
219
 
          >BASE64_ENCODED_DATA</replaceable>
220
 
          </synopsis>
 
224
        <term><option><literal>host = </literal><replaceable
 
225
        >STRING</replaceable></option></term>
 
226
        <listitem>
 
227
          <para>
 
228
            This option is <emphasis>optional</emphasis>, but highly
 
229
            <emphasis>recommended</emphasis> unless the
 
230
            <option>checker</option> option is modified to a
 
231
            non-standard value without <quote>%%(host)s</quote> in it.
 
232
          </para>
 
233
          <para>
 
234
            Host name for this client.  This is not used by the server
 
235
            directly, but can be, and is by default, used by the
 
236
            checker.  See the <option>checker</option> option.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>interval<literal> = </literal><replaceable
 
243
        >TIME</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            How often to run the checker to confirm that a client is
 
250
            still up.  <emphasis>Note:</emphasis> a new checker will
 
251
            not be started if an old one is still running.  The server
 
252
            will wait for a checker to complete until the below
 
253
            <quote><varname>timeout</varname></quote> occurs, at which
 
254
            time the client will be disabled, and any running checker
 
255
            killed.  The default interval is 2 minutes.
 
256
          </para>
 
257
          <para>
 
258
            The format of <replaceable>TIME</replaceable> is the same
 
259
            as for <varname>timeout</varname> below.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>
 
263
      
 
264
      <varlistentry>
 
265
        <term><option>secfile<literal> = </literal><replaceable
 
266
        >FILENAME</replaceable></option></term>
 
267
        <listitem>
 
268
          <para>
 
269
            This option is only used if <option>secret</option> is not
 
270
            specified, in which case this option is
 
271
            <emphasis>required</emphasis>.
 
272
          </para>
 
273
          <para>
 
274
            Similar to the <option>secret</option>, except the secret
 
275
            data is in an external file.  The contents of the file
 
276
            should <emphasis>not</emphasis> be base64-encoded, but
 
277
            will be sent to clients verbatim.
 
278
          </para>
 
279
          <para>
 
280
            File names of the form <filename>~user/foo/bar</filename>
 
281
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
282
            are supported.
 
283
          </para>
 
284
        </listitem>
 
285
      </varlistentry>
 
286
      
 
287
      <varlistentry>
 
288
        <term><option>secret<literal> = </literal><replaceable
 
289
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
290
        <listitem>
 
291
          <para>
 
292
            If this option is not specified, the <option
 
293
            >secfile</option> option is <emphasis>required</emphasis>
 
294
            to be present.
 
295
          </para>
221
296
          <para>
222
297
            If present, this option must be set to a string of
223
298
            base64-encoded binary data.  It will be decoded and sent
236
311
            lines is that a line beginning with white space adds to
237
312
            the value of the previous line, RFC 822-style.
238
313
          </para>
239
 
          <para>
240
 
            If this option is not specified, the <option
241
 
            >secfile</option> option is used instead, but one of them
242
 
            <emphasis>must</emphasis> be present.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
 
247
 
      <varlistentry>
248
 
        <term><literal>secfile</literal></term>
249
 
        <listitem>
250
 
          <synopsis><literal>secfile = </literal><replaceable
251
 
          >FILENAME</replaceable>
252
 
          </synopsis>
253
 
          <para>
254
 
            The same as <option>secret</option>, but the secret data
255
 
            is in an external file.  The contents of the file should
256
 
            <emphasis>not</emphasis> be base64-encoded, but will be
257
 
            sent to clients verbatim.
258
 
          </para>
259
 
          <para>
260
 
            This option is only used, and <emphasis>must</emphasis> be
261
 
            present, if <option>secret</option> is not specified.
262
 
          </para>
263
 
        </listitem>
264
 
      </varlistentry>
265
 
 
266
 
      <varlistentry>
267
 
        <term><literal>host</literal></term>
268
 
        <listitem>
269
 
          <synopsis><literal>host = </literal><replaceable
270
 
          >STRING</replaceable>
271
 
          </synopsis>
272
 
          <para>
273
 
            Host name for this client.  This is not used by the server
274
 
            directly, but can be, and is by default, used by the
275
 
            checker.  See the <option>checker</option> option.
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>timeout<literal> = </literal><replaceable
 
319
        >TIME</replaceable></option></term>
 
320
        <listitem>
 
321
          <para>
 
322
            This option is <emphasis>optional</emphasis>.
 
323
          </para>
 
324
          <para>
 
325
            The timeout is how long the server will wait, after a
 
326
            successful checker run, until a client is disabled and not
 
327
            allowed to get the data this server holds.  By default
 
328
            Mandos will use 5 minutes.  See also the
 
329
            <option>extended_timeout</option> option.
 
330
          </para>
 
331
          <para>
 
332
            The <replaceable>TIME</replaceable> is specified as a
 
333
            space-separated number of values, each of which is a
 
334
            number and a one-character suffix.  The suffix must be one
 
335
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
336
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
337
            minutes, hours, and weeks, respectively.  The values are
 
338
            added together to give the total time value, so all of
 
339
            <quote><literal>330s</literal></quote>,
 
340
            <quote><literal>110s 110s 110s</literal></quote>, and
 
341
            <quote><literal>5m 30s</literal></quote> will give a value
 
342
            of five minutes and thirty seconds.
276
343
          </para>
277
344
        </listitem>
278
345
      </varlistentry>
279
346
      
280
347
    </variablelist>
281
 
  </refsect1>  
 
348
  </refsect1>
282
349
  
283
350
  <refsect1 id="expansion">
284
351
    <title>EXPANSION</title>
315
382
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
316
383
        ></quote> will be replaced by the value of the attribute
317
384
        <varname>foo</varname> of the internal
318
 
        <quote><classname>Client</classname></quote> object.  See the
319
 
        source code for details, and let the authors know of any
320
 
        attributes that are useful so they may be preserved to any new
321
 
        versions of this software.
 
385
        <quote><classname>Client</classname></quote> object in the
 
386
        Mandos server.  The currently allowed values for
 
387
        <replaceable>foo</replaceable> are:
 
388
        <quote><literal>approval_delay</literal></quote>,
 
389
        <quote><literal>approval_duration</literal></quote>,
 
390
        <quote><literal>created</literal></quote>,
 
391
        <quote><literal>enabled</literal></quote>,
 
392
        <quote><literal>fingerprint</literal></quote>,
 
393
        <quote><literal>host</literal></quote>,
 
394
        <quote><literal>interval</literal></quote>,
 
395
        <quote><literal>last_approval_request</literal></quote>,
 
396
        <quote><literal>last_checked_ok</literal></quote>,
 
397
        <quote><literal>last_enabled</literal></quote>,
 
398
        <quote><literal>name</literal></quote>,
 
399
        <quote><literal>timeout</literal></quote>, and, if using
 
400
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
401
        See the source code for details.  <emphasis role="strong"
 
402
        >Currently, <emphasis>none</emphasis> of these attributes
 
403
        except <quote><literal>host</literal></quote> are guaranteed
 
404
        to be valid in future versions.</emphasis> Therefore, please
 
405
        let the authors know of any attributes that are useful so they
 
406
        may be preserved to any new versions of this software.
322
407
      </para>
323
408
      <para>
324
409
        Note that this means that, in order to include an actual
327
412
        percent characters in a row (<quote>%%%%</quote>) must be
328
413
        entered.  Also, a bad format here will lead to an immediate
329
414
        but <emphasis>silent</emphasis> run-time fatal exit; debug
330
 
        mode is needed to track down an error of this kind.
 
415
        mode is needed to expose an error of this kind.
331
416
      </para>
332
417
    </refsect2>
333
 
 
334
 
  </refsect1>  
 
418
    
 
419
  </refsect1>
335
420
  
336
421
  <refsect1 id="files">
337
422
    <title>FILES</title>
359
444
    <informalexample>
360
445
      <programlisting>
361
446
[DEFAULT]
362
 
timeout = 1h
363
 
interval = 5m
364
 
checker = fping -q -- %(host)s
 
447
timeout = 5m
 
448
interval = 2m
 
449
checker = fping -q -- %%(host)s
365
450
 
366
451
# Client "foo"
367
452
[foo]
390
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
476
secfile = /etc/mandos/bar-secret
392
477
timeout = 15m
393
 
 
 
478
approved_by_default = False
 
479
approval_delay = 30s
394
480
      </programlisting>
395
481
    </informalexample>
396
 
  </refsect1>  
 
482
  </refsect1>
397
483
  
398
484
  <refsect1 id="see_also">
399
485
    <title>SEE ALSO</title>
400
486
    <para>
401
 
      <citerefentry>
402
 
        <refentrytitle>mandos</refentrytitle>
403
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
404
 
        <refentrytitle>mandos-keygen</refentrytitle>
405
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
 
        <refentrytitle>mandos.conf</refentrytitle>
407
 
        <manvolnum>5</manvolnum></citerefentry>
 
487
      <citerefentry><refentrytitle>intro</refentrytitle>
 
488
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
489
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
490
      <manvolnum>8</manvolnum></citerefentry>,
 
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
492
      <manvolnum>5</manvolnum></citerefentry>,
 
493
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
494
      <manvolnum>8</manvolnum></citerefentry>
408
495
    </para>
409
496
  </refsect1>
410
497
</refentry>
 
498
<!-- Local Variables: -->
 
499
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
500
<!-- time-stamp-end: "[\"']>" -->
 
501
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
502
<!-- End: -->