/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: 2009-10-30 16:27:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091030162717-dun2a9li8bu6jm2w
* Makefile (DOCBOOKTOMAN, DOCBOOKTOHTML, common.ent, mandos,
            mandos-keygen, mandos-ctl, mandos.lsm): Add $(strip) to
                                                    make commands
                                                    easier to read
                                                    when run.
           (plugins.d/mandos-client): Use $(LINK.c) to compile in the
                                      same way as the other programs -
                                      i.e. not via an object file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
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-09-04">
 
6
<!ENTITY TIMESTAMP "2009-09-17">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
38
40
    <xi:include href="legalnotice.xml"/>
39
41
  </refentryinfo>
40
 
 
 
42
  
41
43
  <refmeta>
42
44
    <refentrytitle>&CONFNAME;</refentrytitle>
43
45
    <manvolnum>5</manvolnum>
49
51
      Configuration file for the Mandos server
50
52
    </refpurpose>
51
53
  </refnamediv>
52
 
 
 
54
  
53
55
  <refsynopsisdiv>
54
56
    <synopsis>&CONFPATH;</synopsis>
55
57
  </refsynopsisdiv>
56
 
 
 
58
  
57
59
  <refsect1 id="description">
58
60
    <title>DESCRIPTION</title>
59
61
    <para>
95
97
    <para>
96
98
      Unknown options are ignored.  The used options are as follows:
97
99
    </para>
98
 
 
 
100
    
99
101
    <variablelist>
100
 
 
 
102
      
101
103
      <varlistentry>
102
104
        <term><option>timeout<literal> = </literal><replaceable
103
105
        >TIME</replaceable></option></term>
106
108
            This option is <emphasis>optional</emphasis>.
107
109
          </para>
108
110
          <para>
109
 
            The timeout is how long the server will wait for a
110
 
            successful checker run until a client is considered
111
 
            invalid - that is, ineligible to get the data this server
112
 
            holds.  By default Mandos will use 1 hour.
 
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.
113
116
          </para>
114
117
          <para>
115
118
            The <replaceable>TIME</replaceable> is specified as a
126
129
          </para>
127
130
        </listitem>
128
131
      </varlistentry>
129
 
 
 
132
      
130
133
      <varlistentry>
131
134
        <term><option>interval<literal> = </literal><replaceable
132
135
        >TIME</replaceable></option></term>
149
152
          </para>
150
153
        </listitem>
151
154
      </varlistentry>
152
 
 
 
155
      
153
156
      <varlistentry>
154
157
        <term><option>checker<literal> = </literal><replaceable
155
158
        >COMMAND</replaceable></option></term>
168
171
            <varname>PATH</varname> will be searched.  The default
169
172
            value for the checker command is <quote><literal
170
173
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
174
            >--</option> %%(host)s</literal></quote>.
172
175
          </para>
173
176
          <para>
174
177
            In addition to normal start time expansion, this option
223
226
          </para>
224
227
        </listitem>
225
228
      </varlistentry>
226
 
 
 
229
      
227
230
      <varlistentry>
228
231
        <term><option>secfile<literal> = </literal><replaceable
229
232
        >FILENAME</replaceable></option></term>
239
242
            should <emphasis>not</emphasis> be base64-encoded, but
240
243
            will be sent to clients verbatim.
241
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>
242
250
        </listitem>
243
251
      </varlistentry>
244
 
 
 
252
      
245
253
      <varlistentry>
246
254
        <term><option><literal>host = </literal><replaceable
247
255
        >STRING</replaceable></option></term>
250
258
            This option is <emphasis>optional</emphasis>, but highly
251
259
            <emphasis>recommended</emphasis> unless the
252
260
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
 
261
            non-standard value without <quote>%%(host)s</quote> in it.
254
262
          </para>
255
263
          <para>
256
264
            Host name for this client.  This is not used by the server
313
321
        mode is needed to expose an error of this kind.
314
322
      </para>
315
323
    </refsect2>
316
 
 
 
324
    
317
325
  </refsect1>
318
326
  
319
327
  <refsect1 id="files">
344
352
[DEFAULT]
345
353
timeout = 1h
346
354
interval = 5m
347
 
checker = fping -q -- %(host)s
 
355
checker = fping -q -- %%(host)s
348
356
 
349
357
# Client "foo"
350
358
[foo]
373
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
382
secfile = /etc/mandos/bar-secret
375
383
timeout = 15m
376
 
 
377
384
      </programlisting>
378
385
    </informalexample>
379
386
  </refsect1>