/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: 2024-09-12 02:53:43 UTC
  • Revision ID: teddy@recompile.se-20240912025343-05elzcldczplvk89
Ignore some more files

* .bzrignore: Ignore "cl", which is used to temporarily save the
  commit message.  Ignore the .mypy_cache directories.  Ignore
  *.c.local files which are used by the tools to sort #include
  directives and associated comments.

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-09-24">
 
6
<!ENTITY TIMESTAMP "2019-02-10">
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>
 
45
      <year>2018</year>
 
46
      <year>2019</year>
39
47
      <holder>Teddy Hogeborn</holder>
40
48
      <holder>Björn Påhlsson</holder>
41
49
    </copyright>
65
73
      ><refentrytitle>mandos</refentrytitle>
66
74
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
75
      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.
 
76
      the service.  The settings in this file can be overridden by
 
77
      runtime changes to the server, which it saves across restarts.
 
78
      (See the section called <quote>PERSISTENT STATE</quote> in
 
79
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
80
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
81
      >changes</emphasis> to this file (including adding and removing
 
82
      clients) will, at startup, override changes done during runtime.
70
83
    </para>
71
84
    <para>
72
85
      The format starts with a <literal>[<replaceable>section
111
124
          <para>
112
125
            How long to wait for external approval before resorting to
113
126
            use the <option>approved_by_default</option> value.  The
114
 
            default is <quote>0s</quote>, i.e. not to wait.
 
127
            default is <quote>PT0S</quote>, i.e. not to wait.
115
128
          </para>
116
129
          <para>
117
130
            The format of <replaceable>TIME</replaceable> is the same
161
174
            This option is <emphasis>optional</emphasis>.
162
175
          </para>
163
176
          <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>
 
177
            This option overrides the default shell command that the
 
178
            server will use to check if the client is still up.  Any
 
179
            output of the command will be ignored, only the exit code
 
180
            is checked:  If the exit code of the command is zero, the
 
181
            client is considered up.  The command will be run using
 
182
            <quote><command><filename>/bin/sh</filename>
170
183
            <option>-c</option></command></quote>, so
171
184
            <varname>PATH</varname> will be searched.  The default
172
185
            value for the checker command is <quote><literal
173
186
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
187
            >--</option> %%(host)s</literal></quote>.  Note that
 
188
            <command>mandos-keygen</command>, when generating output
 
189
            to be inserted into this file, normally looks for an SSH
 
190
            server on the Mandos client, and, if it finds one, outputs
 
191
            a <option>checker</option> option to check for the
 
192
            client’s SSH key fingerprint – this is more secure against
 
193
            spoofing.
175
194
          </para>
176
195
          <para>
177
196
            In addition to normal start time expansion, this option
190
209
          </para>
191
210
          <para>
192
211
            Extended timeout is an added timeout that is given once
193
 
            after a password has been sent sucessfully to a client.
 
212
            after a password has been sent successfully to a client.
194
213
            The timeout is by default longer than the normal timeout,
195
214
            and is used for handling the extra long downtime while a
196
215
            machine is booting up.  Time to take into consideration
209
228
        ><replaceable>HEXSTRING</replaceable></option></term>
210
229
        <listitem>
211
230
          <para>
212
 
            This option is <emphasis>required</emphasis>.
213
 
          </para>
214
 
          <para>
215
 
            This option sets the OpenPGP fingerprint that identifies
216
 
            the public key that clients authenticate themselves with
217
 
            through TLS.  The string needs to be in hexidecimal form,
218
 
            but spaces or upper/lower case are not significant.
 
231
            This option is <emphasis>required</emphasis> if the
 
232
            <option>key_id</option> is not set, and
 
233
            <emphasis>optional</emphasis> otherwise.
 
234
          </para>
 
235
          <para>
 
236
            This option sets the OpenPGP fingerprint that (before
 
237
            GnuTLS 3.6.0) identified the public key that clients
 
238
            authenticate themselves with through TLS.  The string
 
239
            needs to be in hexadecimal form, but spaces or upper/lower
 
240
            case are not significant.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
      
 
245
      <varlistentry>
 
246
        <term><option>key_id<literal> = </literal
 
247
        ><replaceable>HEXSTRING</replaceable></option></term>
 
248
        <listitem>
 
249
          <para>
 
250
            This option is <emphasis>required</emphasis> if the
 
251
            <option>fingerprint</option> is not set, and
 
252
            <emphasis>optional</emphasis> otherwise.
 
253
          </para>
 
254
          <para>
 
255
            This option sets the certificate key ID that (with GnuTLS
 
256
            3.6.6 or later) identifies the public key that clients
 
257
            authenticate themselves with through TLS.  The string
 
258
            needs to be in hexadecimal form, but spaces or upper/lower
 
259
            case are not significant.
219
260
          </para>
220
261
        </listitem>
221
262
      </varlistentry>
296
337
          <para>
297
338
            If present, this option must be set to a string of
298
339
            base64-encoded binary data.  It will be decoded and sent
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.
 
340
            to the client matching the above <option>key_id</option>
 
341
            or <option>fingerprint</option>.  This should, of course,
 
342
            be OpenPGP encrypted data, decryptable only by the client.
302
343
            The program <citerefentry><refentrytitle><command
303
344
            >mandos-keygen</command></refentrytitle><manvolnum
304
345
            >8</manvolnum></citerefentry> can, using its
329
370
            <option>extended_timeout</option> option.
330
371
          </para>
331
372
          <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.
 
373
            The <replaceable>TIME</replaceable> is specified as an RFC
 
374
            3339 duration; for example
 
375
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
376
            one year, two months, three days, four hours, five
 
377
            minutes, and six seconds.  Some values can be omitted, see
 
378
            RFC 3339 Appendix A for details.
 
379
          </para>
 
380
        </listitem>
 
381
      </varlistentry>
 
382
      
 
383
      <varlistentry>
 
384
        <term><option>enabled<literal> = </literal>{ <literal
 
385
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
386
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
387
        >no</literal> | <literal>false</literal> | <literal
 
388
        >off</literal> }</option></term>
 
389
        <listitem>
 
390
          <para>
 
391
            Whether this client should be enabled by default.  The
 
392
            default is <quote>true</quote>.
343
393
          </para>
344
394
        </listitem>
345
395
      </varlistentry>
389
439
        <quote><literal>approval_duration</literal></quote>,
390
440
        <quote><literal>created</literal></quote>,
391
441
        <quote><literal>enabled</literal></quote>,
 
442
        <quote><literal>expires</literal></quote>,
 
443
        <quote><literal>key_id</literal></quote>,
392
444
        <quote><literal>fingerprint</literal></quote>,
393
445
        <quote><literal>host</literal></quote>,
394
446
        <quote><literal>interval</literal></quote>,
437
489
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
438
490
      obscure.
439
491
    </para>
 
492
    <xi:include href="bugs.xml"/>
440
493
  </refsect1>
441
494
  
442
495
  <refsect1 id="example">
444
497
    <informalexample>
445
498
      <programlisting>
446
499
[DEFAULT]
447
 
timeout = 5m
448
 
interval = 2m
 
500
timeout = PT5M
 
501
interval = PT2M
449
502
checker = fping -q -- %%(host)s
450
503
 
451
504
# Client "foo"
452
505
[foo]
 
506
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
453
507
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
454
508
secret =
455
509
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
468
522
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
523
        QlnHIvPzEArRQLo=
470
524
host = foo.example.org
471
 
interval = 1m
 
525
interval = PT1M
472
526
 
473
527
# Client "bar"
474
528
[bar]
 
529
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
475
530
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
476
531
secfile = /etc/mandos/bar-secret
477
 
timeout = 15m
 
532
timeout = PT15M
478
533
approved_by_default = False
479
 
approval_delay = 30s
 
534
approval_delay = PT30S
480
535
      </programlisting>
481
536
    </informalexample>
482
537
  </refsect1>
491
546
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
547
      <manvolnum>5</manvolnum></citerefentry>,
493
548
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
549
      <manvolnum>8</manvolnum></citerefentry>,
 
550
      <citerefentry><refentrytitle>fping</refentrytitle>
494
551
      <manvolnum>8</manvolnum></citerefentry>
495
552
    </para>
 
553
    <variablelist>
 
554
      <varlistentry>
 
555
        <term>
 
556
          RFC 3339: <citetitle>Date and Time on the Internet:
 
557
          Timestamps</citetitle>
 
558
        </term>
 
559
      <listitem>
 
560
        <para>
 
561
          The time intervals are in the "duration" format, as
 
562
          specified in ABNF in Appendix A of RFC 3339.
 
563
        </para>
 
564
      </listitem>
 
565
      </varlistentry>
 
566
    </variablelist>
496
567
  </refsect1>
497
568
</refentry>
498
569
<!-- Local Variables: -->