/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-08-31 16:04:47 UTC
  • mfrom: (24.1.77 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080831160447-2xte5k90onspphki
Merge.

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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY CONFNAME "mandos-clients.conf">
6
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
 
7
<!ENTITY TIMESTAMP "2008-08-31">
7
8
]>
8
9
 
9
 
<refentry>
 
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
11
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
 
14
    <productname>Mandos</productname>
14
15
    <productnumber>&VERSION;</productnumber>
 
16
    <date>&TIMESTAMP;</date>
15
17
    <authorgroup>
16
18
      <author>
17
19
        <firstname>Björn</firstname>
33
35
      <holder>Teddy Hogeborn</holder>
34
36
      <holder>Björn Påhlsson</holder>
35
37
    </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>
 
38
    <xi:include href="legalnotice.xml"/>
59
39
  </refentryinfo>
60
40
 
61
41
  <refmeta>
71
51
  </refnamediv>
72
52
 
73
53
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
54
    <synopsis>&CONFPATH;</synopsis>
77
55
  </refsynopsisdiv>
78
56
 
79
57
  <refsect1 id="description">
80
58
    <title>DESCRIPTION</title>
81
59
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
60
      The file &CONFPATH; is a configuration file for <citerefentry
83
61
      ><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
 
      where each client that will be able to use the service needs to
86
 
      be listed.  All clients listed will be regarded as valid, even
 
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
 
63
      The file needs to list all clients that should be able to use
 
64
      the service.  All clients listed will be regarded as valid, even
87
65
      if a client was declared invalid in a previous run of the
88
66
      server.
89
67
    </para>
111
89
  <refsect1 id="options">
112
90
    <title>OPTIONS</title>
113
91
    <para>
114
 
      The possible options are:
 
92
      <emphasis>Note:</emphasis> all option values are subject to
 
93
      start time expansion, see <xref linkend="expansion"/>.
 
94
    </para>
 
95
    <para>
 
96
      Uknown options are ignored.  The used options are as follows:
115
97
    </para>
116
98
 
117
99
    <variablelist>
118
100
 
119
101
      <varlistentry>
120
 
        <term><literal><varname>timeout</varname></literal></term>
 
102
        <term><option>timeout<literal> = </literal><replaceable
 
103
        >TIME</replaceable></option></term>
121
104
        <listitem>
122
 
          <synopsis><literal>timeout = </literal><replaceable
123
 
          >TIME</replaceable>
124
 
          </synopsis>
125
105
          <para>
126
106
            The timeout is how long the server will wait for a
127
107
            successful checker run until a client is considered
145
125
      </varlistentry>
146
126
 
147
127
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
 
128
        <term><option>interval<literal> = </literal><replaceable
 
129
        >TIME</replaceable></option></term>
149
130
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
153
131
          <para>
154
132
            How often to run the checker to confirm that a client is
155
133
            still up.  <emphasis>Note:</emphasis> a new checker will
164
142
            as for <varname>timeout</varname> above.
165
143
          </para>
166
144
        </listitem>
167
 
      </varlistentry>      
 
145
      </varlistentry>
168
146
 
169
147
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
 
148
        <term><option>checker<literal> = </literal><replaceable
 
149
        >COMMAND</replaceable></option></term>
171
150
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
175
151
          <para>
176
152
            This option allows you to override the default shell
177
153
            command that the server will use to check if the client is
178
 
            still up.  The output of the command will be ignored, only
179
 
            the exit code is checked.  The command will be run using
180
 
            <quote><command><filename>/bin/sh</filename>
181
 
            <option>-c</option></command></quote>.  The default
182
 
            command is <quote><literal><command>fping</command>
183
 
            <option>-q</option> <option>--</option>
184
 
            %(host)s</literal></quote>.
 
154
            still up.  Any output of the command will be ignored, only
 
155
            the exit code is checked:  If the exit code of the command
 
156
            is zero, the client is considered up.  The command will be
 
157
            run using <quote><command><filename>/bin/sh</filename>
 
158
            <option>-c</option></command></quote>, so
 
159
            <varname>PATH</varname> will be searched.  The default
 
160
            value for the checker command is <quote><literal
 
161
            ><command>fping</command> <option>-q</option> <option
 
162
            >--</option> %(host)s</literal></quote>.
185
163
          </para>
186
164
          <para>
187
165
            In addition to normal start time expansion, this option
192
170
      </varlistentry>
193
171
      
194
172
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
173
        <term><option>fingerprint<literal> = </literal
 
174
        ><replaceable>HEXSTRING</replaceable></option></term>
196
175
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
200
176
          <para>
201
177
            This option sets the OpenPGP fingerprint that identifies
202
178
            the public key that clients authenticate themselves with
207
183
      </varlistentry>
208
184
      
209
185
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
 
186
        <term><option>secret<literal> = </literal><replaceable
 
187
        >BASE64_ENCODED_DATA</replaceable></option></term>
211
188
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
215
189
          <para>
216
190
            If present, this option must be set to a string of
217
191
            base64-encoded binary data.  It will be decoded and sent
218
192
            to the client matching the above
219
193
            <option>fingerprint</option>.  This should, of course, be
220
194
            OpenPGP encrypted data, decryptable only by the client.
221
 
<!--        The program <citerefentry><refentrytitle><command -->
222
 
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
223
 
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
224
 
<!--        if desired. -->
225
 
          </para>
226
 
          <para>
227
 
            Note: this value of this option will probably run over
228
 
            many lines, and will then have to use the fact that a line
229
 
            beginning with white space adds to the value of the
230
 
            previous line, RFC 822-style.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>secfile</literal></term>
237
 
        <listitem>
238
 
          <para>
239
 
            Base 64 encoded OpenPGP encrypted password encrypted by
240
 
            the clients openpgp certificate as a binary file.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
      <varlistentry>
246
 
        <term><literal>host</literal></term>
247
 
        <listitem>
248
 
          <para>
249
 
            Host name that can be used in for checking that the client is up.
250
 
          </para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
 
254
 
      <varlistentry>
255
 
        <term><literal>checker</literal></term>
256
 
        <listitem>
257
 
          <para>
258
 
            Shell command that the server will use to check up if a
259
 
            client is still up.
260
 
          </para>
261
 
        </listitem>
262
 
      </varlistentry>      
263
 
 
264
 
      <varlistentry>
265
 
        <term><literal>timeout</literal></term>
266
 
        <listitem>
267
 
          <para>
268
 
            Duration that a client can be down whitout be removed from
269
 
            the client list.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry> 
 
195
            The program <citerefentry><refentrytitle><command
 
196
            >mandos-keygen</command></refentrytitle><manvolnum
 
197
            >8</manvolnum></citerefentry> can, using its
 
198
            <option>--password</option> option, be used to generate
 
199
            this, if desired.
 
200
          </para>
 
201
          <para>
 
202
            Note: this value of this option will probably be very
 
203
            long.  A useful feature to avoid having unreadably-long
 
204
            lines is that a line beginning with white space adds to
 
205
            the value of the previous line, RFC 822-style.
 
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>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><option>secfile<literal> = </literal><replaceable
 
217
        >FILENAME</replaceable></option></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Similar to the <option>secret</option>, except the secret
 
221
            data is in an external file.  The contents of the file
 
222
            should <emphasis>not</emphasis> be base64-encoded, but
 
223
            will be sent to clients verbatim.
 
224
          </para>
 
225
          <para>
 
226
            This option is only used, and <emphasis>must</emphasis> be
 
227
            present, if <option>secret</option> is not specified.
 
228
          </para>
 
229
        </listitem>
 
230
      </varlistentry>
 
231
 
 
232
      <varlistentry>
 
233
        <term><option><literal>host = </literal><replaceable
 
234
        >STRING</replaceable></option></term>
 
235
        <listitem>
 
236
          <para>
 
237
            Host name for this client.  This is not used by the server
 
238
            directly, but can be, and is by default, used by the
 
239
            checker.  See the <option>checker</option> option.
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
273
243
      
274
244
    </variablelist>
275
 
  </refsect1>  
 
245
  </refsect1>
276
246
  
277
247
  <refsect1 id="expansion">
278
248
    <title>EXPANSION</title>
317
287
      <para>
318
288
        Note that this means that, in order to include an actual
319
289
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
290
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
291
        percent characters in a row (<quote>%%%%</quote>) must be
322
292
        entered.  Also, a bad format here will lead to an immediate
323
293
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
294
        mode is needed to expose an error of this kind.
325
295
      </para>
326
296
    </refsect2>
327
297
 
328
 
  </refsect1>  
 
298
  </refsect1>
329
299
  
330
300
  <refsect1 id="files">
331
301
    <title>FILES</title>
376
346
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
347
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
348
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
349
host = foo.example.org
381
 
interval = 5m
 
350
interval = 1m
382
351
 
383
352
# Client "bar"
384
353
[bar]
385
354
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
 
355
secfile = /etc/mandos/bar-secret
 
356
timeout = 15m
387
357
 
388
358
      </programlisting>
389
359
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
360
  </refsect1>
 
361
  
 
362
  <refsect1 id="see_also">
 
363
    <title>SEE ALSO</title>
 
364
    <para>
 
365
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
366
      <manvolnum>8</manvolnum></citerefentry>,
 
367
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
368
      <manvolnum>5</manvolnum></citerefentry>,
 
369
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
370
      <manvolnum>8</manvolnum></citerefentry>
 
371
    </para>
 
372
  </refsect1>
392
373
</refentry>
 
374
<!-- Local Variables: -->
 
375
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
376
<!-- time-stamp-end: "[\"']>" -->
 
377
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
378
<!-- End: -->