/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: Teddy Hogeborn
  • Date: 2018-08-15 09:13:36 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 368.
  • Revision ID: teddy@recompile.se-20180815091336-fxwk6vbop0m8xyur
Linking flags correction

* Makefile (CFLAGS): Remove "$(GNUTLS_CFLAGS) $(AVAHI_CFLAGS)
                     $(GPGME_CFLAGS)", since these libraries are not
                     used by all programs.
  (plugins.d/mandos-client): Add "$(GNUTLS_CFLAGS) $(AVAHI_CFLAGS)
                             $(GPGME_CFLAGS)".

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-01-08">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
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 a
112
 
            successful checker run until a client is considered
113
 
            invalid - that is, ineligible to get the data this server
114
 
            holds.  By default Mandos will use 1 hour.
115
 
          </para>
116
 
          <para>
117
 
            The <replaceable>TIME</replaceable> is specified as a
118
 
            space-separated number of values, each of which is a
119
 
            number and a one-character suffix.  The suffix must be one
120
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
121
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
122
 
            minutes, hours, and weeks, respectively.  The values are
123
 
            added together to give the total time value, so all of
124
 
            <quote><literal>330s</literal></quote>,
125
 
            <quote><literal>110s 110s 110s</literal></quote>, and
126
 
            <quote><literal>5m 30s</literal></quote> will give a value
127
 
            of five minutes and thirty seconds.
128
 
          </para>
129
 
        </listitem>
130
 
      </varlistentry>
131
 
      
132
 
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
135
 
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
139
 
          <para>
140
 
            How often to run the checker to confirm that a client is
141
 
            still up.  <emphasis>Note:</emphasis> a new checker will
142
 
            not be started if an old one is still running.  The server
143
 
            will wait for a checker to complete until the above
144
 
            <quote><varname>timeout</varname></quote> occurs, at which
145
 
            time the client will be marked invalid, and any running
146
 
            checker killed.  The default interval is 5 minutes.
147
 
          </para>
148
 
          <para>
149
 
            The format of <replaceable>TIME</replaceable> is the same
150
 
            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>.
151
164
          </para>
152
165
        </listitem>
153
166
      </varlistentry>
160
173
            This option is <emphasis>optional</emphasis>.
161
174
          </para>
162
175
          <para>
163
 
            This option allows you to override the default shell
164
 
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            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>
169
182
            <option>-c</option></command></quote>, so
170
183
            <varname>PATH</varname> will be searched.  The default
171
184
            value for the checker command is <quote><literal
172
185
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</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.
174
193
          </para>
175
194
          <para>
176
195
            In addition to normal start time expansion, this option
181
200
      </varlistentry>
182
201
      
183
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>
184
226
        <term><option>fingerprint<literal> = </literal
185
227
        ><replaceable>HEXSTRING</replaceable></option></term>
186
228
        <listitem>
190
232
          <para>
191
233
            This option sets the OpenPGP fingerprint that identifies
192
234
            the public key that clients authenticate themselves with
193
 
            through TLS.  The string needs to be in hexidecimal form,
 
235
            through TLS.  The string needs to be in hexadecimal form,
194
236
            but spaces or upper/lower case are not significant.
195
237
          </para>
196
238
        </listitem>
197
239
      </varlistentry>
198
240
      
199
241
      <varlistentry>
 
242
        <term><option><literal>host = </literal><replaceable
 
243
        >STRING</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>, but highly
 
247
            <emphasis>recommended</emphasis> unless the
 
248
            <option>checker</option> option is modified to a
 
249
            non-standard value without <quote>%%(host)s</quote> in it.
 
250
          </para>
 
251
          <para>
 
252
            Host name for this client.  This is not used by the server
 
253
            directly, but can be, and is by default, used by the
 
254
            checker.  See the <option>checker</option> option.
 
255
          </para>
 
256
        </listitem>
 
257
      </varlistentry>
 
258
      
 
259
      <varlistentry>
 
260
        <term><option>interval<literal> = </literal><replaceable
 
261
        >TIME</replaceable></option></term>
 
262
        <listitem>
 
263
          <para>
 
264
            This option is <emphasis>optional</emphasis>.
 
265
          </para>
 
266
          <para>
 
267
            How often to run the checker to confirm that a client is
 
268
            still up.  <emphasis>Note:</emphasis> a new checker will
 
269
            not be started if an old one is still running.  The server
 
270
            will wait for a checker to complete until the below
 
271
            <quote><varname>timeout</varname></quote> occurs, at which
 
272
            time the client will be disabled, and any running checker
 
273
            killed.  The default interval is 2 minutes.
 
274
          </para>
 
275
          <para>
 
276
            The format of <replaceable>TIME</replaceable> is the same
 
277
            as for <varname>timeout</varname> below.
 
278
          </para>
 
279
        </listitem>
 
280
      </varlistentry>
 
281
      
 
282
      <varlistentry>
 
283
        <term><option>secfile<literal> = </literal><replaceable
 
284
        >FILENAME</replaceable></option></term>
 
285
        <listitem>
 
286
          <para>
 
287
            This option is only used if <option>secret</option> is not
 
288
            specified, in which case this option is
 
289
            <emphasis>required</emphasis>.
 
290
          </para>
 
291
          <para>
 
292
            Similar to the <option>secret</option>, except the secret
 
293
            data is in an external file.  The contents of the file
 
294
            should <emphasis>not</emphasis> be base64-encoded, but
 
295
            will be sent to clients verbatim.
 
296
          </para>
 
297
          <para>
 
298
            File names of the form <filename>~user/foo/bar</filename>
 
299
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
300
            are supported.
 
301
          </para>
 
302
        </listitem>
 
303
      </varlistentry>
 
304
      
 
305
      <varlistentry>
200
306
        <term><option>secret<literal> = </literal><replaceable
201
307
        >BASE64_ENCODED_DATA</replaceable></option></term>
202
308
        <listitem>
227
333
      </varlistentry>
228
334
      
229
335
      <varlistentry>
230
 
        <term><option>secfile<literal> = </literal><replaceable
231
 
        >FILENAME</replaceable></option></term>
 
336
        <term><option>timeout<literal> = </literal><replaceable
 
337
        >TIME</replaceable></option></term>
232
338
        <listitem>
233
339
          <para>
234
 
            This option is only used if <option>secret</option> is not
235
 
            specified, in which case this option is
236
 
            <emphasis>required</emphasis>.
237
 
          </para>
238
 
          <para>
239
 
            Similar to the <option>secret</option>, except the secret
240
 
            data is in an external file.  The contents of the file
241
 
            should <emphasis>not</emphasis> be base64-encoded, but
242
 
            will be sent to clients verbatim.
243
 
          </para>
244
 
          <para>
245
 
            File names of the form <filename>~user/foo/bar</filename>
246
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
 
            are supported.
 
340
            This option is <emphasis>optional</emphasis>.
 
341
          </para>
 
342
          <para>
 
343
            The timeout is how long the server will wait, after a
 
344
            successful checker run, until a client is disabled and not
 
345
            allowed to get the data this server holds.  By default
 
346
            Mandos will use 5 minutes.  See also the
 
347
            <option>extended_timeout</option> option.
 
348
          </para>
 
349
          <para>
 
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.
248
356
          </para>
249
357
        </listitem>
250
358
      </varlistentry>
251
359
      
252
360
      <varlistentry>
253
 
        <term><option><literal>host = </literal><replaceable
254
 
        >STRING</replaceable></option></term>
 
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>
255
366
        <listitem>
256
367
          <para>
257
 
            This option is <emphasis>optional</emphasis>, but highly
258
 
            <emphasis>recommended</emphasis> unless the
259
 
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%(host)s</quote> in it.
261
 
          </para>
262
 
          <para>
263
 
            Host name for this client.  This is not used by the server
264
 
            directly, but can be, and is by default, used by the
265
 
            checker.  See the <option>checker</option> option.
 
368
            Whether this client should be enabled by default.  The
 
369
            default is <quote>true</quote>.
266
370
          </para>
267
371
        </listitem>
268
372
      </varlistentry>
305
409
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
306
410
        ></quote> will be replaced by the value of the attribute
307
411
        <varname>foo</varname> of the internal
308
 
        <quote><classname>Client</classname></quote> object.  See the
309
 
        source code for details, and let the authors know of any
310
 
        attributes that are useful so they may be preserved to any new
311
 
        versions of this software.
 
412
        <quote><classname>Client</classname></quote> object in the
 
413
        Mandos server.  The currently allowed values for
 
414
        <replaceable>foo</replaceable> are:
 
415
        <quote><literal>approval_delay</literal></quote>,
 
416
        <quote><literal>approval_duration</literal></quote>,
 
417
        <quote><literal>created</literal></quote>,
 
418
        <quote><literal>enabled</literal></quote>,
 
419
        <quote><literal>expires</literal></quote>,
 
420
        <quote><literal>fingerprint</literal></quote>,
 
421
        <quote><literal>host</literal></quote>,
 
422
        <quote><literal>interval</literal></quote>,
 
423
        <quote><literal>last_approval_request</literal></quote>,
 
424
        <quote><literal>last_checked_ok</literal></quote>,
 
425
        <quote><literal>last_enabled</literal></quote>,
 
426
        <quote><literal>name</literal></quote>,
 
427
        <quote><literal>timeout</literal></quote>, and, if using
 
428
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
429
        See the source code for details.  <emphasis role="strong"
 
430
        >Currently, <emphasis>none</emphasis> of these attributes
 
431
        except <quote><literal>host</literal></quote> are guaranteed
 
432
        to be valid in future versions.</emphasis> Therefore, please
 
433
        let the authors know of any attributes that are useful so they
 
434
        may be preserved to any new versions of this software.
312
435
      </para>
313
436
      <para>
314
437
        Note that this means that, in order to include an actual
342
465
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
343
466
      obscure.
344
467
    </para>
 
468
    <xi:include href="bugs.xml"/>
345
469
  </refsect1>
346
470
  
347
471
  <refsect1 id="example">
349
473
    <informalexample>
350
474
      <programlisting>
351
475
[DEFAULT]
352
 
timeout = 1h
353
 
interval = 5m
 
476
timeout = PT5M
 
477
interval = PT2M
354
478
checker = fping -q -- %%(host)s
355
479
 
356
480
# Client "foo"
373
497
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
374
498
        QlnHIvPzEArRQLo=
375
499
host = foo.example.org
376
 
interval = 1m
 
500
interval = PT1M
377
501
 
378
502
# Client "bar"
379
503
[bar]
380
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
505
secfile = /etc/mandos/bar-secret
382
 
timeout = 15m
 
506
timeout = PT15M
 
507
approved_by_default = False
 
508
approval_delay = PT30S
383
509
      </programlisting>
384
510
    </informalexample>
385
511
  </refsect1>
387
513
  <refsect1 id="see_also">
388
514
    <title>SEE ALSO</title>
389
515
    <para>
 
516
      <citerefentry><refentrytitle>intro</refentrytitle>
 
517
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
518
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
519
      <manvolnum>8</manvolnum></citerefentry>,
392
520
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
521
      <manvolnum>5</manvolnum></citerefentry>,
394
522
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
523
      <manvolnum>8</manvolnum></citerefentry>,
 
524
      <citerefentry><refentrytitle>fping</refentrytitle>
395
525
      <manvolnum>8</manvolnum></citerefentry>
396
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>
397
541
  </refsect1>
398
542
</refentry>
399
543
<!-- Local Variables: -->