/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-24 23:33:02 UTC
  • mfrom: (24.1.65 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080824233302-kfu4g2pkozg7xrmz
* plugin-runner.c (process): Set "completed" and "status" as volatile.
  (handle_sigchld): Bug fix: reset proc to process_list every time.

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 "2011-02-27">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
33
      <holder>Teddy Hogeborn</holder>
40
34
      <holder>Björn Påhlsson</holder>
41
35
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
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>
43
59
  </refentryinfo>
44
 
  
 
60
 
45
61
  <refmeta>
46
62
    <refentrytitle>&CONFNAME;</refentrytitle>
47
63
    <manvolnum>5</manvolnum>
53
69
      Configuration file for the Mandos server
54
70
    </refpurpose>
55
71
  </refnamediv>
56
 
  
 
72
 
57
73
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
59
77
  </refsynopsisdiv>
60
 
  
 
78
 
61
79
  <refsect1 id="description">
62
80
    <title>DESCRIPTION</title>
63
81
    <para>
64
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
65
83
      ><refentrytitle>mandos</refentrytitle>
66
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
 
      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.
 
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
 
85
      where each client that will be able to use the service needs to
 
86
      be listed.  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
92
111
  <refsect1 id="options">
93
112
    <title>OPTIONS</title>
94
113
    <para>
95
 
      <emphasis>Note:</emphasis> all option values are subject to
96
 
      start time expansion, see <xref linkend="expansion"/>.
97
 
    </para>
98
 
    <para>
99
 
      Unknown options are ignored.  The used options are as follows:
100
 
    </para>
101
 
    
 
114
      The possible options are:
 
115
    </para>
 
116
 
102
117
    <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>
 
118
 
 
119
      <varlistentry>
 
120
        <term><literal><varname>timeout</varname></literal></term>
 
121
        <listitem>
 
122
          <synopsis><literal>timeout = </literal><replaceable
 
123
          >TIME</replaceable>
 
124
          </synopsis>
 
125
          <para>
 
126
            The timeout is how long the server will wait for a
 
127
            successful checker run until a client is considered
 
128
            invalid - that is, ineligible to get the data this server
 
129
            holds.  By default Mandos will use 1 hour.
 
130
          </para>
 
131
          <para>
 
132
            The <replaceable>TIME</replaceable> is specified as a
 
133
            space-separated number of values, each of which is a
 
134
            number and a one-character suffix.  The suffix must be one
 
135
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
136
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
137
            minutes, hours, and weeks, respectively.  The values are
 
138
            added together to give the total time value, so all of
 
139
            <quote><literal>330s</literal></quote>,
 
140
            <quote><literal>110s 110s 110s</literal></quote>, and
 
141
            <quote><literal>5m 30s</literal></quote> will give a value
 
142
            of five minutes and thirty seconds.
 
143
          </para>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
 
 
147
      <varlistentry>
 
148
        <term><literal><varname>interval</varname></literal></term>
 
149
        <listitem>
 
150
          <synopsis><literal>interval = </literal><replaceable
 
151
          >TIME</replaceable>
 
152
          </synopsis>
 
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
 
 
169
      <varlistentry>
 
170
        <term><literal>checker</literal></term>
 
171
        <listitem>
 
172
          <synopsis><literal>checker = </literal><replaceable
 
173
          >COMMAND</replaceable>
 
174
          </synopsis>
163
175
          <para>
164
176
            This option allows you to override the default shell
165
177
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            run using <quote><command><filename>/bin/sh</filename>
170
 
            <option>-c</option></command></quote>, so
171
 
            <varname>PATH</varname> will be searched.  The default
172
 
            value for the checker command is <quote><literal
173
 
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
178
            still up.  The output of the command will be ignored, only
 
179
            the exit code is checked.  The command will be run using
 
180
            <quote><command><filename>/bin/sh</filename>
 
181
            <option>-c</option></command></quote>.  The default
 
182
            command is <quote><literal><command>fping</command>
 
183
            <option>-q</option> <option>--</option>
 
184
            %(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>fingerprint<literal> = </literal
186
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
195
        <term><literal>fingerprint</literal></term>
187
196
        <listitem>
188
 
          <para>
189
 
            This option is <emphasis>required</emphasis>.
190
 
          </para>
 
197
          <synopsis><literal>fingerprint = </literal><replaceable
 
198
          >HEXSTRING</replaceable>
 
199
          </synopsis>
191
200
          <para>
192
201
            This option sets the OpenPGP fingerprint that identifies
193
202
            the public key that clients authenticate themselves with
198
207
      </varlistentry>
199
208
      
200
209
      <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 5 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>
 
210
        <term><literal>secret</literal></term>
 
211
        <listitem>
 
212
          <synopsis><literal>secret = </literal><replaceable
 
213
          >BASE64_ENCODED_DATA</replaceable>
 
214
          </synopsis>
273
215
          <para>
274
216
            If present, this option must be set to a string of
275
217
            base64-encoded binary data.  It will be decoded and sent
276
218
            to the client matching the above
277
219
            <option>fingerprint</option>.  This should, of course, be
278
220
            OpenPGP encrypted data, decryptable only by the client.
279
 
            The program <citerefentry><refentrytitle><command
280
 
            >mandos-keygen</command></refentrytitle><manvolnum
281
 
            >8</manvolnum></citerefentry> can, using its
282
 
            <option>--password</option> option, be used to generate
283
 
            this, if desired.
284
 
          </para>
285
 
          <para>
286
 
            Note: this value of this option will probably be very
287
 
            long.  A useful feature to avoid having unreadably-long
288
 
            lines is that a line beginning with white space adds to
289
 
            the value of the previous line, RFC 822-style.
290
 
          </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 1 hour.
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>
 
221
<!--        The program <citerefentry><refentrytitle><command -->
 
222
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
 
223
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
 
224
<!--        if desired. -->
 
225
          </para>
 
226
          <para>
 
227
            Note: this value of this option will probably run over
 
228
            many lines, and will then have to use the fact that a line
 
229
            beginning with white space adds to the value of the
 
230
            previous line, RFC 822-style.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>secfile</literal></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Base 64 encoded OpenPGP encrypted password encrypted by
 
240
            the clients openpgp certificate as a binary file.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
 
 
245
      <varlistentry>
 
246
        <term><literal>host</literal></term>
 
247
        <listitem>
 
248
          <para>
 
249
            Host name that can be used in for checking that the client is up.
 
250
          </para>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
 
 
254
      <varlistentry>
 
255
        <term><literal>checker</literal></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Shell command that the server will use to check up if a
 
259
            client is still up.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>      
 
263
 
 
264
      <varlistentry>
 
265
        <term><literal>timeout</literal></term>
 
266
        <listitem>
 
267
          <para>
 
268
            Duration that a client can be down whitout be removed from
 
269
            the client list.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry> 
322
273
      
323
274
    </variablelist>
324
 
  </refsect1>
 
275
  </refsect1>  
325
276
  
326
277
  <refsect1 id="expansion">
327
278
    <title>EXPANSION</title>
358
309
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
359
310
        ></quote> will be replaced by the value of the attribute
360
311
        <varname>foo</varname> of the internal
361
 
        <quote><classname>Client</classname></quote> object in the
362
 
        Mandos server.  The currently allowed values for
363
 
        <replaceable>foo</replaceable> are:
364
 
        <quote><literal>approval_delay</literal></quote>,
365
 
        <quote><literal>approval_duration</literal></quote>,
366
 
        <quote><literal>created</literal></quote>,
367
 
        <quote><literal>enabled</literal></quote>,
368
 
        <quote><literal>fingerprint</literal></quote>,
369
 
        <quote><literal>host</literal></quote>,
370
 
        <quote><literal>interval</literal></quote>,
371
 
        <quote><literal>last_approval_request</literal></quote>,
372
 
        <quote><literal>last_checked_ok</literal></quote>,
373
 
        <quote><literal>last_enabled</literal></quote>,
374
 
        <quote><literal>name</literal></quote>,
375
 
        <quote><literal>timeout</literal></quote>, and, if using
376
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
377
 
        See the source code for details.  <emphasis role="strong"
378
 
        >Currently, <emphasis>none</emphasis> of these attributes
379
 
        except <quote><literal>host</literal></quote> are guaranteed
380
 
        to be valid in future versions.</emphasis> Therefore, please
381
 
        let the authors know of any attributes that are useful so they
382
 
        may be preserved to any new versions of this software.
 
312
        <quote><classname>Client</classname></quote> object.  See the
 
313
        source code for details, and let the authors know of any
 
314
        attributes that are useful so they may be preserved to any new
 
315
        versions of this software.
383
316
      </para>
384
317
      <para>
385
318
        Note that this means that, in order to include an actual
386
319
        percent character (<quote>%</quote>) in a
387
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
320
        <varname>checker</varname> options, <emphasis>four</emphasis>
388
321
        percent characters in a row (<quote>%%%%</quote>) must be
389
322
        entered.  Also, a bad format here will lead to an immediate
390
323
        but <emphasis>silent</emphasis> run-time fatal exit; debug
391
 
        mode is needed to expose an error of this kind.
 
324
        mode is needed to track down an error of this kind.
392
325
      </para>
393
326
    </refsect2>
394
 
    
395
 
  </refsect1>
 
327
 
 
328
  </refsect1>  
396
329
  
397
330
  <refsect1 id="files">
398
331
    <title>FILES</title>
422
355
[DEFAULT]
423
356
timeout = 1h
424
357
interval = 5m
425
 
checker = fping -q -- %%(host)s
 
358
checker = fping -q -- %(host)s
426
359
 
427
360
# Client "foo"
428
361
[foo]
443
376
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
444
377
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
445
378
        QlnHIvPzEArRQLo=
 
379
        =iHhv
446
380
host = foo.example.org
447
 
interval = 1m
 
381
interval = 5m
448
382
 
449
383
# Client "bar"
450
384
[bar]
451
385
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
452
 
secfile = /etc/mandos/bar-secret
453
 
timeout = 15m
454
 
approved_by_default = False
455
 
approval_delay = 30s
 
386
secfile = /etc/mandos/bar-secret.txt.asc
 
387
 
456
388
      </programlisting>
457
389
    </informalexample>
458
 
  </refsect1>
459
 
  
460
 
  <refsect1 id="see_also">
461
 
    <title>SEE ALSO</title>
462
 
    <para>
463
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
 
      <manvolnum>8</manvolnum></citerefentry>,
465
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
466
 
      <manvolnum>5</manvolnum></citerefentry>,
467
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
468
 
      <manvolnum>8</manvolnum></citerefentry>
469
 
    </para>
470
 
  </refsect1>
 
390
  </refsect1>  
 
391
 
471
392
</refentry>
472
 
<!-- Local Variables: -->
473
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
474
 
<!-- time-stamp-end: "[\"']>" -->
475
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
476
 
<!-- End: -->