/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: 2014-06-22 02:19:30 UTC
  • Revision ID: teddy@recompile.se-20140622021930-icl7h4cm97blhjml
mandos-keygen: Generate "checker" option to use SSH fingerprints.

To turn this off, use a new "--no-ssh" option to mandos-keygen.

* INSTALL (Mandos Server, Mandos Client): Document new suggested
                                          installation of SSH.
* Makefile (confdir/clients.conf): Use new "--no-ssh" option to
                                   "mandos-keygen".
* debian/control (mandos/Depends): Changed to "fping | ssh-client".
  (mandos-client/Recommends): New; set to "ssh".
* intro.xml (FREQUENTLY ASKED QUESTIONS): Rename and rewrite section
                                          called "Faking ping
                                          replies?" to address new
                                          default behavior.
* mandos-clients.conf.xml (OPTIONS/checker): Briefly discuss new
                                             behavior of
                                             mandos-keygen.
* mandos-keygen: Bug fix: Suppress failure output of "shred" to remove
                 "sec*", since no such files may exist.
 (password mode): Scan for SSH key fingerprints and output as new
                  "checker" and "ssh_fingerprint" options, unless new
                  "--no-ssh" option is given.
* mandos-keygen.xml (SYNOPSIS/--force): Bug fix: Document short form.
  (OPTIONS/--no-ssh): New.
  (SEE ALSO): Add reference "ssh-keyscan(1)".
* plugins.d/mandos-client.xml (SECURITY): Briefly mention the
                                          possibility of using SSH key
                                          fingerprints for checking.

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 "2014-06-22">
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>
37
40
      <holder>Teddy Hogeborn</holder>
38
41
      <holder>Björn Påhlsson</holder>
39
42
    </copyright>
63
66
      ><refentrytitle>mandos</refentrytitle>
64
67
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
68
      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.
 
69
      the service.  The settings in this file can be overridden by
 
70
      runtime changes to the server, which it saves across restarts.
 
71
      (See the section called <quote>PERSISTENT STATE</quote> in
 
72
      <citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
 
73
      >8</manvolnum></citerefentry>.)  However, any <emphasis
 
74
      >changes</emphasis> to this file (including adding and removing
 
75
      clients) will, at startup, override changes done during runtime.
69
76
    </para>
70
77
    <para>
71
78
      The format starts with a <literal>[<replaceable>section
101
108
    <variablelist>
102
109
      
103
110
      <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.
 
111
        <term><option>approval_delay<literal> = </literal><replaceable
 
112
        >TIME</replaceable></option></term>
 
113
        <listitem>
 
114
          <para>
 
115
            This option is <emphasis>optional</emphasis>.
 
116
          </para>
 
117
          <para>
 
118
            How long to wait for external approval before resorting to
 
119
            use the <option>approved_by_default</option> value.  The
 
120
            default is <quote>PT0S</quote>, i.e. not to wait.
 
121
          </para>
 
122
          <para>
 
123
            The format of <replaceable>TIME</replaceable> is the same
 
124
            as for <varname>timeout</varname> below.
 
125
          </para>
 
126
        </listitem>
 
127
      </varlistentry>
 
128
      
 
129
      <varlistentry>
 
130
        <term><option>approval_duration<literal> = </literal
 
131
        ><replaceable>TIME</replaceable></option></term>
 
132
        <listitem>
 
133
          <para>
 
134
            This option is <emphasis>optional</emphasis>.
 
135
          </para>
 
136
          <para>
 
137
            How long an external approval lasts.  The default is 1
 
138
            second.
 
139
          </para>
 
140
          <para>
 
141
            The format of <replaceable>TIME</replaceable> is the same
 
142
            as for <varname>timeout</varname> below.
 
143
          </para>
 
144
        </listitem>
 
145
      </varlistentry>
 
146
      
 
147
      <varlistentry>
 
148
        <term><option>approved_by_default<literal> = </literal
 
149
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
 
150
          >true</literal> | <literal>on</literal> | <literal
 
151
          >0</literal> | <literal>no</literal> | <literal
 
152
          >false</literal> | <literal>off</literal> }</option></term>
 
153
        <listitem>
 
154
          <para>
 
155
            Whether to approve a client by default after
 
156
            the <option>approval_delay</option>.  The default
 
157
            is <quote>True</quote>.
152
158
          </para>
153
159
        </listitem>
154
160
      </varlistentry>
161
167
            This option is <emphasis>optional</emphasis>.
162
168
          </para>
163
169
          <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>
 
170
            This option overrides the default shell command that the
 
171
            server will use to check if the client is still up.  Any
 
172
            output of the command will be ignored, only the exit code
 
173
            is checked:  If the exit code of the command is zero, the
 
174
            client is considered up.  The command will be run using
 
175
            <quote><command><filename>/bin/sh</filename>
170
176
            <option>-c</option></command></quote>, so
171
177
            <varname>PATH</varname> will be searched.  The default
172
178
            value for the checker command is <quote><literal
173
179
            ><command>fping</command> <option>-q</option> <option
174
 
            >--</option> %%(host)s</literal></quote>.
 
180
            >--</option> %%(host)s</literal></quote>.  Note that
 
181
            <command>mandos-keygen</command>, when generating output
 
182
            to be inserted into this file, normally looks for an SSH
 
183
            server on the Mandos client, and, if it find one, outputs
 
184
            a <option>checker</option> option to check for the
 
185
            client’s key fingerprint – this is more secure against
 
186
            spoofing.
175
187
          </para>
176
188
          <para>
177
189
            In addition to normal start time expansion, this option
182
194
      </varlistentry>
183
195
      
184
196
      <varlistentry>
 
197
        <term><option>extended_timeout<literal> = </literal><replaceable
 
198
        >TIME</replaceable></option></term>
 
199
        <listitem>
 
200
          <para>
 
201
            This option is <emphasis>optional</emphasis>.
 
202
          </para>
 
203
          <para>
 
204
            Extended timeout is an added timeout that is given once
 
205
            after a password has been sent successfully to a client.
 
206
            The timeout is by default longer than the normal timeout,
 
207
            and is used for handling the extra long downtime while a
 
208
            machine is booting up.  Time to take into consideration
 
209
            when changing this value is file system checks and quota
 
210
            checks.  The default value is 15 minutes.
 
211
          </para>
 
212
          <para>
 
213
            The format of <replaceable>TIME</replaceable> is the same
 
214
            as for <varname>timeout</varname> below.
 
215
          </para>
 
216
        </listitem>
 
217
      </varlistentry>
 
218
      
 
219
      <varlistentry>
185
220
        <term><option>fingerprint<literal> = </literal
186
221
        ><replaceable>HEXSTRING</replaceable></option></term>
187
222
        <listitem>
198
233
      </varlistentry>
199
234
      
200
235
      <varlistentry>
 
236
        <term><option><literal>host = </literal><replaceable
 
237
        >STRING</replaceable></option></term>
 
238
        <listitem>
 
239
          <para>
 
240
            This option is <emphasis>optional</emphasis>, but highly
 
241
            <emphasis>recommended</emphasis> unless the
 
242
            <option>checker</option> option is modified to a
 
243
            non-standard value without <quote>%%(host)s</quote> in it.
 
244
          </para>
 
245
          <para>
 
246
            Host name for this client.  This is not used by the server
 
247
            directly, but can be, and is by default, used by the
 
248
            checker.  See the <option>checker</option> option.
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
      
 
253
      <varlistentry>
 
254
        <term><option>interval<literal> = </literal><replaceable
 
255
        >TIME</replaceable></option></term>
 
256
        <listitem>
 
257
          <para>
 
258
            This option is <emphasis>optional</emphasis>.
 
259
          </para>
 
260
          <para>
 
261
            How often to run the checker to confirm that a client is
 
262
            still up.  <emphasis>Note:</emphasis> a new checker will
 
263
            not be started if an old one is still running.  The server
 
264
            will wait for a checker to complete until the below
 
265
            <quote><varname>timeout</varname></quote> occurs, at which
 
266
            time the client will be disabled, and any running checker
 
267
            killed.  The default interval is 2 minutes.
 
268
          </para>
 
269
          <para>
 
270
            The format of <replaceable>TIME</replaceable> is the same
 
271
            as for <varname>timeout</varname> below.
 
272
          </para>
 
273
        </listitem>
 
274
      </varlistentry>
 
275
      
 
276
      <varlistentry>
 
277
        <term><option>secfile<literal> = </literal><replaceable
 
278
        >FILENAME</replaceable></option></term>
 
279
        <listitem>
 
280
          <para>
 
281
            This option is only used if <option>secret</option> is not
 
282
            specified, in which case this option is
 
283
            <emphasis>required</emphasis>.
 
284
          </para>
 
285
          <para>
 
286
            Similar to the <option>secret</option>, except the secret
 
287
            data is in an external file.  The contents of the file
 
288
            should <emphasis>not</emphasis> be base64-encoded, but
 
289
            will be sent to clients verbatim.
 
290
          </para>
 
291
          <para>
 
292
            File names of the form <filename>~user/foo/bar</filename>
 
293
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
294
            are supported.
 
295
          </para>
 
296
        </listitem>
 
297
      </varlistentry>
 
298
      
 
299
      <varlistentry>
201
300
        <term><option>secret<literal> = </literal><replaceable
202
301
        >BASE64_ENCODED_DATA</replaceable></option></term>
203
302
        <listitem>
228
327
      </varlistentry>
229
328
      
230
329
      <varlistentry>
231
 
        <term><option>secfile<literal> = </literal><replaceable
232
 
        >FILENAME</replaceable></option></term>
 
330
        <term><option>timeout<literal> = </literal><replaceable
 
331
        >TIME</replaceable></option></term>
233
332
        <listitem>
234
333
          <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.
 
334
            This option is <emphasis>optional</emphasis>.
 
335
          </para>
 
336
          <para>
 
337
            The timeout is how long the server will wait, after a
 
338
            successful checker run, until a client is disabled and not
 
339
            allowed to get the data this server holds.  By default
 
340
            Mandos will use 5 minutes.  See also the
 
341
            <option>extended_timeout</option> option.
 
342
          </para>
 
343
          <para>
 
344
            The <replaceable>TIME</replaceable> is specified as an RFC
 
345
            3339 duration; for example
 
346
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
347
            one year, two months, three days, four hours, five
 
348
            minutes, and six seconds.  Some values can be omitted, see
 
349
            RFC 3339 Appendix A for details.
249
350
          </para>
250
351
        </listitem>
251
352
      </varlistentry>
252
353
      
253
354
      <varlistentry>
254
 
        <term><option><literal>host = </literal><replaceable
255
 
        >STRING</replaceable></option></term>
 
355
        <term><option>enabled<literal> = </literal>{ <literal
 
356
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
357
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
358
        >no</literal> | <literal>false</literal> | <literal
 
359
        >off</literal> }</option></term>
256
360
        <listitem>
257
361
          <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.
 
362
            Whether this client should be enabled by default.  The
 
363
            default is <quote>true</quote>.
267
364
          </para>
268
365
        </listitem>
269
366
      </varlistentry>
306
403
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
307
404
        ></quote> will be replaced by the value of the attribute
308
405
        <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.
 
406
        <quote><classname>Client</classname></quote> object in the
 
407
        Mandos server.  The currently allowed values for
 
408
        <replaceable>foo</replaceable> are:
 
409
        <quote><literal>approval_delay</literal></quote>,
 
410
        <quote><literal>approval_duration</literal></quote>,
 
411
        <quote><literal>created</literal></quote>,
 
412
        <quote><literal>enabled</literal></quote>,
 
413
        <quote><literal>expires</literal></quote>,
 
414
        <quote><literal>fingerprint</literal></quote>,
 
415
        <quote><literal>host</literal></quote>,
 
416
        <quote><literal>interval</literal></quote>,
 
417
        <quote><literal>last_approval_request</literal></quote>,
 
418
        <quote><literal>last_checked_ok</literal></quote>,
 
419
        <quote><literal>last_enabled</literal></quote>,
 
420
        <quote><literal>name</literal></quote>,
 
421
        <quote><literal>timeout</literal></quote>, and, if using
 
422
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
423
        See the source code for details.  <emphasis role="strong"
 
424
        >Currently, <emphasis>none</emphasis> of these attributes
 
425
        except <quote><literal>host</literal></quote> are guaranteed
 
426
        to be valid in future versions.</emphasis> Therefore, please
 
427
        let the authors know of any attributes that are useful so they
 
428
        may be preserved to any new versions of this software.
313
429
      </para>
314
430
      <para>
315
431
        Note that this means that, in order to include an actual
350
466
    <informalexample>
351
467
      <programlisting>
352
468
[DEFAULT]
353
 
timeout = 1h
354
 
interval = 5m
 
469
timeout = PT5M
 
470
interval = PT2M
355
471
checker = fping -q -- %%(host)s
356
472
 
357
473
# Client "foo"
374
490
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
375
491
        QlnHIvPzEArRQLo=
376
492
host = foo.example.org
377
 
interval = 1m
 
493
interval = PT1M
378
494
 
379
495
# Client "bar"
380
496
[bar]
381
497
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
382
498
secfile = /etc/mandos/bar-secret
383
 
timeout = 15m
 
499
timeout = PT15M
 
500
approved_by_default = False
 
501
approval_delay = PT30S
384
502
      </programlisting>
385
503
    </informalexample>
386
504
  </refsect1>
388
506
  <refsect1 id="see_also">
389
507
    <title>SEE ALSO</title>
390
508
    <para>
 
509
      <citerefentry><refentrytitle>intro</refentrytitle>
 
510
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
511
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
392
512
      <manvolnum>8</manvolnum></citerefentry>,
393
513
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
394
514
      <manvolnum>5</manvolnum></citerefentry>,
395
515
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
516
      <manvolnum>8</manvolnum></citerefentry>,
 
517
      <citerefentry><refentrytitle>fping</refentrytitle>
396
518
      <manvolnum>8</manvolnum></citerefentry>
397
519
    </para>
 
520
    <variablelist>
 
521
      <varlistentry>
 
522
        <term>
 
523
          RFC 3339: <citetitle>Date and Time on the Internet:
 
524
          Timestamps</citetitle>
 
525
        </term>
 
526
      <listitem>
 
527
        <para>
 
528
          The time intervals are in the "duration" format, as
 
529
          specified in ABNF in Appendix A of RFC 3339.
 
530
        </para>
 
531
      </listitem>
 
532
      </varlistentry>
 
533
    </variablelist>
398
534
  </refsect1>
399
535
</refentry>
400
536
<!-- Local Variables: -->