/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: 2008-08-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2010-09-26">
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
35
      <holder>Teddy Hogeborn</holder>
39
36
      <holder>Björn Påhlsson</holder>
40
37
    </copyright>
41
 
    <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>
42
61
  </refentryinfo>
43
 
  
 
62
 
44
63
  <refmeta>
45
64
    <refentrytitle>&CONFNAME;</refentrytitle>
46
65
    <manvolnum>5</manvolnum>
52
71
      Configuration file for the Mandos server
53
72
    </refpurpose>
54
73
  </refnamediv>
55
 
  
 
74
 
56
75
  <refsynopsisdiv>
57
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
58
79
  </refsynopsisdiv>
59
 
  
 
80
 
60
81
  <refsect1 id="description">
61
82
    <title>DESCRIPTION</title>
62
83
    <para>
64
85
      ><refentrytitle>mandos</refentrytitle>
65
86
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
87
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      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.
69
91
    </para>
70
92
    <para>
71
93
      The format starts with a <literal>[<replaceable>section
95
117
      start time expansion, see <xref linkend="expansion"/>.
96
118
    </para>
97
119
    <para>
98
 
      Unknown options are ignored.  The used options are as follows:
 
120
      Uknown options are ignored.  The used options are as follows:
99
121
    </para>
100
 
    
 
122
 
101
123
    <variablelist>
102
 
      
103
 
      <varlistentry>
104
 
        <term><option>approval_delay<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
106
 
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
110
 
          <para>
111
 
            How long to wait for external approval before resorting to
112
 
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
114
 
          </para>
115
 
          <para>
116
 
            The format of <replaceable>TIME</replaceable> is the same
117
 
            as for <varname>timeout</varname> below.
118
 
          </para>
119
 
        </listitem>
120
 
      </varlistentry>
121
 
      
122
 
      <varlistentry>
123
 
        <term><option>approval_duration<literal> = </literal
124
 
        ><replaceable>TIME</replaceable></option></term>
125
 
        <listitem>
126
 
          <para>
127
 
            This option is <emphasis>optional</emphasis>.
128
 
          </para>
129
 
          <para>
130
 
            How long an external approval lasts.  The default is 1
131
 
            second.
132
 
          </para>
133
 
          <para>
134
 
            The format of <replaceable>TIME</replaceable> is the same
135
 
            as for <varname>timeout</varname> below.
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>
139
 
      
140
 
      <varlistentry>
141
 
        <term><option>approved_by_default<literal> = </literal
142
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
143
 
          >true</literal> | <literal>on</literal> | <literal
144
 
          >0</literal> | <literal>no</literal> | <literal
145
 
          >false</literal> | <literal>off</literal> }</option></term>
146
 
        <listitem>
147
 
          <para>
148
 
            Whether to approve a client by default after
149
 
            the <option>approval_delay</option>.  The default
150
 
            is <quote>True</quote>.
151
 
          </para>
152
 
        </listitem>
153
 
      </varlistentry>
154
 
      
155
 
      <varlistentry>
156
 
        <term><option>checker<literal> = </literal><replaceable
157
 
        >COMMAND</replaceable></option></term>
158
 
        <listitem>
159
 
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </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>
162
181
          <para>
163
182
            This option allows you to override the default shell
164
183
            command that the server will use to check if the client is
170
189
            <varname>PATH</varname> will be searched.  The default
171
190
            value for the checker command is <quote><literal
172
191
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
192
            >--</option> %(host)s</literal></quote>.
174
193
          </para>
175
194
          <para>
176
195
            In addition to normal start time expansion, this option
181
200
      </varlistentry>
182
201
      
183
202
      <varlistentry>
184
 
        <term><option>fingerprint<literal> = </literal
185
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
203
        <term><literal>fingerprint</literal></term>
186
204
        <listitem>
187
 
          <para>
188
 
            This option is <emphasis>required</emphasis>.
189
 
          </para>
 
205
          <synopsis><literal>fingerprint = </literal><replaceable
 
206
          >HEXSTRING</replaceable>
 
207
          </synopsis>
190
208
          <para>
191
209
            This option sets the OpenPGP fingerprint that identifies
192
210
            the public key that clients authenticate themselves with
197
215
      </varlistentry>
198
216
      
199
217
      <varlistentry>
200
 
        <term><option><literal>host = </literal><replaceable
201
 
        >STRING</replaceable></option></term>
202
 
        <listitem>
203
 
          <para>
204
 
            This option is <emphasis>optional</emphasis>, but highly
205
 
            <emphasis>recommended</emphasis> unless the
206
 
            <option>checker</option> option is modified to a
207
 
            non-standard value without <quote>%%(host)s</quote> in it.
208
 
          </para>
209
 
          <para>
210
 
            Host name for this client.  This is not used by the server
211
 
            directly, but can be, and is by default, used by the
212
 
            checker.  See the <option>checker</option> option.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><option>interval<literal> = </literal><replaceable
219
 
        >TIME</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            This option is <emphasis>optional</emphasis>.
223
 
          </para>
224
 
          <para>
225
 
            How often to run the checker to confirm that a client is
226
 
            still up.  <emphasis>Note:</emphasis> a new checker will
227
 
            not be started if an old one is still running.  The server
228
 
            will wait for a checker to complete until the below
229
 
            <quote><varname>timeout</varname></quote> occurs, at which
230
 
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
232
 
          </para>
233
 
          <para>
234
 
            The format of <replaceable>TIME</replaceable> is the same
235
 
            as for <varname>timeout</varname> below.
236
 
          </para>
237
 
        </listitem>
238
 
      </varlistentry>
239
 
      
240
 
      <varlistentry>
241
 
        <term><option>secfile<literal> = </literal><replaceable
242
 
        >FILENAME</replaceable></option></term>
243
 
        <listitem>
244
 
          <para>
245
 
            This option is only used if <option>secret</option> is not
246
 
            specified, in which case this option is
247
 
            <emphasis>required</emphasis>.
248
 
          </para>
249
 
          <para>
250
 
            Similar to the <option>secret</option>, except the secret
251
 
            data is in an external file.  The contents of the file
252
 
            should <emphasis>not</emphasis> be base64-encoded, but
253
 
            will be sent to clients verbatim.
254
 
          </para>
255
 
          <para>
256
 
            File names of the form <filename>~user/foo/bar</filename>
257
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
258
 
            are supported.
259
 
          </para>
260
 
        </listitem>
261
 
      </varlistentry>
262
 
      
263
 
      <varlistentry>
264
 
        <term><option>secret<literal> = </literal><replaceable
265
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
266
 
        <listitem>
267
 
          <para>
268
 
            If this option is not specified, the <option
269
 
            >secfile</option> option is <emphasis>required</emphasis>
270
 
            to be present.
271
 
          </para>
 
218
        <term><literal>secret</literal></term>
 
219
        <listitem>
 
220
          <synopsis><literal>secret = </literal><replaceable
 
221
          >BASE64_ENCODED_DATA</replaceable>
 
222
          </synopsis>
272
223
          <para>
273
224
            If present, this option must be set to a string of
274
225
            base64-encoded binary data.  It will be decoded and sent
287
238
            lines is that a line beginning with white space adds to
288
239
            the value of the previous line, RFC 822-style.
289
240
          </para>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>timeout<literal> = </literal><replaceable
295
 
        >TIME</replaceable></option></term>
296
 
        <listitem>
297
 
          <para>
298
 
            This option is <emphasis>optional</emphasis>.
299
 
          </para>
300
 
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
305
 
          </para>
306
 
          <para>
307
 
            The <replaceable>TIME</replaceable> is specified as a
308
 
            space-separated number of values, each of which is a
309
 
            number and a one-character suffix.  The suffix must be one
310
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
312
 
            minutes, hours, and weeks, respectively.  The values are
313
 
            added together to give the total time value, so all of
314
 
            <quote><literal>330s</literal></quote>,
315
 
            <quote><literal>110s 110s 110s</literal></quote>, and
316
 
            <quote><literal>5m 30s</literal></quote> will give a value
317
 
            of five minutes and thirty seconds.
 
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.
318
278
          </para>
319
279
        </listitem>
320
280
      </varlistentry>
321
281
      
322
282
    </variablelist>
323
 
  </refsect1>
 
283
  </refsect1>  
324
284
  
325
285
  <refsect1 id="expansion">
326
286
    <title>EXPANSION</title>
357
317
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
358
318
        ></quote> will be replaced by the value of the attribute
359
319
        <varname>foo</varname> of the internal
360
 
        <quote><classname>Client</classname></quote> object in the
361
 
        Mandos server.  The currently allowed values for
362
 
        <replaceable>foo</replaceable> are:
363
 
        <quote><literal>approval_delay</literal></quote>,
364
 
        <quote><literal>approval_duration</literal></quote>,
365
 
        <quote><literal>created</literal></quote>,
366
 
        <quote><literal>enabled</literal></quote>,
367
 
        <quote><literal>fingerprint</literal></quote>,
368
 
        <quote><literal>host</literal></quote>,
369
 
        <quote><literal>interval</literal></quote>,
370
 
        <quote><literal>last_approval_request</literal></quote>,
371
 
        <quote><literal>last_checked_ok</literal></quote>,
372
 
        <quote><literal>last_enabled</literal></quote>,
373
 
        <quote><literal>name</literal></quote>,
374
 
        <quote><literal>timeout</literal></quote>, and, if using
375
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
376
 
        See the source code for details.  <emphasis role="strong"
377
 
        >Currently, <emphasis>none</emphasis> of these attributes
378
 
        except <quote><literal>host</literal></quote> are guaranteed
379
 
        to be valid in future versions.</emphasis> Therefore, please
380
 
        let the authors know of any attributes that are useful so they
381
 
        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.
382
324
      </para>
383
325
      <para>
384
326
        Note that this means that, in order to include an actual
387
329
        percent characters in a row (<quote>%%%%</quote>) must be
388
330
        entered.  Also, a bad format here will lead to an immediate
389
331
        but <emphasis>silent</emphasis> run-time fatal exit; debug
390
 
        mode is needed to expose an error of this kind.
 
332
        mode is needed to track down an error of this kind.
391
333
      </para>
392
334
    </refsect2>
393
 
    
394
 
  </refsect1>
 
335
 
 
336
  </refsect1>  
395
337
  
396
338
  <refsect1 id="files">
397
339
    <title>FILES</title>
421
363
[DEFAULT]
422
364
timeout = 1h
423
365
interval = 5m
424
 
checker = fping -q -- %%(host)s
 
366
checker = fping -q -- %(host)s
425
367
 
426
368
# Client "foo"
427
369
[foo]
450
392
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
393
secfile = /etc/mandos/bar-secret
452
394
timeout = 15m
453
 
approved_by_default = False
454
 
approval_delay = 30s
 
395
 
455
396
      </programlisting>
456
397
    </informalexample>
457
 
  </refsect1>
 
398
  </refsect1>  
458
399
  
459
400
  <refsect1 id="see_also">
460
401
    <title>SEE ALSO</title>
461
402
    <para>
462
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
 
      <manvolnum>8</manvolnum></citerefentry>,
464
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
 
      <manvolnum>5</manvolnum></citerefentry>,
466
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
467
 
      <manvolnum>8</manvolnum></citerefentry>
 
403
      <citerefentry>
 
404
        <refentrytitle>mandos</refentrytitle>
 
405
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
406
        <refentrytitle>mandos-keygen</refentrytitle>
 
407
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
408
        <refentrytitle>mandos.conf</refentrytitle>
 
409
        <manvolnum>5</manvolnum></citerefentry>
468
410
    </para>
469
411
  </refsect1>
470
412
</refentry>