/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: 2018-02-06 20:03:50 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20180206200350-jzvorueb731xkph3
Update Debian Debhelper compatibility version.

* (debian/compat): Change to "10".

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-02-27">
 
6
<!ENTITY TIMESTAMP "2017-02-23">
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@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.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>
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
182
199
      </varlistentry>
183
200
      
184
201
      <varlistentry>
 
202
        <term><option>extended_timeout<literal> = </literal><replaceable
 
203
        >TIME</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            This option is <emphasis>optional</emphasis>.
 
207
          </para>
 
208
          <para>
 
209
            Extended timeout is an added timeout that is given once
 
210
            after a password has been sent successfully to a client.
 
211
            The timeout is by default longer than the normal timeout,
 
212
            and is used for handling the extra long downtime while a
 
213
            machine is booting up.  Time to take into consideration
 
214
            when changing this value is file system checks and quota
 
215
            checks.  The default value is 15 minutes.
 
216
          </para>
 
217
          <para>
 
218
            The format of <replaceable>TIME</replaceable> is the same
 
219
            as for <varname>timeout</varname> below.
 
220
          </para>
 
221
        </listitem>
 
222
      </varlistentry>
 
223
      
 
224
      <varlistentry>
185
225
        <term><option>fingerprint<literal> = </literal
186
226
        ><replaceable>HEXSTRING</replaceable></option></term>
187
227
        <listitem>
191
231
          <para>
192
232
            This option sets the OpenPGP fingerprint that identifies
193
233
            the public key that clients authenticate themselves with
194
 
            through TLS.  The string needs to be in hexidecimal form,
 
234
            through TLS.  The string needs to be in hexadecimal form,
195
235
            but spaces or upper/lower case are not significant.
196
236
          </para>
197
237
        </listitem>
229
269
            will wait for a checker to complete until the below
230
270
            <quote><varname>timeout</varname></quote> occurs, at which
231
271
            time the client will be disabled, and any running checker
232
 
            killed.  The default interval is 5 minutes.
 
272
            killed.  The default interval is 2 minutes.
233
273
          </para>
234
274
          <para>
235
275
            The format of <replaceable>TIME</replaceable> is the same
299
339
            This option is <emphasis>optional</emphasis>.
300
340
          </para>
301
341
          <para>
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.
 
342
            The timeout is how long the server will wait, after a
 
343
            successful checker run, until a client is disabled and not
 
344
            allowed to get the data this server holds.  By default
 
345
            Mandos will use 5 minutes.  See also the
 
346
            <option>extended_timeout</option> option.
 
347
          </para>
 
348
          <para>
 
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>.
319
369
          </para>
320
370
        </listitem>
321
371
      </varlistentry>
365
415
        <quote><literal>approval_duration</literal></quote>,
366
416
        <quote><literal>created</literal></quote>,
367
417
        <quote><literal>enabled</literal></quote>,
 
418
        <quote><literal>expires</literal></quote>,
368
419
        <quote><literal>fingerprint</literal></quote>,
369
420
        <quote><literal>host</literal></quote>,
370
421
        <quote><literal>interval</literal></quote>,
413
464
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
414
465
      obscure.
415
466
    </para>
 
467
    <xi:include href="bugs.xml"/>
416
468
  </refsect1>
417
469
  
418
470
  <refsect1 id="example">
420
472
    <informalexample>
421
473
      <programlisting>
422
474
[DEFAULT]
423
 
timeout = 1h
424
 
interval = 5m
 
475
timeout = PT5M
 
476
interval = PT2M
425
477
checker = fping -q -- %%(host)s
426
478
 
427
479
# Client "foo"
444
496
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
445
497
        QlnHIvPzEArRQLo=
446
498
host = foo.example.org
447
 
interval = 1m
 
499
interval = PT1M
448
500
 
449
501
# Client "bar"
450
502
[bar]
451
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
452
504
secfile = /etc/mandos/bar-secret
453
 
timeout = 15m
 
505
timeout = PT15M
454
506
approved_by_default = False
455
 
approval_delay = 30s
 
507
approval_delay = PT30S
456
508
      </programlisting>
457
509
    </informalexample>
458
510
  </refsect1>
460
512
  <refsect1 id="see_also">
461
513
    <title>SEE ALSO</title>
462
514
    <para>
 
515
      <citerefentry><refentrytitle>intro</refentrytitle>
 
516
      <manvolnum>8mandos</manvolnum></citerefentry>,
463
517
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
464
518
      <manvolnum>8</manvolnum></citerefentry>,
465
519
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
466
520
      <manvolnum>5</manvolnum></citerefentry>,
467
521
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
522
      <manvolnum>8</manvolnum></citerefentry>,
 
523
      <citerefentry><refentrytitle>fping</refentrytitle>
468
524
      <manvolnum>8</manvolnum></citerefentry>
469
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>
470
540
  </refsect1>
471
541
</refentry>
472
542
<!-- Local Variables: -->