/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: 2010-10-07 18:42:26 UTC
  • mto: (237.4.29 release)
  • mto: This revision was merged to the branch mainline in revision 457.
  • Revision ID: teddy@fukt.bsnet.se-20101007184226-yl55rd8g1t64t9nj
Tags: version-1.2.2-1
* Makefile (version): Changed to "1.2.2".
* NEWS (Version 1.2.2): New entry.
* debian/changelog (1.2.2-1): - '' -

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 "2017-02-23">
 
6
<!ENTITY TIMESTAMP "2010-09-26">
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@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.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>
43
 
      <year>2016</year>
44
 
      <year>2017</year>
45
38
      <holder>Teddy Hogeborn</holder>
46
39
      <holder>Björn Påhlsson</holder>
47
40
    </copyright>
71
64
      ><refentrytitle>mandos</refentrytitle>
72
65
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
73
66
      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.
 
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.
81
69
    </para>
82
70
    <para>
83
71
      The format starts with a <literal>[<replaceable>section
122
110
          <para>
123
111
            How long to wait for external approval before resorting to
124
112
            use the <option>approved_by_default</option> value.  The
125
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
113
            default is <quote>0s</quote>, i.e. not to wait.
126
114
          </para>
127
115
          <para>
128
116
            The format of <replaceable>TIME</replaceable> is the same
172
160
            This option is <emphasis>optional</emphasis>.
173
161
          </para>
174
162
          <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>
 
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>
181
169
            <option>-c</option></command></quote>, so
182
170
            <varname>PATH</varname> will be searched.  The default
183
171
            value for the checker command is <quote><literal
184
172
            ><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.
 
173
            >--</option> %%(host)s</literal></quote>.
192
174
          </para>
193
175
          <para>
194
176
            In addition to normal start time expansion, this option
199
181
      </varlistentry>
200
182
      
201
183
      <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
184
        <term><option>fingerprint<literal> = </literal
226
185
        ><replaceable>HEXSTRING</replaceable></option></term>
227
186
        <listitem>
231
190
          <para>
232
191
            This option sets the OpenPGP fingerprint that identifies
233
192
            the public key that clients authenticate themselves with
234
 
            through TLS.  The string needs to be in hexadecimal form,
 
193
            through TLS.  The string needs to be in hexidecimal form,
235
194
            but spaces or upper/lower case are not significant.
236
195
          </para>
237
196
        </listitem>
269
228
            will wait for a checker to complete until the below
270
229
            <quote><varname>timeout</varname></quote> occurs, at which
271
230
            time the client will be disabled, and any running checker
272
 
            killed.  The default interval is 2 minutes.
 
231
            killed.  The default interval is 5 minutes.
273
232
          </para>
274
233
          <para>
275
234
            The format of <replaceable>TIME</replaceable> is the same
339
298
            This option is <emphasis>optional</emphasis>.
340
299
          </para>
341
300
          <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>.
 
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.
369
318
          </para>
370
319
        </listitem>
371
320
      </varlistentry>
415
364
        <quote><literal>approval_duration</literal></quote>,
416
365
        <quote><literal>created</literal></quote>,
417
366
        <quote><literal>enabled</literal></quote>,
418
 
        <quote><literal>expires</literal></quote>,
419
367
        <quote><literal>fingerprint</literal></quote>,
420
368
        <quote><literal>host</literal></quote>,
421
369
        <quote><literal>interval</literal></quote>,
464
412
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
465
413
      obscure.
466
414
    </para>
467
 
    <xi:include href="bugs.xml"/>
468
415
  </refsect1>
469
416
  
470
417
  <refsect1 id="example">
472
419
    <informalexample>
473
420
      <programlisting>
474
421
[DEFAULT]
475
 
timeout = PT5M
476
 
interval = PT2M
 
422
timeout = 1h
 
423
interval = 5m
477
424
checker = fping -q -- %%(host)s
478
425
 
479
426
# Client "foo"
496
443
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
497
444
        QlnHIvPzEArRQLo=
498
445
host = foo.example.org
499
 
interval = PT1M
 
446
interval = 1m
500
447
 
501
448
# Client "bar"
502
449
[bar]
503
450
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
504
451
secfile = /etc/mandos/bar-secret
505
 
timeout = PT15M
 
452
timeout = 15m
506
453
approved_by_default = False
507
 
approval_delay = PT30S
 
454
approval_delay = 30s
508
455
      </programlisting>
509
456
    </informalexample>
510
457
  </refsect1>
512
459
  <refsect1 id="see_also">
513
460
    <title>SEE ALSO</title>
514
461
    <para>
515
 
      <citerefentry><refentrytitle>intro</refentrytitle>
516
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
517
462
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
518
463
      <manvolnum>8</manvolnum></citerefentry>,
519
464
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
520
465
      <manvolnum>5</manvolnum></citerefentry>,
521
466
      <citerefentry><refentrytitle>mandos</refentrytitle>
522
 
      <manvolnum>8</manvolnum></citerefentry>,
523
 
      <citerefentry><refentrytitle>fping</refentrytitle>
524
467
      <manvolnum>8</manvolnum></citerefentry>
525
468
    </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
469
  </refsect1>
541
470
</refentry>
542
471
<!-- Local Variables: -->