/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:
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 "2009-02-15">
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
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
 
    <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>
41
61
  </refentryinfo>
42
 
  
 
62
 
43
63
  <refmeta>
44
64
    <refentrytitle>&CONFNAME;</refentrytitle>
45
65
    <manvolnum>5</manvolnum>
51
71
      Configuration file for the Mandos server
52
72
    </refpurpose>
53
73
  </refnamediv>
54
 
  
 
74
 
55
75
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
57
79
  </refsynopsisdiv>
58
 
  
 
80
 
59
81
  <refsect1 id="description">
60
82
    <title>DESCRIPTION</title>
61
83
    <para>
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
 
      
 
124
 
103
125
      <varlistentry>
104
 
        <term><option>timeout<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
 
126
        <term><literal><varname>timeout</varname></literal></term>
106
127
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
 
128
          <synopsis><literal>timeout = </literal><replaceable
 
129
          >TIME</replaceable>
 
130
          </synopsis>
110
131
          <para>
111
132
            The timeout is how long the server will wait for a
112
133
            successful checker run until a client is considered
128
149
          </para>
129
150
        </listitem>
130
151
      </varlistentry>
131
 
      
 
152
 
132
153
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
 
154
        <term><literal><varname>interval</varname></literal></term>
135
155
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
 
156
          <synopsis><literal>interval = </literal><replaceable
 
157
          >TIME</replaceable>
 
158
          </synopsis>
139
159
          <para>
140
160
            How often to run the checker to confirm that a client is
141
161
            still up.  <emphasis>Note:</emphasis> a new checker will
150
170
            as for <varname>timeout</varname> above.
151
171
          </para>
152
172
        </listitem>
153
 
      </varlistentry>
154
 
      
 
173
      </varlistentry>      
 
174
 
155
175
      <varlistentry>
156
 
        <term><option>checker<literal> = </literal><replaceable
157
 
        >COMMAND</replaceable></option></term>
 
176
        <term><literal>checker</literal></term>
158
177
        <listitem>
159
 
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </para>
 
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>secret<literal> = </literal><replaceable
201
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
218
        <term><literal>secret</literal></term>
202
219
        <listitem>
203
 
          <para>
204
 
            If this option is not specified, the <option
205
 
            >secfile</option> option is <emphasis>required</emphasis>
206
 
            to be present.
207
 
          </para>
 
220
          <synopsis><literal>secret = </literal><replaceable
 
221
          >BASE64_ENCODED_DATA</replaceable>
 
222
          </synopsis>
208
223
          <para>
209
224
            If present, this option must be set to a string of
210
225
            base64-encoded binary data.  It will be decoded and sent
223
238
            lines is that a line beginning with white space adds to
224
239
            the value of the previous line, RFC 822-style.
225
240
          </para>
226
 
        </listitem>
227
 
      </varlistentry>
228
 
      
229
 
      <varlistentry>
230
 
        <term><option>secfile<literal> = </literal><replaceable
231
 
        >FILENAME</replaceable></option></term>
232
 
        <listitem>
233
 
          <para>
234
 
            This option is only used if <option>secret</option> is not
235
 
            specified, in which case this option is
236
 
            <emphasis>required</emphasis>.
237
 
          </para>
238
 
          <para>
239
 
            Similar to the <option>secret</option>, except the secret
240
 
            data is in an external file.  The contents of the file
241
 
            should <emphasis>not</emphasis> be base64-encoded, but
242
 
            will be sent to clients verbatim.
243
 
          </para>
244
 
          <para>
245
 
            File names of the form <filename>~user/foo/bar</filename>
246
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
 
            are supported.
248
 
          </para>
249
 
        </listitem>
250
 
      </varlistentry>
251
 
      
252
 
      <varlistentry>
253
 
        <term><option><literal>host = </literal><replaceable
254
 
        >STRING</replaceable></option></term>
255
 
        <listitem>
256
 
          <para>
257
 
            This option is <emphasis>optional</emphasis>, but highly
258
 
            <emphasis>recommended</emphasis> unless the
259
 
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%%(host)s</quote> in it.
261
 
          </para>
 
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>
262
274
          <para>
263
275
            Host name for this client.  This is not used by the server
264
276
            directly, but can be, and is by default, used by the
268
280
      </varlistentry>
269
281
      
270
282
    </variablelist>
271
 
  </refsect1>
 
283
  </refsect1>  
272
284
  
273
285
  <refsect1 id="expansion">
274
286
    <title>EXPANSION</title>
317
329
        percent characters in a row (<quote>%%%%</quote>) must be
318
330
        entered.  Also, a bad format here will lead to an immediate
319
331
        but <emphasis>silent</emphasis> run-time fatal exit; debug
320
 
        mode is needed to expose an error of this kind.
 
332
        mode is needed to track down an error of this kind.
321
333
      </para>
322
334
    </refsect2>
323
 
    
324
 
  </refsect1>
 
335
 
 
336
  </refsect1>  
325
337
  
326
338
  <refsect1 id="files">
327
339
    <title>FILES</title>
351
363
[DEFAULT]
352
364
timeout = 1h
353
365
interval = 5m
354
 
checker = fping -q -- %%(host)s
 
366
checker = fping -q -- %(host)s
355
367
 
356
368
# Client "foo"
357
369
[foo]
380
392
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
393
secfile = /etc/mandos/bar-secret
382
394
timeout = 15m
 
395
 
383
396
      </programlisting>
384
397
    </informalexample>
385
 
  </refsect1>
 
398
  </refsect1>  
386
399
  
387
400
  <refsect1 id="see_also">
388
401
    <title>SEE ALSO</title>
389
402
    <para>
390
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
 
      <manvolnum>8</manvolnum></citerefentry>,
392
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
 
      <manvolnum>5</manvolnum></citerefentry>,
394
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
395
 
      <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>
396
410
    </para>
397
411
  </refsect1>
398
412
</refentry>