/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 01:29:53 UTC
  • mto: This revision was merged to the branch mainline in revision 794.
  • Revision ID: teddy@recompile.se-20151205012953-oi5hosp5yqhrmudh
Tags: version-1.7.1-2
* debian/changelog (1.7.1-2): New entry.

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 "2011-02-27">
 
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>
36
36
      <year>2009</year>
37
37
      <year>2010</year>
38
38
      <year>2011</year>
 
39
      <year>2012</year>
 
40
      <year>2013</year>
 
41
      <year>2014</year>
 
42
      <year>2015</year>
39
43
      <holder>Teddy Hogeborn</holder>
40
44
      <holder>Björn Påhlsson</holder>
41
45
    </copyright>
65
69
      ><refentrytitle>mandos</refentrytitle>
66
70
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
71
      The file needs to list all clients that should be able to use
68
 
      the service.  All clients listed will be regarded as enabled,
69
 
      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.
70
79
    </para>
71
80
    <para>
72
81
      The format starts with a <literal>[<replaceable>section
111
120
          <para>
112
121
            How long to wait for external approval before resorting to
113
122
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
123
            default is <quote>PT0S</quote>, i.e. not to wait.
115
124
          </para>
116
125
          <para>
117
126
            The format of <replaceable>TIME</replaceable> is the same
161
170
            This option is <emphasis>optional</emphasis>.
162
171
          </para>
163
172
          <para>
164
 
            This option allows you to override the default shell
165
 
            command that the server will use to check if the client is
166
 
            still up.  Any output of the command will be ignored, only
167
 
            the exit code is checked:  If the exit code of the command
168
 
            is zero, the client is considered up.  The command will be
169
 
            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>
170
179
            <option>-c</option></command></quote>, so
171
180
            <varname>PATH</varname> will be searched.  The default
172
181
            value for the checker command is <quote><literal
173
182
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</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.
175
190
          </para>
176
191
          <para>
177
192
            In addition to normal start time expansion, this option
182
197
      </varlistentry>
183
198
      
184
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>
185
223
        <term><option>fingerprint<literal> = </literal
186
224
        ><replaceable>HEXSTRING</replaceable></option></term>
187
225
        <listitem>
229
267
            will wait for a checker to complete until the below
230
268
            <quote><varname>timeout</varname></quote> occurs, at which
231
269
            time the client will be disabled, and any running checker
232
 
            killed.  The default interval is 5 minutes.
 
270
            killed.  The default interval is 2 minutes.
233
271
          </para>
234
272
          <para>
235
273
            The format of <replaceable>TIME</replaceable> is the same
299
337
            This option is <emphasis>optional</emphasis>.
300
338
          </para>
301
339
          <para>
302
 
            The timeout is how long the server will wait (for either a
303
 
            successful checker run or a client receiving its secret)
304
 
            until a client is disabled and not allowed to get the data
305
 
            this server holds.  By default Mandos will use 1 hour.
306
 
          </para>
307
 
          <para>
308
 
            The <replaceable>TIME</replaceable> is specified as a
309
 
            space-separated number of values, each of which is a
310
 
            number and a one-character suffix.  The suffix must be one
311
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
312
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
313
 
            minutes, hours, and weeks, respectively.  The values are
314
 
            added together to give the total time value, so all of
315
 
            <quote><literal>330s</literal></quote>,
316
 
            <quote><literal>110s 110s 110s</literal></quote>, and
317
 
            <quote><literal>5m 30s</literal></quote> will give a value
318
 
            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>.
319
367
          </para>
320
368
        </listitem>
321
369
      </varlistentry>
365
413
        <quote><literal>approval_duration</literal></quote>,
366
414
        <quote><literal>created</literal></quote>,
367
415
        <quote><literal>enabled</literal></quote>,
 
416
        <quote><literal>expires</literal></quote>,
368
417
        <quote><literal>fingerprint</literal></quote>,
369
418
        <quote><literal>host</literal></quote>,
370
419
        <quote><literal>interval</literal></quote>,
420
469
    <informalexample>
421
470
      <programlisting>
422
471
[DEFAULT]
423
 
timeout = 1h
424
 
interval = 5m
 
472
timeout = PT5M
 
473
interval = PT2M
425
474
checker = fping -q -- %%(host)s
426
475
 
427
476
# Client "foo"
444
493
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
445
494
        QlnHIvPzEArRQLo=
446
495
host = foo.example.org
447
 
interval = 1m
 
496
interval = PT1M
448
497
 
449
498
# Client "bar"
450
499
[bar]
451
500
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
452
501
secfile = /etc/mandos/bar-secret
453
 
timeout = 15m
 
502
timeout = PT15M
454
503
approved_by_default = False
455
 
approval_delay = 30s
 
504
approval_delay = PT30S
456
505
      </programlisting>
457
506
    </informalexample>
458
507
  </refsect1>
460
509
  <refsect1 id="see_also">
461
510
    <title>SEE ALSO</title>
462
511
    <para>
 
512
      <citerefentry><refentrytitle>intro</refentrytitle>
 
513
      <manvolnum>8mandos</manvolnum></citerefentry>,
463
514
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
515
      <manvolnum>8</manvolnum></citerefentry>,
465
516
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
466
517
      <manvolnum>5</manvolnum></citerefentry>,
467
518
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
519
      <manvolnum>8</manvolnum></citerefentry>,
 
520
      <citerefentry><refentrytitle>fping</refentrytitle>
468
521
      <manvolnum>8</manvolnum></citerefentry>
469
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>
470
537
  </refsect1>
471
538
</refentry>
472
539
<!-- Local Variables: -->