/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-08-19 14:06:55 UTC
  • Revision ID: teddy@recompile.se-20180819140655-ghsl0d4jsx8xwg44
Move UMASK setting to more proper place

* Makefile (install-client-nokey): Also install new conf files
  "initramfs-tools-conf".
* debian/mandos-client.dirs: Add "usr/share/initramfs-tools/conf.d".
* initramfs-tools-conf: New file which sets UMASK.
* initramfs-tools-hook: Change comment to correctly state new location
  of UMASK setting.
* initramfs-tools-hook-conf: Remove UMASK setting.

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