/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: 2011-03-08 19:12:56 UTC
  • mfrom: (237.7.20 trunk)
  • Revision ID: teddy@fukt.bsnet.se-20110308191256-mjcukty9on3z0yhd
Merge from trunk.

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