/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-02-08 10:02:51 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 362.
  • Revision ID: teddy@recompile.se-20180208100251-x7qq39sjsgk4r2sq
Update Debian watch file to version 4

* debian/watch (version): Change to "4".
  (opts/pgpsigurlmangle): Remove.
  (opts/pgpmode): New; set to "auto".
  (URL): Change to "https://ftp.recompile.se/pub/@PACKAGE@/@PACKAGE@@ANY_VERSION@(?:\.orig)?@ARCHIVE_EXT@".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-09-12">
 
6
<!ENTITY TIMESTAMP "2017-02-23">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
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>
35
45
      <holder>Teddy Hogeborn</holder>
36
46
      <holder>Björn Påhlsson</holder>
37
47
    </copyright>
61
71
      ><refentrytitle>mandos</refentrytitle>
62
72
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
73
      The file needs to list all clients that should be able to use
64
 
      the service.  All clients listed will be regarded as valid, even
65
 
      if a client was declared invalid in a previous run of the
66
 
      server.
 
74
      the service.  The settings in this file can be overridden by
 
75
      runtime changes to the server, which it saves across restarts.
 
76
      (See the section called <quote>PERSISTENT STATE</quote> in
 
77
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
78
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
79
      >changes</emphasis> to this file (including adding and removing
 
80
      clients) will, at startup, override changes done during runtime.
67
81
    </para>
68
82
    <para>
69
83
      The format starts with a <literal>[<replaceable>section
99
113
    <variablelist>
100
114
      
101
115
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
104
 
        <listitem>
105
 
          <para>
106
 
            This option is <emphasis>optional</emphasis>.
107
 
          </para>
108
 
          <para>
109
 
            The timeout is how long the server will wait for a
110
 
            successful checker run until a client is considered
111
 
            invalid - that is, ineligible to get the data this server
112
 
            holds.  By default Mandos will use 1 hour.
113
 
          </para>
114
 
          <para>
115
 
            The <replaceable>TIME</replaceable> is specified as a
116
 
            space-separated number of values, each of which is a
117
 
            number and a one-character suffix.  The suffix must be one
118
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
119
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
120
 
            minutes, hours, and weeks, respectively.  The values are
121
 
            added together to give the total time value, so all of
122
 
            <quote><literal>330s</literal></quote>,
123
 
            <quote><literal>110s 110s 110s</literal></quote>, and
124
 
            <quote><literal>5m 30s</literal></quote> will give a value
125
 
            of five minutes and thirty seconds.
126
 
          </para>
127
 
        </listitem>
128
 
      </varlistentry>
129
 
      
130
 
      <varlistentry>
131
 
        <term><option>interval<literal> = </literal><replaceable
132
 
        >TIME</replaceable></option></term>
133
 
        <listitem>
134
 
          <para>
135
 
            This option is <emphasis>optional</emphasis>.
136
 
          </para>
137
 
          <para>
138
 
            How often to run the checker to confirm that a client is
139
 
            still up.  <emphasis>Note:</emphasis> a new checker will
140
 
            not be started if an old one is still running.  The server
141
 
            will wait for a checker to complete until the above
142
 
            <quote><varname>timeout</varname></quote> occurs, at which
143
 
            time the client will be marked invalid, and any running
144
 
            checker killed.  The default interval is 5 minutes.
145
 
          </para>
146
 
          <para>
147
 
            The format of <replaceable>TIME</replaceable> is the same
148
 
            as for <varname>timeout</varname> above.
 
116
        <term><option>approval_delay<literal> = </literal><replaceable
 
117
        >TIME</replaceable></option></term>
 
118
        <listitem>
 
119
          <para>
 
120
            This option is <emphasis>optional</emphasis>.
 
121
          </para>
 
122
          <para>
 
123
            How long to wait for external approval before resorting to
 
124
            use the <option>approved_by_default</option> value.  The
 
125
            default is <quote>PT0S</quote>, i.e. not to wait.
 
126
          </para>
 
127
          <para>
 
128
            The format of <replaceable>TIME</replaceable> is the same
 
129
            as for <varname>timeout</varname> below.
 
130
          </para>
 
131
        </listitem>
 
132
      </varlistentry>
 
133
      
 
134
      <varlistentry>
 
135
        <term><option>approval_duration<literal> = </literal
 
136
        ><replaceable>TIME</replaceable></option></term>
 
137
        <listitem>
 
138
          <para>
 
139
            This option is <emphasis>optional</emphasis>.
 
140
          </para>
 
141
          <para>
 
142
            How long an external approval lasts.  The default is 1
 
143
            second.
 
144
          </para>
 
145
          <para>
 
146
            The format of <replaceable>TIME</replaceable> is the same
 
147
            as for <varname>timeout</varname> below.
 
148
          </para>
 
149
        </listitem>
 
150
      </varlistentry>
 
151
      
 
152
      <varlistentry>
 
153
        <term><option>approved_by_default<literal> = </literal
 
154
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
155
          >true</literal> | <literal>on</literal> | <literal
 
156
          >0</literal> | <literal>no</literal> | <literal
 
157
          >false</literal> | <literal>off</literal> }</option></term>
 
158
        <listitem>
 
159
          <para>
 
160
            Whether to approve a client by default after
 
161
            the <option>approval_delay</option>.  The default
 
162
            is <quote>True</quote>.
149
163
          </para>
150
164
        </listitem>
151
165
      </varlistentry>
158
172
            This option is <emphasis>optional</emphasis>.
159
173
          </para>
160
174
          <para>
161
 
            This option allows you to override the default shell
162
 
            command that the server will use to check if the client is
163
 
            still up.  Any output of the command will be ignored, only
164
 
            the exit code is checked:  If the exit code of the command
165
 
            is zero, the client is considered up.  The command will be
166
 
            run using <quote><command><filename>/bin/sh</filename>
 
175
            This option overrides the default shell command that the
 
176
            server will use to check if the client is still up.  Any
 
177
            output of the command will be ignored, only the exit code
 
178
            is checked:  If the exit code of the command is zero, the
 
179
            client is considered up.  The command will be run using
 
180
            <quote><command><filename>/bin/sh</filename>
167
181
            <option>-c</option></command></quote>, so
168
182
            <varname>PATH</varname> will be searched.  The default
169
183
            value for the checker command is <quote><literal
170
184
            ><command>fping</command> <option>-q</option> <option
171
 
            >--</option> %(host)s</literal></quote>.
 
185
            >--</option> %%(host)s</literal></quote>.  Note that
 
186
            <command>mandos-keygen</command>, when generating output
 
187
            to be inserted into this file, normally looks for an SSH
 
188
            server on the Mandos client, and, if it find one, outputs
 
189
            a <option>checker</option> option to check for the
 
190
            client’s key fingerprint – this is more secure against
 
191
            spoofing.
172
192
          </para>
173
193
          <para>
174
194
            In addition to normal start time expansion, this option
179
199
      </varlistentry>
180
200
      
181
201
      <varlistentry>
 
202
        <term><option>extended_timeout<literal> = </literal><replaceable
 
203
        >TIME</replaceable></option></term>
 
204
        <listitem>
 
205
          <para>
 
206
            This option is <emphasis>optional</emphasis>.
 
207
          </para>
 
208
          <para>
 
209
            Extended timeout is an added timeout that is given once
 
210
            after a password has been sent successfully to a client.
 
211
            The timeout is by default longer than the normal timeout,
 
212
            and is used for handling the extra long downtime while a
 
213
            machine is booting up.  Time to take into consideration
 
214
            when changing this value is file system checks and quota
 
215
            checks.  The default value is 15 minutes.
 
216
          </para>
 
217
          <para>
 
218
            The format of <replaceable>TIME</replaceable> is the same
 
219
            as for <varname>timeout</varname> below.
 
220
          </para>
 
221
        </listitem>
 
222
      </varlistentry>
 
223
      
 
224
      <varlistentry>
182
225
        <term><option>fingerprint<literal> = </literal
183
226
        ><replaceable>HEXSTRING</replaceable></option></term>
184
227
        <listitem>
188
231
          <para>
189
232
            This option sets the OpenPGP fingerprint that identifies
190
233
            the public key that clients authenticate themselves with
191
 
            through TLS.  The string needs to be in hexidecimal form,
 
234
            through TLS.  The string needs to be in hexadecimal form,
192
235
            but spaces or upper/lower case are not significant.
193
236
          </para>
194
237
        </listitem>
195
238
      </varlistentry>
196
239
      
197
240
      <varlistentry>
 
241
        <term><option><literal>host = </literal><replaceable
 
242
        >STRING</replaceable></option></term>
 
243
        <listitem>
 
244
          <para>
 
245
            This option is <emphasis>optional</emphasis>, but highly
 
246
            <emphasis>recommended</emphasis> unless the
 
247
            <option>checker</option> option is modified to a
 
248
            non-standard value without <quote>%%(host)s</quote> in it.
 
249
          </para>
 
250
          <para>
 
251
            Host name for this client.  This is not used by the server
 
252
            directly, but can be, and is by default, used by the
 
253
            checker.  See the <option>checker</option> option.
 
254
          </para>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
 
259
        <term><option>interval<literal> = </literal><replaceable
 
260
        >TIME</replaceable></option></term>
 
261
        <listitem>
 
262
          <para>
 
263
            This option is <emphasis>optional</emphasis>.
 
264
          </para>
 
265
          <para>
 
266
            How often to run the checker to confirm that a client is
 
267
            still up.  <emphasis>Note:</emphasis> a new checker will
 
268
            not be started if an old one is still running.  The server
 
269
            will wait for a checker to complete until the below
 
270
            <quote><varname>timeout</varname></quote> occurs, at which
 
271
            time the client will be disabled, and any running checker
 
272
            killed.  The default interval is 2 minutes.
 
273
          </para>
 
274
          <para>
 
275
            The format of <replaceable>TIME</replaceable> is the same
 
276
            as for <varname>timeout</varname> below.
 
277
          </para>
 
278
        </listitem>
 
279
      </varlistentry>
 
280
      
 
281
      <varlistentry>
 
282
        <term><option>secfile<literal> = </literal><replaceable
 
283
        >FILENAME</replaceable></option></term>
 
284
        <listitem>
 
285
          <para>
 
286
            This option is only used if <option>secret</option> is not
 
287
            specified, in which case this option is
 
288
            <emphasis>required</emphasis>.
 
289
          </para>
 
290
          <para>
 
291
            Similar to the <option>secret</option>, except the secret
 
292
            data is in an external file.  The contents of the file
 
293
            should <emphasis>not</emphasis> be base64-encoded, but
 
294
            will be sent to clients verbatim.
 
295
          </para>
 
296
          <para>
 
297
            File names of the form <filename>~user/foo/bar</filename>
 
298
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
299
            are supported.
 
300
          </para>
 
301
        </listitem>
 
302
      </varlistentry>
 
303
      
 
304
      <varlistentry>
198
305
        <term><option>secret<literal> = </literal><replaceable
199
306
        >BASE64_ENCODED_DATA</replaceable></option></term>
200
307
        <listitem>
225
332
      </varlistentry>
226
333
      
227
334
      <varlistentry>
228
 
        <term><option>secfile<literal> = </literal><replaceable
229
 
        >FILENAME</replaceable></option></term>
 
335
        <term><option>timeout<literal> = </literal><replaceable
 
336
        >TIME</replaceable></option></term>
230
337
        <listitem>
231
338
          <para>
232
 
            This option is only used if <option>secret</option> is not
233
 
            specified, in which case this option is
234
 
            <emphasis>required</emphasis>.
235
 
          </para>
236
 
          <para>
237
 
            Similar to the <option>secret</option>, except the secret
238
 
            data is in an external file.  The contents of the file
239
 
            should <emphasis>not</emphasis> be base64-encoded, but
240
 
            will be sent to clients verbatim.
 
339
            This option is <emphasis>optional</emphasis>.
 
340
          </para>
 
341
          <para>
 
342
            The timeout is how long the server will wait, after a
 
343
            successful checker run, until a client is disabled and not
 
344
            allowed to get the data this server holds.  By default
 
345
            Mandos will use 5 minutes.  See also the
 
346
            <option>extended_timeout</option> option.
 
347
          </para>
 
348
          <para>
 
349
            The <replaceable>TIME</replaceable> is specified as an RFC
 
350
            3339 duration; for example
 
351
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
352
            one year, two months, three days, four hours, five
 
353
            minutes, and six seconds.  Some values can be omitted, see
 
354
            RFC 3339 Appendix A for details.
241
355
          </para>
242
356
        </listitem>
243
357
      </varlistentry>
244
358
      
245
359
      <varlistentry>
246
 
        <term><option><literal>host = </literal><replaceable
247
 
        >STRING</replaceable></option></term>
 
360
        <term><option>enabled<literal> = </literal>{ <literal
 
361
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
362
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
363
        >no</literal> | <literal>false</literal> | <literal
 
364
        >off</literal> }</option></term>
248
365
        <listitem>
249
366
          <para>
250
 
            This option is <emphasis>optional</emphasis>, but highly
251
 
            <emphasis>recommended</emphasis> unless the
252
 
            <option>checker</option> option is modified to a
253
 
            non-standard value without <quote>%(host)s</quote> in it.
254
 
          </para>
255
 
          <para>
256
 
            Host name for this client.  This is not used by the server
257
 
            directly, but can be, and is by default, used by the
258
 
            checker.  See the <option>checker</option> option.
 
367
            Whether this client should be enabled by default.  The
 
368
            default is <quote>true</quote>.
259
369
          </para>
260
370
        </listitem>
261
371
      </varlistentry>
298
408
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
299
409
        ></quote> will be replaced by the value of the attribute
300
410
        <varname>foo</varname> of the internal
301
 
        <quote><classname>Client</classname></quote> object.  See the
302
 
        source code for details, and let the authors know of any
303
 
        attributes that are useful so they may be preserved to any new
304
 
        versions of this software.
 
411
        <quote><classname>Client</classname></quote> object in the
 
412
        Mandos server.  The currently allowed values for
 
413
        <replaceable>foo</replaceable> are:
 
414
        <quote><literal>approval_delay</literal></quote>,
 
415
        <quote><literal>approval_duration</literal></quote>,
 
416
        <quote><literal>created</literal></quote>,
 
417
        <quote><literal>enabled</literal></quote>,
 
418
        <quote><literal>expires</literal></quote>,
 
419
        <quote><literal>fingerprint</literal></quote>,
 
420
        <quote><literal>host</literal></quote>,
 
421
        <quote><literal>interval</literal></quote>,
 
422
        <quote><literal>last_approval_request</literal></quote>,
 
423
        <quote><literal>last_checked_ok</literal></quote>,
 
424
        <quote><literal>last_enabled</literal></quote>,
 
425
        <quote><literal>name</literal></quote>,
 
426
        <quote><literal>timeout</literal></quote>, and, if using
 
427
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
428
        See the source code for details.  <emphasis role="strong"
 
429
        >Currently, <emphasis>none</emphasis> of these attributes
 
430
        except <quote><literal>host</literal></quote> are guaranteed
 
431
        to be valid in future versions.</emphasis> Therefore, please
 
432
        let the authors know of any attributes that are useful so they
 
433
        may be preserved to any new versions of this software.
305
434
      </para>
306
435
      <para>
307
436
        Note that this means that, in order to include an actual
335
464
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
336
465
      obscure.
337
466
    </para>
 
467
    <xi:include href="bugs.xml"/>
338
468
  </refsect1>
339
469
  
340
470
  <refsect1 id="example">
342
472
    <informalexample>
343
473
      <programlisting>
344
474
[DEFAULT]
345
 
timeout = 1h
346
 
interval = 5m
347
 
checker = fping -q -- %(host)s
 
475
timeout = PT5M
 
476
interval = PT2M
 
477
checker = fping -q -- %%(host)s
348
478
 
349
479
# Client "foo"
350
480
[foo]
366
496
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
367
497
        QlnHIvPzEArRQLo=
368
498
host = foo.example.org
369
 
interval = 1m
 
499
interval = PT1M
370
500
 
371
501
# Client "bar"
372
502
[bar]
373
503
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
504
secfile = /etc/mandos/bar-secret
375
 
timeout = 15m
 
505
timeout = PT15M
 
506
approved_by_default = False
 
507
approval_delay = PT30S
376
508
      </programlisting>
377
509
    </informalexample>
378
510
  </refsect1>
380
512
  <refsect1 id="see_also">
381
513
    <title>SEE ALSO</title>
382
514
    <para>
 
515
      <citerefentry><refentrytitle>intro</refentrytitle>
 
516
      <manvolnum>8mandos</manvolnum></citerefentry>,
383
517
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
384
518
      <manvolnum>8</manvolnum></citerefentry>,
385
519
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
386
520
      <manvolnum>5</manvolnum></citerefentry>,
387
521
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
522
      <manvolnum>8</manvolnum></citerefentry>,
 
523
      <citerefentry><refentrytitle>fping</refentrytitle>
388
524
      <manvolnum>8</manvolnum></citerefentry>
389
525
    </para>
 
526
    <variablelist>
 
527
      <varlistentry>
 
528
        <term>
 
529
          RFC 3339: <citetitle>Date and Time on the Internet:
 
530
          Timestamps</citetitle>
 
531
        </term>
 
532
      <listitem>
 
533
        <para>
 
534
          The time intervals are in the "duration" format, as
 
535
          specified in ABNF in Appendix A of RFC 3339.
 
536
        </para>
 
537
      </listitem>
 
538
      </varlistentry>
 
539
    </variablelist>
390
540
  </refsect1>
391
541
</refentry>
392
542
<!-- Local Variables: -->