/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-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

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