/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: 2017-08-20 16:23:14 UTC
  • Revision ID: teddy@recompile.se-20170820162314-hcvb6auvbm0mlppk
Use the https form of the Format URL in debian/copyright.

* debian/copyright (Format): Use https in URL.

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 "2011-10-03">
 
6
<!ENTITY TIMESTAMP "2017-02-23">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
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>
39
45
      <holder>Teddy Hogeborn</holder>
40
46
      <holder>Björn Påhlsson</holder>
41
47
    </copyright>
65
71
      ><refentrytitle>mandos</refentrytitle>
66
72
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
73
      The file needs to list all clients that should be able to use
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.
 
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.
70
81
    </para>
71
82
    <para>
72
83
      The format starts with a <literal>[<replaceable>section
111
122
          <para>
112
123
            How long to wait for external approval before resorting to
113
124
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
125
            default is <quote>PT0S</quote>, i.e. not to wait.
115
126
          </para>
116
127
          <para>
117
128
            The format of <replaceable>TIME</replaceable> is the same
161
172
            This option is <emphasis>optional</emphasis>.
162
173
          </para>
163
174
          <para>
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>
 
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>
170
181
            <option>-c</option></command></quote>, so
171
182
            <varname>PATH</varname> will be searched.  The default
172
183
            value for the checker command is <quote><literal
173
184
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
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.
175
192
          </para>
176
193
          <para>
177
194
            In addition to normal start time expansion, this option
190
207
          </para>
191
208
          <para>
192
209
            Extended timeout is an added timeout that is given once
193
 
            after a password has been sent sucessfully to a client.
 
210
            after a password has been sent successfully to a client.
194
211
            The timeout is by default longer than the normal timeout,
195
212
            and is used for handling the extra long downtime while a
196
213
            machine is booting up.  Time to take into consideration
214
231
          <para>
215
232
            This option sets the OpenPGP fingerprint that identifies
216
233
            the public key that clients authenticate themselves with
217
 
            through TLS.  The string needs to be in hexidecimal form,
 
234
            through TLS.  The string needs to be in hexadecimal form,
218
235
            but spaces or upper/lower case are not significant.
219
236
          </para>
220
237
        </listitem>
329
346
            <option>extended_timeout</option> option.
330
347
          </para>
331
348
          <para>
332
 
            The <replaceable>TIME</replaceable> is specified as a
333
 
            space-separated number of values, each of which is a
334
 
            number and a one-character suffix.  The suffix must be one
335
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
 
            minutes, hours, and weeks, respectively.  The values are
338
 
            added together to give the total time value, so all of
339
 
            <quote><literal>330s</literal></quote>,
340
 
            <quote><literal>110s 110s 110s</literal></quote>, and
341
 
            <quote><literal>5m 30s</literal></quote> will give a value
342
 
            of five minutes and thirty seconds.
 
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>.
343
369
          </para>
344
370
        </listitem>
345
371
      </varlistentry>
389
415
        <quote><literal>approval_duration</literal></quote>,
390
416
        <quote><literal>created</literal></quote>,
391
417
        <quote><literal>enabled</literal></quote>,
 
418
        <quote><literal>expires</literal></quote>,
392
419
        <quote><literal>fingerprint</literal></quote>,
393
420
        <quote><literal>host</literal></quote>,
394
421
        <quote><literal>interval</literal></quote>,
437
464
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
438
465
      obscure.
439
466
    </para>
 
467
    <xi:include href="bugs.xml"/>
440
468
  </refsect1>
441
469
  
442
470
  <refsect1 id="example">
444
472
    <informalexample>
445
473
      <programlisting>
446
474
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
475
timeout = PT5M
 
476
interval = PT2M
449
477
checker = fping -q -- %%(host)s
450
478
 
451
479
# Client "foo"
468
496
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
497
        QlnHIvPzEArRQLo=
470
498
host = foo.example.org
471
 
interval = 1m
 
499
interval = PT1M
472
500
 
473
501
# Client "bar"
474
502
[bar]
475
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
476
504
secfile = /etc/mandos/bar-secret
477
 
timeout = 15m
 
505
timeout = PT15M
478
506
approved_by_default = False
479
 
approval_delay = 30s
 
507
approval_delay = PT30S
480
508
      </programlisting>
481
509
    </informalexample>
482
510
  </refsect1>
491
519
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
520
      <manvolnum>5</manvolnum></citerefentry>,
493
521
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
522
      <manvolnum>8</manvolnum></citerefentry>,
 
523
      <citerefentry><refentrytitle>fping</refentrytitle>
494
524
      <manvolnum>8</manvolnum></citerefentry>
495
525
    </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>
496
540
  </refsect1>
497
541
</refentry>
498
542
<!-- Local Variables: -->