/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-28 18:00:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20081028180020-qsiaedlurboi3nm4
* INSTALL: Fixed typo.

* Makefile: Split long lines.
  (install-html): Depend on "html", not "$(htmldocs)".

* README (Copyright): Modified legalese.

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