/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 at bsnet
  • Date: 2010-08-16 19:00:59 UTC
  • mto: This revision was merged to the branch mainline in revision 420.
  • Revision ID: teddy@fukt.bsnet.se-20100816190059-69vvi27up95cgbbl
* Makefile (run-server, run-client): Add notices about harmless error
                                     messages.

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 "2009-09-17">
 
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>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
33
37
      <holder>Teddy Hogeborn</holder>
34
38
      <holder>Björn Påhlsson</holder>
35
39
    </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>
 
40
    <xi:include href="legalnotice.xml"/>
59
41
  </refentryinfo>
60
 
 
 
42
  
61
43
  <refmeta>
62
44
    <refentrytitle>&CONFNAME;</refentrytitle>
63
45
    <manvolnum>5</manvolnum>
69
51
      Configuration file for the Mandos server
70
52
    </refpurpose>
71
53
  </refnamediv>
72
 
 
 
54
  
73
55
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
77
57
  </refsynopsisdiv>
78
 
 
 
58
  
79
59
  <refsect1 id="description">
80
60
    <title>DESCRIPTION</title>
81
61
    <para>
115
95
      start time expansion, see <xref linkend="expansion"/>.
116
96
    </para>
117
97
    <para>
118
 
      Uknown options are ignored.  The used options are as follows:
 
98
      Unknown options are ignored.  The used options are as follows:
119
99
    </para>
120
 
 
 
100
    
121
101
    <variablelist>
122
 
 
 
102
      
123
103
      <varlistentry>
124
 
        <term><literal><varname>timeout</varname></literal></term>
 
104
        <term><option>timeout<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
125
106
        <listitem>
126
 
          <synopsis><literal>timeout = </literal><replaceable
127
 
          >TIME</replaceable>
128
 
          </synopsis>
129
 
          <para>
130
 
            The timeout is how long the server will wait for a
131
 
            successful checker run until a client is considered
132
 
            invalid - that is, ineligible to get the data this server
133
 
            holds.  By default Mandos will use 1 hour.
 
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
 
110
          <para>
 
111
            The timeout is how long the server will wait (for either a
 
112
            successful checker run or a client receiving its secret)
 
113
            until a client is considered invalid - that is, ineligible
 
114
            to get the data this server holds.  By default Mandos will
 
115
            use 1 hour.
134
116
          </para>
135
117
          <para>
136
118
            The <replaceable>TIME</replaceable> is specified as a
147
129
          </para>
148
130
        </listitem>
149
131
      </varlistentry>
150
 
 
 
132
      
151
133
      <varlistentry>
152
 
        <term><literal><varname>interval</varname></literal></term>
 
134
        <term><option>interval<literal> = </literal><replaceable
 
135
        >TIME</replaceable></option></term>
153
136
        <listitem>
154
 
          <synopsis><literal>interval = </literal><replaceable
155
 
          >TIME</replaceable>
156
 
          </synopsis>
 
137
          <para>
 
138
            This option is <emphasis>optional</emphasis>.
 
139
          </para>
157
140
          <para>
158
141
            How often to run the checker to confirm that a client is
159
142
            still up.  <emphasis>Note:</emphasis> a new checker will
168
151
            as for <varname>timeout</varname> above.
169
152
          </para>
170
153
        </listitem>
171
 
      </varlistentry>      
172
 
 
 
154
      </varlistentry>
 
155
      
173
156
      <varlistentry>
174
 
        <term><literal>checker</literal></term>
 
157
        <term><option>checker<literal> = </literal><replaceable
 
158
        >COMMAND</replaceable></option></term>
175
159
        <listitem>
176
 
          <synopsis><literal>checker = </literal><replaceable
177
 
          >COMMAND</replaceable>
178
 
          </synopsis>
 
160
          <para>
 
161
            This option is <emphasis>optional</emphasis>.
 
162
          </para>
179
163
          <para>
180
164
            This option allows you to override the default shell
181
165
            command that the server will use to check if the client is
187
171
            <varname>PATH</varname> will be searched.  The default
188
172
            value for the checker command is <quote><literal
189
173
            ><command>fping</command> <option>-q</option> <option
190
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
191
175
          </para>
192
176
          <para>
193
177
            In addition to normal start time expansion, this option
198
182
      </varlistentry>
199
183
      
200
184
      <varlistentry>
201
 
        <term><literal>fingerprint</literal></term>
 
185
        <term><option>fingerprint<literal> = </literal
 
186
        ><replaceable>HEXSTRING</replaceable></option></term>
202
187
        <listitem>
203
 
          <synopsis><literal>fingerprint = </literal><replaceable
204
 
          >HEXSTRING</replaceable>
205
 
          </synopsis>
 
188
          <para>
 
189
            This option is <emphasis>required</emphasis>.
 
190
          </para>
206
191
          <para>
207
192
            This option sets the OpenPGP fingerprint that identifies
208
193
            the public key that clients authenticate themselves with
213
198
      </varlistentry>
214
199
      
215
200
      <varlistentry>
216
 
        <term><literal>secret</literal></term>
 
201
        <term><option>secret<literal> = </literal><replaceable
 
202
        >BASE64_ENCODED_DATA</replaceable></option></term>
217
203
        <listitem>
218
 
          <synopsis><literal>secret = </literal><replaceable
219
 
          >BASE64_ENCODED_DATA</replaceable>
220
 
          </synopsis>
 
204
          <para>
 
205
            If this option is not specified, the <option
 
206
            >secfile</option> option is <emphasis>required</emphasis>
 
207
            to be present.
 
208
          </para>
221
209
          <para>
222
210
            If present, this option must be set to a string of
223
211
            base64-encoded binary data.  It will be decoded and sent
236
224
            lines is that a line beginning with white space adds to
237
225
            the value of the previous line, RFC 822-style.
238
226
          </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>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
      
 
230
      <varlistentry>
 
231
        <term><option>secfile<literal> = </literal><replaceable
 
232
        >FILENAME</replaceable></option></term>
 
233
        <listitem>
 
234
          <para>
 
235
            This option is only used if <option>secret</option> is not
 
236
            specified, in which case this option is
 
237
            <emphasis>required</emphasis>.
 
238
          </para>
 
239
          <para>
 
240
            Similar to the <option>secret</option>, except the secret
 
241
            data is in an external file.  The contents of the file
 
242
            should <emphasis>not</emphasis> be base64-encoded, but
 
243
            will be sent to clients verbatim.
 
244
          </para>
 
245
          <para>
 
246
            File names of the form <filename>~user/foo/bar</filename>
 
247
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
248
            are supported.
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
      
 
253
      <varlistentry>
 
254
        <term><option><literal>host = </literal><replaceable
 
255
        >STRING</replaceable></option></term>
 
256
        <listitem>
 
257
          <para>
 
258
            This option is <emphasis>optional</emphasis>, but highly
 
259
            <emphasis>recommended</emphasis> unless the
 
260
            <option>checker</option> option is modified to a
 
261
            non-standard value without <quote>%%(host)s</quote> in it.
 
262
          </para>
272
263
          <para>
273
264
            Host name for this client.  This is not used by the server
274
265
            directly, but can be, and is by default, used by the
278
269
      </varlistentry>
279
270
      
280
271
    </variablelist>
281
 
  </refsect1>  
 
272
  </refsect1>
282
273
  
283
274
  <refsect1 id="expansion">
284
275
    <title>EXPANSION</title>
327
318
        percent characters in a row (<quote>%%%%</quote>) must be
328
319
        entered.  Also, a bad format here will lead to an immediate
329
320
        but <emphasis>silent</emphasis> run-time fatal exit; debug
330
 
        mode is needed to track down an error of this kind.
 
321
        mode is needed to expose an error of this kind.
331
322
      </para>
332
323
    </refsect2>
333
 
 
334
 
  </refsect1>  
 
324
    
 
325
  </refsect1>
335
326
  
336
327
  <refsect1 id="files">
337
328
    <title>FILES</title>
361
352
[DEFAULT]
362
353
timeout = 1h
363
354
interval = 5m
364
 
checker = fping -q -- %(host)s
 
355
checker = fping -q -- %%(host)s
365
356
 
366
357
# Client "foo"
367
358
[foo]
390
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
391
382
secfile = /etc/mandos/bar-secret
392
383
timeout = 15m
393
 
 
394
384
      </programlisting>
395
385
    </informalexample>
396
 
  </refsect1>  
 
386
  </refsect1>
397
387
  
398
388
  <refsect1 id="see_also">
399
389
    <title>SEE ALSO</title>
400
390
    <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>
 
391
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
392
      <manvolnum>8</manvolnum></citerefentry>,
 
393
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
394
      <manvolnum>5</manvolnum></citerefentry>,
 
395
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
396
      <manvolnum>8</manvolnum></citerefentry>
408
397
    </para>
409
398
  </refsect1>
410
399
</refentry>
 
400
<!-- Local Variables: -->
 
401
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
402
<!-- time-stamp-end: "[\"']>" -->
 
403
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
404
<!-- End: -->