/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
33
38
      <holder>Teddy Hogeborn</holder>
34
39
      <holder>Björn Påhlsson</holder>
35
40
    </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>
 
41
    <xi:include href="legalnotice.xml"/>
59
42
  </refentryinfo>
60
 
 
 
43
  
61
44
  <refmeta>
62
45
    <refentrytitle>&CONFNAME;</refentrytitle>
63
46
    <manvolnum>5</manvolnum>
69
52
      Configuration file for the Mandos server
70
53
    </refpurpose>
71
54
  </refnamediv>
72
 
 
 
55
  
73
56
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
57
    <synopsis>&CONFPATH;</synopsis>
77
58
  </refsynopsisdiv>
78
 
 
 
59
  
79
60
  <refsect1 id="description">
80
61
    <title>DESCRIPTION</title>
81
62
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
63
      The file &CONFPATH; is a configuration file for <citerefentry
83
64
      ><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
87
 
      if a client was declared invalid in a previous run of the
88
 
      server.
 
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.
89
69
    </para>
90
70
    <para>
91
71
      The format starts with a <literal>[<replaceable>section
111
91
  <refsect1 id="options">
112
92
    <title>OPTIONS</title>
113
93
    <para>
114
 
      The possible options are:
115
 
    </para>
116
 
 
 
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
    
117
101
    <variablelist>
118
 
 
119
 
      <varlistentry>
120
 
        <term><literal><varname>timeout</varname></literal></term>
121
 
        <listitem>
122
 
          <synopsis><literal>timeout = </literal><replaceable
123
 
          >TIME</replaceable>
124
 
          </synopsis>
125
 
          <para>
126
 
            The timeout is how long the server will wait for a
127
 
            successful checker run until a client is considered
128
 
            invalid - that is, ineligible to get the data this server
129
 
            holds.  By default Mandos will use 1 hour.
130
 
          </para>
131
 
          <para>
132
 
            The <replaceable>TIME</replaceable> is specified as a
133
 
            space-separated number of values, each of which is a
134
 
            number and a one-character suffix.  The suffix must be one
135
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
136
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
137
 
            minutes, hours, and weeks, respectively.  The values are
138
 
            added together to give the total time value, so all of
139
 
            <quote><literal>330s</literal></quote>,
140
 
            <quote><literal>110s 110s 110s</literal></quote>, and
141
 
            <quote><literal>5m 30s</literal></quote> will give a value
142
 
            of five minutes and thirty seconds.
143
 
          </para>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
147
 
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
149
 
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
153
 
          <para>
154
 
            How often to run the checker to confirm that a client is
155
 
            still up.  <emphasis>Note:</emphasis> a new checker will
156
 
            not be started if an old one is still running.  The server
157
 
            will wait for a checker to complete until the above
158
 
            <quote><varname>timeout</varname></quote> occurs, at which
159
 
            time the client will be marked invalid, and any running
160
 
            checker killed.  The default interval is 5 minutes.
161
 
          </para>
162
 
          <para>
163
 
            The format of <replaceable>TIME</replaceable> is the same
164
 
            as for <varname>timeout</varname> above.
165
 
          </para>
166
 
        </listitem>
167
 
      </varlistentry>      
168
 
 
169
 
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
171
 
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
 
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>
175
162
          <para>
176
163
            This option allows you to override the default shell
177
164
            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>.
 
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>.
185
174
          </para>
186
175
          <para>
187
176
            In addition to normal start time expansion, this option
192
181
      </varlistentry>
193
182
      
194
183
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
184
        <term><option>fingerprint<literal> = </literal
 
185
        ><replaceable>HEXSTRING</replaceable></option></term>
196
186
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
 
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
200
190
          <para>
201
191
            This option sets the OpenPGP fingerprint that identifies
202
192
            the public key that clients authenticate themselves with
207
197
      </varlistentry>
208
198
      
209
199
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
211
 
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
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>
215
272
          <para>
216
273
            If present, this option must be set to a string of
217
274
            base64-encoded binary data.  It will be decoded and sent
218
275
            to the client matching the above
219
276
            <option>fingerprint</option>.  This should, of course, be
220
277
            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> 
 
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.
 
305
          </para>
 
306
          <para>
 
307
            The <replaceable>TIME</replaceable> is specified as a
 
308
            space-separated number of values, each of which is a
 
309
            number and a one-character suffix.  The suffix must be one
 
310
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
311
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
312
            minutes, hours, and weeks, respectively.  The values are
 
313
            added together to give the total time value, so all of
 
314
            <quote><literal>330s</literal></quote>,
 
315
            <quote><literal>110s 110s 110s</literal></quote>, and
 
316
            <quote><literal>5m 30s</literal></quote> will give a value
 
317
            of five minutes and thirty seconds.
 
318
          </para>
 
319
        </listitem>
 
320
      </varlistentry>
273
321
      
274
322
    </variablelist>
275
 
  </refsect1>  
 
323
  </refsect1>
276
324
  
277
325
  <refsect1 id="expansion">
278
326
    <title>EXPANSION</title>
309
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
310
358
        ></quote> will be replaced by the value of the attribute
311
359
        <varname>foo</varname> of the internal
312
 
        <quote><classname>Client</classname></quote> object.  See the
313
 
        source code for details, and let the authors know of any
314
 
        attributes that are useful so they may be preserved to any new
315
 
        versions of this software.
 
360
        <quote><classname>Client</classname></quote> object in the
 
361
        Mandos server.  The currently allowed values for
 
362
        <replaceable>foo</replaceable> are:
 
363
        <quote><literal>approval_delay</literal></quote>,
 
364
        <quote><literal>approval_duration</literal></quote>,
 
365
        <quote><literal>created</literal></quote>,
 
366
        <quote><literal>enabled</literal></quote>,
 
367
        <quote><literal>fingerprint</literal></quote>,
 
368
        <quote><literal>host</literal></quote>,
 
369
        <quote><literal>interval</literal></quote>,
 
370
        <quote><literal>last_approval_request</literal></quote>,
 
371
        <quote><literal>last_checked_ok</literal></quote>,
 
372
        <quote><literal>last_enabled</literal></quote>,
 
373
        <quote><literal>name</literal></quote>,
 
374
        <quote><literal>timeout</literal></quote>, and, if using
 
375
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
376
        See the source code for details.  <emphasis role="strong"
 
377
        >Currently, <emphasis>none</emphasis> of these attributes
 
378
        except <quote><literal>host</literal></quote> are guaranteed
 
379
        to be valid in future versions.</emphasis> Therefore, please
 
380
        let the authors know of any attributes that are useful so they
 
381
        may be preserved to any new versions of this software.
316
382
      </para>
317
383
      <para>
318
384
        Note that this means that, in order to include an actual
319
385
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
386
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
387
        percent characters in a row (<quote>%%%%</quote>) must be
322
388
        entered.  Also, a bad format here will lead to an immediate
323
389
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
390
        mode is needed to expose an error of this kind.
325
391
      </para>
326
392
    </refsect2>
327
 
 
328
 
  </refsect1>  
 
393
    
 
394
  </refsect1>
329
395
  
330
396
  <refsect1 id="files">
331
397
    <title>FILES</title>
355
421
[DEFAULT]
356
422
timeout = 1h
357
423
interval = 5m
358
 
checker = fping -q -- %(host)s
 
424
checker = fping -q -- %%(host)s
359
425
 
360
426
# Client "foo"
361
427
[foo]
376
442
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
443
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
444
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
445
host = foo.example.org
381
 
interval = 5m
 
446
interval = 1m
382
447
 
383
448
# Client "bar"
384
449
[bar]
385
450
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
387
 
 
 
451
secfile = /etc/mandos/bar-secret
 
452
timeout = 15m
 
453
approved_by_default = False
 
454
approval_delay = 30s
388
455
      </programlisting>
389
456
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
457
  </refsect1>
 
458
  
 
459
  <refsect1 id="see_also">
 
460
    <title>SEE ALSO</title>
 
461
    <para>
 
462
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
463
      <manvolnum>8</manvolnum></citerefentry>,
 
464
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
465
      <manvolnum>5</manvolnum></citerefentry>,
 
466
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
467
      <manvolnum>8</manvolnum></citerefentry>
 
468
    </para>
 
469
  </refsect1>
392
470
</refentry>
 
471
<!-- Local Variables: -->
 
472
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
473
<!-- time-stamp-end: "[\"']>" -->
 
474
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
475
<!-- End: -->