/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: Björn Påhlsson
  • Date: 2011-10-02 13:45:45 UTC
  • mto: This revision was merged to the branch mainline in revision 505.
  • Revision ID: belorn@fukt.bsnet.se-20111002134545-oytmfbl15r8lsm6p
working transition code for going between se.bsnet.fukt to se.recompile

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 "2011-09-19">
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
206
190
          </para>
207
191
          <para>
208
192
            Extended timeout is an added timeout that is given once
209
 
            after a password has been sent successfully to a client.
 
193
            after a password has been sent sucessfully to a client.
210
194
            The timeout is by default longer than the normal timeout,
211
195
            and is used for handling the extra long downtime while a
212
196
            machine is booting up.  Time to take into consideration
230
214
          <para>
231
215
            This option sets the OpenPGP fingerprint that identifies
232
216
            the public key that clients authenticate themselves with
233
 
            through TLS.  The string needs to be in hexadecimal form,
 
217
            through TLS.  The string needs to be in hexidecimal form,
234
218
            but spaces or upper/lower case are not significant.
235
219
          </para>
236
220
        </listitem>
338
322
            This option is <emphasis>optional</emphasis>.
339
323
          </para>
340
324
          <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>.
 
325
            The timeout is how long the server will wait (for either a
 
326
            successful checker run or a client receiving its secret)
 
327
            until a client is disabled and not allowed to get the data
 
328
            this server holds.  By default Mandos will use 5 minutes.
 
329
          </para>
 
330
          <para>
 
331
            The <replaceable>TIME</replaceable> is specified as a
 
332
            space-separated number of values, each of which is a
 
333
            number and a one-character suffix.  The suffix must be one
 
334
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
335
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
336
            minutes, hours, and weeks, respectively.  The values are
 
337
            added together to give the total time value, so all of
 
338
            <quote><literal>330s</literal></quote>,
 
339
            <quote><literal>110s 110s 110s</literal></quote>, and
 
340
            <quote><literal>5m 30s</literal></quote> will give a value
 
341
            of five minutes and thirty seconds.
368
342
          </para>
369
343
        </listitem>
370
344
      </varlistentry>
414
388
        <quote><literal>approval_duration</literal></quote>,
415
389
        <quote><literal>created</literal></quote>,
416
390
        <quote><literal>enabled</literal></quote>,
417
 
        <quote><literal>expires</literal></quote>,
418
391
        <quote><literal>fingerprint</literal></quote>,
419
392
        <quote><literal>host</literal></quote>,
420
393
        <quote><literal>interval</literal></quote>,
463
436
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
464
437
      obscure.
465
438
    </para>
466
 
    <xi:include href="bugs.xml"/>
467
439
  </refsect1>
468
440
  
469
441
  <refsect1 id="example">
471
443
    <informalexample>
472
444
      <programlisting>
473
445
[DEFAULT]
474
 
timeout = PT5M
475
 
interval = PT2M
 
446
timeout = 5m
 
447
interval = 2m
476
448
checker = fping -q -- %%(host)s
477
449
 
478
450
# Client "foo"
495
467
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
496
468
        QlnHIvPzEArRQLo=
497
469
host = foo.example.org
498
 
interval = PT1M
 
470
interval = 1m
499
471
 
500
472
# Client "bar"
501
473
[bar]
502
474
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
503
475
secfile = /etc/mandos/bar-secret
504
 
timeout = PT15M
 
476
timeout = 15m
505
477
approved_by_default = False
506
 
approval_delay = PT30S
 
478
approval_delay = 30s
507
479
      </programlisting>
508
480
    </informalexample>
509
481
  </refsect1>
518
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
519
491
      <manvolnum>5</manvolnum></citerefentry>,
520
492
      <citerefentry><refentrytitle>mandos</refentrytitle>
521
 
      <manvolnum>8</manvolnum></citerefentry>,
522
 
      <citerefentry><refentrytitle>fping</refentrytitle>
523
493
      <manvolnum>8</manvolnum></citerefentry>
524
494
    </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
495
  </refsect1>
540
496
</refentry>
541
497
<!-- Local Variables: -->