/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: 2018-02-12 17:07:19 UTC
  • mfrom: (365 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 366.
  • Revision ID: teddy@recompile.se-20180212170719-pg26c4ob584d3xls
Merge from release branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY CONFNAME "mandos-clients.conf">
5
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2010-09-25">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
20
20
        <firstname>Björn</firstname>
21
21
        <surname>Påhlsson</surname>
22
22
        <address>
23
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
24
24
        </address>
25
25
      </author>
26
26
      <author>
27
27
        <firstname>Teddy</firstname>
28
28
        <surname>Hogeborn</surname>
29
29
        <address>
30
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
31
31
        </address>
32
32
      </author>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
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>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
63
72
      ><refentrytitle>mandos</refentrytitle>
64
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
74
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
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.
68
82
    </para>
69
83
    <para>
70
84
      The format starts with a <literal>[<replaceable>section
109
123
          <para>
110
124
            How long to wait for external approval before resorting to
111
125
            use the <option>approved_by_default</option> value.  The
112
 
            default is <quote>0s</quote>, i.e. not to wait.
 
126
            default is <quote>PT0S</quote>, i.e. not to wait.
113
127
          </para>
114
128
          <para>
115
129
            The format of <replaceable>TIME</replaceable> is the same
159
173
            This option is <emphasis>optional</emphasis>.
160
174
          </para>
161
175
          <para>
162
 
            This option allows you to override the default shell
163
 
            command that the server will use to check if the client is
164
 
            still up.  Any output of the command will be ignored, only
165
 
            the exit code is checked:  If the exit code of the command
166
 
            is zero, the client is considered up.  The command will be
167
 
            run using <quote><command><filename>/bin/sh</filename>
 
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>
168
182
            <option>-c</option></command></quote>, so
169
183
            <varname>PATH</varname> will be searched.  The default
170
184
            value for the checker command is <quote><literal
171
185
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
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.
173
193
          </para>
174
194
          <para>
175
195
            In addition to normal start time expansion, this option
180
200
      </varlistentry>
181
201
      
182
202
      <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>
183
226
        <term><option>fingerprint<literal> = </literal
184
227
        ><replaceable>HEXSTRING</replaceable></option></term>
185
228
        <listitem>
189
232
          <para>
190
233
            This option sets the OpenPGP fingerprint that identifies
191
234
            the public key that clients authenticate themselves with
192
 
            through TLS.  The string needs to be in hexidecimal form,
 
235
            through TLS.  The string needs to be in hexadecimal form,
193
236
            but spaces or upper/lower case are not significant.
194
237
          </para>
195
238
        </listitem>
227
270
            will wait for a checker to complete until the below
228
271
            <quote><varname>timeout</varname></quote> occurs, at which
229
272
            time the client will be disabled, and any running checker
230
 
            killed.  The default interval is 5 minutes.
 
273
            killed.  The default interval is 2 minutes.
231
274
          </para>
232
275
          <para>
233
276
            The format of <replaceable>TIME</replaceable> is the same
297
340
            This option is <emphasis>optional</emphasis>.
298
341
          </para>
299
342
          <para>
300
 
            The timeout is how long the server will wait (for either a
301
 
            successful checker run or a client receiving its secret)
302
 
            until a client is disabled and not allowed to get the data
303
 
            this server holds.  By default Mandos will use 1 hour.
304
 
          </para>
305
 
          <para>
306
 
            The <replaceable>TIME</replaceable> is specified as a
307
 
            space-separated number of values, each of which is a
308
 
            number and a one-character suffix.  The suffix must be one
309
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
310
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
311
 
            minutes, hours, and weeks, respectively.  The values are
312
 
            added together to give the total time value, so all of
313
 
            <quote><literal>330s</literal></quote>,
314
 
            <quote><literal>110s 110s 110s</literal></quote>, and
315
 
            <quote><literal>5m 30s</literal></quote> will give a value
316
 
            of five minutes and thirty seconds.
 
343
            The timeout is how long the server will wait, after a
 
344
            successful checker run, until a client is disabled and not
 
345
            allowed to get the data this server holds.  By default
 
346
            Mandos will use 5 minutes.  See also the
 
347
            <option>extended_timeout</option> option.
 
348
          </para>
 
349
          <para>
 
350
            The <replaceable>TIME</replaceable> is specified as an RFC
 
351
            3339 duration; for example
 
352
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
353
            one year, two months, three days, four hours, five
 
354
            minutes, and six seconds.  Some values can be omitted, see
 
355
            RFC 3339 Appendix A for details.
 
356
          </para>
 
357
        </listitem>
 
358
      </varlistentry>
 
359
      
 
360
      <varlistentry>
 
361
        <term><option>enabled<literal> = </literal>{ <literal
 
362
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
363
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
364
        >no</literal> | <literal>false</literal> | <literal
 
365
        >off</literal> }</option></term>
 
366
        <listitem>
 
367
          <para>
 
368
            Whether this client should be enabled by default.  The
 
369
            default is <quote>true</quote>.
317
370
          </para>
318
371
        </listitem>
319
372
      </varlistentry>
356
409
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
357
410
        ></quote> will be replaced by the value of the attribute
358
411
        <varname>foo</varname> of the internal
359
 
        <quote><classname>Client</classname></quote> object.  See the
360
 
        source code for details, and let the authors know of any
361
 
        attributes that are useful so they may be preserved to any new
362
 
        versions of this software.
 
412
        <quote><classname>Client</classname></quote> object in the
 
413
        Mandos server.  The currently allowed values for
 
414
        <replaceable>foo</replaceable> are:
 
415
        <quote><literal>approval_delay</literal></quote>,
 
416
        <quote><literal>approval_duration</literal></quote>,
 
417
        <quote><literal>created</literal></quote>,
 
418
        <quote><literal>enabled</literal></quote>,
 
419
        <quote><literal>expires</literal></quote>,
 
420
        <quote><literal>fingerprint</literal></quote>,
 
421
        <quote><literal>host</literal></quote>,
 
422
        <quote><literal>interval</literal></quote>,
 
423
        <quote><literal>last_approval_request</literal></quote>,
 
424
        <quote><literal>last_checked_ok</literal></quote>,
 
425
        <quote><literal>last_enabled</literal></quote>,
 
426
        <quote><literal>name</literal></quote>,
 
427
        <quote><literal>timeout</literal></quote>, and, if using
 
428
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
429
        See the source code for details.  <emphasis role="strong"
 
430
        >Currently, <emphasis>none</emphasis> of these attributes
 
431
        except <quote><literal>host</literal></quote> are guaranteed
 
432
        to be valid in future versions.</emphasis> Therefore, please
 
433
        let the authors know of any attributes that are useful so they
 
434
        may be preserved to any new versions of this software.
363
435
      </para>
364
436
      <para>
365
437
        Note that this means that, in order to include an actual
393
465
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
394
466
      obscure.
395
467
    </para>
 
468
    <xi:include href="bugs.xml"/>
396
469
  </refsect1>
397
470
  
398
471
  <refsect1 id="example">
400
473
    <informalexample>
401
474
      <programlisting>
402
475
[DEFAULT]
403
 
timeout = 1h
404
 
interval = 5m
 
476
timeout = PT5M
 
477
interval = PT2M
405
478
checker = fping -q -- %%(host)s
406
479
 
407
480
# Client "foo"
424
497
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
425
498
        QlnHIvPzEArRQLo=
426
499
host = foo.example.org
427
 
interval = 1m
 
500
interval = PT1M
428
501
 
429
502
# Client "bar"
430
503
[bar]
431
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
432
505
secfile = /etc/mandos/bar-secret
433
 
timeout = 15m
 
506
timeout = PT15M
434
507
approved_by_default = False
435
 
approval_delay = 30s
 
508
approval_delay = PT30S
436
509
      </programlisting>
437
510
    </informalexample>
438
511
  </refsect1>
440
513
  <refsect1 id="see_also">
441
514
    <title>SEE ALSO</title>
442
515
    <para>
 
516
      <citerefentry><refentrytitle>intro</refentrytitle>
 
517
      <manvolnum>8mandos</manvolnum></citerefentry>,
443
518
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
444
519
      <manvolnum>8</manvolnum></citerefentry>,
445
520
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
446
521
      <manvolnum>5</manvolnum></citerefentry>,
447
522
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
523
      <manvolnum>8</manvolnum></citerefentry>,
 
524
      <citerefentry><refentrytitle>fping</refentrytitle>
448
525
      <manvolnum>8</manvolnum></citerefentry>
449
526
    </para>
 
527
    <variablelist>
 
528
      <varlistentry>
 
529
        <term>
 
530
          RFC 3339: <citetitle>Date and Time on the Internet:
 
531
          Timestamps</citetitle>
 
532
        </term>
 
533
      <listitem>
 
534
        <para>
 
535
          The time intervals are in the "duration" format, as
 
536
          specified in ABNF in Appendix A of RFC 3339.
 
537
        </para>
 
538
      </listitem>
 
539
      </varlistentry>
 
540
    </variablelist>
450
541
  </refsect1>
451
542
</refentry>
452
543
<!-- Local Variables: -->