/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-06 17:24:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080906172458-2x5wlfkn7oqckt1y
* legalnotice.xml: Copy DocBook 4.4-formatted text from
                   <http://www.gnu.org/licenses/gpl-3.0.dbk>.

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 "2019-02-09">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-09-04">
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
 
      <year>2017</year>
45
 
      <year>2018</year>
46
35
      <holder>Teddy Hogeborn</holder>
47
36
      <holder>Björn Påhlsson</holder>
48
37
    </copyright>
49
38
    <xi:include href="legalnotice.xml"/>
50
39
  </refentryinfo>
51
 
  
 
40
 
52
41
  <refmeta>
53
42
    <refentrytitle>&CONFNAME;</refentrytitle>
54
43
    <manvolnum>5</manvolnum>
60
49
      Configuration file for the Mandos server
61
50
    </refpurpose>
62
51
  </refnamediv>
63
 
  
 
52
 
64
53
  <refsynopsisdiv>
65
54
    <synopsis>&CONFPATH;</synopsis>
66
55
  </refsynopsisdiv>
67
 
  
 
56
 
68
57
  <refsect1 id="description">
69
58
    <title>DESCRIPTION</title>
70
59
    <para>
72
61
      ><refentrytitle>mandos</refentrytitle>
73
62
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
63
      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.
 
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.
82
67
    </para>
83
68
    <para>
84
69
      The format starts with a <literal>[<replaceable>section
110
95
    <para>
111
96
      Unknown options are ignored.  The used options are as follows:
112
97
    </para>
113
 
    
 
98
 
114
99
    <variablelist>
115
 
      
116
 
      <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>.
164
 
          </para>
165
 
        </listitem>
166
 
      </varlistentry>
167
 
      
 
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
 
168
153
      <varlistentry>
169
154
        <term><option>checker<literal> = </literal><replaceable
170
155
        >COMMAND</replaceable></option></term>
173
158
            This option is <emphasis>optional</emphasis>.
174
159
          </para>
175
160
          <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>
 
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>
182
167
            <option>-c</option></command></quote>, so
183
168
            <varname>PATH</varname> will be searched.  The default
184
169
            value for the checker command is <quote><literal
185
170
            ><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.
 
171
            >--</option> %(host)s</literal></quote>.
193
172
          </para>
194
173
          <para>
195
174
            In addition to normal start time expansion, this option
200
179
      </varlistentry>
201
180
      
202
181
      <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
182
        <term><option>fingerprint<literal> = </literal
227
183
        ><replaceable>HEXSTRING</replaceable></option></term>
228
184
        <listitem>
232
188
          <para>
233
189
            This option sets the OpenPGP fingerprint that identifies
234
190
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
236
 
            but spaces or upper/lower case are not significant.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
 
        <term><option>key_id<literal> = </literal
243
 
        ><replaceable>HEXSTRING</replaceable></option></term>
244
 
        <listitem>
245
 
          <para>
246
 
            This option is <emphasis>optional</emphasis>.
247
 
          </para>
248
 
          <para>
249
 
            This option sets the certificate key ID that identifies
250
 
            the public key that clients authenticate themselves with
251
 
            through TLS.  The string needs to be in hexadecimal form,
252
 
            but spaces or upper/lower case are not significant.
253
 
          </para>
254
 
        </listitem>
255
 
      </varlistentry>
256
 
      
257
 
      <varlistentry>
258
 
        <term><option><literal>host = </literal><replaceable
259
 
        >STRING</replaceable></option></term>
260
 
        <listitem>
261
 
          <para>
262
 
            This option is <emphasis>optional</emphasis>, but highly
263
 
            <emphasis>recommended</emphasis> unless the
264
 
            <option>checker</option> option is modified to a
265
 
            non-standard value without <quote>%%(host)s</quote> in it.
266
 
          </para>
267
 
          <para>
268
 
            Host name for this client.  This is not used by the server
269
 
            directly, but can be, and is by default, used by the
270
 
            checker.  See the <option>checker</option> option.
271
 
          </para>
272
 
        </listitem>
273
 
      </varlistentry>
274
 
      
275
 
      <varlistentry>
276
 
        <term><option>interval<literal> = </literal><replaceable
277
 
        >TIME</replaceable></option></term>
278
 
        <listitem>
279
 
          <para>
280
 
            This option is <emphasis>optional</emphasis>.
281
 
          </para>
282
 
          <para>
283
 
            How often to run the checker to confirm that a client is
284
 
            still up.  <emphasis>Note:</emphasis> a new checker will
285
 
            not be started if an old one is still running.  The server
286
 
            will wait for a checker to complete until the below
287
 
            <quote><varname>timeout</varname></quote> occurs, at which
288
 
            time the client will be disabled, and any running checker
289
 
            killed.  The default interval is 2 minutes.
290
 
          </para>
291
 
          <para>
292
 
            The format of <replaceable>TIME</replaceable> is the same
293
 
            as for <varname>timeout</varname> below.
294
 
          </para>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
      
298
 
      <varlistentry>
299
 
        <term><option>secfile<literal> = </literal><replaceable
300
 
        >FILENAME</replaceable></option></term>
301
 
        <listitem>
302
 
          <para>
303
 
            This option is only used if <option>secret</option> is not
304
 
            specified, in which case this option is
305
 
            <emphasis>required</emphasis>.
306
 
          </para>
307
 
          <para>
308
 
            Similar to the <option>secret</option>, except the secret
309
 
            data is in an external file.  The contents of the file
310
 
            should <emphasis>not</emphasis> be base64-encoded, but
311
 
            will be sent to clients verbatim.
312
 
          </para>
313
 
          <para>
314
 
            File names of the form <filename>~user/foo/bar</filename>
315
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
316
 
            are supported.
 
191
            through TLS.  The string needs to be in hexidecimal form,
 
192
            but spaces or upper/lower case are not significant.
317
193
          </para>
318
194
        </listitem>
319
195
      </varlistentry>
330
206
          <para>
331
207
            If present, this option must be set to a string of
332
208
            base64-encoded binary data.  It will be decoded and sent
333
 
            to the client matching the above <option>key_id</option>
334
 
            or <option>fingerprint</option>.  This should, of course,
335
 
            be OpenPGP encrypted data, decryptable only by the client.
 
209
            to the client matching the above
 
210
            <option>fingerprint</option>.  This should, of course, be
 
211
            OpenPGP encrypted data, decryptable only by the client.
336
212
            The program <citerefentry><refentrytitle><command
337
213
            >mandos-keygen</command></refentrytitle><manvolnum
338
214
            >8</manvolnum></citerefentry> can, using its
347
223
          </para>
348
224
        </listitem>
349
225
      </varlistentry>
350
 
      
 
226
 
351
227
      <varlistentry>
352
 
        <term><option>timeout<literal> = </literal><replaceable
353
 
        >TIME</replaceable></option></term>
 
228
        <term><option>secfile<literal> = </literal><replaceable
 
229
        >FILENAME</replaceable></option></term>
354
230
        <listitem>
355
231
          <para>
356
 
            This option is <emphasis>optional</emphasis>.
357
 
          </para>
358
 
          <para>
359
 
            The timeout is how long the server will wait, after a
360
 
            successful checker run, until a client is disabled and not
361
 
            allowed to get the data this server holds.  By default
362
 
            Mandos will use 5 minutes.  See also the
363
 
            <option>extended_timeout</option> option.
364
 
          </para>
365
 
          <para>
366
 
            The <replaceable>TIME</replaceable> is specified as an RFC
367
 
            3339 duration; for example
368
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
369
 
            one year, two months, three days, four hours, five
370
 
            minutes, and six seconds.  Some values can be omitted, see
371
 
            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.
372
241
          </para>
373
242
        </listitem>
374
243
      </varlistentry>
375
 
      
 
244
 
376
245
      <varlistentry>
377
 
        <term><option>enabled<literal> = </literal>{ <literal
378
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
379
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
380
 
        >no</literal> | <literal>false</literal> | <literal
381
 
        >off</literal> }</option></term>
 
246
        <term><option><literal>host = </literal><replaceable
 
247
        >STRING</replaceable></option></term>
382
248
        <listitem>
383
249
          <para>
384
 
            Whether this client should be enabled by default.  The
385
 
            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.
386
259
          </para>
387
260
        </listitem>
388
261
      </varlistentry>
425
298
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
426
299
        ></quote> will be replaced by the value of the attribute
427
300
        <varname>foo</varname> of the internal
428
 
        <quote><classname>Client</classname></quote> object in the
429
 
        Mandos server.  The currently allowed values for
430
 
        <replaceable>foo</replaceable> are:
431
 
        <quote><literal>approval_delay</literal></quote>,
432
 
        <quote><literal>approval_duration</literal></quote>,
433
 
        <quote><literal>created</literal></quote>,
434
 
        <quote><literal>enabled</literal></quote>,
435
 
        <quote><literal>expires</literal></quote>,
436
 
        <quote><literal>key_id</literal></quote>,
437
 
        <quote><literal>fingerprint</literal></quote>,
438
 
        <quote><literal>host</literal></quote>,
439
 
        <quote><literal>interval</literal></quote>,
440
 
        <quote><literal>last_approval_request</literal></quote>,
441
 
        <quote><literal>last_checked_ok</literal></quote>,
442
 
        <quote><literal>last_enabled</literal></quote>,
443
 
        <quote><literal>name</literal></quote>,
444
 
        <quote><literal>timeout</literal></quote>, and, if using
445
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
446
 
        See the source code for details.  <emphasis role="strong"
447
 
        >Currently, <emphasis>none</emphasis> of these attributes
448
 
        except <quote><literal>host</literal></quote> are guaranteed
449
 
        to be valid in future versions.</emphasis> Therefore, please
450
 
        let the authors know of any attributes that are useful so they
451
 
        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.
452
305
      </para>
453
306
      <para>
454
307
        Note that this means that, in order to include an actual
460
313
        mode is needed to expose an error of this kind.
461
314
      </para>
462
315
    </refsect2>
463
 
    
 
316
 
464
317
  </refsect1>
465
318
  
466
319
  <refsect1 id="files">
482
335
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
483
336
      obscure.
484
337
    </para>
485
 
    <xi:include href="bugs.xml"/>
486
338
  </refsect1>
487
339
  
488
340
  <refsect1 id="example">
490
342
    <informalexample>
491
343
      <programlisting>
492
344
[DEFAULT]
493
 
timeout = PT5M
494
 
interval = PT2M
495
 
checker = fping -q -- %%(host)s
 
345
timeout = 1h
 
346
interval = 5m
 
347
checker = fping -q -- %(host)s
496
348
 
497
349
# Client "foo"
498
350
[foo]
499
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
500
351
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
501
352
secret =
502
353
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
515
366
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
516
367
        QlnHIvPzEArRQLo=
517
368
host = foo.example.org
518
 
interval = PT1M
 
369
interval = 1m
519
370
 
520
371
# Client "bar"
521
372
[bar]
522
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
523
373
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
524
374
secfile = /etc/mandos/bar-secret
525
 
timeout = PT15M
526
 
approved_by_default = False
527
 
approval_delay = PT30S
 
375
timeout = 15m
 
376
 
528
377
      </programlisting>
529
378
    </informalexample>
530
379
  </refsect1>
532
381
  <refsect1 id="see_also">
533
382
    <title>SEE ALSO</title>
534
383
    <para>
535
 
      <citerefentry><refentrytitle>intro</refentrytitle>
536
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
537
384
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
538
385
      <manvolnum>8</manvolnum></citerefentry>,
539
386
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
387
      <manvolnum>5</manvolnum></citerefentry>,
541
388
      <citerefentry><refentrytitle>mandos</refentrytitle>
542
 
      <manvolnum>8</manvolnum></citerefentry>,
543
 
      <citerefentry><refentrytitle>fping</refentrytitle>
544
389
      <manvolnum>8</manvolnum></citerefentry>
545
390
    </para>
546
 
    <variablelist>
547
 
      <varlistentry>
548
 
        <term>
549
 
          RFC 3339: <citetitle>Date and Time on the Internet:
550
 
          Timestamps</citetitle>
551
 
        </term>
552
 
      <listitem>
553
 
        <para>
554
 
          The time intervals are in the "duration" format, as
555
 
          specified in ABNF in Appendix A of RFC 3339.
556
 
        </para>
557
 
      </listitem>
558
 
      </varlistentry>
559
 
    </variablelist>
560
391
  </refsect1>
561
392
</refentry>
562
393
<!-- Local Variables: -->