/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2011-08-08">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-29">
9
8
]>
10
9
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
12
11
  <refentryinfo>
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
 
      <year>2011</year>
39
35
      <holder>Teddy Hogeborn</holder>
40
36
      <holder>Björn Påhlsson</holder>
41
37
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
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
61
  </refentryinfo>
44
 
  
 
62
 
45
63
  <refmeta>
46
64
    <refentrytitle>&CONFNAME;</refentrytitle>
47
65
    <manvolnum>5</manvolnum>
53
71
      Configuration file for the Mandos server
54
72
    </refpurpose>
55
73
  </refnamediv>
56
 
  
 
74
 
57
75
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
59
79
  </refsynopsisdiv>
60
 
  
 
80
 
61
81
  <refsect1 id="description">
62
82
    <title>DESCRIPTION</title>
63
83
    <para>
65
85
      ><refentrytitle>mandos</refentrytitle>
66
86
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
87
      The file needs to list all clients that should be able to use
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.
 
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.
70
91
    </para>
71
92
    <para>
72
93
      The format starts with a <literal>[<replaceable>section
96
117
      start time expansion, see <xref linkend="expansion"/>.
97
118
    </para>
98
119
    <para>
99
 
      Unknown options are ignored.  The used options are as follows:
 
120
      Uknown options are ignored.  The used options are as follows:
100
121
    </para>
101
 
    
 
122
 
102
123
    <variablelist>
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>
 
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>
163
181
          <para>
164
182
            This option allows you to override the default shell
165
183
            command that the server will use to check if the client is
171
189
            <varname>PATH</varname> will be searched.  The default
172
190
            value for the checker command is <quote><literal
173
191
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
192
            >--</option> %(host)s</literal></quote>.
175
193
          </para>
176
194
          <para>
177
195
            In addition to normal start time expansion, this option
182
200
      </varlistentry>
183
201
      
184
202
      <varlistentry>
185
 
        <term><option>fingerprint<literal> = </literal
186
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
203
        <term><literal>fingerprint</literal></term>
187
204
        <listitem>
188
 
          <para>
189
 
            This option is <emphasis>required</emphasis>.
190
 
          </para>
 
205
          <synopsis><literal>fingerprint = </literal><replaceable
 
206
          >HEXSTRING</replaceable>
 
207
          </synopsis>
191
208
          <para>
192
209
            This option sets the OpenPGP fingerprint that identifies
193
210
            the public key that clients authenticate themselves with
198
215
      </varlistentry>
199
216
      
200
217
      <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 2 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>
265
 
        <term><option>secret<literal> = </literal><replaceable
266
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
267
 
        <listitem>
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>
 
218
        <term><literal>secret</literal></term>
 
219
        <listitem>
 
220
          <synopsis><literal>secret = </literal><replaceable
 
221
          >BASE64_ENCODED_DATA</replaceable>
 
222
          </synopsis>
273
223
          <para>
274
224
            If present, this option must be set to a string of
275
225
            base64-encoded binary data.  It will be decoded and sent
288
238
            lines is that a line beginning with white space adds to
289
239
            the value of the previous line, RFC 822-style.
290
240
          </para>
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 5 minutes.
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.
319
 
          </para>
320
 
        </listitem>
321
 
      </varlistentry>
322
 
 
323
 
      <varlistentry>
324
 
        <term><option>extended_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
 
            Extended timeout is an added timeout that is given once
332
 
            after a password has been sent sucessfully to a client.
333
 
            The timeout is by default longer than the normal timeout,
334
 
            and is used for handling the extra long downtime while a
335
 
            matchine is booting up.  Time to take into consideration
336
 
            when changing this value is system file checks and quota
337
 
            checks.  The default value is 15 minutes.
338
 
          </para>
339
 
          <para>
340
 
            The format of <replaceable>TIME</replaceable> is the same
341
 
            as for <varname>timeout</varname> above.
 
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.
342
278
          </para>
343
279
        </listitem>
344
280
      </varlistentry>
345
281
      
346
282
    </variablelist>
347
 
  </refsect1>
 
283
  </refsect1>  
348
284
  
349
285
  <refsect1 id="expansion">
350
286
    <title>EXPANSION</title>
381
317
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
382
318
        ></quote> will be replaced by the value of the attribute
383
319
        <varname>foo</varname> of the internal
384
 
        <quote><classname>Client</classname></quote> object in the
385
 
        Mandos server.  The currently allowed values for
386
 
        <replaceable>foo</replaceable> are:
387
 
        <quote><literal>approval_delay</literal></quote>,
388
 
        <quote><literal>approval_duration</literal></quote>,
389
 
        <quote><literal>created</literal></quote>,
390
 
        <quote><literal>enabled</literal></quote>,
391
 
        <quote><literal>fingerprint</literal></quote>,
392
 
        <quote><literal>host</literal></quote>,
393
 
        <quote><literal>interval</literal></quote>,
394
 
        <quote><literal>last_approval_request</literal></quote>,
395
 
        <quote><literal>last_checked_ok</literal></quote>,
396
 
        <quote><literal>last_enabled</literal></quote>,
397
 
        <quote><literal>name</literal></quote>,
398
 
        <quote><literal>timeout</literal></quote>, and, if using
399
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
400
 
        See the source code for details.  <emphasis role="strong"
401
 
        >Currently, <emphasis>none</emphasis> of these attributes
402
 
        except <quote><literal>host</literal></quote> are guaranteed
403
 
        to be valid in future versions.</emphasis> Therefore, please
404
 
        let the authors know of any attributes that are useful so they
405
 
        may be preserved to any new versions of this software.
 
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.
406
324
      </para>
407
325
      <para>
408
326
        Note that this means that, in order to include an actual
411
329
        percent characters in a row (<quote>%%%%</quote>) must be
412
330
        entered.  Also, a bad format here will lead to an immediate
413
331
        but <emphasis>silent</emphasis> run-time fatal exit; debug
414
 
        mode is needed to expose an error of this kind.
 
332
        mode is needed to track down an error of this kind.
415
333
      </para>
416
334
    </refsect2>
417
 
    
418
 
  </refsect1>
 
335
 
 
336
  </refsect1>  
419
337
  
420
338
  <refsect1 id="files">
421
339
    <title>FILES</title>
443
361
    <informalexample>
444
362
      <programlisting>
445
363
[DEFAULT]
446
 
timeout = 5m
447
 
interval = 2m
448
 
checker = fping -q -- %%(host)s
 
364
timeout = 1h
 
365
interval = 5m
 
366
checker = fping -q -- %(host)s
449
367
 
450
368
# Client "foo"
451
369
[foo]
474
392
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
475
393
secfile = /etc/mandos/bar-secret
476
394
timeout = 15m
477
 
approved_by_default = False
478
 
approval_delay = 30s
 
395
 
479
396
      </programlisting>
480
397
    </informalexample>
481
 
  </refsect1>
 
398
  </refsect1>  
482
399
  
483
400
  <refsect1 id="see_also">
484
401
    <title>SEE ALSO</title>
485
402
    <para>
486
 
      <citerefentry><refentrytitle>intro</refentrytitle>
487
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
488
403
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
489
404
      <manvolnum>8</manvolnum></citerefentry>,
490
405
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>