/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: 2016-02-28 14:22:10 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228142210-2df89dih7mzxxr0h
Update copyright year.

* DBUS-API: Update copyright year.
* debian/copyright: - '' -
* intro.xml (COPYRIGHT): - '' -
* mandos: - '' -
* mandos-clients.conf.xml (COPYRIGHT): - '' -
* mandos-ctl: - '' -
* mandos-ctl.xml (COPYRIGHT): - '' -
* mandos-keygen: - '' -
* mandos-keygen.xml (COPYRIGHT): - '' -
* mandos-monitor: - '' -
* mandos-monitor.xml (COPYRIGHT): - '' -
* mandos.conf.xml (COPYRIGHT): - '' -
* mandos.xml (COPYRIGHT): - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugin-runner.xml (COPYRIGHT): - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/askpass-fifo.xml (COPYRIGHT): - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/mandos-client.xml (COPYRIGHT): - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/password-prompt.xml (COPYRIGHT): - ''
* plugins.d/plymouth.c: - '' -
* plugins.d/plymouth.xml (COPYRIGHT): - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/splashy.xml (COPYRIGHT): - '' -
* plugins.d/usplash.c: - '' -
* plugins.d/usplash.xml (COPYRIGHT): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
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-11-26">
 
6
<!ENTITY TIMESTAMP "2016-02-28">
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>
39
44
      <holder>Teddy Hogeborn</holder>
40
45
      <holder>Björn Påhlsson</holder>
41
46
    </copyright>
65
70
      ><refentrytitle>mandos</refentrytitle>
66
71
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
72
      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.
 
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.
70
80
    </para>
71
81
    <para>
72
82
      The format starts with a <literal>[<replaceable>section
111
121
          <para>
112
122
            How long to wait for external approval before resorting to
113
123
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
124
            default is <quote>PT0S</quote>, i.e. not to wait.
115
125
          </para>
116
126
          <para>
117
127
            The format of <replaceable>TIME</replaceable> is the same
161
171
            This option is <emphasis>optional</emphasis>.
162
172
          </para>
163
173
          <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>
 
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>
170
180
            <option>-c</option></command></quote>, so
171
181
            <varname>PATH</varname> will be searched.  The default
172
182
            value for the checker command is <quote><literal
173
183
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
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.
175
191
          </para>
176
192
          <para>
177
193
            In addition to normal start time expansion, this option
329
345
            <option>extended_timeout</option> option.
330
346
          </para>
331
347
          <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.
 
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.
343
354
          </para>
344
355
        </listitem>
345
356
      </varlistentry>
403
414
        <quote><literal>approval_duration</literal></quote>,
404
415
        <quote><literal>created</literal></quote>,
405
416
        <quote><literal>enabled</literal></quote>,
 
417
        <quote><literal>expires</literal></quote>,
406
418
        <quote><literal>fingerprint</literal></quote>,
407
419
        <quote><literal>host</literal></quote>,
408
420
        <quote><literal>interval</literal></quote>,
458
470
    <informalexample>
459
471
      <programlisting>
460
472
[DEFAULT]
461
 
timeout = 5m
462
 
interval = 2m
 
473
timeout = PT5M
 
474
interval = PT2M
463
475
checker = fping -q -- %%(host)s
464
476
 
465
477
# Client "foo"
482
494
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
483
495
        QlnHIvPzEArRQLo=
484
496
host = foo.example.org
485
 
interval = 1m
 
497
interval = PT1M
486
498
 
487
499
# Client "bar"
488
500
[bar]
489
501
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
490
502
secfile = /etc/mandos/bar-secret
491
 
timeout = 15m
 
503
timeout = PT15M
492
504
approved_by_default = False
493
 
approval_delay = 30s
 
505
approval_delay = PT30S
494
506
      </programlisting>
495
507
    </informalexample>
496
508
  </refsect1>
505
517
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
506
518
      <manvolnum>5</manvolnum></citerefentry>,
507
519
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
520
      <manvolnum>8</manvolnum></citerefentry>,
 
521
      <citerefentry><refentrytitle>fping</refentrytitle>
508
522
      <manvolnum>8</manvolnum></citerefentry>
509
523
    </para>
 
524
    <variablelist>
 
525
      <varlistentry>
 
526
        <term>
 
527
          RFC 3339: <citetitle>Date and Time on the Internet:
 
528
          Timestamps</citetitle>
 
529
        </term>
 
530
      <listitem>
 
531
        <para>
 
532
          The time intervals are in the "duration" format, as
 
533
          specified in ABNF in Appendix A of RFC 3339.
 
534
        </para>
 
535
      </listitem>
 
536
      </varlistentry>
 
537
    </variablelist>
510
538
  </refsect1>
511
539
</refentry>
512
540
<!-- Local Variables: -->