/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: Björn Påhlsson
  • Date: 2011-10-02 19:18:24 UTC
  • mto: (237.7.53 trunk)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20111002191824-eweh4pvneeg3qzia
transitional stuff actually working
documented change to D-Bus API

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 "2019-02-10">
 
6
<!ENTITY TIMESTAMP "2011-09-19">
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@recompile.se</email>
 
23
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
30
          <email>teddy@fukt.bsnet.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>
47
39
      <holder>Teddy Hogeborn</holder>
48
40
      <holder>Björn Påhlsson</holder>
49
41
    </copyright>
73
65
      ><refentrytitle>mandos</refentrytitle>
74
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
67
      The file needs to list all clients that should be able to use
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.
 
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.
83
70
    </para>
84
71
    <para>
85
72
      The format starts with a <literal>[<replaceable>section
124
111
          <para>
125
112
            How long to wait for external approval before resorting to
126
113
            use the <option>approved_by_default</option> value.  The
127
 
            default is <quote>PT0S</quote>, i.e. not to wait.
 
114
            default is <quote>0s</quote>, i.e. not to wait.
128
115
          </para>
129
116
          <para>
130
117
            The format of <replaceable>TIME</replaceable> is the same
174
161
            This option is <emphasis>optional</emphasis>.
175
162
          </para>
176
163
          <para>
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>
 
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>
183
170
            <option>-c</option></command></quote>, so
184
171
            <varname>PATH</varname> will be searched.  The default
185
172
            value for the checker command is <quote><literal
186
173
            ><command>fping</command> <option>-q</option> <option
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.
 
174
            >--</option> %%(host)s</literal></quote>.
194
175
          </para>
195
176
          <para>
196
177
            In addition to normal start time expansion, this option
209
190
          </para>
210
191
          <para>
211
192
            Extended timeout is an added timeout that is given once
212
 
            after a password has been sent successfully to a client.
 
193
            after a password has been sent sucessfully to a client.
213
194
            The timeout is by default longer than the normal timeout,
214
195
            and is used for handling the extra long downtime while a
215
196
            machine is booting up.  Time to take into consideration
228
209
        ><replaceable>HEXSTRING</replaceable></option></term>
229
210
        <listitem>
230
211
          <para>
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.
 
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.
260
219
          </para>
261
220
        </listitem>
262
221
      </varlistentry>
337
296
          <para>
338
297
            If present, this option must be set to a string of
339
298
            base64-encoded binary data.  It will be decoded and sent
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.
 
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.
343
302
            The program <citerefentry><refentrytitle><command
344
303
            >mandos-keygen</command></refentrytitle><manvolnum
345
304
            >8</manvolnum></citerefentry> can, using its
363
322
            This option is <emphasis>optional</emphasis>.
364
323
          </para>
365
324
          <para>
366
 
            The timeout is how long the server will wait, after a
367
 
            successful checker run, until a client is disabled and not
368
 
            allowed to get the data this server holds.  By default
369
 
            Mandos will use 5 minutes.  See also the
370
 
            <option>extended_timeout</option> option.
371
 
          </para>
372
 
          <para>
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>.
 
325
            The timeout is how long the server will wait (for either a
 
326
            successful checker run or a client receiving its secret)
 
327
            until a client is disabled and not allowed to get the data
 
328
            this server holds.  By default Mandos will use 5 minutes.
 
329
          </para>
 
330
          <para>
 
331
            The <replaceable>TIME</replaceable> is specified as a
 
332
            space-separated number of values, each of which is a
 
333
            number and a one-character suffix.  The suffix must be one
 
334
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
 
335
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
 
336
            minutes, hours, and weeks, respectively.  The values are
 
337
            added together to give the total time value, so all of
 
338
            <quote><literal>330s</literal></quote>,
 
339
            <quote><literal>110s 110s 110s</literal></quote>, and
 
340
            <quote><literal>5m 30s</literal></quote> will give a value
 
341
            of five minutes and thirty seconds.
393
342
          </para>
394
343
        </listitem>
395
344
      </varlistentry>
439
388
        <quote><literal>approval_duration</literal></quote>,
440
389
        <quote><literal>created</literal></quote>,
441
390
        <quote><literal>enabled</literal></quote>,
442
 
        <quote><literal>expires</literal></quote>,
443
 
        <quote><literal>key_id</literal></quote>,
444
391
        <quote><literal>fingerprint</literal></quote>,
445
392
        <quote><literal>host</literal></quote>,
446
393
        <quote><literal>interval</literal></quote>,
489
436
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
490
437
      obscure.
491
438
    </para>
492
 
    <xi:include href="bugs.xml"/>
493
439
  </refsect1>
494
440
  
495
441
  <refsect1 id="example">
497
443
    <informalexample>
498
444
      <programlisting>
499
445
[DEFAULT]
500
 
timeout = PT5M
501
 
interval = PT2M
 
446
timeout = 5m
 
447
interval = 2m
502
448
checker = fping -q -- %%(host)s
503
449
 
504
450
# Client "foo"
505
451
[foo]
506
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
507
452
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
508
453
secret =
509
454
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
522
467
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
523
468
        QlnHIvPzEArRQLo=
524
469
host = foo.example.org
525
 
interval = PT1M
 
470
interval = 1m
526
471
 
527
472
# Client "bar"
528
473
[bar]
529
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
530
474
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
531
475
secfile = /etc/mandos/bar-secret
532
 
timeout = PT15M
 
476
timeout = 15m
533
477
approved_by_default = False
534
 
approval_delay = PT30S
 
478
approval_delay = 30s
535
479
      </programlisting>
536
480
    </informalexample>
537
481
  </refsect1>
546
490
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
547
491
      <manvolnum>5</manvolnum></citerefentry>,
548
492
      <citerefentry><refentrytitle>mandos</refentrytitle>
549
 
      <manvolnum>8</manvolnum></citerefentry>,
550
 
      <citerefentry><refentrytitle>fping</refentrytitle>
551
493
      <manvolnum>8</manvolnum></citerefentry>
552
494
    </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>
567
495
  </refsect1>
568
496
</refentry>
569
497
<!-- Local Variables: -->