/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

* Makefile (run-client): Add "--network-hook-dir" option.
* plugin-runner.c (main): Only try to work around Debian bug #633582
                          if started as root.
* plugins.d/mandos-client.c (run_network_hooks): Bug fix: Run all
                                                 network hooks, not
                                                 just the first one.
                                                 Also add debug output.
  (main): Only try to work around Debian bug #633582 or run network
          hooks as root if started as root.

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 "2019-02-09">
 
6
<!ENTITY TIMESTAMP "2011-10-10">
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>
46
39
      <holder>Teddy Hogeborn</holder>
47
40
      <holder>Björn Påhlsson</holder>
48
41
    </copyright>
72
65
      ><refentrytitle>mandos</refentrytitle>
73
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
74
67
      The file needs to list all clients that should be able to use
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.
 
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.
82
70
    </para>
83
71
    <para>
84
72
      The format starts with a <literal>[<replaceable>section
123
111
          <para>
124
112
            How long to wait for external approval before resorting to
125
113
            use the <option>approved_by_default</option> value.  The
126
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
127
115
          </para>
128
116
          <para>
129
117
            The format of <replaceable>TIME</replaceable> is the same
173
161
            This option is <emphasis>optional</emphasis>.
174
162
          </para>
175
163
          <para>
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>
 
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>
182
170
            <option>-c</option></command></quote>, so
183
171
            <varname>PATH</varname> will be searched.  The default
184
172
            value for the checker command is <quote><literal
185
173
            ><command>fping</command> <option>-q</option> <option
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
            >--</option> %%(host)s</literal></quote>.
193
175
          </para>
194
176
          <para>
195
177
            In addition to normal start time expansion, this option
232
214
          <para>
233
215
            This option sets the OpenPGP fingerprint that identifies
234
216
            the public key that clients authenticate themselves with
235
 
            through TLS.  The string needs to be in hexadecimal form,
236
 
            but spaces or upper/lower case are not significant.
237
 
          </para>
238
 
        </listitem>
239
 
      </varlistentry>
240
 
      
241
 
      <varlistentry>
242
 
        <term><option>key_id<literal> = </literal
243
 
        ><replaceable>HEXSTRING</replaceable></option></term>
244
 
        <listitem>
245
 
          <para>
246
 
            This option is <emphasis>optional</emphasis>.
247
 
          </para>
248
 
          <para>
249
 
            This option sets the certificate key ID that identifies
250
 
            the public key that clients authenticate themselves with
251
 
            through TLS.  The string needs to be in hexadecimal form,
 
217
            through TLS.  The string needs to be in hexidecimal form,
252
218
            but spaces or upper/lower case are not significant.
253
219
          </para>
254
220
        </listitem>
330
296
          <para>
331
297
            If present, this option must be set to a string of
332
298
            base64-encoded binary data.  It will be decoded and sent
333
 
            to the client matching the above <option>key_id</option>
334
 
            or <option>fingerprint</option>.  This should, of course,
335
 
            be OpenPGP encrypted data, decryptable only by the client.
 
299
            to the client matching the above
 
300
            <option>fingerprint</option>.  This should, of course, be
 
301
            OpenPGP encrypted data, decryptable only by the client.
336
302
            The program <citerefentry><refentrytitle><command
337
303
            >mandos-keygen</command></refentrytitle><manvolnum
338
304
            >8</manvolnum></citerefentry> can, using its
363
329
            <option>extended_timeout</option> option.
364
330
          </para>
365
331
          <para>
366
 
            The <replaceable>TIME</replaceable> is specified as an RFC
367
 
            3339 duration; for example
368
 
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
369
 
            one year, two months, three days, four hours, five
370
 
            minutes, and six seconds.  Some values can be omitted, see
371
 
            RFC 3339 Appendix A for details.
372
 
          </para>
373
 
        </listitem>
374
 
      </varlistentry>
375
 
      
376
 
      <varlistentry>
377
 
        <term><option>enabled<literal> = </literal>{ <literal
378
 
        >1</literal> | <literal>yes</literal> | <literal>true</literal
379
 
        > | <literal >on</literal> | <literal>0</literal> | <literal
380
 
        >no</literal> | <literal>false</literal> | <literal
381
 
        >off</literal> }</option></term>
382
 
        <listitem>
383
 
          <para>
384
 
            Whether this client should be enabled by default.  The
385
 
            default is <quote>true</quote>.
 
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.
386
343
          </para>
387
344
        </listitem>
388
345
      </varlistentry>
432
389
        <quote><literal>approval_duration</literal></quote>,
433
390
        <quote><literal>created</literal></quote>,
434
391
        <quote><literal>enabled</literal></quote>,
435
 
        <quote><literal>expires</literal></quote>,
436
 
        <quote><literal>key_id</literal></quote>,
437
392
        <quote><literal>fingerprint</literal></quote>,
438
393
        <quote><literal>host</literal></quote>,
439
394
        <quote><literal>interval</literal></quote>,
482
437
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
483
438
      obscure.
484
439
    </para>
485
 
    <xi:include href="bugs.xml"/>
486
440
  </refsect1>
487
441
  
488
442
  <refsect1 id="example">
490
444
    <informalexample>
491
445
      <programlisting>
492
446
[DEFAULT]
493
 
timeout = PT5M
494
 
interval = PT2M
 
447
timeout = 5m
 
448
interval = 2m
495
449
checker = fping -q -- %%(host)s
496
450
 
497
451
# Client "foo"
498
452
[foo]
499
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
500
453
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
501
454
secret =
502
455
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
515
468
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
516
469
        QlnHIvPzEArRQLo=
517
470
host = foo.example.org
518
 
interval = PT1M
 
471
interval = 1m
519
472
 
520
473
# Client "bar"
521
474
[bar]
522
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
523
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
524
476
secfile = /etc/mandos/bar-secret
525
 
timeout = PT15M
 
477
timeout = 15m
526
478
approved_by_default = False
527
 
approval_delay = PT30S
 
479
approval_delay = 30s
528
480
      </programlisting>
529
481
    </informalexample>
530
482
  </refsect1>
539
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
540
492
      <manvolnum>5</manvolnum></citerefentry>,
541
493
      <citerefentry><refentrytitle>mandos</refentrytitle>
542
 
      <manvolnum>8</manvolnum></citerefentry>,
543
 
      <citerefentry><refentrytitle>fping</refentrytitle>
544
494
      <manvolnum>8</manvolnum></citerefentry>
545
495
    </para>
546
 
    <variablelist>
547
 
      <varlistentry>
548
 
        <term>
549
 
          RFC 3339: <citetitle>Date and Time on the Internet:
550
 
          Timestamps</citetitle>
551
 
        </term>
552
 
      <listitem>
553
 
        <para>
554
 
          The time intervals are in the "duration" format, as
555
 
          specified in ABNF in Appendix A of RFC 3339.
556
 
        </para>
557
 
      </listitem>
558
 
      </varlistentry>
559
 
    </variablelist>
560
496
  </refsect1>
561
497
</refentry>
562
498
<!-- Local Variables: -->