/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-08-31 15:06:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831150639-tqdkyea3b9p3rou7
* Makefile: Make all DocBook rules include legalnotice.xml as a
            dependency.

* legalnotice.xml: New file with just the <legalnotice> tag in it.

* mandos-clients.conf.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".
* mandos-keygen.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos-conf.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos.xml (/refentry/refentryinfo/legalnotice): - '' -

* overview.xml: Changed root node tag name in DOCTYPE declaration.

* plugin-runner.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-prompt.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-request.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

Show diffs side-by-side

added added

removed removed

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