/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

* mandos.xml (APPROVAL): New section.

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-25">
 
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>
33
37
      <holder>Teddy Hogeborn</holder>
34
38
      <holder>Björn Påhlsson</holder>
35
39
    </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>
 
40
    <xi:include href="legalnotice.xml"/>
59
41
  </refentryinfo>
60
 
 
 
42
  
61
43
  <refmeta>
62
44
    <refentrytitle>&CONFNAME;</refentrytitle>
63
45
    <manvolnum>5</manvolnum>
69
51
      Configuration file for the Mandos server
70
52
    </refpurpose>
71
53
  </refnamediv>
72
 
 
 
54
  
73
55
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
77
57
  </refsynopsisdiv>
78
 
 
 
58
  
79
59
  <refsect1 id="description">
80
60
    <title>DESCRIPTION</title>
81
61
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
62
      The file &CONFPATH; is a configuration file for <citerefentry
83
63
      ><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.
 
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
 
65
      The file needs to list all clients that should be able to use
 
66
      the service.  All clients listed will be regarded as enabled,
 
67
      even if a client was disabled in a previous run of the server.
89
68
    </para>
90
69
    <para>
91
70
      The format starts with a <literal>[<replaceable>section
111
90
  <refsect1 id="options">
112
91
    <title>OPTIONS</title>
113
92
    <para>
114
 
      The possible options are:
115
 
    </para>
116
 
 
 
93
      <emphasis>Note:</emphasis> all option values are subject to
 
94
      start time expansion, see <xref linkend="expansion"/>.
 
95
    </para>
 
96
    <para>
 
97
      Unknown options are ignored.  The used options are as follows:
 
98
    </para>
 
99
    
117
100
    <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>
 
101
      
 
102
      <varlistentry>
 
103
        <term><option>approval_delay<literal> = </literal><replaceable
 
104
        >TIME</replaceable></option></term>
 
105
        <listitem>
 
106
          <para>
 
107
            This option is <emphasis>optional</emphasis>.
 
108
          </para>
 
109
          <para>
 
110
            How long to wait for external approval before resorting to
 
111
            use the <option>approved_by_default</option> value.  The
 
112
            default is <quote>0s</quote>, i.e. not to wait.
 
113
          </para>
 
114
          <para>
 
115
            The format of <replaceable>TIME</replaceable> is the same
 
116
            as for <varname>timeout</varname> below.
 
117
          </para>
 
118
        </listitem>
 
119
      </varlistentry>
 
120
      
 
121
      <varlistentry>
 
122
        <term><option>approval_duration<literal> = </literal
 
123
        ><replaceable>TIME</replaceable></option></term>
 
124
        <listitem>
 
125
          <para>
 
126
            This option is <emphasis>optional</emphasis>.
 
127
          </para>
 
128
          <para>
 
129
            How long an external approval lasts.  The default is 1
 
130
            second.
 
131
          </para>
 
132
          <para>
 
133
            The format of <replaceable>TIME</replaceable> is the same
 
134
            as for <varname>timeout</varname> below.
 
135
          </para>
 
136
        </listitem>
 
137
      </varlistentry>
 
138
      
 
139
      <varlistentry>
 
140
        <term><option>approved_by_default<literal> = </literal
 
141
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
142
          >true</literal> | <literal>on</literal> | <literal
 
143
          >0</literal> | <literal>no</literal> | <literal
 
144
          >false</literal> | <literal>off</literal> }</option></term>
 
145
        <listitem>
 
146
          <para>
 
147
            Whether to approve a client by default after
 
148
            the <option>approval_delay</option>.  The default
 
149
            is <quote>True</quote>.
 
150
          </para>
 
151
        </listitem>
 
152
      </varlistentry>
 
153
      
 
154
      <varlistentry>
 
155
        <term><option>checker<literal> = </literal><replaceable
 
156
        >COMMAND</replaceable></option></term>
 
157
        <listitem>
 
158
          <para>
 
159
            This option is <emphasis>optional</emphasis>.
 
160
          </para>
175
161
          <para>
176
162
            This option allows you to override the default shell
177
163
            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>.
 
164
            still up.  Any output of the command will be ignored, only
 
165
            the exit code is checked:  If the exit code of the command
 
166
            is zero, the client is considered up.  The command will be
 
167
            run using <quote><command><filename>/bin/sh</filename>
 
168
            <option>-c</option></command></quote>, so
 
169
            <varname>PATH</varname> will be searched.  The default
 
170
            value for the checker command is <quote><literal
 
171
            ><command>fping</command> <option>-q</option> <option
 
172
            >--</option> %%(host)s</literal></quote>.
185
173
          </para>
186
174
          <para>
187
175
            In addition to normal start time expansion, this option
192
180
      </varlistentry>
193
181
      
194
182
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
183
        <term><option>fingerprint<literal> = </literal
 
184
        ><replaceable>HEXSTRING</replaceable></option></term>
196
185
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
 
186
          <para>
 
187
            This option is <emphasis>required</emphasis>.
 
188
          </para>
200
189
          <para>
201
190
            This option sets the OpenPGP fingerprint that identifies
202
191
            the public key that clients authenticate themselves with
207
196
      </varlistentry>
208
197
      
209
198
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
211
 
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
199
        <term><option><literal>host = </literal><replaceable
 
200
        >STRING</replaceable></option></term>
 
201
        <listitem>
 
202
          <para>
 
203
            This option is <emphasis>optional</emphasis>, but highly
 
204
            <emphasis>recommended</emphasis> unless the
 
205
            <option>checker</option> option is modified to a
 
206
            non-standard value without <quote>%%(host)s</quote> in it.
 
207
          </para>
 
208
          <para>
 
209
            Host name for this client.  This is not used by the server
 
210
            directly, but can be, and is by default, used by the
 
211
            checker.  See the <option>checker</option> option.
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
      
 
216
      <varlistentry>
 
217
        <term><option>interval<literal> = </literal><replaceable
 
218
        >TIME</replaceable></option></term>
 
219
        <listitem>
 
220
          <para>
 
221
            This option is <emphasis>optional</emphasis>.
 
222
          </para>
 
223
          <para>
 
224
            How often to run the checker to confirm that a client is
 
225
            still up.  <emphasis>Note:</emphasis> a new checker will
 
226
            not be started if an old one is still running.  The server
 
227
            will wait for a checker to complete until the below
 
228
            <quote><varname>timeout</varname></quote> occurs, at which
 
229
            time the client will be disabled, and any running checker
 
230
            killed.  The default interval is 5 minutes.
 
231
          </para>
 
232
          <para>
 
233
            The format of <replaceable>TIME</replaceable> is the same
 
234
            as for <varname>timeout</varname> below.
 
235
          </para>
 
236
        </listitem>
 
237
      </varlistentry>
 
238
      
 
239
      <varlistentry>
 
240
        <term><option>secfile<literal> = </literal><replaceable
 
241
        >FILENAME</replaceable></option></term>
 
242
        <listitem>
 
243
          <para>
 
244
            This option is only used if <option>secret</option> is not
 
245
            specified, in which case this option is
 
246
            <emphasis>required</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            Similar to the <option>secret</option>, except the secret
 
250
            data is in an external file.  The contents of the file
 
251
            should <emphasis>not</emphasis> be base64-encoded, but
 
252
            will be sent to clients verbatim.
 
253
          </para>
 
254
          <para>
 
255
            File names of the form <filename>~user/foo/bar</filename>
 
256
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
257
            are supported.
 
258
          </para>
 
259
        </listitem>
 
260
      </varlistentry>
 
261
      
 
262
      <varlistentry>
 
263
        <term><option>secret<literal> = </literal><replaceable
 
264
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
265
        <listitem>
 
266
          <para>
 
267
            If this option is not specified, the <option
 
268
            >secfile</option> option is <emphasis>required</emphasis>
 
269
            to be present.
 
270
          </para>
215
271
          <para>
216
272
            If present, this option must be set to a string of
217
273
            base64-encoded binary data.  It will be decoded and sent
218
274
            to the client matching the above
219
275
            <option>fingerprint</option>.  This should, of course, be
220
276
            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> 
 
277
            The program <citerefentry><refentrytitle><command
 
278
            >mandos-keygen</command></refentrytitle><manvolnum
 
279
            >8</manvolnum></citerefentry> can, using its
 
280
            <option>--password</option> option, be used to generate
 
281
            this, if desired.
 
282
          </para>
 
283
          <para>
 
284
            Note: this value of this option will probably be very
 
285
            long.  A useful feature to avoid having unreadably-long
 
286
            lines is that a line beginning with white space adds to
 
287
            the value of the previous line, RFC 822-style.
 
288
          </para>
 
289
        </listitem>
 
290
      </varlistentry>
 
291
      
 
292
      <varlistentry>
 
293
        <term><option>timeout<literal> = </literal><replaceable
 
294
        >TIME</replaceable></option></term>
 
295
        <listitem>
 
296
          <para>
 
297
            This option is <emphasis>optional</emphasis>.
 
298
          </para>
 
299
          <para>
 
300
            The timeout is how long the server will wait (for either a
 
301
            successful checker run or a client receiving its secret)
 
302
            until a client is disabled and not allowed to get the data
 
303
            this server holds.  By default Mandos will use 1 hour.
 
304
          </para>
 
305
          <para>
 
306
            The <replaceable>TIME</replaceable> is specified as a
 
307
            space-separated number of values, each of which is a
 
308
            number and a one-character suffix.  The suffix must be one
 
309
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
310
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
311
            minutes, hours, and weeks, respectively.  The values are
 
312
            added together to give the total time value, so all of
 
313
            <quote><literal>330s</literal></quote>,
 
314
            <quote><literal>110s 110s 110s</literal></quote>, and
 
315
            <quote><literal>5m 30s</literal></quote> will give a value
 
316
            of five minutes and thirty seconds.
 
317
          </para>
 
318
        </listitem>
 
319
      </varlistentry>
273
320
      
274
321
    </variablelist>
275
 
  </refsect1>  
 
322
  </refsect1>
276
323
  
277
324
  <refsect1 id="expansion">
278
325
    <title>EXPANSION</title>
317
364
      <para>
318
365
        Note that this means that, in order to include an actual
319
366
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
367
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
368
        percent characters in a row (<quote>%%%%</quote>) must be
322
369
        entered.  Also, a bad format here will lead to an immediate
323
370
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
371
        mode is needed to expose an error of this kind.
325
372
      </para>
326
373
    </refsect2>
327
 
 
328
 
  </refsect1>  
 
374
    
 
375
  </refsect1>
329
376
  
330
377
  <refsect1 id="files">
331
378
    <title>FILES</title>
355
402
[DEFAULT]
356
403
timeout = 1h
357
404
interval = 5m
358
 
checker = fping -q -- %(host)s
 
405
checker = fping -q -- %%(host)s
359
406
 
360
407
# Client "foo"
361
408
[foo]
376
423
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
424
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
425
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
426
host = foo.example.org
381
 
interval = 5m
 
427
interval = 1m
382
428
 
383
429
# Client "bar"
384
430
[bar]
385
431
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
387
 
 
 
432
secfile = /etc/mandos/bar-secret
 
433
timeout = 15m
 
434
approved_by_default = False
 
435
approval_delay = 30s
388
436
      </programlisting>
389
437
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
438
  </refsect1>
 
439
  
 
440
  <refsect1 id="see_also">
 
441
    <title>SEE ALSO</title>
 
442
    <para>
 
443
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
444
      <manvolnum>8</manvolnum></citerefentry>,
 
445
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
446
      <manvolnum>5</manvolnum></citerefentry>,
 
447
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
448
      <manvolnum>8</manvolnum></citerefentry>
 
449
    </para>
 
450
  </refsect1>
392
451
</refentry>
 
452
<!-- Local Variables: -->
 
453
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
454
<!-- time-stamp-end: "[\"']>" -->
 
455
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
456
<!-- End: -->