/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2018-02-08">
 
6
<!ENTITY TIMESTAMP "2009-12-09">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
 
      <year>2016</year>
44
 
      <year>2017</year>
45
 
      <year>2018</year>
46
37
      <holder>Teddy Hogeborn</holder>
47
38
      <holder>Björn Påhlsson</holder>
48
39
    </copyright>
72
63
      ><refentrytitle>mandos</refentrytitle>
73
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
65
      The file needs to list all clients that should be able to use
75
 
      the service.  The settings in this file can be overridden by
76
 
      runtime changes to the server, which it saves across restarts.
77
 
      (See the section called <quote>PERSISTENT STATE</quote> in
78
 
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
79
 
      >8</manvolnum></citerefentry>.)  However, any <emphasis
80
 
      >changes</emphasis> to this file (including adding and removing
81
 
      clients) will, at startup, override changes done during runtime.
 
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.
82
68
    </para>
83
69
    <para>
84
70
      The format starts with a <literal>[<replaceable>section
114
100
    <variablelist>
115
101
      
116
102
      <varlistentry>
117
 
        <term><option>approval_delay<literal> = </literal><replaceable
118
 
        >TIME</replaceable></option></term>
119
 
        <listitem>
120
 
          <para>
121
 
            This option is <emphasis>optional</emphasis>.
122
 
          </para>
123
 
          <para>
124
 
            How long to wait for external approval before resorting to
125
 
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
127
 
          </para>
128
 
          <para>
129
 
            The format of <replaceable>TIME</replaceable> is the same
130
 
            as for <varname>timeout</varname> below.
131
 
          </para>
132
 
        </listitem>
133
 
      </varlistentry>
134
 
      
135
 
      <varlistentry>
136
 
        <term><option>approval_duration<literal> = </literal
137
 
        ><replaceable>TIME</replaceable></option></term>
138
 
        <listitem>
139
 
          <para>
140
 
            This option is <emphasis>optional</emphasis>.
141
 
          </para>
142
 
          <para>
143
 
            How long an external approval lasts.  The default is 1
144
 
            second.
145
 
          </para>
146
 
          <para>
147
 
            The format of <replaceable>TIME</replaceable> is the same
148
 
            as for <varname>timeout</varname> below.
149
 
          </para>
150
 
        </listitem>
151
 
      </varlistentry>
152
 
      
153
 
      <varlistentry>
154
 
        <term><option>approved_by_default<literal> = </literal
155
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
156
 
          >true</literal> | <literal>on</literal> | <literal
157
 
          >0</literal> | <literal>no</literal> | <literal
158
 
          >false</literal> | <literal>off</literal> }</option></term>
159
 
        <listitem>
160
 
          <para>
161
 
            Whether to approve a client by default after
162
 
            the <option>approval_delay</option>.  The default
163
 
            is <quote>True</quote>.
 
103
        <term><option>timeout<literal> = </literal><replaceable
 
104
        >TIME</replaceable></option></term>
 
105
        <listitem>
 
106
          <para>
 
107
            This option is <emphasis>optional</emphasis>.
 
108
          </para>
 
109
          <para>
 
110
            The timeout is how long the server will wait (for either a
 
111
            successful checker run or a client receiving its secret)
 
112
            until a client is disabled and not allowed to get the data
 
113
            this server holds.  By default Mandos will use 1 hour.
 
114
          </para>
 
115
          <para>
 
116
            The <replaceable>TIME</replaceable> is specified as a
 
117
            space-separated number of values, each of which is a
 
118
            number and a one-character suffix.  The suffix must be one
 
119
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
120
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
121
            minutes, hours, and weeks, respectively.  The values are
 
122
            added together to give the total time value, so all of
 
123
            <quote><literal>330s</literal></quote>,
 
124
            <quote><literal>110s 110s 110s</literal></quote>, and
 
125
            <quote><literal>5m 30s</literal></quote> will give a value
 
126
            of five minutes and thirty seconds.
 
127
          </para>
 
128
        </listitem>
 
129
      </varlistentry>
 
130
      
 
131
      <varlistentry>
 
132
        <term><option>interval<literal> = </literal><replaceable
 
133
        >TIME</replaceable></option></term>
 
134
        <listitem>
 
135
          <para>
 
136
            This option is <emphasis>optional</emphasis>.
 
137
          </para>
 
138
          <para>
 
139
            How often to run the checker to confirm that a client is
 
140
            still up.  <emphasis>Note:</emphasis> a new checker will
 
141
            not be started if an old one is still running.  The server
 
142
            will wait for a checker to complete until the above
 
143
            <quote><varname>timeout</varname></quote> occurs, at which
 
144
            time the client will be disabled, and any running checker
 
145
            killed.  The default interval is 5 minutes.
 
146
          </para>
 
147
          <para>
 
148
            The format of <replaceable>TIME</replaceable> is the same
 
149
            as for <varname>timeout</varname> above.
164
150
          </para>
165
151
        </listitem>
166
152
      </varlistentry>
173
159
            This option is <emphasis>optional</emphasis>.
174
160
          </para>
175
161
          <para>
176
 
            This option overrides the default shell command that the
177
 
            server will use to check if the client is still up.  Any
178
 
            output of the command will be ignored, only the exit code
179
 
            is checked:  If the exit code of the command is zero, the
180
 
            client is considered up.  The command will be run using
181
 
            <quote><command><filename>/bin/sh</filename>
 
162
            This option allows you to override the default shell
 
163
            command that the server will use to check if the client is
 
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>
182
168
            <option>-c</option></command></quote>, so
183
169
            <varname>PATH</varname> will be searched.  The default
184
170
            value for the checker command is <quote><literal
185
171
            ><command>fping</command> <option>-q</option> <option
186
 
            >--</option> %%(host)s</literal></quote>.  Note that
187
 
            <command>mandos-keygen</command>, when generating output
188
 
            to be inserted into this file, normally looks for an SSH
189
 
            server on the Mandos client, and, if it find one, outputs
190
 
            a <option>checker</option> option to check for the
191
 
            client’s key fingerprint – this is more secure against
192
 
            spoofing.
 
172
            >--</option> %%(host)s</literal></quote>.
193
173
          </para>
194
174
          <para>
195
175
            In addition to normal start time expansion, this option
200
180
      </varlistentry>
201
181
      
202
182
      <varlistentry>
203
 
        <term><option>extended_timeout<literal> = </literal><replaceable
204
 
        >TIME</replaceable></option></term>
205
 
        <listitem>
206
 
          <para>
207
 
            This option is <emphasis>optional</emphasis>.
208
 
          </para>
209
 
          <para>
210
 
            Extended timeout is an added timeout that is given once
211
 
            after a password has been sent successfully to a client.
212
 
            The timeout is by default longer than the normal timeout,
213
 
            and is used for handling the extra long downtime while a
214
 
            machine is booting up.  Time to take into consideration
215
 
            when changing this value is file system checks and quota
216
 
            checks.  The default value is 15 minutes.
217
 
          </para>
218
 
          <para>
219
 
            The format of <replaceable>TIME</replaceable> is the same
220
 
            as for <varname>timeout</varname> below.
221
 
          </para>
222
 
        </listitem>
223
 
      </varlistentry>
224
 
      
225
 
      <varlistentry>
226
183
        <term><option>fingerprint<literal> = </literal
227
184
        ><replaceable>HEXSTRING</replaceable></option></term>
228
185
        <listitem>
232
189
          <para>
233
190
            This option sets the OpenPGP fingerprint that identifies
234
191
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
 
192
            through TLS.  The string needs to be in hexidecimal form,
236
193
            but spaces or upper/lower case are not significant.
237
194
          </para>
238
195
        </listitem>
239
196
      </varlistentry>
240
197
      
241
198
      <varlistentry>
242
 
        <term><option><literal>host = </literal><replaceable
243
 
        >STRING</replaceable></option></term>
244
 
        <listitem>
245
 
          <para>
246
 
            This option is <emphasis>optional</emphasis>, but highly
247
 
            <emphasis>recommended</emphasis> unless the
248
 
            <option>checker</option> option is modified to a
249
 
            non-standard value without <quote>%%(host)s</quote> in it.
250
 
          </para>
251
 
          <para>
252
 
            Host name for this client.  This is not used by the server
253
 
            directly, but can be, and is by default, used by the
254
 
            checker.  See the <option>checker</option> option.
255
 
          </para>
256
 
        </listitem>
257
 
      </varlistentry>
258
 
      
259
 
      <varlistentry>
260
 
        <term><option>interval<literal> = </literal><replaceable
261
 
        >TIME</replaceable></option></term>
262
 
        <listitem>
263
 
          <para>
264
 
            This option is <emphasis>optional</emphasis>.
265
 
          </para>
266
 
          <para>
267
 
            How often to run the checker to confirm that a client is
268
 
            still up.  <emphasis>Note:</emphasis> a new checker will
269
 
            not be started if an old one is still running.  The server
270
 
            will wait for a checker to complete until the below
271
 
            <quote><varname>timeout</varname></quote> occurs, at which
272
 
            time the client will be disabled, and any running checker
273
 
            killed.  The default interval is 2 minutes.
274
 
          </para>
275
 
          <para>
276
 
            The format of <replaceable>TIME</replaceable> is the same
277
 
            as for <varname>timeout</varname> below.
278
 
          </para>
279
 
        </listitem>
280
 
      </varlistentry>
281
 
      
282
 
      <varlistentry>
283
 
        <term><option>secfile<literal> = </literal><replaceable
284
 
        >FILENAME</replaceable></option></term>
285
 
        <listitem>
286
 
          <para>
287
 
            This option is only used if <option>secret</option> is not
288
 
            specified, in which case this option is
289
 
            <emphasis>required</emphasis>.
290
 
          </para>
291
 
          <para>
292
 
            Similar to the <option>secret</option>, except the secret
293
 
            data is in an external file.  The contents of the file
294
 
            should <emphasis>not</emphasis> be base64-encoded, but
295
 
            will be sent to clients verbatim.
296
 
          </para>
297
 
          <para>
298
 
            File names of the form <filename>~user/foo/bar</filename>
299
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
300
 
            are supported.
301
 
          </para>
302
 
        </listitem>
303
 
      </varlistentry>
304
 
      
305
 
      <varlistentry>
306
199
        <term><option>secret<literal> = </literal><replaceable
307
200
        >BASE64_ENCODED_DATA</replaceable></option></term>
308
201
        <listitem>
333
226
      </varlistentry>
334
227
      
335
228
      <varlistentry>
336
 
        <term><option>timeout<literal> = </literal><replaceable
337
 
        >TIME</replaceable></option></term>
 
229
        <term><option>secfile<literal> = </literal><replaceable
 
230
        >FILENAME</replaceable></option></term>
338
231
        <listitem>
339
232
          <para>
340
 
            This option is <emphasis>optional</emphasis>.
341
 
          </para>
342
 
          <para>
343
 
            The timeout is how long the server will wait, after a
344
 
            successful checker run, until a client is disabled and not
345
 
            allowed to get the data this server holds.  By default
346
 
            Mandos will use 5 minutes.  See also the
347
 
            <option>extended_timeout</option> option.
348
 
          </para>
349
 
          <para>
350
 
            The <replaceable>TIME</replaceable> is specified as an RFC
351
 
            3339 duration; for example
352
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
353
 
            one year, two months, three days, four hours, five
354
 
            minutes, and six seconds.  Some values can be omitted, see
355
 
            RFC 3339 Appendix A for details.
 
233
            This option is only used if <option>secret</option> is not
 
234
            specified, in which case this option is
 
235
            <emphasis>required</emphasis>.
 
236
          </para>
 
237
          <para>
 
238
            Similar to the <option>secret</option>, except the secret
 
239
            data is in an external file.  The contents of the file
 
240
            should <emphasis>not</emphasis> be base64-encoded, but
 
241
            will be sent to clients verbatim.
 
242
          </para>
 
243
          <para>
 
244
            File names of the form <filename>~user/foo/bar</filename>
 
245
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
246
            are supported.
356
247
          </para>
357
248
        </listitem>
358
249
      </varlistentry>
359
250
      
360
251
      <varlistentry>
361
 
        <term><option>enabled<literal> = </literal>{ <literal
362
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
363
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
364
 
        >no</literal> | <literal>false</literal> | <literal
365
 
        >off</literal> }</option></term>
 
252
        <term><option><literal>host = </literal><replaceable
 
253
        >STRING</replaceable></option></term>
366
254
        <listitem>
367
255
          <para>
368
 
            Whether this client should be enabled by default.  The
369
 
            default is <quote>true</quote>.
 
256
            This option is <emphasis>optional</emphasis>, but highly
 
257
            <emphasis>recommended</emphasis> unless the
 
258
            <option>checker</option> option is modified to a
 
259
            non-standard value without <quote>%%(host)s</quote> in it.
 
260
          </para>
 
261
          <para>
 
262
            Host name for this client.  This is not used by the server
 
263
            directly, but can be, and is by default, used by the
 
264
            checker.  See the <option>checker</option> option.
370
265
          </para>
371
266
        </listitem>
372
267
      </varlistentry>
409
304
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
410
305
        ></quote> will be replaced by the value of the attribute
411
306
        <varname>foo</varname> of the internal
412
 
        <quote><classname>Client</classname></quote> object in the
413
 
        Mandos server.  The currently allowed values for
414
 
        <replaceable>foo</replaceable> are:
415
 
        <quote><literal>approval_delay</literal></quote>,
416
 
        <quote><literal>approval_duration</literal></quote>,
417
 
        <quote><literal>created</literal></quote>,
418
 
        <quote><literal>enabled</literal></quote>,
419
 
        <quote><literal>expires</literal></quote>,
420
 
        <quote><literal>fingerprint</literal></quote>,
421
 
        <quote><literal>host</literal></quote>,
422
 
        <quote><literal>interval</literal></quote>,
423
 
        <quote><literal>last_approval_request</literal></quote>,
424
 
        <quote><literal>last_checked_ok</literal></quote>,
425
 
        <quote><literal>last_enabled</literal></quote>,
426
 
        <quote><literal>name</literal></quote>,
427
 
        <quote><literal>timeout</literal></quote>, and, if using
428
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
429
 
        See the source code for details.  <emphasis role="strong"
430
 
        >Currently, <emphasis>none</emphasis> of these attributes
431
 
        except <quote><literal>host</literal></quote> are guaranteed
432
 
        to be valid in future versions.</emphasis> Therefore, please
433
 
        let the authors know of any attributes that are useful so they
434
 
        may be preserved to any new versions of this software.
 
307
        <quote><classname>Client</classname></quote> object.  See the
 
308
        source code for details, and let the authors know of any
 
309
        attributes that are useful so they may be preserved to any new
 
310
        versions of this software.
435
311
      </para>
436
312
      <para>
437
313
        Note that this means that, in order to include an actual
465
341
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
466
342
      obscure.
467
343
    </para>
468
 
    <xi:include href="bugs.xml"/>
469
344
  </refsect1>
470
345
  
471
346
  <refsect1 id="example">
473
348
    <informalexample>
474
349
      <programlisting>
475
350
[DEFAULT]
476
 
timeout = PT5M
477
 
interval = PT2M
 
351
timeout = 1h
 
352
interval = 5m
478
353
checker = fping -q -- %%(host)s
479
354
 
480
355
# Client "foo"
497
372
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
498
373
        QlnHIvPzEArRQLo=
499
374
host = foo.example.org
500
 
interval = PT1M
 
375
interval = 1m
501
376
 
502
377
# Client "bar"
503
378
[bar]
504
379
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
505
380
secfile = /etc/mandos/bar-secret
506
 
timeout = PT15M
507
 
approved_by_default = False
508
 
approval_delay = PT30S
 
381
timeout = 15m
509
382
      </programlisting>
510
383
    </informalexample>
511
384
  </refsect1>
513
386
  <refsect1 id="see_also">
514
387
    <title>SEE ALSO</title>
515
388
    <para>
516
 
      <citerefentry><refentrytitle>intro</refentrytitle>
517
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
518
389
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
519
390
      <manvolnum>8</manvolnum></citerefentry>,
520
391
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
521
392
      <manvolnum>5</manvolnum></citerefentry>,
522
393
      <citerefentry><refentrytitle>mandos</refentrytitle>
523
 
      <manvolnum>8</manvolnum></citerefentry>,
524
 
      <citerefentry><refentrytitle>fping</refentrytitle>
525
394
      <manvolnum>8</manvolnum></citerefentry>
526
395
    </para>
527
 
    <variablelist>
528
 
      <varlistentry>
529
 
        <term>
530
 
          RFC 3339: <citetitle>Date and Time on the Internet:
531
 
          Timestamps</citetitle>
532
 
        </term>
533
 
      <listitem>
534
 
        <para>
535
 
          The time intervals are in the "duration" format, as
536
 
          specified in ABNF in Appendix A of RFC 3339.
537
 
        </para>
538
 
      </listitem>
539
 
      </varlistentry>
540
 
    </variablelist>
541
396
  </refsect1>
542
397
</refentry>
543
398
<!-- Local Variables: -->