/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-15 21:09:25 UTC
  • mfrom: (24.1.52 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080815210925-32718zu3nrlotix5
Merge.

* plugin-runner.c (ARGFILE): Renamed to "plugin-runner.conf".

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
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY CONFNAME "mandos-clients.conf">
6
8
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-12">
8
9
]>
9
10
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
11
12
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
 
13
    <title>&CONFNAME;</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>&CONFNAME;</productname>
15
16
    <productnumber>&VERSION;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
17
17
    <authorgroup>
18
18
      <author>
19
19
        <firstname>Björn</firstname>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
 
      <holder>Teddy Hogeborn</holder>
36
 
      <holder>Björn Påhlsson</holder>
 
35
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
39
60
  </refentryinfo>
40
 
  
 
61
 
41
62
  <refmeta>
42
63
    <refentrytitle>&CONFNAME;</refentrytitle>
43
64
    <manvolnum>5</manvolnum>
46
67
  <refnamediv>
47
68
    <refname><filename>&CONFNAME;</filename></refname>
48
69
    <refpurpose>
49
 
      Configuration file for the Mandos server
 
70
      Configuration file for Mandos clients
50
71
    </refpurpose>
51
72
  </refnamediv>
52
 
  
 
73
 
53
74
  <refsynopsisdiv>
54
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
55
78
  </refsynopsisdiv>
56
 
  
 
79
 
57
80
  <refsect1 id="description">
58
81
    <title>DESCRIPTION</title>
59
82
    <para>
60
 
      The file &CONFPATH; is a configuration file for <citerefentry
61
 
      ><refentrytitle>mandos</refentrytitle>
62
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
 
      The file needs to list all clients that should be able to use
64
 
      the service.  All clients listed will be regarded as valid, even
65
 
      if a client was declared invalid in a previous run of the
66
 
      server.
67
 
    </para>
68
 
    <para>
69
 
      The format starts with a <literal>[<replaceable>section
70
 
      header</replaceable>]</literal> which is either
71
 
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
72
 
      name</replaceable>]</literal>.  The <replaceable>client
73
 
      name</replaceable> can be anything, and is not tied to a host
74
 
      name.  Following the section header is any number of
75
 
      <quote><varname><replaceable>option</replaceable
76
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
77
 
      with continuations in the style of RFC 822.  <quote><varname
78
 
      ><replaceable>option</replaceable></varname>: <replaceable
79
 
      >value</replaceable></quote> is also accepted.  Note that
80
 
      leading whitespace is removed from values.  Values can contain
81
 
      format strings which refer to other values in the same section,
82
 
      or values in the <quote>DEFAULT</quote> section (see <xref
83
 
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
84
 
      or <quote>;</quote> are ignored and may be used to provide
85
 
      comments.
 
83
      The file &CONFPATH; is the configuration file for mandos where
 
84
      each client that will be abel to use the service need to be
 
85
      specified. The configuration file is looked on at the startup of
 
86
      the service, so to reenable timedout clients one need to only
 
87
      restart the server. The format starts with a section under []
 
88
      which is eather <literal>[DEFAULT]</literal> or a client
 
89
      name. Values is set through the use of VAR = VALUE pair. Values
 
90
      may not be empty.
86
91
    </para>
87
92
  </refsect1>
88
 
  
89
 
  <refsect1 id="options">
90
 
    <title>OPTIONS</title>
91
 
    <para>
92
 
      <emphasis>Note:</emphasis> all option values are subject to
93
 
      start time expansion, see <xref linkend="expansion"/>.
94
 
    </para>
95
 
    <para>
96
 
      Unknown options are ignored.  The used options are as follows:
97
 
    </para>
98
 
    
 
93
 
 
94
  <refsect1 id="default">
 
95
    <title>DEFAULTS</title>
 
96
    <para>
 
97
      The paramters for <literal>[DEFAULT]</literal> are:
 
98
    </para>
 
99
 
99
100
    <variablelist>
100
101
      
101
102
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
104
 
        <listitem>
105
 
          <para>
106
 
            This option is <emphasis>optional</emphasis>.
107
 
          </para>
108
 
          <para>
109
 
            The timeout is how long the server will wait for a
110
 
            successful checker run until a client is considered
111
 
            invalid - that is, ineligible to get the data this server
112
 
            holds.  By default Mandos will use 1 hour.
113
 
          </para>
114
 
          <para>
115
 
            The <replaceable>TIME</replaceable> is specified as a
116
 
            space-separated number of values, each of which is a
117
 
            number and a one-character suffix.  The suffix must be one
118
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
120
 
            minutes, hours, and weeks, respectively.  The values are
121
 
            added together to give the total time value, so all of
122
 
            <quote><literal>330s</literal></quote>,
123
 
            <quote><literal>110s 110s 110s</literal></quote>, and
124
 
            <quote><literal>5m 30s</literal></quote> will give a value
125
 
            of five minutes and thirty seconds.
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>
129
 
      
130
 
      <varlistentry>
131
 
        <term><option>interval<literal> = </literal><replaceable
132
 
        >TIME</replaceable></option></term>
133
 
        <listitem>
134
 
          <para>
135
 
            This option is <emphasis>optional</emphasis>.
136
 
          </para>
137
 
          <para>
138
 
            How often to run the checker to confirm that a client is
139
 
            still up.  <emphasis>Note:</emphasis> a new checker will
140
 
            not be started if an old one is still running.  The server
141
 
            will wait for a checker to complete until the above
142
 
            <quote><varname>timeout</varname></quote> occurs, at which
143
 
            time the client will be marked invalid, and any running
144
 
            checker killed.  The default interval is 5 minutes.
145
 
          </para>
146
 
          <para>
147
 
            The format of <replaceable>TIME</replaceable> is the same
148
 
            as for <varname>timeout</varname> above.
149
 
          </para>
150
 
        </listitem>
151
 
      </varlistentry>
152
 
      
153
 
      <varlistentry>
154
 
        <term><option>checker<literal> = </literal><replaceable
155
 
        >COMMAND</replaceable></option></term>
156
 
        <listitem>
157
 
          <para>
158
 
            This option is <emphasis>optional</emphasis>.
159
 
          </para>
 
103
        <term><literal>timeout</literal></term>
 
104
        <listitem>
 
105
          <para>
 
106
            This option allows you to override the default timeout
 
107
            that clients will get. By default mandos will use 1hr.
 
108
          </para>
 
109
        </listitem>
 
110
      </varlistentry>
 
111
 
 
112
      <varlistentry>
 
113
        <term><literal>interval</literal></term>
 
114
        <listitem>
 
115
          <para>
 
116
            This option allows you to override the default interval
 
117
            used between checkups for disconnected clients. By default
 
118
            mandos will use 5m.
 
119
          </para>
 
120
        </listitem>
 
121
      </varlistentry>      
 
122
 
 
123
      <varlistentry>
 
124
        <term><literal>checker</literal></term>
 
125
        <listitem>
160
126
          <para>
161
127
            This option allows you to override the default shell
162
 
            command that the server will use to check if the client is
163
 
            still up.  Any output of the command will be ignored, only
164
 
            the exit code is checked:  If the exit code of the command
165
 
            is zero, the client is considered up.  The command will be
166
 
            run using <quote><command><filename>/bin/sh</filename>
167
 
            <option>-c</option></command></quote>, so
168
 
            <varname>PATH</varname> will be searched.  The default
169
 
            value for the checker command is <quote><literal
170
 
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
172
 
          </para>
173
 
          <para>
174
 
            In addition to normal start time expansion, this option
175
 
            will also be subject to runtime expansion; see <xref
176
 
            linkend="expansion"/>.
177
 
          </para>
178
 
        </listitem>
179
 
      </varlistentry>
180
 
      
181
 
      <varlistentry>
182
 
        <term><option>fingerprint<literal> = </literal
183
 
        ><replaceable>HEXSTRING</replaceable></option></term>
184
 
        <listitem>
185
 
          <para>
186
 
            This option is <emphasis>required</emphasis>.
187
 
          </para>
188
 
          <para>
189
 
            This option sets the OpenPGP fingerprint that identifies
190
 
            the public key that clients authenticate themselves with
191
 
            through TLS.  The string needs to be in hexidecimal form,
192
 
            but spaces or upper/lower case are not significant.
193
 
          </para>
194
 
        </listitem>
195
 
      </varlistentry>
196
 
      
197
 
      <varlistentry>
198
 
        <term><option>secret<literal> = </literal><replaceable
199
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
200
 
        <listitem>
201
 
          <para>
202
 
            If this option is not specified, the <option
203
 
            >secfile</option> option is <emphasis>required</emphasis>
204
 
            to be present.
205
 
          </para>
206
 
          <para>
207
 
            If present, this option must be set to a string of
208
 
            base64-encoded binary data.  It will be decoded and sent
209
 
            to the client matching the above
210
 
            <option>fingerprint</option>.  This should, of course, be
211
 
            OpenPGP encrypted data, decryptable only by the client.
212
 
            The program <citerefentry><refentrytitle><command
213
 
            >mandos-keygen</command></refentrytitle><manvolnum
214
 
            >8</manvolnum></citerefentry> can, using its
215
 
            <option>--password</option> option, be used to generate
216
 
            this, if desired.
217
 
          </para>
218
 
          <para>
219
 
            Note: this value of this option will probably be very
220
 
            long.  A useful feature to avoid having unreadably-long
221
 
            lines is that a line beginning with white space adds to
222
 
            the value of the previous line, RFC 822-style.
223
 
          </para>
224
 
        </listitem>
225
 
      </varlistentry>
226
 
      
227
 
      <varlistentry>
228
 
        <term><option>secfile<literal> = </literal><replaceable
229
 
        >FILENAME</replaceable></option></term>
230
 
        <listitem>
231
 
          <para>
232
 
            This option is only used if <option>secret</option> is not
233
 
            specified, in which case this option is
234
 
            <emphasis>required</emphasis>.
235
 
          </para>
236
 
          <para>
237
 
            Similar to the <option>secret</option>, except the secret
238
 
            data is in an external file.  The contents of the file
239
 
            should <emphasis>not</emphasis> be base64-encoded, but
240
 
            will be sent to clients verbatim.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
      
245
 
      <varlistentry>
246
 
        <term><option><literal>host = </literal><replaceable
247
 
        >STRING</replaceable></option></term>
248
 
        <listitem>
249
 
          <para>
250
 
            This option is <emphasis>optional</emphasis>, but highly
251
 
            <emphasis>recommended</emphasis> unless the
252
 
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
254
 
          </para>
255
 
          <para>
256
 
            Host name for this client.  This is not used by the server
257
 
            directly, but can be, and is by default, used by the
258
 
            checker.  See the <option>checker</option> option.
259
 
          </para>
260
 
        </listitem>
261
 
      </varlistentry>
262
 
      
263
 
    </variablelist>
264
 
  </refsect1>
265
 
  
266
 
  <refsect1 id="expansion">
267
 
    <title>EXPANSION</title>
268
 
    <para>
269
 
      There are two forms of expansion: Start time expansion and
270
 
      runtime expansion.
271
 
    </para>
272
 
    <refsect2 id="start_time_expansion">
273
 
      <title>START TIME EXPANSION</title>
274
 
      <para>
275
 
        Any string in an option value of the form
276
 
        <quote><literal>%(<replaceable>foo</replaceable>)s</literal
277
 
        ></quote> will be replaced by the value of the option
278
 
        <varname>foo</varname> either in the same section, or, if it
279
 
        does not exist there, the <literal>[DEFAULT]</literal>
280
 
        section.  This is done at start time, when the configuration
281
 
        file is read.
282
 
      </para>
283
 
      <para>
284
 
        Note that this means that, in order to include an actual
285
 
        percent character (<quote>%</quote>) in an option value, two
286
 
        percent characters in a row (<quote>%%</quote>) must be
287
 
        entered.
288
 
      </para>
289
 
    </refsect2>
290
 
    <refsect2 id="runtime_expansion">
291
 
      <title>RUNTIME EXPANSION</title>
292
 
      <para>
293
 
        This is currently only done for the <varname>checker</varname>
294
 
        option.
295
 
      </para>
296
 
      <para>
297
 
        Any string in an option value of the form
298
 
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
 
        ></quote> will be replaced by the value of the attribute
300
 
        <varname>foo</varname> of the internal
301
 
        <quote><classname>Client</classname></quote> object.  See the
302
 
        source code for details, and let the authors know of any
303
 
        attributes that are useful so they may be preserved to any new
304
 
        versions of this software.
305
 
      </para>
306
 
      <para>
307
 
        Note that this means that, in order to include an actual
308
 
        percent character (<quote>%</quote>) in a
309
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
310
 
        percent characters in a row (<quote>%%%%</quote>) must be
311
 
        entered.  Also, a bad format here will lead to an immediate
312
 
        but <emphasis>silent</emphasis> run-time fatal exit; debug
313
 
        mode is needed to expose an error of this kind.
314
 
      </para>
315
 
    </refsect2>
316
 
    
317
 
  </refsect1>
318
 
  
319
 
  <refsect1 id="files">
320
 
    <title>FILES</title>
321
 
    <para>
322
 
      The file described here is &CONFPATH;
323
 
    </para>
324
 
  </refsect1>
325
 
  
326
 
  <refsect1 id="bugs">
327
 
    <title>BUGS</title>
328
 
    <para>
329
 
      The format for specifying times for <varname>timeout</varname>
330
 
      and <varname>interval</varname> is not very good.
331
 
    </para>
332
 
    <para>
333
 
      The difference between
334
 
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
335
 
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
336
 
      obscure.
337
 
    </para>
338
 
  </refsect1>
339
 
  
340
 
  <refsect1 id="example">
341
 
    <title>EXAMPLE</title>
 
128
            command that the server will use to check up if the client
 
129
            is still up. By default mandos will "fping -q -- %%(host)s"
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
    </variablelist>
 
135
  </refsect1>
 
136
 
 
137
  <refsect1 id="clients">
 
138
    <title>CLIENTS</title>
 
139
    <para>
 
140
      The paramters for clients are:
 
141
    </para>
 
142
 
 
143
    <variablelist>
 
144
      
 
145
      <varlistentry>
 
146
        <term><literal>fingerprint</literal></term>
 
147
        <listitem>
 
148
          <para>
 
149
            This option sets the openpgp fingerprint that identifies
 
150
            the public certificate that clients authenticates themself
 
151
            through gnutls. The string need to be in hex-decimal form.
 
152
          </para>
 
153
        </listitem>
 
154
      </varlistentry>
 
155
      
 
156
      <varlistentry>
 
157
        <term><literal>secret</literal></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Base 64 encoded OpenPGP encrypted password encrypted by
 
161
            the clients openpgp certificate.
 
162
          </para>
 
163
        </listitem>
 
164
      </varlistentry>
 
165
 
 
166
      <varlistentry>
 
167
        <term><literal>secfile</literal></term>
 
168
        <listitem>
 
169
          <para>
 
170
            Base 64 encoded OpenPGP encrypted password encrypted by
 
171
            the clients openpgp certificate as a binary file.
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
 
 
176
      <varlistentry>
 
177
        <term><literal>host</literal></term>
 
178
        <listitem>
 
179
          <para>
 
180
            Host name that can be used in for checking that the client is up.
 
181
          </para>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
 
 
185
      <varlistentry>
 
186
        <term><literal>checker</literal></term>
 
187
        <listitem>
 
188
          <para>
 
189
            Shell command that the server will use to check up if a
 
190
            client is still up.
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>      
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>timeout</literal></term>
 
197
        <listitem>
 
198
          <para>
 
199
            Duration that a client can be down whitout be removed from
 
200
            the client list.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry> 
 
204
      
 
205
    </variablelist>
 
206
  </refsect1>  
 
207
 
 
208
  <refsect1 id="examples">
 
209
    <title>EXAMPLES</title>
342
210
    <informalexample>
343
211
      <programlisting>
344
212
[DEFAULT]
345
213
timeout = 1h
346
214
interval = 5m
347
 
checker = fping -q -- %(host)s
 
215
checker = fping -q -- %%(host)s
348
216
 
349
 
# Client "foo"
350
 
[foo]
 
217
[example_client]
351
218
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
 
219
 
352
220
secret =
353
221
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
354
222
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
365
233
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
366
234
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
367
235
        QlnHIvPzEArRQLo=
368
 
host = foo.example.org
369
 
interval = 1m
 
236
        =iHhv
370
237
 
371
 
# Client "bar"
372
 
[bar]
373
 
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
 
secfile = /etc/mandos/bar-secret
375
 
timeout = 15m
 
238
host = localhost
 
239
interval = 5m
376
240
      </programlisting>
377
241
    </informalexample>
378
 
  </refsect1>
 
242
  </refsect1>  
379
243
  
380
 
  <refsect1 id="see_also">
381
 
    <title>SEE ALSO</title>
 
244
  <refsect1 id="files">
 
245
    <title>FILES</title>
382
246
    <para>
383
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
384
 
      <manvolnum>8</manvolnum></citerefentry>,
385
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
386
 
      <manvolnum>5</manvolnum></citerefentry>,
387
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
388
 
      <manvolnum>8</manvolnum></citerefentry>
 
247
      The file described here is &CONFPATH;
389
248
    </para>
390
249
  </refsect1>
391
250
</refentry>
392
 
<!-- Local Variables: -->
393
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
394
 
<!-- time-stamp-end: "[\"']>" -->
395
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
396
 
<!-- End: -->