/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-09-25 23:52:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100925235217-4hhqfryz1ste6uw3
* mandos (ClientDBus.__init__): Bug fix: Translate "-" in client names
                                to "_" in D-Bus object paths.
  (MandosServer.handle_ipc): Bug fix: Send only address string to
                             D-Bus signal, not whole tuple.

* mandos-ctl: New options "--approve-by-default", "--deny-by-default",
              "--approval-delay", and "--approval-duration".
* mandos-ctl.xml (SYNOPSIS, OPTIONS): Document new options.

* mandos-monitor (MandosClientWidget.update): Fix spelling.

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-06-23">
 
6
<!ENTITY TIMESTAMP "2010-09-25">
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>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
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
37
      <holder>Teddy Hogeborn</holder>
45
38
      <holder>Björn Påhlsson</holder>
46
39
    </copyright>
70
63
      ><refentrytitle>mandos</refentrytitle>
71
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
72
65
      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.
 
66
      the service.  All clients listed will be regarded as enabled,
 
67
      even if a client was disabled in a previous run of the server.
80
68
    </para>
81
69
    <para>
82
70
      The format starts with a <literal>[<replaceable>section
121
109
          <para>
122
110
            How long to wait for external approval before resorting to
123
111
            use the <option>approved_by_default</option> value.  The
124
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
112
            default is <quote>0s</quote>, i.e. not to wait.
125
113
          </para>
126
114
          <para>
127
115
            The format of <replaceable>TIME</replaceable> is the same
171
159
            This option is <emphasis>optional</emphasis>.
172
160
          </para>
173
161
          <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>
 
162
            This option allows you to override the default shell
 
163
            command that the server will use to check if the client is
 
164
            still up.  Any output of the command will be ignored, only
 
165
            the exit code is checked:  If the exit code of the command
 
166
            is zero, the client is considered up.  The command will be
 
167
            run using <quote><command><filename>/bin/sh</filename>
180
168
            <option>-c</option></command></quote>, so
181
169
            <varname>PATH</varname> will be searched.  The default
182
170
            value for the checker command is <quote><literal
183
171
            ><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.
 
172
            >--</option> %%(host)s</literal></quote>.
191
173
          </para>
192
174
          <para>
193
175
            In addition to normal start time expansion, this option
198
180
      </varlistentry>
199
181
      
200
182
      <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
183
        <term><option>fingerprint<literal> = </literal
225
184
        ><replaceable>HEXSTRING</replaceable></option></term>
226
185
        <listitem>
230
189
          <para>
231
190
            This option sets the OpenPGP fingerprint that identifies
232
191
            the public key that clients authenticate themselves with
233
 
            through TLS.  The string needs to be in hexadecimal form,
 
192
            through TLS.  The string needs to be in hexidecimal form,
234
193
            but spaces or upper/lower case are not significant.
235
194
          </para>
236
195
        </listitem>
268
227
            will wait for a checker to complete until the below
269
228
            <quote><varname>timeout</varname></quote> occurs, at which
270
229
            time the client will be disabled, and any running checker
271
 
            killed.  The default interval is 2 minutes.
 
230
            killed.  The default interval is 5 minutes.
272
231
          </para>
273
232
          <para>
274
233
            The format of <replaceable>TIME</replaceable> is the same
338
297
            This option is <emphasis>optional</emphasis>.
339
298
          </para>
340
299
          <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>.
 
300
            The timeout is how long the server will wait (for either a
 
301
            successful checker run or a client receiving its secret)
 
302
            until a client is disabled and not allowed to get the data
 
303
            this server holds.  By default Mandos will use 1 hour.
 
304
          </para>
 
305
          <para>
 
306
            The <replaceable>TIME</replaceable> is specified as a
 
307
            space-separated number of values, each of which is a
 
308
            number and a one-character suffix.  The suffix must be one
 
309
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
310
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
311
            minutes, hours, and weeks, respectively.  The values are
 
312
            added together to give the total time value, so all of
 
313
            <quote><literal>330s</literal></quote>,
 
314
            <quote><literal>110s 110s 110s</literal></quote>, and
 
315
            <quote><literal>5m 30s</literal></quote> will give a value
 
316
            of five minutes and thirty seconds.
368
317
          </para>
369
318
        </listitem>
370
319
      </varlistentry>
407
356
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
408
357
        ></quote> will be replaced by the value of the attribute
409
358
        <varname>foo</varname> of the internal
410
 
        <quote><classname>Client</classname></quote> object in the
411
 
        Mandos server.  The currently allowed values for
412
 
        <replaceable>foo</replaceable> are:
413
 
        <quote><literal>approval_delay</literal></quote>,
414
 
        <quote><literal>approval_duration</literal></quote>,
415
 
        <quote><literal>created</literal></quote>,
416
 
        <quote><literal>enabled</literal></quote>,
417
 
        <quote><literal>expires</literal></quote>,
418
 
        <quote><literal>fingerprint</literal></quote>,
419
 
        <quote><literal>host</literal></quote>,
420
 
        <quote><literal>interval</literal></quote>,
421
 
        <quote><literal>last_approval_request</literal></quote>,
422
 
        <quote><literal>last_checked_ok</literal></quote>,
423
 
        <quote><literal>last_enabled</literal></quote>,
424
 
        <quote><literal>name</literal></quote>,
425
 
        <quote><literal>timeout</literal></quote>, and, if using
426
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
427
 
        See the source code for details.  <emphasis role="strong"
428
 
        >Currently, <emphasis>none</emphasis> of these attributes
429
 
        except <quote><literal>host</literal></quote> are guaranteed
430
 
        to be valid in future versions.</emphasis> Therefore, please
431
 
        let the authors know of any attributes that are useful so they
432
 
        may be preserved to any new versions of this software.
 
359
        <quote><classname>Client</classname></quote> object.  See the
 
360
        source code for details, and let the authors know of any
 
361
        attributes that are useful so they may be preserved to any new
 
362
        versions of this software.
433
363
      </para>
434
364
      <para>
435
365
        Note that this means that, in order to include an actual
463
393
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
464
394
      obscure.
465
395
    </para>
466
 
    <xi:include href="bugs.xml"/>
467
396
  </refsect1>
468
397
  
469
398
  <refsect1 id="example">
471
400
    <informalexample>
472
401
      <programlisting>
473
402
[DEFAULT]
474
 
timeout = PT5M
475
 
interval = PT2M
 
403
timeout = 1h
 
404
interval = 5m
476
405
checker = fping -q -- %%(host)s
477
406
 
478
407
# Client "foo"
495
424
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
496
425
        QlnHIvPzEArRQLo=
497
426
host = foo.example.org
498
 
interval = PT1M
 
427
interval = 1m
499
428
 
500
429
# Client "bar"
501
430
[bar]
502
431
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
503
432
secfile = /etc/mandos/bar-secret
504
 
timeout = PT15M
 
433
timeout = 15m
505
434
approved_by_default = False
506
 
approval_delay = PT30S
 
435
approval_delay = 30s
507
436
      </programlisting>
508
437
    </informalexample>
509
438
  </refsect1>
511
440
  <refsect1 id="see_also">
512
441
    <title>SEE ALSO</title>
513
442
    <para>
514
 
      <citerefentry><refentrytitle>intro</refentrytitle>
515
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
516
443
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
517
444
      <manvolnum>8</manvolnum></citerefentry>,
518
445
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
519
446
      <manvolnum>5</manvolnum></citerefentry>,
520
447
      <citerefentry><refentrytitle>mandos</refentrytitle>
521
 
      <manvolnum>8</manvolnum></citerefentry>,
522
 
      <citerefentry><refentrytitle>fping</refentrytitle>
523
448
      <manvolnum>8</manvolnum></citerefentry>
524
449
    </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
450
  </refsect1>
540
451
</refentry>
541
452
<!-- Local Variables: -->