/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 (AvahiService.entry_group_state_changed): Log a name
                                                   collision as
                                                   "info", not as
                                                   "warning".

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>">
7
 
<!ENTITY TIMESTAMP "2008-08-30">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2010</year>
35
38
      <holder>Teddy Hogeborn</holder>
36
39
      <holder>Björn Påhlsson</holder>
37
40
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
41
    <xi:include href="legalnotice.xml"/>
61
42
  </refentryinfo>
62
 
 
 
43
  
63
44
  <refmeta>
64
45
    <refentrytitle>&CONFNAME;</refentrytitle>
65
46
    <manvolnum>5</manvolnum>
71
52
      Configuration file for the Mandos server
72
53
    </refpurpose>
73
54
  </refnamediv>
74
 
 
 
55
  
75
56
  <refsynopsisdiv>
76
57
    <synopsis>&CONFPATH;</synopsis>
77
58
  </refsynopsisdiv>
78
 
 
 
59
  
79
60
  <refsect1 id="description">
80
61
    <title>DESCRIPTION</title>
81
62
    <para>
83
64
      ><refentrytitle>mandos</refentrytitle>
84
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
85
66
      The file needs to list all clients that should be able to use
86
 
      the service.  All clients listed will be regarded as valid, even
87
 
      if a client was declared invalid in a previous run of the
88
 
      server.
 
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
115
95
      start time expansion, see <xref linkend="expansion"/>.
116
96
    </para>
117
97
    <para>
118
 
      Uknown options are ignored.  The used options are as follows:
 
98
      Unknown options are ignored.  The used options are as follows:
119
99
    </para>
120
 
 
 
100
    
121
101
    <variablelist>
122
 
 
123
 
      <varlistentry>
124
 
        <term><option>timeout<literal> = </literal><replaceable
125
 
        >TIME</replaceable></option></term>
126
 
        <listitem>
127
 
          <para>
128
 
            The timeout is how long the server will wait for a
129
 
            successful checker run until a client is considered
130
 
            invalid - that is, ineligible to get the data this server
131
 
            holds.  By default Mandos will use 1 hour.
132
 
          </para>
133
 
          <para>
134
 
            The <replaceable>TIME</replaceable> is specified as a
135
 
            space-separated number of values, each of which is a
136
 
            number and a one-character suffix.  The suffix must be one
137
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
138
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
139
 
            minutes, hours, and weeks, respectively.  The values are
140
 
            added together to give the total time value, so all of
141
 
            <quote><literal>330s</literal></quote>,
142
 
            <quote><literal>110s 110s 110s</literal></quote>, and
143
 
            <quote><literal>5m 30s</literal></quote> will give a value
144
 
            of five minutes and thirty seconds.
145
 
          </para>
146
 
        </listitem>
147
 
      </varlistentry>
148
 
 
149
 
      <varlistentry>
150
 
        <term><option>interval<literal> = </literal><replaceable
151
 
        >TIME</replaceable></option></term>
152
 
        <listitem>
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
 
 
 
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
      
169
155
      <varlistentry>
170
156
        <term><option>checker<literal> = </literal><replaceable
171
157
        >COMMAND</replaceable></option></term>
172
158
        <listitem>
173
159
          <para>
 
160
            This option is <emphasis>optional</emphasis>.
 
161
          </para>
 
162
          <para>
174
163
            This option allows you to override the default shell
175
164
            command that the server will use to check if the client is
176
165
            still up.  Any output of the command will be ignored, only
181
170
            <varname>PATH</varname> will be searched.  The default
182
171
            value for the checker command is <quote><literal
183
172
            ><command>fping</command> <option>-q</option> <option
184
 
            >--</option> %(host)s</literal></quote>.
 
173
            >--</option> %%(host)s</literal></quote>.
185
174
          </para>
186
175
          <para>
187
176
            In addition to normal start time expansion, this option
196
185
        ><replaceable>HEXSTRING</replaceable></option></term>
197
186
        <listitem>
198
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
 
190
          <para>
199
191
            This option sets the OpenPGP fingerprint that identifies
200
192
            the public key that clients authenticate themselves with
201
193
            through TLS.  The string needs to be in hexidecimal form,
205
197
      </varlistentry>
206
198
      
207
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>
208
264
        <term><option>secret<literal> = </literal><replaceable
209
265
        >BASE64_ENCODED_DATA</replaceable></option></term>
210
266
        <listitem>
211
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>
212
273
            If present, this option must be set to a string of
213
274
            base64-encoded binary data.  It will be decoded and sent
214
275
            to the client matching the above
226
287
            lines is that a line beginning with white space adds to
227
288
            the value of the previous line, RFC 822-style.
228
289
          </para>
229
 
          <para>
230
 
            If this option is not specified, the <option
231
 
            >secfile</option> option is used instead, but one of them
232
 
            <emphasis>must</emphasis> be present.
233
 
          </para>
234
 
        </listitem>
235
 
      </varlistentry>
236
 
 
237
 
      <varlistentry>
238
 
        <term><option>secfile<literal> = </literal><replaceable
239
 
        >FILENAME</replaceable></option></term>
240
 
        <listitem>
241
 
          <para>
242
 
            Similar to the <option>secret</option>, except the secret
243
 
            data is in an external file.  The contents of the file
244
 
            should <emphasis>not</emphasis> be base64-encoded, but
245
 
            will be sent to clients verbatim.
246
 
          </para>
247
 
          <para>
248
 
            This option is only used, and <emphasis>must</emphasis> be
249
 
            present, if <option>secret</option> is not specified.
250
 
          </para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
 
254
 
      <varlistentry>
255
 
        <term><option><literal>host = </literal><replaceable
256
 
        >STRING</replaceable></option></term>
257
 
        <listitem>
258
 
          <para>
259
 
            Host name for this client.  This is not used by the server
260
 
            directly, but can be, and is by default, used by the
261
 
            checker.  See the <option>checker</option> option.
 
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.
262
318
          </para>
263
319
        </listitem>
264
320
      </varlistentry>
301
357
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
302
358
        ></quote> will be replaced by the value of the attribute
303
359
        <varname>foo</varname> of the internal
304
 
        <quote><classname>Client</classname></quote> object.  See the
305
 
        source code for details, and let the authors know of any
306
 
        attributes that are useful so they may be preserved to any new
307
 
        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.
308
382
      </para>
309
383
      <para>
310
384
        Note that this means that, in order to include an actual
316
390
        mode is needed to expose an error of this kind.
317
391
      </para>
318
392
    </refsect2>
319
 
 
 
393
    
320
394
  </refsect1>
321
395
  
322
396
  <refsect1 id="files">
347
421
[DEFAULT]
348
422
timeout = 1h
349
423
interval = 5m
350
 
checker = fping -q -- %(host)s
 
424
checker = fping -q -- %%(host)s
351
425
 
352
426
# Client "foo"
353
427
[foo]
376
450
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
377
451
secfile = /etc/mandos/bar-secret
378
452
timeout = 15m
379
 
 
 
453
approved_by_default = False
 
454
approval_delay = 30s
380
455
      </programlisting>
381
456
    </informalexample>
382
457
  </refsect1>