/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-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2010-09-26">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
33
      <holder>Teddy Hogeborn</holder>
39
34
      <holder>Björn Påhlsson</holder>
40
35
    </copyright>
41
 
    <xi:include href="legalnotice.xml"/>
 
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>
42
59
  </refentryinfo>
43
 
  
 
60
 
44
61
  <refmeta>
45
62
    <refentrytitle>&CONFNAME;</refentrytitle>
46
63
    <manvolnum>5</manvolnum>
52
69
      Configuration file for the Mandos server
53
70
    </refpurpose>
54
71
  </refnamediv>
55
 
  
 
72
 
56
73
  <refsynopsisdiv>
57
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
58
77
  </refsynopsisdiv>
59
 
  
 
78
 
60
79
  <refsect1 id="description">
61
80
    <title>DESCRIPTION</title>
62
81
    <para>
63
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
64
83
      ><refentrytitle>mandos</refentrytitle>
65
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
 
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      even if a client was disabled in a previous run of the server.
 
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
 
87
      if a client was declared invalid in a previous run of the
 
88
      server.
69
89
    </para>
70
90
    <para>
71
 
      The format starts with a <literal>[<replaceable>section
72
 
      header</replaceable>]</literal> which is either
 
91
      The format starts with a section under [] which is either
73
92
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
74
 
      name</replaceable>]</literal>.  The <replaceable>client
75
 
      name</replaceable> can be anything, and is not tied to a host
76
 
      name.  Following the section header is any number of
77
 
      <quote><varname><replaceable>option</replaceable
 
93
      name</replaceable>]</literal>.  Following the section is any
 
94
      number of <quote><varname><replaceable>option</replaceable
78
95
      ></varname>=<replaceable>value</replaceable></quote> entries,
79
96
      with continuations in the style of RFC 822.  <quote><varname
80
97
      ><replaceable>option</replaceable></varname>: <replaceable
81
98
      >value</replaceable></quote> is also accepted.  Note that
82
99
      leading whitespace is removed from values.  Values can contain
83
100
      format strings which refer to other values in the same section,
84
 
      or values in the <quote>DEFAULT</quote> section (see <xref
85
 
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
86
 
      or <quote>;</quote> are ignored and may be used to provide
87
 
      comments.
 
101
      or values in the <quote>DEFAULT</quote> section.  Lines
 
102
      beginning with <quote>#</quote> or <quote>;</quote> are ignored
 
103
      and may be used to provide comments.
88
104
    </para>
89
105
  </refsect1>
90
106
  
91
107
  <refsect1 id="options">
92
108
    <title>OPTIONS</title>
93
109
    <para>
94
 
      <emphasis>Note:</emphasis> all option values are subject to
95
 
      start time expansion, see <xref linkend="expansion"/>.
96
 
    </para>
97
 
    <para>
98
 
      Unknown options are ignored.  The used options are as follows:
99
 
    </para>
100
 
    
 
110
      The possible options are:
 
111
    </para>
 
112
 
101
113
    <variablelist>
102
 
      
103
 
      <varlistentry>
104
 
        <term><option>approval_delay<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
106
 
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
110
 
          <para>
111
 
            How long to wait for external approval before resorting to
112
 
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
114
 
          </para>
115
 
          <para>
116
 
            The format of <replaceable>TIME</replaceable> is the same
117
 
            as for <varname>timeout</varname> below.
118
 
          </para>
119
 
        </listitem>
120
 
      </varlistentry>
121
 
      
122
 
      <varlistentry>
123
 
        <term><option>approval_duration<literal> = </literal
124
 
        ><replaceable>TIME</replaceable></option></term>
125
 
        <listitem>
126
 
          <para>
127
 
            This option is <emphasis>optional</emphasis>.
128
 
          </para>
129
 
          <para>
130
 
            How long an external approval lasts.  The default is 1
131
 
            second.
132
 
          </para>
133
 
          <para>
134
 
            The format of <replaceable>TIME</replaceable> is the same
135
 
            as for <varname>timeout</varname> below.
136
 
          </para>
137
 
        </listitem>
138
 
      </varlistentry>
139
 
      
140
 
      <varlistentry>
141
 
        <term><option>approved_by_default<literal> = </literal
142
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
143
 
          >true</literal> | <literal>on</literal> | <literal
144
 
          >0</literal> | <literal>no</literal> | <literal
145
 
          >false</literal> | <literal>off</literal> }</option></term>
146
 
        <listitem>
147
 
          <para>
148
 
            Whether to approve a client by default after
149
 
            the <option>approval_delay</option>.  The default
150
 
            is <quote>True</quote>.
151
 
          </para>
152
 
        </listitem>
153
 
      </varlistentry>
154
 
      
155
 
      <varlistentry>
156
 
        <term><option>checker<literal> = </literal><replaceable
157
 
        >COMMAND</replaceable></option></term>
158
 
        <listitem>
159
 
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </para>
162
 
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            run using <quote><command><filename>/bin/sh</filename>
169
 
            <option>-c</option></command></quote>, so
170
 
            <varname>PATH</varname> will be searched.  The default
171
 
            value for the checker command is <quote><literal
172
 
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
174
 
          </para>
175
 
          <para>
176
 
            In addition to normal start time expansion, this option
177
 
            will also be subject to runtime expansion; see <xref
178
 
            linkend="expansion"/>.
179
 
          </para>
180
 
        </listitem>
181
 
      </varlistentry>
182
 
      
183
 
      <varlistentry>
184
 
        <term><option>fingerprint<literal> = </literal
185
 
        ><replaceable>HEXSTRING</replaceable></option></term>
186
 
        <listitem>
187
 
          <para>
188
 
            This option is <emphasis>required</emphasis>.
189
 
          </para>
190
 
          <para>
191
 
            This option sets the OpenPGP fingerprint that identifies
192
 
            the public key that clients authenticate themselves with
193
 
            through TLS.  The string needs to be in hexidecimal form,
194
 
            but spaces or upper/lower case are not significant.
195
 
          </para>
196
 
        </listitem>
197
 
      </varlistentry>
198
 
      
199
 
      <varlistentry>
200
 
        <term><option><literal>host = </literal><replaceable
201
 
        >STRING</replaceable></option></term>
202
 
        <listitem>
203
 
          <para>
204
 
            This option is <emphasis>optional</emphasis>, but highly
205
 
            <emphasis>recommended</emphasis> unless the
206
 
            <option>checker</option> option is modified to a
207
 
            non-standard value without <quote>%%(host)s</quote> in it.
208
 
          </para>
209
 
          <para>
210
 
            Host name for this client.  This is not used by the server
211
 
            directly, but can be, and is by default, used by the
212
 
            checker.  See the <option>checker</option> option.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><option>interval<literal> = </literal><replaceable
219
 
        >TIME</replaceable></option></term>
220
 
        <listitem>
221
 
          <para>
222
 
            This option is <emphasis>optional</emphasis>.
223
 
          </para>
224
 
          <para>
225
 
            How often to run the checker to confirm that a client is
226
 
            still up.  <emphasis>Note:</emphasis> a new checker will
227
 
            not be started if an old one is still running.  The server
228
 
            will wait for a checker to complete until the below
229
 
            <quote><varname>timeout</varname></quote> occurs, at which
230
 
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
232
 
          </para>
233
 
          <para>
234
 
            The format of <replaceable>TIME</replaceable> is the same
235
 
            as for <varname>timeout</varname> below.
236
 
          </para>
237
 
        </listitem>
238
 
      </varlistentry>
239
 
      
240
 
      <varlistentry>
241
 
        <term><option>secfile<literal> = </literal><replaceable
242
 
        >FILENAME</replaceable></option></term>
243
 
        <listitem>
244
 
          <para>
245
 
            This option is only used if <option>secret</option> is not
246
 
            specified, in which case this option is
247
 
            <emphasis>required</emphasis>.
248
 
          </para>
249
 
          <para>
250
 
            Similar to the <option>secret</option>, except the secret
251
 
            data is in an external file.  The contents of the file
252
 
            should <emphasis>not</emphasis> be base64-encoded, but
253
 
            will be sent to clients verbatim.
254
 
          </para>
255
 
          <para>
256
 
            File names of the form <filename>~user/foo/bar</filename>
257
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
258
 
            are supported.
259
 
          </para>
260
 
        </listitem>
261
 
      </varlistentry>
262
 
      
263
 
      <varlistentry>
264
 
        <term><option>secret<literal> = </literal><replaceable
265
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
266
 
        <listitem>
267
 
          <para>
268
 
            If this option is not specified, the <option
269
 
            >secfile</option> option is <emphasis>required</emphasis>
270
 
            to be present.
271
 
          </para>
272
 
          <para>
273
 
            If present, this option must be set to a string of
274
 
            base64-encoded binary data.  It will be decoded and sent
275
 
            to the client matching the above
276
 
            <option>fingerprint</option>.  This should, of course, be
277
 
            OpenPGP encrypted data, decryptable only by the client.
278
 
            The program <citerefentry><refentrytitle><command
279
 
            >mandos-keygen</command></refentrytitle><manvolnum
280
 
            >8</manvolnum></citerefentry> can, using its
281
 
            <option>--password</option> option, be used to generate
282
 
            this, if desired.
283
 
          </para>
284
 
          <para>
285
 
            Note: this value of this option will probably be very
286
 
            long.  A useful feature to avoid having unreadably-long
287
 
            lines is that a line beginning with white space adds to
288
 
            the value of the previous line, RFC 822-style.
289
 
          </para>
290
 
        </listitem>
291
 
      </varlistentry>
292
 
      
293
 
      <varlistentry>
294
 
        <term><option>timeout<literal> = </literal><replaceable
295
 
        >TIME</replaceable></option></term>
296
 
        <listitem>
297
 
          <para>
298
 
            This option is <emphasis>optional</emphasis>.
299
 
          </para>
300
 
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
 
114
 
 
115
      <varlistentry>
 
116
        <term><literal><varname>timeout</varname></literal></term>
 
117
        <listitem>
 
118
          <synopsis><literal>timeout = </literal><replaceable
 
119
          >TIME</replaceable>
 
120
          </synopsis>
 
121
          <para>
 
122
            The timeout is how long the server will wait for a
 
123
            successful checker run until a client is considered
 
124
            invalid - that is, ineligible to get the data this server
 
125
            holds.  By default Mandos will use 1 hour.
305
126
          </para>
306
127
          <para>
307
128
            The <replaceable>TIME</replaceable> is specified as a
318
139
          </para>
319
140
        </listitem>
320
141
      </varlistentry>
 
142
 
 
143
      <varlistentry>
 
144
        <term><literal><varname>interval</varname></literal></term>
 
145
        <listitem>
 
146
          <synopsis><literal>interval = </literal><replaceable
 
147
          >TIME</replaceable>
 
148
          </synopsis>
 
149
          <para>
 
150
            How often to run the checker to confirm that a client is
 
151
            still up.  <emphasis>Note:</emphasis> a new checker will
 
152
            not be started if an old one is still running.  The server
 
153
            will wait for a checker to complete until the above
 
154
            <quote><varname>timeout</varname></quote> occurs, at which
 
155
            time the client will be marked invalid, and any running
 
156
            checker killed.  The default interval is 5 minutes.
 
157
          </para>
 
158
          <para>
 
159
            The format of <replaceable>TIME</replaceable> is the same
 
160
            as for <varname>timeout</varname> above.
 
161
          </para>
 
162
        </listitem>
 
163
      </varlistentry>      
 
164
 
 
165
      <varlistentry>
 
166
        <term><literal>checker</literal></term>
 
167
        <listitem>
 
168
          <para>
 
169
            This option allows you to override the default shell
 
170
            command that the server will use to check up if the client
 
171
            is still up. By default mandos will "fping -q -- %%(host)s"
 
172
          </para>
 
173
        </listitem>
 
174
      </varlistentry>
 
175
      
 
176
      <varlistentry>
 
177
        <term><literal>fingerprint</literal></term>
 
178
        <listitem>
 
179
          <para>
 
180
            This option sets the openpgp fingerprint that identifies
 
181
            the public certificate that clients authenticates themself
 
182
            through gnutls. The string need to be in hex-decimal form.
 
183
          </para>
 
184
        </listitem>
 
185
      </varlistentry>
 
186
      
 
187
      <varlistentry>
 
188
        <term><literal>secret</literal></term>
 
189
        <listitem>
 
190
          <para>
 
191
            Base 64 encoded OpenPGP encrypted password encrypted by
 
192
            the clients openpgp certificate.
 
193
          </para>
 
194
        </listitem>
 
195
      </varlistentry>
 
196
 
 
197
      <varlistentry>
 
198
        <term><literal>secfile</literal></term>
 
199
        <listitem>
 
200
          <para>
 
201
            Base 64 encoded OpenPGP encrypted password encrypted by
 
202
            the clients openpgp certificate as a binary file.
 
203
          </para>
 
204
        </listitem>
 
205
      </varlistentry>
 
206
 
 
207
      <varlistentry>
 
208
        <term><literal>host</literal></term>
 
209
        <listitem>
 
210
          <para>
 
211
            Host name that can be used in for checking that the client is up.
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
 
 
216
      <varlistentry>
 
217
        <term><literal>checker</literal></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Shell command that the server will use to check up if a
 
221
            client is still up.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>      
 
225
 
 
226
      <varlistentry>
 
227
        <term><literal>timeout</literal></term>
 
228
        <listitem>
 
229
          <para>
 
230
            Duration that a client can be down whitout be removed from
 
231
            the client list.
 
232
          </para>
 
233
        </listitem>
 
234
      </varlistentry> 
321
235
      
322
236
    </variablelist>
323
 
  </refsect1>
 
237
  </refsect1>  
324
238
  
325
239
  <refsect1 id="expansion">
326
240
    <title>EXPANSION</title>
328
242
      There are two forms of expansion: Start time expansion and
329
243
      runtime expansion.
330
244
    </para>
331
 
    <refsect2 id="start_time_expansion">
 
245
    <refsect2>
332
246
      <title>START TIME EXPANSION</title>
333
247
      <para>
334
248
        Any string in an option value of the form
346
260
        entered.
347
261
      </para>
348
262
    </refsect2>
349
 
    <refsect2 id="runtime_expansion">
 
263
    <refsect2>
350
264
      <title>RUNTIME EXPANSION</title>
351
265
      <para>
352
266
        This is currently only done for the <varname>checker</varname>
365
279
      <para>
366
280
        Note that this means that, in order to include an actual
367
281
        percent character (<quote>%</quote>) in a
368
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
282
        <varname>checker</varname> options, <emphasis>four</emphasis>
369
283
        percent characters in a row (<quote>%%%%</quote>) must be
370
284
        entered.  Also, a bad format here will lead to an immediate
371
285
        but <emphasis>silent</emphasis> run-time fatal exit; debug
372
 
        mode is needed to expose an error of this kind.
 
286
        mode is needed to track down an error of this kind.
373
287
      </para>
374
288
    </refsect2>
375
 
    
376
 
  </refsect1>
 
289
 
 
290
  </refsect1>  
377
291
  
378
292
  <refsect1 id="files">
379
293
    <title>FILES</title>
424
338
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
425
339
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
426
340
        QlnHIvPzEArRQLo=
 
341
        =iHhv
427
342
host = foo.example.org
428
 
interval = 1m
 
343
interval = 5m
429
344
 
430
345
# Client "bar"
431
346
[bar]
432
347
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
433
 
secfile = /etc/mandos/bar-secret
434
 
timeout = 15m
435
 
approved_by_default = False
436
 
approval_delay = 30s
 
348
secfile = /etc/mandos/bar-secret.txt.asc
 
349
 
437
350
      </programlisting>
438
351
    </informalexample>
439
 
  </refsect1>
440
 
  
441
 
  <refsect1 id="see_also">
442
 
    <title>SEE ALSO</title>
443
 
    <para>
444
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
445
 
      <manvolnum>8</manvolnum></citerefentry>,
446
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
447
 
      <manvolnum>5</manvolnum></citerefentry>,
448
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
449
 
      <manvolnum>8</manvolnum></citerefentry>
450
 
    </para>
451
 
  </refsect1>
 
352
  </refsect1>  
 
353
 
452
354
</refentry>
453
 
<!-- Local Variables: -->
454
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
455
 
<!-- time-stamp-end: "[\"']>" -->
456
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
457
 
<!-- End: -->