/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: 2018-02-18 01:29:21 UTC
  • Revision ID: teddy@recompile.se-20180218012921-itiazxid50ycv77o
Correct comments

* plugin-helpers/mandos-client-iprouteadddel.c: Comment change only.

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 "2010-09-26">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
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>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
37
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
      <year>2017</year>
 
45
      <year>2018</year>
38
46
      <holder>Teddy Hogeborn</holder>
39
47
      <holder>Björn Påhlsson</holder>
40
48
    </copyright>
64
72
      ><refentrytitle>mandos</refentrytitle>
65
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
74
      The file needs to list all clients that should be able to use
67
 
      the service.  All clients listed will be regarded as enabled,
68
 
      even if a client was disabled in a previous run of the server.
 
75
      the service.  The settings in this file can be overridden by
 
76
      runtime changes to the server, which it saves across restarts.
 
77
      (See the section called <quote>PERSISTENT STATE</quote> in
 
78
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
79
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
80
      >changes</emphasis> to this file (including adding and removing
 
81
      clients) will, at startup, override changes done during runtime.
69
82
    </para>
70
83
    <para>
71
84
      The format starts with a <literal>[<replaceable>section
110
123
          <para>
111
124
            How long to wait for external approval before resorting to
112
125
            use the <option>approved_by_default</option> value.  The
113
 
            default is <quote>0s</quote>, i.e. not to wait.
 
126
            default is <quote>PT0S</quote>, i.e. not to wait.
114
127
          </para>
115
128
          <para>
116
129
            The format of <replaceable>TIME</replaceable> is the same
160
173
            This option is <emphasis>optional</emphasis>.
161
174
          </para>
162
175
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            run using <quote><command><filename>/bin/sh</filename>
 
176
            This option overrides the default shell command that the
 
177
            server will use to check if the client is still up.  Any
 
178
            output of the command will be ignored, only the exit code
 
179
            is checked:  If the exit code of the command is zero, the
 
180
            client is considered up.  The command will be run using
 
181
            <quote><command><filename>/bin/sh</filename>
169
182
            <option>-c</option></command></quote>, so
170
183
            <varname>PATH</varname> will be searched.  The default
171
184
            value for the checker command is <quote><literal
172
185
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
186
            >--</option> %%(host)s</literal></quote>.  Note that
 
187
            <command>mandos-keygen</command>, when generating output
 
188
            to be inserted into this file, normally looks for an SSH
 
189
            server on the Mandos client, and, if it find one, outputs
 
190
            a <option>checker</option> option to check for the
 
191
            client’s key fingerprint – this is more secure against
 
192
            spoofing.
174
193
          </para>
175
194
          <para>
176
195
            In addition to normal start time expansion, this option
181
200
      </varlistentry>
182
201
      
183
202
      <varlistentry>
 
203
        <term><option>extended_timeout<literal> = </literal><replaceable
 
204
        >TIME</replaceable></option></term>
 
205
        <listitem>
 
206
          <para>
 
207
            This option is <emphasis>optional</emphasis>.
 
208
          </para>
 
209
          <para>
 
210
            Extended timeout is an added timeout that is given once
 
211
            after a password has been sent successfully to a client.
 
212
            The timeout is by default longer than the normal timeout,
 
213
            and is used for handling the extra long downtime while a
 
214
            machine is booting up.  Time to take into consideration
 
215
            when changing this value is file system checks and quota
 
216
            checks.  The default value is 15 minutes.
 
217
          </para>
 
218
          <para>
 
219
            The format of <replaceable>TIME</replaceable> is the same
 
220
            as for <varname>timeout</varname> below.
 
221
          </para>
 
222
        </listitem>
 
223
      </varlistentry>
 
224
      
 
225
      <varlistentry>
184
226
        <term><option>fingerprint<literal> = </literal
185
227
        ><replaceable>HEXSTRING</replaceable></option></term>
186
228
        <listitem>
190
232
          <para>
191
233
            This option sets the OpenPGP fingerprint that identifies
192
234
            the public key that clients authenticate themselves with
193
 
            through TLS.  The string needs to be in hexidecimal form,
 
235
            through TLS.  The string needs to be in hexadecimal form,
194
236
            but spaces or upper/lower case are not significant.
195
237
          </para>
196
238
        </listitem>
228
270
            will wait for a checker to complete until the below
229
271
            <quote><varname>timeout</varname></quote> occurs, at which
230
272
            time the client will be disabled, and any running checker
231
 
            killed.  The default interval is 5 minutes.
 
273
            killed.  The default interval is 2 minutes.
232
274
          </para>
233
275
          <para>
234
276
            The format of <replaceable>TIME</replaceable> is the same
298
340
            This option is <emphasis>optional</emphasis>.
299
341
          </para>
300
342
          <para>
301
 
            The timeout is how long the server will wait (for either a
302
 
            successful checker run or a client receiving its secret)
303
 
            until a client is disabled and not allowed to get the data
304
 
            this server holds.  By default Mandos will use 1 hour.
305
 
          </para>
306
 
          <para>
307
 
            The <replaceable>TIME</replaceable> is specified as a
308
 
            space-separated number of values, each of which is a
309
 
            number and a one-character suffix.  The suffix must be one
310
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
312
 
            minutes, hours, and weeks, respectively.  The values are
313
 
            added together to give the total time value, so all of
314
 
            <quote><literal>330s</literal></quote>,
315
 
            <quote><literal>110s 110s 110s</literal></quote>, and
316
 
            <quote><literal>5m 30s</literal></quote> will give a value
317
 
            of five minutes and thirty seconds.
 
343
            The timeout is how long the server will wait, after a
 
344
            successful checker run, until a client is disabled and not
 
345
            allowed to get the data this server holds.  By default
 
346
            Mandos will use 5 minutes.  See also the
 
347
            <option>extended_timeout</option> option.
 
348
          </para>
 
349
          <para>
 
350
            The <replaceable>TIME</replaceable> is specified as an RFC
 
351
            3339 duration; for example
 
352
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
353
            one year, two months, three days, four hours, five
 
354
            minutes, and six seconds.  Some values can be omitted, see
 
355
            RFC 3339 Appendix A for details.
 
356
          </para>
 
357
        </listitem>
 
358
      </varlistentry>
 
359
      
 
360
      <varlistentry>
 
361
        <term><option>enabled<literal> = </literal>{ <literal
 
362
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
363
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
364
        >no</literal> | <literal>false</literal> | <literal
 
365
        >off</literal> }</option></term>
 
366
        <listitem>
 
367
          <para>
 
368
            Whether this client should be enabled by default.  The
 
369
            default is <quote>true</quote>.
318
370
          </para>
319
371
        </listitem>
320
372
      </varlistentry>
364
416
        <quote><literal>approval_duration</literal></quote>,
365
417
        <quote><literal>created</literal></quote>,
366
418
        <quote><literal>enabled</literal></quote>,
 
419
        <quote><literal>expires</literal></quote>,
367
420
        <quote><literal>fingerprint</literal></quote>,
368
421
        <quote><literal>host</literal></quote>,
369
422
        <quote><literal>interval</literal></quote>,
412
465
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
413
466
      obscure.
414
467
    </para>
 
468
    <xi:include href="bugs.xml"/>
415
469
  </refsect1>
416
470
  
417
471
  <refsect1 id="example">
419
473
    <informalexample>
420
474
      <programlisting>
421
475
[DEFAULT]
422
 
timeout = 1h
423
 
interval = 5m
 
476
timeout = PT5M
 
477
interval = PT2M
424
478
checker = fping -q -- %%(host)s
425
479
 
426
480
# Client "foo"
443
497
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
444
498
        QlnHIvPzEArRQLo=
445
499
host = foo.example.org
446
 
interval = 1m
 
500
interval = PT1M
447
501
 
448
502
# Client "bar"
449
503
[bar]
450
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
451
505
secfile = /etc/mandos/bar-secret
452
 
timeout = 15m
 
506
timeout = PT15M
453
507
approved_by_default = False
454
 
approval_delay = 30s
 
508
approval_delay = PT30S
455
509
      </programlisting>
456
510
    </informalexample>
457
511
  </refsect1>
459
513
  <refsect1 id="see_also">
460
514
    <title>SEE ALSO</title>
461
515
    <para>
 
516
      <citerefentry><refentrytitle>intro</refentrytitle>
 
517
      <manvolnum>8mandos</manvolnum></citerefentry>,
462
518
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
463
519
      <manvolnum>8</manvolnum></citerefentry>,
464
520
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
465
521
      <manvolnum>5</manvolnum></citerefentry>,
466
522
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
523
      <manvolnum>8</manvolnum></citerefentry>,
 
524
      <citerefentry><refentrytitle>fping</refentrytitle>
467
525
      <manvolnum>8</manvolnum></citerefentry>
468
526
    </para>
 
527
    <variablelist>
 
528
      <varlistentry>
 
529
        <term>
 
530
          RFC 3339: <citetitle>Date and Time on the Internet:
 
531
          Timestamps</citetitle>
 
532
        </term>
 
533
      <listitem>
 
534
        <para>
 
535
          The time intervals are in the "duration" format, as
 
536
          specified in ABNF in Appendix A of RFC 3339.
 
537
        </para>
 
538
      </listitem>
 
539
      </varlistentry>
 
540
    </variablelist>
469
541
  </refsect1>
470
542
</refentry>
471
543
<!-- Local Variables: -->