/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: 2015-12-05 02:00:01 UTC
  • mfrom: (237.4.61 release)
  • Revision ID: teddy@recompile.se-20151205020001-b0cpa52ame0usaul
Merge from release branch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-26">
 
6
<!ENTITY TIMESTAMP "2015-07-20">
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>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
 
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
38
43
      <holder>Teddy Hogeborn</holder>
39
44
      <holder>Björn Påhlsson</holder>
40
45
    </copyright>
64
69
      ><refentrytitle>mandos</refentrytitle>
65
70
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
71
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      even if a client was disabled in a previous run of the server.
 
72
      the service.  The settings in this file can be overridden by
 
73
      runtime changes to the server, which it saves across restarts.
 
74
      (See the section called <quote>PERSISTENT STATE</quote> in
 
75
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
76
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
77
      >changes</emphasis> to this file (including adding and removing
 
78
      clients) will, at startup, override changes done during runtime.
69
79
    </para>
70
80
    <para>
71
81
      The format starts with a <literal>[<replaceable>section
110
120
          <para>
111
121
            How long to wait for external approval before resorting to
112
122
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
 
123
            default is <quote>PT0S</quote>, i.e. not to wait.
114
124
          </para>
115
125
          <para>
116
126
            The format of <replaceable>TIME</replaceable> is the same
160
170
            This option is <emphasis>optional</emphasis>.
161
171
          </para>
162
172
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            run using <quote><command><filename>/bin/sh</filename>
 
173
            This option overrides the default shell command that the
 
174
            server will use to check if the client is still up.  Any
 
175
            output of the command will be ignored, only the exit code
 
176
            is checked:  If the exit code of the command is zero, the
 
177
            client is considered up.  The command will be run using
 
178
            <quote><command><filename>/bin/sh</filename>
169
179
            <option>-c</option></command></quote>, so
170
180
            <varname>PATH</varname> will be searched.  The default
171
181
            value for the checker command is <quote><literal
172
182
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
183
            >--</option> %%(host)s</literal></quote>.  Note that
 
184
            <command>mandos-keygen</command>, when generating output
 
185
            to be inserted into this file, normally looks for an SSH
 
186
            server on the Mandos client, and, if it find one, outputs
 
187
            a <option>checker</option> option to check for the
 
188
            client’s key fingerprint – this is more secure against
 
189
            spoofing.
174
190
          </para>
175
191
          <para>
176
192
            In addition to normal start time expansion, this option
181
197
      </varlistentry>
182
198
      
183
199
      <varlistentry>
 
200
        <term><option>extended_timeout<literal> = </literal><replaceable
 
201
        >TIME</replaceable></option></term>
 
202
        <listitem>
 
203
          <para>
 
204
            This option is <emphasis>optional</emphasis>.
 
205
          </para>
 
206
          <para>
 
207
            Extended timeout is an added timeout that is given once
 
208
            after a password has been sent successfully to a client.
 
209
            The timeout is by default longer than the normal timeout,
 
210
            and is used for handling the extra long downtime while a
 
211
            machine is booting up.  Time to take into consideration
 
212
            when changing this value is file system checks and quota
 
213
            checks.  The default value is 15 minutes.
 
214
          </para>
 
215
          <para>
 
216
            The format of <replaceable>TIME</replaceable> is the same
 
217
            as for <varname>timeout</varname> below.
 
218
          </para>
 
219
        </listitem>
 
220
      </varlistentry>
 
221
      
 
222
      <varlistentry>
184
223
        <term><option>fingerprint<literal> = </literal
185
224
        ><replaceable>HEXSTRING</replaceable></option></term>
186
225
        <listitem>
228
267
            will wait for a checker to complete until the below
229
268
            <quote><varname>timeout</varname></quote> occurs, at which
230
269
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
270
            killed.  The default interval is 2 minutes.
232
271
          </para>
233
272
          <para>
234
273
            The format of <replaceable>TIME</replaceable> is the same
298
337
            This option is <emphasis>optional</emphasis>.
299
338
          </para>
300
339
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
305
 
          </para>
306
 
          <para>
307
 
            The <replaceable>TIME</replaceable> is specified as a
308
 
            space-separated number of values, each of which is a
309
 
            number and a one-character suffix.  The suffix must be one
310
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
312
 
            minutes, hours, and weeks, respectively.  The values are
313
 
            added together to give the total time value, so all of
314
 
            <quote><literal>330s</literal></quote>,
315
 
            <quote><literal>110s 110s 110s</literal></quote>, and
316
 
            <quote><literal>5m 30s</literal></quote> will give a value
317
 
            of five minutes and thirty seconds.
 
340
            The timeout is how long the server will wait, after a
 
341
            successful checker run, until a client is disabled and not
 
342
            allowed to get the data this server holds.  By default
 
343
            Mandos will use 5 minutes.  See also the
 
344
            <option>extended_timeout</option> option.
 
345
          </para>
 
346
          <para>
 
347
            The <replaceable>TIME</replaceable> is specified as an RFC
 
348
            3339 duration; for example
 
349
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
350
            one year, two months, three days, four hours, five
 
351
            minutes, and six seconds.  Some values can be omitted, see
 
352
            RFC 3339 Appendix A for details.
 
353
          </para>
 
354
        </listitem>
 
355
      </varlistentry>
 
356
      
 
357
      <varlistentry>
 
358
        <term><option>enabled<literal> = </literal>{ <literal
 
359
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
360
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
361
        >no</literal> | <literal>false</literal> | <literal
 
362
        >off</literal> }</option></term>
 
363
        <listitem>
 
364
          <para>
 
365
            Whether this client should be enabled by default.  The
 
366
            default is <quote>true</quote>.
318
367
          </para>
319
368
        </listitem>
320
369
      </varlistentry>
364
413
        <quote><literal>approval_duration</literal></quote>,
365
414
        <quote><literal>created</literal></quote>,
366
415
        <quote><literal>enabled</literal></quote>,
 
416
        <quote><literal>expires</literal></quote>,
367
417
        <quote><literal>fingerprint</literal></quote>,
368
418
        <quote><literal>host</literal></quote>,
369
419
        <quote><literal>interval</literal></quote>,
419
469
    <informalexample>
420
470
      <programlisting>
421
471
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
472
timeout = PT5M
 
473
interval = PT2M
424
474
checker = fping -q -- %%(host)s
425
475
 
426
476
# Client "foo"
443
493
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
444
494
        QlnHIvPzEArRQLo=
445
495
host = foo.example.org
446
 
interval = 1m
 
496
interval = PT1M
447
497
 
448
498
# Client "bar"
449
499
[bar]
450
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
501
secfile = /etc/mandos/bar-secret
452
 
timeout = 15m
 
502
timeout = PT15M
453
503
approved_by_default = False
454
 
approval_delay = 30s
 
504
approval_delay = PT30S
455
505
      </programlisting>
456
506
    </informalexample>
457
507
  </refsect1>
459
509
  <refsect1 id="see_also">
460
510
    <title>SEE ALSO</title>
461
511
    <para>
 
512
      <citerefentry><refentrytitle>intro</refentrytitle>
 
513
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
514
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
515
      <manvolnum>8</manvolnum></citerefentry>,
464
516
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
517
      <manvolnum>5</manvolnum></citerefentry>,
466
518
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
519
      <manvolnum>8</manvolnum></citerefentry>,
 
520
      <citerefentry><refentrytitle>fping</refentrytitle>
467
521
      <manvolnum>8</manvolnum></citerefentry>
468
522
    </para>
 
523
    <variablelist>
 
524
      <varlistentry>
 
525
        <term>
 
526
          RFC 3339: <citetitle>Date and Time on the Internet:
 
527
          Timestamps</citetitle>
 
528
        </term>
 
529
      <listitem>
 
530
        <para>
 
531
          The time intervals are in the "duration" format, as
 
532
          specified in ABNF in Appendix A of RFC 3339.
 
533
        </para>
 
534
      </listitem>
 
535
      </varlistentry>
 
536
    </variablelist>
469
537
  </refsect1>
470
538
</refentry>
471
539
<!-- Local Variables: -->