/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 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

Show diffs side-by-side

added added

removed removed

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