/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: Björn Påhlsson
  • Date: 2008-08-31 16:03:21 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 132.
  • Revision ID: belorn@braxen-20080831160321-fgvlw43uu6qz7k06
Rearranged so plugins and processes is the same thing

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-11-26">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-30">
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>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </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
76
    <synopsis>&CONFPATH;</synopsis>
59
77
  </refsynopsisdiv>
60
 
  
 
78
 
61
79
  <refsect1 id="description">
62
80
    <title>DESCRIPTION</title>
63
81
    <para>
65
83
      ><refentrytitle>mandos</refentrytitle>
66
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
85
      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.
 
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.
70
89
    </para>
71
90
    <para>
72
91
      The format starts with a <literal>[<replaceable>section
96
115
      start time expansion, see <xref linkend="expansion"/>.
97
116
    </para>
98
117
    <para>
99
 
      Unknown options are ignored.  The used options are as follows:
 
118
      Uknown options are ignored.  The used options are as follows:
100
119
    </para>
101
 
    
 
120
 
102
121
    <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
 
      
 
122
 
 
123
      <varlistentry>
 
124
        <term><option>timeout<literal> = </literal><replaceable
 
125
        >TIME</replaceable></option></term>
 
126
        <listitem>
 
127
          <para>
 
128
            The timeout is how long the server will wait for a
 
129
            successful checker run until a client is considered
 
130
            invalid - that is, ineligible to get the data this server
 
131
            holds.  By default Mandos will use 1 hour.
 
132
          </para>
 
133
          <para>
 
134
            The <replaceable>TIME</replaceable> is specified as a
 
135
            space-separated number of values, each of which is a
 
136
            number and a one-character suffix.  The suffix must be one
 
137
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
138
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
139
            minutes, hours, and weeks, respectively.  The values are
 
140
            added together to give the total time value, so all of
 
141
            <quote><literal>330s</literal></quote>,
 
142
            <quote><literal>110s 110s 110s</literal></quote>, and
 
143
            <quote><literal>5m 30s</literal></quote> will give a value
 
144
            of five minutes and thirty seconds.
 
145
          </para>
 
146
        </listitem>
 
147
      </varlistentry>
 
148
 
 
149
      <varlistentry>
 
150
        <term><option>interval<literal> = </literal><replaceable
 
151
        >TIME</replaceable></option></term>
 
152
        <listitem>
 
153
          <para>
 
154
            How often to run the checker to confirm that a client is
 
155
            still up.  <emphasis>Note:</emphasis> a new checker will
 
156
            not be started if an old one is still running.  The server
 
157
            will wait for a checker to complete until the above
 
158
            <quote><varname>timeout</varname></quote> occurs, at which
 
159
            time the client will be marked invalid, and any running
 
160
            checker killed.  The default interval is 5 minutes.
 
161
          </para>
 
162
          <para>
 
163
            The format of <replaceable>TIME</replaceable> is the same
 
164
            as for <varname>timeout</varname> above.
 
165
          </para>
 
166
        </listitem>
 
167
      </varlistentry>
 
168
 
156
169
      <varlistentry>
157
170
        <term><option>checker<literal> = </literal><replaceable
158
171
        >COMMAND</replaceable></option></term>
159
172
        <listitem>
160
173
          <para>
161
 
            This option is <emphasis>optional</emphasis>.
162
 
          </para>
163
 
          <para>
164
174
            This option allows you to override the default shell
165
175
            command that the server will use to check if the client is
166
176
            still up.  Any output of the command will be ignored, only
171
181
            <varname>PATH</varname> will be searched.  The default
172
182
            value for the checker command is <quote><literal
173
183
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
184
            >--</option> %(host)s</literal></quote>.
175
185
          </para>
176
186
          <para>
177
187
            In addition to normal start time expansion, this option
182
192
      </varlistentry>
183
193
      
184
194
      <varlistentry>
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 successfully 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
195
        <term><option>fingerprint<literal> = </literal
209
196
        ><replaceable>HEXSTRING</replaceable></option></term>
210
197
        <listitem>
211
198
          <para>
212
 
            This option is <emphasis>required</emphasis>.
213
 
          </para>
214
 
          <para>
215
199
            This option sets the OpenPGP fingerprint that identifies
216
200
            the public key that clients authenticate themselves with
217
201
            through TLS.  The string needs to be in hexidecimal form,
221
205
      </varlistentry>
222
206
      
223
207
      <varlistentry>
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
208
        <term><option>secret<literal> = </literal><replaceable
289
209
        >BASE64_ENCODED_DATA</replaceable></option></term>
290
210
        <listitem>
291
211
          <para>
292
 
            If this option is not specified, the <option
293
 
            >secfile</option> option is <emphasis>required</emphasis>
294
 
            to be present.
295
 
          </para>
296
 
          <para>
297
212
            If present, this option must be set to a string of
298
213
            base64-encoded binary data.  It will be decoded and sent
299
214
            to the client matching the above
311
226
            lines is that a line beginning with white space adds to
312
227
            the value of the previous line, RFC 822-style.
313
228
          </para>
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.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
 
      
347
 
      <varlistentry>
348
 
        <term><option>enabled<literal> = </literal>{ <literal
349
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
350
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
351
 
        >no</literal> | <literal>false</literal> | <literal
352
 
        >off</literal> }</option></term>
353
 
        <listitem>
354
 
          <para>
355
 
            Whether this client should be enabled by default.  The
356
 
            default is <quote>true</quote>.
 
229
          <para>
 
230
            If this option is not specified, the <option
 
231
            >secfile</option> option is used instead, but one of them
 
232
            <emphasis>must</emphasis> be present.
 
233
          </para>
 
234
        </listitem>
 
235
      </varlistentry>
 
236
 
 
237
      <varlistentry>
 
238
        <term><option>secfile<literal> = </literal><replaceable
 
239
        >FILENAME</replaceable></option></term>
 
240
        <listitem>
 
241
          <para>
 
242
            Similar to the <option>secret</option>, except the secret
 
243
            data is in an external file.  The contents of the file
 
244
            should <emphasis>not</emphasis> be base64-encoded, but
 
245
            will be sent to clients verbatim.
 
246
          </para>
 
247
          <para>
 
248
            This option is only used, and <emphasis>must</emphasis> be
 
249
            present, if <option>secret</option> is not specified.
 
250
          </para>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
 
 
254
      <varlistentry>
 
255
        <term><option><literal>host = </literal><replaceable
 
256
        >STRING</replaceable></option></term>
 
257
        <listitem>
 
258
          <para>
 
259
            Host name for this client.  This is not used by the server
 
260
            directly, but can be, and is by default, used by the
 
261
            checker.  See the <option>checker</option> option.
357
262
          </para>
358
263
        </listitem>
359
264
      </varlistentry>
396
301
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
397
302
        ></quote> will be replaced by the value of the attribute
398
303
        <varname>foo</varname> of the internal
399
 
        <quote><classname>Client</classname></quote> object in the
400
 
        Mandos server.  The currently allowed values for
401
 
        <replaceable>foo</replaceable> are:
402
 
        <quote><literal>approval_delay</literal></quote>,
403
 
        <quote><literal>approval_duration</literal></quote>,
404
 
        <quote><literal>created</literal></quote>,
405
 
        <quote><literal>enabled</literal></quote>,
406
 
        <quote><literal>fingerprint</literal></quote>,
407
 
        <quote><literal>host</literal></quote>,
408
 
        <quote><literal>interval</literal></quote>,
409
 
        <quote><literal>last_approval_request</literal></quote>,
410
 
        <quote><literal>last_checked_ok</literal></quote>,
411
 
        <quote><literal>last_enabled</literal></quote>,
412
 
        <quote><literal>name</literal></quote>,
413
 
        <quote><literal>timeout</literal></quote>, and, if using
414
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
415
 
        See the source code for details.  <emphasis role="strong"
416
 
        >Currently, <emphasis>none</emphasis> of these attributes
417
 
        except <quote><literal>host</literal></quote> are guaranteed
418
 
        to be valid in future versions.</emphasis> Therefore, please
419
 
        let the authors know of any attributes that are useful so they
420
 
        may be preserved to any new versions of this software.
 
304
        <quote><classname>Client</classname></quote> object.  See the
 
305
        source code for details, and let the authors know of any
 
306
        attributes that are useful so they may be preserved to any new
 
307
        versions of this software.
421
308
      </para>
422
309
      <para>
423
310
        Note that this means that, in order to include an actual
429
316
        mode is needed to expose an error of this kind.
430
317
      </para>
431
318
    </refsect2>
432
 
    
 
319
 
433
320
  </refsect1>
434
321
  
435
322
  <refsect1 id="files">
458
345
    <informalexample>
459
346
      <programlisting>
460
347
[DEFAULT]
461
 
timeout = 5m
462
 
interval = 2m
463
 
checker = fping -q -- %%(host)s
 
348
timeout = 1h
 
349
interval = 5m
 
350
checker = fping -q -- %(host)s
464
351
 
465
352
# Client "foo"
466
353
[foo]
489
376
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
490
377
secfile = /etc/mandos/bar-secret
491
378
timeout = 15m
492
 
approved_by_default = False
493
 
approval_delay = 30s
 
379
 
494
380
      </programlisting>
495
381
    </informalexample>
496
382
  </refsect1>
498
384
  <refsect1 id="see_also">
499
385
    <title>SEE ALSO</title>
500
386
    <para>
501
 
      <citerefentry><refentrytitle>intro</refentrytitle>
502
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
503
387
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
504
388
      <manvolnum>8</manvolnum></citerefentry>,
505
389
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>