/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-10-01 15:29:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081001152901-fh30whl3m4vb7m24
* debian/changelog: New Debian revision.

* debian/mandos-client.lintian-overrides: Added comments.
* debian/mandos.lintian-overrides: - '' -

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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2008-09-30">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
35
36
      <holder>Teddy Hogeborn</holder>
36
37
      <holder>Björn Påhlsson</holder>
37
38
    </copyright>
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>
 
39
    <xi:include href="legalnotice.xml"/>
61
40
  </refentryinfo>
62
 
 
 
41
  
63
42
  <refmeta>
64
43
    <refentrytitle>&CONFNAME;</refentrytitle>
65
44
    <manvolnum>5</manvolnum>
71
50
      Configuration file for the Mandos server
72
51
    </refpurpose>
73
52
  </refnamediv>
74
 
 
 
53
  
75
54
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
55
    <synopsis>&CONFPATH;</synopsis>
79
56
  </refsynopsisdiv>
80
 
 
 
57
  
81
58
  <refsect1 id="description">
82
59
    <title>DESCRIPTION</title>
83
60
    <para>
117
94
      start time expansion, see <xref linkend="expansion"/>.
118
95
    </para>
119
96
    <para>
120
 
      Uknown options are ignored.  The used options are as follows:
 
97
      Unknown options are ignored.  The used options are as follows:
121
98
    </para>
122
 
 
 
99
    
123
100
    <variablelist>
124
 
 
 
101
      
125
102
      <varlistentry>
126
 
        <term><literal><varname>timeout</varname></literal></term>
 
103
        <term><option>timeout<literal> = </literal><replaceable
 
104
        >TIME</replaceable></option></term>
127
105
        <listitem>
128
 
          <synopsis><literal>timeout = </literal><replaceable
129
 
          >TIME</replaceable>
130
 
          </synopsis>
 
106
          <para>
 
107
            This option is <emphasis>optional</emphasis>.
 
108
          </para>
131
109
          <para>
132
110
            The timeout is how long the server will wait for a
133
111
            successful checker run until a client is considered
149
127
          </para>
150
128
        </listitem>
151
129
      </varlistentry>
152
 
 
 
130
      
153
131
      <varlistentry>
154
 
        <term><literal><varname>interval</varname></literal></term>
 
132
        <term><option>interval<literal> = </literal><replaceable
 
133
        >TIME</replaceable></option></term>
155
134
        <listitem>
156
 
          <synopsis><literal>interval = </literal><replaceable
157
 
          >TIME</replaceable>
158
 
          </synopsis>
 
135
          <para>
 
136
            This option is <emphasis>optional</emphasis>.
 
137
          </para>
159
138
          <para>
160
139
            How often to run the checker to confirm that a client is
161
140
            still up.  <emphasis>Note:</emphasis> a new checker will
170
149
            as for <varname>timeout</varname> above.
171
150
          </para>
172
151
        </listitem>
173
 
      </varlistentry>      
174
 
 
 
152
      </varlistentry>
 
153
      
175
154
      <varlistentry>
176
 
        <term><literal>checker</literal></term>
 
155
        <term><option>checker<literal> = </literal><replaceable
 
156
        >COMMAND</replaceable></option></term>
177
157
        <listitem>
178
 
          <synopsis><literal>checker = </literal><replaceable
179
 
          >COMMAND</replaceable>
180
 
          </synopsis>
 
158
          <para>
 
159
            This option is <emphasis>optional</emphasis>.
 
160
          </para>
181
161
          <para>
182
162
            This option allows you to override the default shell
183
163
            command that the server will use to check if the client is
200
180
      </varlistentry>
201
181
      
202
182
      <varlistentry>
203
 
        <term><literal>fingerprint</literal></term>
 
183
        <term><option>fingerprint<literal> = </literal
 
184
        ><replaceable>HEXSTRING</replaceable></option></term>
204
185
        <listitem>
205
 
          <synopsis><literal>fingerprint = </literal><replaceable
206
 
          >HEXSTRING</replaceable>
207
 
          </synopsis>
 
186
          <para>
 
187
            This option is <emphasis>required</emphasis>.
 
188
          </para>
208
189
          <para>
209
190
            This option sets the OpenPGP fingerprint that identifies
210
191
            the public key that clients authenticate themselves with
215
196
      </varlistentry>
216
197
      
217
198
      <varlistentry>
218
 
        <term><literal>secret</literal></term>
 
199
        <term><option>secret<literal> = </literal><replaceable
 
200
        >BASE64_ENCODED_DATA</replaceable></option></term>
219
201
        <listitem>
220
 
          <synopsis><literal>secret = </literal><replaceable
221
 
          >BASE64_ENCODED_DATA</replaceable>
222
 
          </synopsis>
 
202
          <para>
 
203
            If this option is not specified, the <option
 
204
            >secfile</option> option is <emphasis>required</emphasis>
 
205
            to be present.
 
206
          </para>
223
207
          <para>
224
208
            If present, this option must be set to a string of
225
209
            base64-encoded binary data.  It will be decoded and sent
238
222
            lines is that a line beginning with white space adds to
239
223
            the value of the previous line, RFC 822-style.
240
224
          </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>
 
225
        </listitem>
 
226
      </varlistentry>
 
227
      
 
228
      <varlistentry>
 
229
        <term><option>secfile<literal> = </literal><replaceable
 
230
        >FILENAME</replaceable></option></term>
 
231
        <listitem>
 
232
          <para>
 
233
            This option is only used if <option>secret</option> is not
 
234
            specified, in which case this option is
 
235
            <emphasis>required</emphasis>.
 
236
          </para>
 
237
          <para>
 
238
            Similar to the <option>secret</option>, except the secret
 
239
            data is in an external file.  The contents of the file
 
240
            should <emphasis>not</emphasis> be base64-encoded, but
 
241
            will be sent to clients verbatim.
 
242
          </para>
 
243
        </listitem>
 
244
      </varlistentry>
 
245
      
 
246
      <varlistentry>
 
247
        <term><option><literal>host = </literal><replaceable
 
248
        >STRING</replaceable></option></term>
 
249
        <listitem>
 
250
          <para>
 
251
            This option is <emphasis>optional</emphasis>, but highly
 
252
            <emphasis>recommended</emphasis> unless the
 
253
            <option>checker</option> option is modified to a
 
254
            non-standard value without <quote>%(host)s</quote> in it.
 
255
          </para>
274
256
          <para>
275
257
            Host name for this client.  This is not used by the server
276
258
            directly, but can be, and is by default, used by the
280
262
      </varlistentry>
281
263
      
282
264
    </variablelist>
283
 
  </refsect1>  
 
265
  </refsect1>
284
266
  
285
267
  <refsect1 id="expansion">
286
268
    <title>EXPANSION</title>
329
311
        percent characters in a row (<quote>%%%%</quote>) must be
330
312
        entered.  Also, a bad format here will lead to an immediate
331
313
        but <emphasis>silent</emphasis> run-time fatal exit; debug
332
 
        mode is needed to track down an error of this kind.
 
314
        mode is needed to expose an error of this kind.
333
315
      </para>
334
316
    </refsect2>
335
 
 
336
 
  </refsect1>  
 
317
    
 
318
  </refsect1>
337
319
  
338
320
  <refsect1 id="files">
339
321
    <title>FILES</title>
392
374
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
393
375
secfile = /etc/mandos/bar-secret
394
376
timeout = 15m
395
 
 
396
377
      </programlisting>
397
378
    </informalexample>
398
 
  </refsect1>  
 
379
  </refsect1>
399
380
  
400
381
  <refsect1 id="see_also">
401
382
    <title>SEE ALSO</title>
402
383
    <para>
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>
 
384
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
385
      <manvolnum>8</manvolnum></citerefentry>,
 
386
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
387
      <manvolnum>5</manvolnum></citerefentry>,
 
388
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
389
      <manvolnum>8</manvolnum></citerefentry>
410
390
    </para>
411
391
  </refsect1>
412
392
</refentry>