/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 07:32:05 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831073205-9hggg03i1iird264
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
* mandos.xml (SYNOPSIS): - '' -
* plugins.d/password-prompt.xml (SYNOPSIS): - '' -
* plugins.d/password-request.xml (SYNOPSIS): - '' -

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