/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
79
79
  <refsect1 id="description">
80
80
    <title>DESCRIPTION</title>
81
81
    <para>
82
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
83
83
      ><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
 
      The file needs to list all clients that should be able to use
86
 
      the service.  All clients listed will be regarded as valid, even
 
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
87
      if a client was declared invalid in a previous run of the
88
88
      server.
89
89
    </para>
90
90
    <para>
91
 
      The format starts with a <literal>[<replaceable>section
92
 
      header</replaceable>]</literal> which is either
 
91
      The format starts with a section under [] which is either
93
92
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
94
 
      name</replaceable>]</literal>.  The <replaceable>client
95
 
      name</replaceable> can be anything, and is not tied to a host
96
 
      name.  Following the section header is any number of
97
 
      <quote><varname><replaceable>option</replaceable
 
93
      name</replaceable>]</literal>.  Following the section is any
 
94
      number of <quote><varname><replaceable>option</replaceable
98
95
      ></varname>=<replaceable>value</replaceable></quote> entries,
99
96
      with continuations in the style of RFC 822.  <quote><varname
100
97
      ><replaceable>option</replaceable></varname>: <replaceable
101
98
      >value</replaceable></quote> is also accepted.  Note that
102
99
      leading whitespace is removed from values.  Values can contain
103
100
      format strings which refer to other values in the same section,
104
 
      or values in the <quote>DEFAULT</quote> section (see <xref
105
 
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
106
 
      or <quote>;</quote> are ignored and may be used to provide
107
 
      comments.
 
101
      or values in the <quote>DEFAULT</quote> section.  Lines
 
102
      beginning with <quote>#</quote> or <quote>;</quote> are ignored
 
103
      and may be used to provide comments.
108
104
    </para>
109
105
  </refsect1>
110
106
  
111
107
  <refsect1 id="options">
112
108
    <title>OPTIONS</title>
113
109
    <para>
114
 
      <emphasis>Note:</emphasis> all option values are subject to
115
 
      start time expansion, see <xref linkend="expansion"/>.
116
 
    </para>
117
 
    <para>
118
 
      Uknown options are ignored.  The used options are as follows:
 
110
      The possible options are:
119
111
    </para>
120
112
 
121
113
    <variablelist>
173
165
      <varlistentry>
174
166
        <term><literal>checker</literal></term>
175
167
        <listitem>
176
 
          <synopsis><literal>checker = </literal><replaceable
177
 
          >COMMAND</replaceable>
178
 
          </synopsis>
179
168
          <para>
180
169
            This option allows you to override the default shell
181
 
            command that the server will use to check if the client is
182
 
            still up.  Any output of the command will be ignored, only
183
 
            the exit code is checked:  If the exit code of the command
184
 
            is zero, the client is considered up.  The command will be
185
 
            run using <quote><command><filename>/bin/sh</filename>
186
 
            <option>-c</option></command></quote>, so
187
 
            <varname>PATH</varname> will be searched.  The default
188
 
            value for the checker command is <quote><literal
189
 
            ><command>fping</command> <option>-q</option> <option
190
 
            >--</option> %(host)s</literal></quote>.
191
 
          </para>
192
 
          <para>
193
 
            In addition to normal start time expansion, this option
194
 
            will also be subject to runtime expansion; see <xref
195
 
            linkend="expansion"/>.
 
170
            command that the server will use to check up if the client
 
171
            is still up. By default mandos will "fping -q -- %%(host)s"
196
172
          </para>
197
173
        </listitem>
198
174
      </varlistentry>
200
176
      <varlistentry>
201
177
        <term><literal>fingerprint</literal></term>
202
178
        <listitem>
203
 
          <synopsis><literal>fingerprint = </literal><replaceable
204
 
          >HEXSTRING</replaceable>
205
 
          </synopsis>
206
179
          <para>
207
 
            This option sets the OpenPGP fingerprint that identifies
208
 
            the public key that clients authenticate themselves with
209
 
            through TLS.  The string needs to be in hexidecimal form,
210
 
            but spaces or upper/lower case are not significant.
 
180
            This option sets the openpgp fingerprint that identifies
 
181
            the public certificate that clients authenticates themself
 
182
            through gnutls. The string need to be in hex-decimal form.
211
183
          </para>
212
184
        </listitem>
213
185
      </varlistentry>
215
187
      <varlistentry>
216
188
        <term><literal>secret</literal></term>
217
189
        <listitem>
218
 
          <synopsis><literal>secret = </literal><replaceable
219
 
          >BASE64_ENCODED_DATA</replaceable>
220
 
          </synopsis>
221
 
          <para>
222
 
            If present, this option must be set to a string of
223
 
            base64-encoded binary data.  It will be decoded and sent
224
 
            to the client matching the above
225
 
            <option>fingerprint</option>.  This should, of course, be
226
 
            OpenPGP encrypted data, decryptable only by the client.
227
 
            The program <citerefentry><refentrytitle><command
228
 
            >mandos-keygen</command></refentrytitle><manvolnum
229
 
            >8</manvolnum></citerefentry> can, using its
230
 
            <option>--password</option> option, be used to generate
231
 
            this, if desired.
232
 
          </para>
233
 
          <para>
234
 
            Note: this value of this option will probably be very
235
 
            long.  A useful feature to avoid having unreadably-long
236
 
            lines is that a line beginning with white space adds to
237
 
            the value of the previous line, RFC 822-style.
238
 
          </para>
239
 
          <para>
240
 
            If this option is not specified, the <option
241
 
            >secfile</option> option is used instead, but one of them
242
 
            <emphasis>must</emphasis> be present.
 
190
          <para>
 
191
            Base 64 encoded OpenPGP encrypted password encrypted by
 
192
            the clients openpgp certificate.
243
193
          </para>
244
194
        </listitem>
245
195
      </varlistentry>
247
197
      <varlistentry>
248
198
        <term><literal>secfile</literal></term>
249
199
        <listitem>
250
 
          <synopsis><literal>secfile = </literal><replaceable
251
 
          >FILENAME</replaceable>
252
 
          </synopsis>
253
 
          <para>
254
 
            The same as <option>secret</option>, but the secret data
255
 
            is in an external file.  The contents of the file should
256
 
            <emphasis>not</emphasis> be base64-encoded, but will be
257
 
            sent to clients verbatim.
258
 
          </para>
259
 
          <para>
260
 
            This option is only used, and <emphasis>must</emphasis> be
261
 
            present, if <option>secret</option> is not specified.
 
200
          <para>
 
201
            Base 64 encoded OpenPGP encrypted password encrypted by
 
202
            the clients openpgp certificate as a binary file.
262
203
          </para>
263
204
        </listitem>
264
205
      </varlistentry>
266
207
      <varlistentry>
267
208
        <term><literal>host</literal></term>
268
209
        <listitem>
269
 
          <synopsis><literal>host = </literal><replaceable
270
 
          >STRING</replaceable>
271
 
          </synopsis>
272
210
          <para>
273
 
            Host name for this client.  This is not used by the server
274
 
            directly, but can be, and is by default, used by the
275
 
            checker.  See the <option>checker</option> option.
 
211
            Host name that can be used in for checking that the client is up.
276
212
          </para>
277
213
        </listitem>
278
214
      </varlistentry>
 
215
 
 
216
      <varlistentry>
 
217
        <term><literal>checker</literal></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Shell command that the server will use to check up if a
 
221
            client is still up.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>      
 
225
 
 
226
      <varlistentry>
 
227
        <term><literal>timeout</literal></term>
 
228
        <listitem>
 
229
          <para>
 
230
            Duration that a client can be down whitout be removed from
 
231
            the client list.
 
232
          </para>
 
233
        </listitem>
 
234
      </varlistentry> 
279
235
      
280
236
    </variablelist>
281
237
  </refsect1>  
286
242
      There are two forms of expansion: Start time expansion and
287
243
      runtime expansion.
288
244
    </para>
289
 
    <refsect2 id="start_time_expansion">
 
245
    <refsect2>
290
246
      <title>START TIME EXPANSION</title>
291
247
      <para>
292
248
        Any string in an option value of the form
304
260
        entered.
305
261
      </para>
306
262
    </refsect2>
307
 
    <refsect2 id="runtime_expansion">
 
263
    <refsect2>
308
264
      <title>RUNTIME EXPANSION</title>
309
265
      <para>
310
266
        This is currently only done for the <varname>checker</varname>
323
279
      <para>
324
280
        Note that this means that, in order to include an actual
325
281
        percent character (<quote>%</quote>) in a
326
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
282
        <varname>checker</varname> options, <emphasis>four</emphasis>
327
283
        percent characters in a row (<quote>%%%%</quote>) must be
328
284
        entered.  Also, a bad format here will lead to an immediate
329
285
        but <emphasis>silent</emphasis> run-time fatal exit; debug
361
317
[DEFAULT]
362
318
timeout = 1h
363
319
interval = 5m
364
 
checker = fping -q -- %(host)s
 
320
checker = fping -q -- %%(host)s
365
321
 
366
322
# Client "foo"
367
323
[foo]
382
338
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
383
339
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
384
340
        QlnHIvPzEArRQLo=
 
341
        =iHhv
385
342
host = foo.example.org
386
 
interval = 1m
 
343
interval = 5m
387
344
 
388
345
# Client "bar"
389
346
[bar]
390
347
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
 
secfile = /etc/mandos/bar-secret
392
 
timeout = 15m
 
348
secfile = /etc/mandos/bar-secret.txt.asc
393
349
 
394
350
      </programlisting>
395
351
    </informalexample>
396
352
  </refsect1>  
397
 
  
398
 
  <refsect1 id="see_also">
399
 
    <title>SEE ALSO</title>
400
 
    <para>
401
 
      <citerefentry>
402
 
        <refentrytitle>mandos</refentrytitle>
403
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
404
 
        <refentrytitle>mandos-keygen</refentrytitle>
405
 
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
406
 
        <refentrytitle>mandos.conf</refentrytitle>
407
 
        <manvolnum>5</manvolnum></citerefentry>
408
 
    </para>
409
 
  </refsect1>
 
353
 
410
354
</refentry>