/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

* INSTALL: Updated.

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