/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: 2019-02-10 03:54:09 UTC
  • Revision ID: teddy@recompile.se-20190210035409-l2mqp2ftzkggwybz
Do minor fix to make mandos-monitor work with new python-urwid

* mandos-monitor (UserInterface.log): Initialize to an
                                      urwid.SimpleListWalker([]), not
                                      an empty list.
  (UserInterface.log_message_raw): Fix off-by-one error.

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 "2009-09-17">
 
6
<!ENTITY TIMESTAMP "2019-02-09">
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>
34
34
    <copyright>
35
35
      <year>2008</year>
36
36
      <year>2009</year>
 
37
      <year>2010</year>
 
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>
37
46
      <holder>Teddy Hogeborn</holder>
38
47
      <holder>Björn Påhlsson</holder>
39
48
    </copyright>
63
72
      ><refentrytitle>mandos</refentrytitle>
64
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
74
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as valid, even
67
 
      if a client was declared invalid in a previous run of the
68
 
      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.
69
82
    </para>
70
83
    <para>
71
84
      The format starts with a <literal>[<replaceable>section
101
114
    <variablelist>
102
115
      
103
116
      <varlistentry>
104
 
        <term><option>timeout<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
106
 
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
110
 
          <para>
111
 
            The timeout is how long the server will wait (for either a
112
 
            successful checker run or a client receiving its secret)
113
 
            until a client is considered invalid - that is, ineligible
114
 
            to get the data this server holds.  By default Mandos will
115
 
            use 1 hour.
116
 
          </para>
117
 
          <para>
118
 
            The <replaceable>TIME</replaceable> is specified as a
119
 
            space-separated number of values, each of which is a
120
 
            number and a one-character suffix.  The suffix must be one
121
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
122
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
123
 
            minutes, hours, and weeks, respectively.  The values are
124
 
            added together to give the total time value, so all of
125
 
            <quote><literal>330s</literal></quote>,
126
 
            <quote><literal>110s 110s 110s</literal></quote>, and
127
 
            <quote><literal>5m 30s</literal></quote> will give a value
128
 
            of five minutes and thirty seconds.
129
 
          </para>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
      
133
 
      <varlistentry>
134
 
        <term><option>interval<literal> = </literal><replaceable
135
 
        >TIME</replaceable></option></term>
136
 
        <listitem>
137
 
          <para>
138
 
            This option is <emphasis>optional</emphasis>.
139
 
          </para>
140
 
          <para>
141
 
            How often to run the checker to confirm that a client is
142
 
            still up.  <emphasis>Note:</emphasis> a new checker will
143
 
            not be started if an old one is still running.  The server
144
 
            will wait for a checker to complete until the above
145
 
            <quote><varname>timeout</varname></quote> occurs, at which
146
 
            time the client will be marked invalid, and any running
147
 
            checker killed.  The default interval is 5 minutes.
148
 
          </para>
149
 
          <para>
150
 
            The format of <replaceable>TIME</replaceable> is the same
151
 
            as for <varname>timeout</varname> above.
 
117
        <term><option>approval_delay<literal> = </literal><replaceable
 
118
        >TIME</replaceable></option></term>
 
119
        <listitem>
 
120
          <para>
 
121
            This option is <emphasis>optional</emphasis>.
 
122
          </para>
 
123
          <para>
 
124
            How long to wait for external approval before resorting to
 
125
            use the <option>approved_by_default</option> value.  The
 
126
            default is <quote>PT0S</quote>, i.e. not to wait.
 
127
          </para>
 
128
          <para>
 
129
            The format of <replaceable>TIME</replaceable> is the same
 
130
            as for <varname>timeout</varname> below.
 
131
          </para>
 
132
        </listitem>
 
133
      </varlistentry>
 
134
      
 
135
      <varlistentry>
 
136
        <term><option>approval_duration<literal> = </literal
 
137
        ><replaceable>TIME</replaceable></option></term>
 
138
        <listitem>
 
139
          <para>
 
140
            This option is <emphasis>optional</emphasis>.
 
141
          </para>
 
142
          <para>
 
143
            How long an external approval lasts.  The default is 1
 
144
            second.
 
145
          </para>
 
146
          <para>
 
147
            The format of <replaceable>TIME</replaceable> is the same
 
148
            as for <varname>timeout</varname> below.
 
149
          </para>
 
150
        </listitem>
 
151
      </varlistentry>
 
152
      
 
153
      <varlistentry>
 
154
        <term><option>approved_by_default<literal> = </literal
 
155
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
156
          >true</literal> | <literal>on</literal> | <literal
 
157
          >0</literal> | <literal>no</literal> | <literal
 
158
          >false</literal> | <literal>off</literal> }</option></term>
 
159
        <listitem>
 
160
          <para>
 
161
            Whether to approve a client by default after
 
162
            the <option>approval_delay</option>.  The default
 
163
            is <quote>True</quote>.
152
164
          </para>
153
165
        </listitem>
154
166
      </varlistentry>
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 finds one, outputs
 
190
            a <option>checker</option> option to check for the
 
191
            client’s SSH 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
182
200
      </varlistentry>
183
201
      
184
202
      <varlistentry>
 
203
        <term><option>extended_timeout<literal> = </literal><replaceable
 
204
        >TIME</replaceable></option></term>
 
205
        <listitem>
 
206
          <para>
 
207
            This option is <emphasis>optional</emphasis>.
 
208
          </para>
 
209
          <para>
 
210
            Extended timeout is an added timeout that is given once
 
211
            after a password has been sent successfully to a client.
 
212
            The timeout is by default longer than the normal timeout,
 
213
            and is used for handling the extra long downtime while a
 
214
            machine is booting up.  Time to take into consideration
 
215
            when changing this value is file system checks and quota
 
216
            checks.  The default value is 15 minutes.
 
217
          </para>
 
218
          <para>
 
219
            The format of <replaceable>TIME</replaceable> is the same
 
220
            as for <varname>timeout</varname> below.
 
221
          </para>
 
222
        </listitem>
 
223
      </varlistentry>
 
224
      
 
225
      <varlistentry>
185
226
        <term><option>fingerprint<literal> = </literal
186
227
        ><replaceable>HEXSTRING</replaceable></option></term>
187
228
        <listitem>
191
232
          <para>
192
233
            This option sets the OpenPGP fingerprint that identifies
193
234
            the public key that clients authenticate themselves with
194
 
            through TLS.  The string needs to be in hexidecimal form,
195
 
            but spaces or upper/lower case are not significant.
 
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,
 
252
            but spaces or upper/lower case are not significant.
 
253
          </para>
 
254
        </listitem>
 
255
      </varlistentry>
 
256
      
 
257
      <varlistentry>
 
258
        <term><option><literal>host = </literal><replaceable
 
259
        >STRING</replaceable></option></term>
 
260
        <listitem>
 
261
          <para>
 
262
            This option is <emphasis>optional</emphasis>, but highly
 
263
            <emphasis>recommended</emphasis> unless the
 
264
            <option>checker</option> option is modified to a
 
265
            non-standard value without <quote>%%(host)s</quote> in it.
 
266
          </para>
 
267
          <para>
 
268
            Host name for this client.  This is not used by the server
 
269
            directly, but can be, and is by default, used by the
 
270
            checker.  See the <option>checker</option> option.
 
271
          </para>
 
272
        </listitem>
 
273
      </varlistentry>
 
274
      
 
275
      <varlistentry>
 
276
        <term><option>interval<literal> = </literal><replaceable
 
277
        >TIME</replaceable></option></term>
 
278
        <listitem>
 
279
          <para>
 
280
            This option is <emphasis>optional</emphasis>.
 
281
          </para>
 
282
          <para>
 
283
            How often to run the checker to confirm that a client is
 
284
            still up.  <emphasis>Note:</emphasis> a new checker will
 
285
            not be started if an old one is still running.  The server
 
286
            will wait for a checker to complete until the below
 
287
            <quote><varname>timeout</varname></quote> occurs, at which
 
288
            time the client will be disabled, and any running checker
 
289
            killed.  The default interval is 2 minutes.
 
290
          </para>
 
291
          <para>
 
292
            The format of <replaceable>TIME</replaceable> is the same
 
293
            as for <varname>timeout</varname> below.
 
294
          </para>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>secfile<literal> = </literal><replaceable
 
300
        >FILENAME</replaceable></option></term>
 
301
        <listitem>
 
302
          <para>
 
303
            This option is only used if <option>secret</option> is not
 
304
            specified, in which case this option is
 
305
            <emphasis>required</emphasis>.
 
306
          </para>
 
307
          <para>
 
308
            Similar to the <option>secret</option>, except the secret
 
309
            data is in an external file.  The contents of the file
 
310
            should <emphasis>not</emphasis> be base64-encoded, but
 
311
            will be sent to clients verbatim.
 
312
          </para>
 
313
          <para>
 
314
            File names of the form <filename>~user/foo/bar</filename>
 
315
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
316
            are supported.
196
317
          </para>
197
318
        </listitem>
198
319
      </varlistentry>
209
330
          <para>
210
331
            If present, this option must be set to a string of
211
332
            base64-encoded binary data.  It will be decoded and sent
212
 
            to the client matching the above
213
 
            <option>fingerprint</option>.  This should, of course, be
214
 
            OpenPGP encrypted data, decryptable only by the client.
 
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.
215
336
            The program <citerefentry><refentrytitle><command
216
337
            >mandos-keygen</command></refentrytitle><manvolnum
217
338
            >8</manvolnum></citerefentry> can, using its
228
349
      </varlistentry>
229
350
      
230
351
      <varlistentry>
231
 
        <term><option>secfile<literal> = </literal><replaceable
232
 
        >FILENAME</replaceable></option></term>
 
352
        <term><option>timeout<literal> = </literal><replaceable
 
353
        >TIME</replaceable></option></term>
233
354
        <listitem>
234
355
          <para>
235
 
            This option is only used if <option>secret</option> is not
236
 
            specified, in which case this option is
237
 
            <emphasis>required</emphasis>.
238
 
          </para>
239
 
          <para>
240
 
            Similar to the <option>secret</option>, except the secret
241
 
            data is in an external file.  The contents of the file
242
 
            should <emphasis>not</emphasis> be base64-encoded, but
243
 
            will be sent to clients verbatim.
244
 
          </para>
245
 
          <para>
246
 
            File names of the form <filename>~user/foo/bar</filename>
247
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
248
 
            are supported.
 
356
            This option is <emphasis>optional</emphasis>.
 
357
          </para>
 
358
          <para>
 
359
            The timeout is how long the server will wait, after a
 
360
            successful checker run, until a client is disabled and not
 
361
            allowed to get the data this server holds.  By default
 
362
            Mandos will use 5 minutes.  See also the
 
363
            <option>extended_timeout</option> option.
 
364
          </para>
 
365
          <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.
249
372
          </para>
250
373
        </listitem>
251
374
      </varlistentry>
252
375
      
253
376
      <varlistentry>
254
 
        <term><option><literal>host = </literal><replaceable
255
 
        >STRING</replaceable></option></term>
 
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>
256
382
        <listitem>
257
383
          <para>
258
 
            This option is <emphasis>optional</emphasis>, but highly
259
 
            <emphasis>recommended</emphasis> unless the
260
 
            <option>checker</option> option is modified to a
261
 
            non-standard value without <quote>%%(host)s</quote> in it.
262
 
          </para>
263
 
          <para>
264
 
            Host name for this client.  This is not used by the server
265
 
            directly, but can be, and is by default, used by the
266
 
            checker.  See the <option>checker</option> option.
 
384
            Whether this client should be enabled by default.  The
 
385
            default is <quote>true</quote>.
267
386
          </para>
268
387
        </listitem>
269
388
      </varlistentry>
306
425
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
307
426
        ></quote> will be replaced by the value of the attribute
308
427
        <varname>foo</varname> of the internal
309
 
        <quote><classname>Client</classname></quote> object.  See the
310
 
        source code for details, and let the authors know of any
311
 
        attributes that are useful so they may be preserved to any new
312
 
        versions of this software.
 
428
        <quote><classname>Client</classname></quote> object in the
 
429
        Mandos server.  The currently allowed values for
 
430
        <replaceable>foo</replaceable> are:
 
431
        <quote><literal>approval_delay</literal></quote>,
 
432
        <quote><literal>approval_duration</literal></quote>,
 
433
        <quote><literal>created</literal></quote>,
 
434
        <quote><literal>enabled</literal></quote>,
 
435
        <quote><literal>expires</literal></quote>,
 
436
        <quote><literal>key_id</literal></quote>,
 
437
        <quote><literal>fingerprint</literal></quote>,
 
438
        <quote><literal>host</literal></quote>,
 
439
        <quote><literal>interval</literal></quote>,
 
440
        <quote><literal>last_approval_request</literal></quote>,
 
441
        <quote><literal>last_checked_ok</literal></quote>,
 
442
        <quote><literal>last_enabled</literal></quote>,
 
443
        <quote><literal>name</literal></quote>,
 
444
        <quote><literal>timeout</literal></quote>, and, if using
 
445
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
446
        See the source code for details.  <emphasis role="strong"
 
447
        >Currently, <emphasis>none</emphasis> of these attributes
 
448
        except <quote><literal>host</literal></quote> are guaranteed
 
449
        to be valid in future versions.</emphasis> Therefore, please
 
450
        let the authors know of any attributes that are useful so they
 
451
        may be preserved to any new versions of this software.
313
452
      </para>
314
453
      <para>
315
454
        Note that this means that, in order to include an actual
343
482
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
344
483
      obscure.
345
484
    </para>
 
485
    <xi:include href="bugs.xml"/>
346
486
  </refsect1>
347
487
  
348
488
  <refsect1 id="example">
350
490
    <informalexample>
351
491
      <programlisting>
352
492
[DEFAULT]
353
 
timeout = 1h
354
 
interval = 5m
 
493
timeout = PT5M
 
494
interval = PT2M
355
495
checker = fping -q -- %%(host)s
356
496
 
357
497
# Client "foo"
358
498
[foo]
 
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
359
500
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
360
501
secret =
361
502
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
374
515
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
375
516
        QlnHIvPzEArRQLo=
376
517
host = foo.example.org
377
 
interval = 1m
 
518
interval = PT1M
378
519
 
379
520
# Client "bar"
380
521
[bar]
 
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
381
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
382
524
secfile = /etc/mandos/bar-secret
383
 
timeout = 15m
 
525
timeout = PT15M
 
526
approved_by_default = False
 
527
approval_delay = PT30S
384
528
      </programlisting>
385
529
    </informalexample>
386
530
  </refsect1>
388
532
  <refsect1 id="see_also">
389
533
    <title>SEE ALSO</title>
390
534
    <para>
 
535
      <citerefentry><refentrytitle>intro</refentrytitle>
 
536
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
537
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
392
538
      <manvolnum>8</manvolnum></citerefentry>,
393
539
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
394
540
      <manvolnum>5</manvolnum></citerefentry>,
395
541
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
542
      <manvolnum>8</manvolnum></citerefentry>,
 
543
      <citerefentry><refentrytitle>fping</refentrytitle>
396
544
      <manvolnum>8</manvolnum></citerefentry>
397
545
    </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>
398
560
  </refsect1>
399
561
</refentry>
400
562
<!-- Local Variables: -->