/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-09-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-09-17">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-31">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
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
38
    <xi:include href="legalnotice.xml"/>
41
39
  </refentryinfo>
42
 
  
 
40
 
43
41
  <refmeta>
44
42
    <refentrytitle>&CONFNAME;</refentrytitle>
45
43
    <manvolnum>5</manvolnum>
51
49
      Configuration file for the Mandos server
52
50
    </refpurpose>
53
51
  </refnamediv>
54
 
  
 
52
 
55
53
  <refsynopsisdiv>
56
54
    <synopsis>&CONFPATH;</synopsis>
57
55
  </refsynopsisdiv>
58
 
  
 
56
 
59
57
  <refsect1 id="description">
60
58
    <title>DESCRIPTION</title>
61
59
    <para>
95
93
      start time expansion, see <xref linkend="expansion"/>.
96
94
    </para>
97
95
    <para>
98
 
      Unknown options are ignored.  The used options are as follows:
 
96
      Uknown options are ignored.  The used options are as follows:
99
97
    </para>
100
 
    
 
98
 
101
99
    <variablelist>
102
 
      
 
100
 
103
101
      <varlistentry>
104
102
        <term><option>timeout<literal> = </literal><replaceable
105
103
        >TIME</replaceable></option></term>
106
104
        <listitem>
107
105
          <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.
 
106
            The timeout is how long the server will wait for a
 
107
            successful checker run until a client is considered
 
108
            invalid - that is, ineligible to get the data this server
 
109
            holds.  By default Mandos will use 1 hour.
116
110
          </para>
117
111
          <para>
118
112
            The <replaceable>TIME</replaceable> is specified as a
129
123
          </para>
130
124
        </listitem>
131
125
      </varlistentry>
132
 
      
 
126
 
133
127
      <varlistentry>
134
128
        <term><option>interval<literal> = </literal><replaceable
135
129
        >TIME</replaceable></option></term>
136
130
        <listitem>
137
131
          <para>
138
 
            This option is <emphasis>optional</emphasis>.
139
 
          </para>
140
 
          <para>
141
132
            How often to run the checker to confirm that a client is
142
133
            still up.  <emphasis>Note:</emphasis> a new checker will
143
134
            not be started if an old one is still running.  The server
152
143
          </para>
153
144
        </listitem>
154
145
      </varlistentry>
155
 
      
 
146
 
156
147
      <varlistentry>
157
148
        <term><option>checker<literal> = </literal><replaceable
158
149
        >COMMAND</replaceable></option></term>
159
150
        <listitem>
160
151
          <para>
161
 
            This option is <emphasis>optional</emphasis>.
162
 
          </para>
163
 
          <para>
164
152
            This option allows you to override the default shell
165
153
            command that the server will use to check if the client is
166
154
            still up.  Any output of the command will be ignored, only
171
159
            <varname>PATH</varname> will be searched.  The default
172
160
            value for the checker command is <quote><literal
173
161
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
162
            >--</option> %(host)s</literal></quote>.
175
163
          </para>
176
164
          <para>
177
165
            In addition to normal start time expansion, this option
186
174
        ><replaceable>HEXSTRING</replaceable></option></term>
187
175
        <listitem>
188
176
          <para>
189
 
            This option is <emphasis>required</emphasis>.
190
 
          </para>
191
 
          <para>
192
177
            This option sets the OpenPGP fingerprint that identifies
193
178
            the public key that clients authenticate themselves with
194
179
            through TLS.  The string needs to be in hexidecimal form,
202
187
        >BASE64_ENCODED_DATA</replaceable></option></term>
203
188
        <listitem>
204
189
          <para>
205
 
            If this option is not specified, the <option
206
 
            >secfile</option> option is <emphasis>required</emphasis>
207
 
            to be present.
208
 
          </para>
209
 
          <para>
210
190
            If present, this option must be set to a string of
211
191
            base64-encoded binary data.  It will be decoded and sent
212
192
            to the client matching the above
224
204
            lines is that a line beginning with white space adds to
225
205
            the value of the previous line, RFC 822-style.
226
206
          </para>
 
207
          <para>
 
208
            If this option is not specified, the <option
 
209
            >secfile</option> option is used instead, but one of them
 
210
            <emphasis>must</emphasis> be present.
 
211
          </para>
227
212
        </listitem>
228
213
      </varlistentry>
229
 
      
 
214
 
230
215
      <varlistentry>
231
216
        <term><option>secfile<literal> = </literal><replaceable
232
217
        >FILENAME</replaceable></option></term>
233
218
        <listitem>
234
219
          <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
220
            Similar to the <option>secret</option>, except the secret
241
221
            data is in an external file.  The contents of the file
242
222
            should <emphasis>not</emphasis> be base64-encoded, but
243
223
            will be sent to clients verbatim.
244
224
          </para>
245
225
          <para>
246
 
            File names of the form <filename>~user/foo/bar</filename>
247
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
248
 
            are supported.
 
226
            This option is only used, and <emphasis>must</emphasis> be
 
227
            present, if <option>secret</option> is not specified.
249
228
          </para>
250
229
        </listitem>
251
230
      </varlistentry>
252
 
      
 
231
 
253
232
      <varlistentry>
254
233
        <term><option><literal>host = </literal><replaceable
255
234
        >STRING</replaceable></option></term>
256
235
        <listitem>
257
236
          <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>
263
 
          <para>
264
237
            Host name for this client.  This is not used by the server
265
238
            directly, but can be, and is by default, used by the
266
239
            checker.  See the <option>checker</option> option.
321
294
        mode is needed to expose an error of this kind.
322
295
      </para>
323
296
    </refsect2>
324
 
    
 
297
 
325
298
  </refsect1>
326
299
  
327
300
  <refsect1 id="files">
352
325
[DEFAULT]
353
326
timeout = 1h
354
327
interval = 5m
355
 
checker = fping -q -- %%(host)s
 
328
checker = fping -q -- %(host)s
356
329
 
357
330
# Client "foo"
358
331
[foo]
381
354
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
382
355
secfile = /etc/mandos/bar-secret
383
356
timeout = 15m
 
357
 
384
358
      </programlisting>
385
359
    </informalexample>
386
360
  </refsect1>