/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-09-03 19:37:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903193707-sas85ud9r37ubs9r
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
                                     whether it is a required or
                                     optional.

Show diffs side-by-side

added added

removed removed

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