/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-04 14:04:09 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904140409-anr3hckg8ew7q60e
* plugin-runner.xml (BUGS): Document the non-recursiveness of the
                            "--config-file" option.

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-09-04">
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
      Unknown 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>
 
105
          <para>
 
106
            This option is <emphasis>optional</emphasis>.
 
107
          </para>
125
108
          <para>
126
109
            The timeout is how long the server will wait for a
127
110
            successful checker run until a client is considered
145
128
      </varlistentry>
146
129
 
147
130
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
 
131
        <term><option>interval<literal> = </literal><replaceable
 
132
        >TIME</replaceable></option></term>
149
133
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
 
134
          <para>
 
135
            This option is <emphasis>optional</emphasis>.
 
136
          </para>
153
137
          <para>
154
138
            How often to run the checker to confirm that a client is
155
139
            still up.  <emphasis>Note:</emphasis> a new checker will
164
148
            as for <varname>timeout</varname> above.
165
149
          </para>
166
150
        </listitem>
167
 
      </varlistentry>      
 
151
      </varlistentry>
168
152
 
169
153
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
 
154
        <term><option>checker<literal> = </literal><replaceable
 
155
        >COMMAND</replaceable></option></term>
171
156
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
 
157
          <para>
 
158
            This option is <emphasis>optional</emphasis>.
 
159
          </para>
175
160
          <para>
176
161
            This option allows you to override the default shell
177
162
            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>.
 
163
            still up.  Any output of the command will be ignored, only
 
164
            the exit code is checked:  If the exit code of the command
 
165
            is zero, the client is considered up.  The command will be
 
166
            run using <quote><command><filename>/bin/sh</filename>
 
167
            <option>-c</option></command></quote>, so
 
168
            <varname>PATH</varname> will be searched.  The default
 
169
            value for the checker command is <quote><literal
 
170
            ><command>fping</command> <option>-q</option> <option
 
171
            >--</option> %(host)s</literal></quote>.
185
172
          </para>
186
173
          <para>
187
174
            In addition to normal start time expansion, this option
192
179
      </varlistentry>
193
180
      
194
181
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
182
        <term><option>fingerprint<literal> = </literal
 
183
        ><replaceable>HEXSTRING</replaceable></option></term>
196
184
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
 
185
          <para>
 
186
            This option is <emphasis>required</emphasis>.
 
187
          </para>
200
188
          <para>
201
189
            This option sets the OpenPGP fingerprint that identifies
202
190
            the public key that clients authenticate themselves with
207
195
      </varlistentry>
208
196
      
209
197
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
 
198
        <term><option>secret<literal> = </literal><replaceable
 
199
        >BASE64_ENCODED_DATA</replaceable></option></term>
211
200
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
201
          <para>
 
202
            If this option is not specified, the <option
 
203
            >secfile</option> option is <emphasis>required</emphasis>
 
204
            to be present.
 
205
          </para>
215
206
          <para>
216
207
            If present, this option must be set to a string of
217
208
            base64-encoded binary data.  It will be decoded and sent
218
209
            to the client matching the above
219
210
            <option>fingerprint</option>.  This should, of course, be
220
211
            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> 
 
212
            The program <citerefentry><refentrytitle><command
 
213
            >mandos-keygen</command></refentrytitle><manvolnum
 
214
            >8</manvolnum></citerefentry> can, using its
 
215
            <option>--password</option> option, be used to generate
 
216
            this, if desired.
 
217
          </para>
 
218
          <para>
 
219
            Note: this value of this option will probably be very
 
220
            long.  A useful feature to avoid having unreadably-long
 
221
            lines is that a line beginning with white space adds to
 
222
            the value of the previous line, RFC 822-style.
 
223
          </para>
 
224
        </listitem>
 
225
      </varlistentry>
 
226
 
 
227
      <varlistentry>
 
228
        <term><option>secfile<literal> = </literal><replaceable
 
229
        >FILENAME</replaceable></option></term>
 
230
        <listitem>
 
231
          <para>
 
232
            This option is only used if <option>secret</option> is not
 
233
            specified, in which case this option is
 
234
            <emphasis>required</emphasis>.
 
235
          </para>
 
236
          <para>
 
237
            Similar to the <option>secret</option>, except the secret
 
238
            data is in an external file.  The contents of the file
 
239
            should <emphasis>not</emphasis> be base64-encoded, but
 
240
            will be sent to clients verbatim.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
 
 
245
      <varlistentry>
 
246
        <term><option><literal>host = </literal><replaceable
 
247
        >STRING</replaceable></option></term>
 
248
        <listitem>
 
249
          <para>
 
250
            This option is <emphasis>optional</emphasis>, but highly
 
251
            <emphasis>recommended</emphasis> unless the
 
252
            <option>checker</option> option is modified to a
 
253
            non-standard value without <quote>%(host)s</quote> in it.
 
254
          </para>
 
255
          <para>
 
256
            Host name for this client.  This is not used by the server
 
257
            directly, but can be, and is by default, used by the
 
258
            checker.  See the <option>checker</option> option.
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
273
262
      
274
263
    </variablelist>
275
 
  </refsect1>  
 
264
  </refsect1>
276
265
  
277
266
  <refsect1 id="expansion">
278
267
    <title>EXPANSION</title>
317
306
      <para>
318
307
        Note that this means that, in order to include an actual
319
308
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
309
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
310
        percent characters in a row (<quote>%%%%</quote>) must be
322
311
        entered.  Also, a bad format here will lead to an immediate
323
312
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
313
        mode is needed to expose an error of this kind.
325
314
      </para>
326
315
    </refsect2>
327
316
 
328
 
  </refsect1>  
 
317
  </refsect1>
329
318
  
330
319
  <refsect1 id="files">
331
320
    <title>FILES</title>
376
365
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
366
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
367
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
368
host = foo.example.org
381
 
interval = 5m
 
369
interval = 1m
382
370
 
383
371
# Client "bar"
384
372
[bar]
385
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
 
374
secfile = /etc/mandos/bar-secret
 
375
timeout = 15m
387
376
 
388
377
      </programlisting>
389
378
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
379
  </refsect1>
 
380
  
 
381
  <refsect1 id="see_also">
 
382
    <title>SEE ALSO</title>
 
383
    <para>
 
384
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
385
      <manvolnum>8</manvolnum></citerefentry>,
 
386
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
387
      <manvolnum>5</manvolnum></citerefentry>,
 
388
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
389
      <manvolnum>8</manvolnum></citerefentry>
 
390
    </para>
 
391
  </refsect1>
392
392
</refentry>
 
393
<!-- Local Variables: -->
 
394
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
395
<!-- time-stamp-end: "[\"']>" -->
 
396
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
397
<!-- End: -->