/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 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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 "2012-01-01">
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.  All clients listed will be regarded as enabled,
70
 
      even if a client was disabled in a previous run of the server.
 
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.
71
89
    </para>
72
90
    <para>
73
91
      The format starts with a <literal>[<replaceable>section
97
115
      start time expansion, see <xref linkend="expansion"/>.
98
116
    </para>
99
117
    <para>
100
 
      Unknown options are ignored.  The used options are as follows:
 
118
      Uknown options are ignored.  The used options are as follows:
101
119
    </para>
102
 
    
 
120
 
103
121
    <variablelist>
104
 
      
105
 
      <varlistentry>
106
 
        <term><option>approval_delay<literal> = </literal><replaceable
107
 
        >TIME</replaceable></option></term>
108
 
        <listitem>
109
 
          <para>
110
 
            This option is <emphasis>optional</emphasis>.
111
 
          </para>
112
 
          <para>
113
 
            How long to wait for external approval before resorting to
114
 
            use the <option>approved_by_default</option> value.  The
115
 
            default is <quote>0s</quote>, i.e. not to wait.
116
 
          </para>
117
 
          <para>
118
 
            The format of <replaceable>TIME</replaceable> is the same
119
 
            as for <varname>timeout</varname> below.
120
 
          </para>
121
 
        </listitem>
122
 
      </varlistentry>
123
 
      
124
 
      <varlistentry>
125
 
        <term><option>approval_duration<literal> = </literal
126
 
        ><replaceable>TIME</replaceable></option></term>
127
 
        <listitem>
128
 
          <para>
129
 
            This option is <emphasis>optional</emphasis>.
130
 
          </para>
131
 
          <para>
132
 
            How long an external approval lasts.  The default is 1
133
 
            second.
134
 
          </para>
135
 
          <para>
136
 
            The format of <replaceable>TIME</replaceable> is the same
137
 
            as for <varname>timeout</varname> below.
138
 
          </para>
139
 
        </listitem>
140
 
      </varlistentry>
141
 
      
142
 
      <varlistentry>
143
 
        <term><option>approved_by_default<literal> = </literal
144
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
145
 
          >true</literal> | <literal>on</literal> | <literal
146
 
          >0</literal> | <literal>no</literal> | <literal
147
 
          >false</literal> | <literal>off</literal> }</option></term>
148
 
        <listitem>
149
 
          <para>
150
 
            Whether to approve a client by default after
151
 
            the <option>approval_delay</option>.  The default
152
 
            is <quote>True</quote>.
153
 
          </para>
154
 
        </listitem>
155
 
      </varlistentry>
156
 
      
 
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
 
157
169
      <varlistentry>
158
170
        <term><option>checker<literal> = </literal><replaceable
159
171
        >COMMAND</replaceable></option></term>
160
172
        <listitem>
161
173
          <para>
162
 
            This option is <emphasis>optional</emphasis>.
163
 
          </para>
164
 
          <para>
165
174
            This option allows you to override the default shell
166
175
            command that the server will use to check if the client is
167
176
            still up.  Any output of the command will be ignored, only
172
181
            <varname>PATH</varname> will be searched.  The default
173
182
            value for the checker command is <quote><literal
174
183
            ><command>fping</command> <option>-q</option> <option
175
 
            >--</option> %%(host)s</literal></quote>.
 
184
            >--</option> %(host)s</literal></quote>.
176
185
          </para>
177
186
          <para>
178
187
            In addition to normal start time expansion, this option
183
192
      </varlistentry>
184
193
      
185
194
      <varlistentry>
186
 
        <term><option>extended_timeout<literal> = </literal><replaceable
187
 
        >TIME</replaceable></option></term>
188
 
        <listitem>
189
 
          <para>
190
 
            This option is <emphasis>optional</emphasis>.
191
 
          </para>
192
 
          <para>
193
 
            Extended timeout is an added timeout that is given once
194
 
            after a password has been sent successfully to a client.
195
 
            The timeout is by default longer than the normal timeout,
196
 
            and is used for handling the extra long downtime while a
197
 
            machine is booting up.  Time to take into consideration
198
 
            when changing this value is file system checks and quota
199
 
            checks.  The default value is 15 minutes.
200
 
          </para>
201
 
          <para>
202
 
            The format of <replaceable>TIME</replaceable> is the same
203
 
            as for <varname>timeout</varname> below.
204
 
          </para>
205
 
        </listitem>
206
 
      </varlistentry>
207
 
      
208
 
      <varlistentry>
209
195
        <term><option>fingerprint<literal> = </literal
210
196
        ><replaceable>HEXSTRING</replaceable></option></term>
211
197
        <listitem>
212
198
          <para>
213
 
            This option is <emphasis>required</emphasis>.
214
 
          </para>
215
 
          <para>
216
199
            This option sets the OpenPGP fingerprint that identifies
217
200
            the public key that clients authenticate themselves with
218
201
            through TLS.  The string needs to be in hexidecimal form,
222
205
      </varlistentry>
223
206
      
224
207
      <varlistentry>
225
 
        <term><option><literal>host = </literal><replaceable
226
 
        >STRING</replaceable></option></term>
227
 
        <listitem>
228
 
          <para>
229
 
            This option is <emphasis>optional</emphasis>, but highly
230
 
            <emphasis>recommended</emphasis> unless the
231
 
            <option>checker</option> option is modified to a
232
 
            non-standard value without <quote>%%(host)s</quote> in it.
233
 
          </para>
234
 
          <para>
235
 
            Host name for this client.  This is not used by the server
236
 
            directly, but can be, and is by default, used by the
237
 
            checker.  See the <option>checker</option> option.
238
 
          </para>
239
 
        </listitem>
240
 
      </varlistentry>
241
 
      
242
 
      <varlistentry>
243
 
        <term><option>interval<literal> = </literal><replaceable
244
 
        >TIME</replaceable></option></term>
245
 
        <listitem>
246
 
          <para>
247
 
            This option is <emphasis>optional</emphasis>.
248
 
          </para>
249
 
          <para>
250
 
            How often to run the checker to confirm that a client is
251
 
            still up.  <emphasis>Note:</emphasis> a new checker will
252
 
            not be started if an old one is still running.  The server
253
 
            will wait for a checker to complete until the below
254
 
            <quote><varname>timeout</varname></quote> occurs, at which
255
 
            time the client will be disabled, and any running checker
256
 
            killed.  The default interval is 2 minutes.
257
 
          </para>
258
 
          <para>
259
 
            The format of <replaceable>TIME</replaceable> is the same
260
 
            as for <varname>timeout</varname> below.
261
 
          </para>
262
 
        </listitem>
263
 
      </varlistentry>
264
 
      
265
 
      <varlistentry>
266
 
        <term><option>secfile<literal> = </literal><replaceable
267
 
        >FILENAME</replaceable></option></term>
268
 
        <listitem>
269
 
          <para>
270
 
            This option is only used if <option>secret</option> is not
271
 
            specified, in which case this option is
272
 
            <emphasis>required</emphasis>.
273
 
          </para>
274
 
          <para>
275
 
            Similar to the <option>secret</option>, except the secret
276
 
            data is in an external file.  The contents of the file
277
 
            should <emphasis>not</emphasis> be base64-encoded, but
278
 
            will be sent to clients verbatim.
279
 
          </para>
280
 
          <para>
281
 
            File names of the form <filename>~user/foo/bar</filename>
282
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
283
 
            are supported.
284
 
          </para>
285
 
        </listitem>
286
 
      </varlistentry>
287
 
      
288
 
      <varlistentry>
289
208
        <term><option>secret<literal> = </literal><replaceable
290
209
        >BASE64_ENCODED_DATA</replaceable></option></term>
291
210
        <listitem>
292
211
          <para>
293
 
            If this option is not specified, the <option
294
 
            >secfile</option> option is <emphasis>required</emphasis>
295
 
            to be present.
296
 
          </para>
297
 
          <para>
298
212
            If present, this option must be set to a string of
299
213
            base64-encoded binary data.  It will be decoded and sent
300
214
            to the client matching the above
312
226
            lines is that a line beginning with white space adds to
313
227
            the value of the previous line, RFC 822-style.
314
228
          </para>
315
 
        </listitem>
316
 
      </varlistentry>
317
 
      
318
 
      <varlistentry>
319
 
        <term><option>timeout<literal> = </literal><replaceable
320
 
        >TIME</replaceable></option></term>
321
 
        <listitem>
322
 
          <para>
323
 
            This option is <emphasis>optional</emphasis>.
324
 
          </para>
325
 
          <para>
326
 
            The timeout is how long the server will wait, after a
327
 
            successful checker run, until a client is disabled and not
328
 
            allowed to get the data this server holds.  By default
329
 
            Mandos will use 5 minutes.  See also the
330
 
            <option>extended_timeout</option> option.
331
 
          </para>
332
 
          <para>
333
 
            The <replaceable>TIME</replaceable> is specified as a
334
 
            space-separated number of values, each of which is a
335
 
            number and a one-character suffix.  The suffix must be one
336
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
337
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
338
 
            minutes, hours, and weeks, respectively.  The values are
339
 
            added together to give the total time value, so all of
340
 
            <quote><literal>330s</literal></quote>,
341
 
            <quote><literal>110s 110s 110s</literal></quote>, and
342
 
            <quote><literal>5m 30s</literal></quote> will give a value
343
 
            of five minutes and thirty seconds.
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
 
      
348
 
      <varlistentry>
349
 
        <term><option>enabled<literal> = </literal>{ <literal
350
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
351
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
352
 
        >no</literal> | <literal>false</literal> | <literal
353
 
        >off</literal> }</option></term>
354
 
        <listitem>
355
 
          <para>
356
 
            Whether this client should be enabled by default.  The
357
 
            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.
358
262
          </para>
359
263
        </listitem>
360
264
      </varlistentry>
397
301
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
398
302
        ></quote> will be replaced by the value of the attribute
399
303
        <varname>foo</varname> of the internal
400
 
        <quote><classname>Client</classname></quote> object in the
401
 
        Mandos server.  The currently allowed values for
402
 
        <replaceable>foo</replaceable> are:
403
 
        <quote><literal>approval_delay</literal></quote>,
404
 
        <quote><literal>approval_duration</literal></quote>,
405
 
        <quote><literal>created</literal></quote>,
406
 
        <quote><literal>enabled</literal></quote>,
407
 
        <quote><literal>fingerprint</literal></quote>,
408
 
        <quote><literal>host</literal></quote>,
409
 
        <quote><literal>interval</literal></quote>,
410
 
        <quote><literal>last_approval_request</literal></quote>,
411
 
        <quote><literal>last_checked_ok</literal></quote>,
412
 
        <quote><literal>last_enabled</literal></quote>,
413
 
        <quote><literal>name</literal></quote>,
414
 
        <quote><literal>timeout</literal></quote>, and, if using
415
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
416
 
        See the source code for details.  <emphasis role="strong"
417
 
        >Currently, <emphasis>none</emphasis> of these attributes
418
 
        except <quote><literal>host</literal></quote> are guaranteed
419
 
        to be valid in future versions.</emphasis> Therefore, please
420
 
        let the authors know of any attributes that are useful so they
421
 
        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.
422
308
      </para>
423
309
      <para>
424
310
        Note that this means that, in order to include an actual
430
316
        mode is needed to expose an error of this kind.
431
317
      </para>
432
318
    </refsect2>
433
 
    
 
319
 
434
320
  </refsect1>
435
321
  
436
322
  <refsect1 id="files">
459
345
    <informalexample>
460
346
      <programlisting>
461
347
[DEFAULT]
462
 
timeout = 5m
463
 
interval = 2m
464
 
checker = fping -q -- %%(host)s
 
348
timeout = 1h
 
349
interval = 5m
 
350
checker = fping -q -- %(host)s
465
351
 
466
352
# Client "foo"
467
353
[foo]
490
376
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
491
377
secfile = /etc/mandos/bar-secret
492
378
timeout = 15m
493
 
approved_by_default = False
494
 
approval_delay = 30s
 
379
 
495
380
      </programlisting>
496
381
    </informalexample>
497
382
  </refsect1>
499
384
  <refsect1 id="see_also">
500
385
    <title>SEE ALSO</title>
501
386
    <para>
502
 
      <citerefentry><refentrytitle>intro</refentrytitle>
503
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
504
387
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
505
388
      <manvolnum>8</manvolnum></citerefentry>,
506
389
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>