/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

* Makefile: Don't use PIE if BROKEN_PIE is set.
* debian/rules: Set BROKEN_PIE on mips and mipsel architectures.

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 "2019-02-10">
 
6
<!ENTITY TIMESTAMP "2009-09-17">
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>
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>
46
 
      <year>2019</year>
47
37
      <holder>Teddy Hogeborn</holder>
48
38
      <holder>Björn Påhlsson</holder>
49
39
    </copyright>
73
63
      ><refentrytitle>mandos</refentrytitle>
74
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
75
65
      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.
 
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.
83
69
    </para>
84
70
    <para>
85
71
      The format starts with a <literal>[<replaceable>section
115
101
    <variablelist>
116
102
      
117
103
      <varlistentry>
118
 
        <term><option>approval_delay<literal> = </literal><replaceable
119
 
        >TIME</replaceable></option></term>
120
 
        <listitem>
121
 
          <para>
122
 
            This option is <emphasis>optional</emphasis>.
123
 
          </para>
124
 
          <para>
125
 
            How long to wait for external approval before resorting to
126
 
            use the <option>approved_by_default</option> value.  The
127
 
            default is <quote>PT0S</quote>, i.e. not to wait.
128
 
          </para>
129
 
          <para>
130
 
            The format of <replaceable>TIME</replaceable> is the same
131
 
            as for <varname>timeout</varname> below.
132
 
          </para>
133
 
        </listitem>
134
 
      </varlistentry>
135
 
      
136
 
      <varlistentry>
137
 
        <term><option>approval_duration<literal> = </literal
138
 
        ><replaceable>TIME</replaceable></option></term>
139
 
        <listitem>
140
 
          <para>
141
 
            This option is <emphasis>optional</emphasis>.
142
 
          </para>
143
 
          <para>
144
 
            How long an external approval lasts.  The default is 1
145
 
            second.
146
 
          </para>
147
 
          <para>
148
 
            The format of <replaceable>TIME</replaceable> is the same
149
 
            as for <varname>timeout</varname> below.
150
 
          </para>
151
 
        </listitem>
152
 
      </varlistentry>
153
 
      
154
 
      <varlistentry>
155
 
        <term><option>approved_by_default<literal> = </literal
156
 
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
157
 
          >true</literal> | <literal>on</literal> | <literal
158
 
          >0</literal> | <literal>no</literal> | <literal
159
 
          >false</literal> | <literal>off</literal> }</option></term>
160
 
        <listitem>
161
 
          <para>
162
 
            Whether to approve a client by default after
163
 
            the <option>approval_delay</option>.  The default
164
 
            is <quote>True</quote>.
 
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.
165
152
          </para>
166
153
        </listitem>
167
154
      </varlistentry>
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
201
182
      </varlistentry>
202
183
      
203
184
      <varlistentry>
204
 
        <term><option>extended_timeout<literal> = </literal><replaceable
205
 
        >TIME</replaceable></option></term>
206
 
        <listitem>
207
 
          <para>
208
 
            This option is <emphasis>optional</emphasis>.
209
 
          </para>
210
 
          <para>
211
 
            Extended timeout is an added timeout that is given once
212
 
            after a password has been sent successfully to a client.
213
 
            The timeout is by default longer than the normal timeout,
214
 
            and is used for handling the extra long downtime while a
215
 
            machine is booting up.  Time to take into consideration
216
 
            when changing this value is file system checks and quota
217
 
            checks.  The default value is 15 minutes.
218
 
          </para>
219
 
          <para>
220
 
            The format of <replaceable>TIME</replaceable> is the same
221
 
            as for <varname>timeout</varname> below.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>
225
 
      
226
 
      <varlistentry>
227
185
        <term><option>fingerprint<literal> = </literal
228
186
        ><replaceable>HEXSTRING</replaceable></option></term>
229
187
        <listitem>
230
188
          <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.
260
 
          </para>
261
 
        </listitem>
262
 
      </varlistentry>
263
 
      
264
 
      <varlistentry>
265
 
        <term><option><literal>host = </literal><replaceable
266
 
        >STRING</replaceable></option></term>
267
 
        <listitem>
268
 
          <para>
269
 
            This option is <emphasis>optional</emphasis>, but highly
270
 
            <emphasis>recommended</emphasis> unless the
271
 
            <option>checker</option> option is modified to a
272
 
            non-standard value without <quote>%%(host)s</quote> in it.
273
 
          </para>
274
 
          <para>
275
 
            Host name for this client.  This is not used by the server
276
 
            directly, but can be, and is by default, used by the
277
 
            checker.  See the <option>checker</option> option.
278
 
          </para>
279
 
        </listitem>
280
 
      </varlistentry>
281
 
      
282
 
      <varlistentry>
283
 
        <term><option>interval<literal> = </literal><replaceable
284
 
        >TIME</replaceable></option></term>
285
 
        <listitem>
286
 
          <para>
287
 
            This option is <emphasis>optional</emphasis>.
288
 
          </para>
289
 
          <para>
290
 
            How often to run the checker to confirm that a client is
291
 
            still up.  <emphasis>Note:</emphasis> a new checker will
292
 
            not be started if an old one is still running.  The server
293
 
            will wait for a checker to complete until the below
294
 
            <quote><varname>timeout</varname></quote> occurs, at which
295
 
            time the client will be disabled, and any running checker
296
 
            killed.  The default interval is 2 minutes.
297
 
          </para>
298
 
          <para>
299
 
            The format of <replaceable>TIME</replaceable> is the same
300
 
            as for <varname>timeout</varname> below.
301
 
          </para>
302
 
        </listitem>
303
 
      </varlistentry>
304
 
      
305
 
      <varlistentry>
306
 
        <term><option>secfile<literal> = </literal><replaceable
307
 
        >FILENAME</replaceable></option></term>
308
 
        <listitem>
309
 
          <para>
310
 
            This option is only used if <option>secret</option> is not
311
 
            specified, in which case this option is
312
 
            <emphasis>required</emphasis>.
313
 
          </para>
314
 
          <para>
315
 
            Similar to the <option>secret</option>, except the secret
316
 
            data is in an external file.  The contents of the file
317
 
            should <emphasis>not</emphasis> be base64-encoded, but
318
 
            will be sent to clients verbatim.
319
 
          </para>
320
 
          <para>
321
 
            File names of the form <filename>~user/foo/bar</filename>
322
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
323
 
            are supported.
 
189
            This option is <emphasis>required</emphasis>.
 
190
          </para>
 
191
          <para>
 
192
            This option sets the OpenPGP fingerprint that identifies
 
193
            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.
324
196
          </para>
325
197
        </listitem>
326
198
      </varlistentry>
337
209
          <para>
338
210
            If present, this option must be set to a string of
339
211
            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.
 
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.
343
215
            The program <citerefentry><refentrytitle><command
344
216
            >mandos-keygen</command></refentrytitle><manvolnum
345
217
            >8</manvolnum></citerefentry> can, using its
356
228
      </varlistentry>
357
229
      
358
230
      <varlistentry>
359
 
        <term><option>timeout<literal> = </literal><replaceable
360
 
        >TIME</replaceable></option></term>
 
231
        <term><option>secfile<literal> = </literal><replaceable
 
232
        >FILENAME</replaceable></option></term>
361
233
        <listitem>
362
234
          <para>
363
 
            This option is <emphasis>optional</emphasis>.
364
 
          </para>
365
 
          <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.
 
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.
379
249
          </para>
380
250
        </listitem>
381
251
      </varlistentry>
382
252
      
383
253
      <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>
 
254
        <term><option><literal>host = </literal><replaceable
 
255
        >STRING</replaceable></option></term>
389
256
        <listitem>
390
257
          <para>
391
 
            Whether this client should be enabled by default.  The
392
 
            default is <quote>true</quote>.
 
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.
393
267
          </para>
394
268
        </listitem>
395
269
      </varlistentry>
432
306
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
433
307
        ></quote> will be replaced by the value of the attribute
434
308
        <varname>foo</varname> of the internal
435
 
        <quote><classname>Client</classname></quote> object in the
436
 
        Mandos server.  The currently allowed values for
437
 
        <replaceable>foo</replaceable> are:
438
 
        <quote><literal>approval_delay</literal></quote>,
439
 
        <quote><literal>approval_duration</literal></quote>,
440
 
        <quote><literal>created</literal></quote>,
441
 
        <quote><literal>enabled</literal></quote>,
442
 
        <quote><literal>expires</literal></quote>,
443
 
        <quote><literal>key_id</literal></quote>,
444
 
        <quote><literal>fingerprint</literal></quote>,
445
 
        <quote><literal>host</literal></quote>,
446
 
        <quote><literal>interval</literal></quote>,
447
 
        <quote><literal>last_approval_request</literal></quote>,
448
 
        <quote><literal>last_checked_ok</literal></quote>,
449
 
        <quote><literal>last_enabled</literal></quote>,
450
 
        <quote><literal>name</literal></quote>,
451
 
        <quote><literal>timeout</literal></quote>, and, if using
452
 
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
453
 
        See the source code for details.  <emphasis role="strong"
454
 
        >Currently, <emphasis>none</emphasis> of these attributes
455
 
        except <quote><literal>host</literal></quote> are guaranteed
456
 
        to be valid in future versions.</emphasis> Therefore, please
457
 
        let the authors know of any attributes that are useful so they
458
 
        may be preserved to any new versions of this software.
 
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.
459
313
      </para>
460
314
      <para>
461
315
        Note that this means that, in order to include an actual
489
343
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
490
344
      obscure.
491
345
    </para>
492
 
    <xi:include href="bugs.xml"/>
493
346
  </refsect1>
494
347
  
495
348
  <refsect1 id="example">
497
350
    <informalexample>
498
351
      <programlisting>
499
352
[DEFAULT]
500
 
timeout = PT5M
501
 
interval = PT2M
 
353
timeout = 1h
 
354
interval = 5m
502
355
checker = fping -q -- %%(host)s
503
356
 
504
357
# Client "foo"
505
358
[foo]
506
 
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
507
359
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
508
360
secret =
509
361
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
522
374
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
523
375
        QlnHIvPzEArRQLo=
524
376
host = foo.example.org
525
 
interval = PT1M
 
377
interval = 1m
526
378
 
527
379
# Client "bar"
528
380
[bar]
529
 
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
530
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
531
382
secfile = /etc/mandos/bar-secret
532
 
timeout = PT15M
533
 
approved_by_default = False
534
 
approval_delay = PT30S
 
383
timeout = 15m
535
384
      </programlisting>
536
385
    </informalexample>
537
386
  </refsect1>
539
388
  <refsect1 id="see_also">
540
389
    <title>SEE ALSO</title>
541
390
    <para>
542
 
      <citerefentry><refentrytitle>intro</refentrytitle>
543
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
544
391
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
545
392
      <manvolnum>8</manvolnum></citerefentry>,
546
393
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
547
394
      <manvolnum>5</manvolnum></citerefentry>,
548
395
      <citerefentry><refentrytitle>mandos</refentrytitle>
549
 
      <manvolnum>8</manvolnum></citerefentry>,
550
 
      <citerefentry><refentrytitle>fping</refentrytitle>
551
396
      <manvolnum>8</manvolnum></citerefentry>
552
397
    </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
398
  </refsect1>
568
399
</refentry>
569
400
<!-- Local Variables: -->