/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: 2018-08-19 14:32:00 UTC
  • Revision ID: teddy@recompile.se-20180819143200-8j8sc2hv4ovjqo11
Remove workaround for old mkinitramfs-kpkg

* Makefile (install-client-nokey): Do not install
  "initramfs-tools-hook-conf".
* debian/control (mandos-client/Depends): Add "(>= 0.99)" to
  dependency on "initramfs-tools", since that is the version which
  removed mkinitramfs-kpkg.
* debian/mandos-client.dirs: Remove
  "usr/share/initramfs-tools/conf-hooks.d".
* initramfs-tools-hook-conf: Removed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-08-31">
 
6
<!ENTITY TIMESTAMP "2018-02-08">
 
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>
 
45
      <year>2018</year>
35
46
      <holder>Teddy Hogeborn</holder>
36
47
      <holder>Björn Påhlsson</holder>
37
48
    </copyright>
38
49
    <xi:include href="legalnotice.xml"/>
39
50
  </refentryinfo>
40
 
 
 
51
  
41
52
  <refmeta>
42
53
    <refentrytitle>&CONFNAME;</refentrytitle>
43
54
    <manvolnum>5</manvolnum>
49
60
      Configuration file for the Mandos server
50
61
    </refpurpose>
51
62
  </refnamediv>
52
 
 
 
63
  
53
64
  <refsynopsisdiv>
54
65
    <synopsis>&CONFPATH;</synopsis>
55
66
  </refsynopsisdiv>
56
 
 
 
67
  
57
68
  <refsect1 id="description">
58
69
    <title>DESCRIPTION</title>
59
70
    <para>
61
72
      ><refentrytitle>mandos</refentrytitle>
62
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
74
      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.
 
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.
67
82
    </para>
68
83
    <para>
69
84
      The format starts with a <literal>[<replaceable>section
93
108
      start time expansion, see <xref linkend="expansion"/>.
94
109
    </para>
95
110
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
111
      Unknown options are ignored.  The used options are as follows:
97
112
    </para>
98
 
 
 
113
    
99
114
    <variablelist>
100
 
 
101
 
      <varlistentry>
102
 
        <term><option>timeout<literal> = </literal><replaceable
103
 
        >TIME</replaceable></option></term>
104
 
        <listitem>
105
 
          <para>
106
 
            The timeout is how long the server will wait for a
107
 
            successful checker run until a client is considered
108
 
            invalid - that is, ineligible to get the data this server
109
 
            holds.  By default Mandos will use 1 hour.
110
 
          </para>
111
 
          <para>
112
 
            The <replaceable>TIME</replaceable> is specified as a
113
 
            space-separated number of values, each of which is a
114
 
            number and a one-character suffix.  The suffix must be one
115
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
116
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
117
 
            minutes, hours, and weeks, respectively.  The values are
118
 
            added together to give the total time value, so all of
119
 
            <quote><literal>330s</literal></quote>,
120
 
            <quote><literal>110s 110s 110s</literal></quote>, and
121
 
            <quote><literal>5m 30s</literal></quote> will give a value
122
 
            of five minutes and thirty seconds.
123
 
          </para>
124
 
        </listitem>
125
 
      </varlistentry>
126
 
 
127
 
      <varlistentry>
128
 
        <term><option>interval<literal> = </literal><replaceable
129
 
        >TIME</replaceable></option></term>
130
 
        <listitem>
131
 
          <para>
132
 
            How often to run the checker to confirm that a client is
133
 
            still up.  <emphasis>Note:</emphasis> a new checker will
134
 
            not be started if an old one is still running.  The server
135
 
            will wait for a checker to complete until the above
136
 
            <quote><varname>timeout</varname></quote> occurs, at which
137
 
            time the client will be marked invalid, and any running
138
 
            checker killed.  The default interval is 5 minutes.
139
 
          </para>
140
 
          <para>
141
 
            The format of <replaceable>TIME</replaceable> is the same
142
 
            as for <varname>timeout</varname> above.
143
 
          </para>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
 
 
115
      
 
116
      <varlistentry>
 
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>.
 
164
          </para>
 
165
        </listitem>
 
166
      </varlistentry>
 
167
      
147
168
      <varlistentry>
148
169
        <term><option>checker<literal> = </literal><replaceable
149
170
        >COMMAND</replaceable></option></term>
150
171
        <listitem>
151
172
          <para>
152
 
            This option allows you to override the default shell
153
 
            command that the server will use to check if the client is
154
 
            still up.  Any output of the command will be ignored, only
155
 
            the exit code is checked:  If the exit code of the command
156
 
            is zero, the client is considered up.  The command will be
157
 
            run using <quote><command><filename>/bin/sh</filename>
 
173
            This option is <emphasis>optional</emphasis>.
 
174
          </para>
 
175
          <para>
 
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>
158
182
            <option>-c</option></command></quote>, so
159
183
            <varname>PATH</varname> will be searched.  The default
160
184
            value for the checker command is <quote><literal
161
185
            ><command>fping</command> <option>-q</option> <option
162
 
            >--</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.
163
193
          </para>
164
194
          <para>
165
195
            In addition to normal start time expansion, this option
170
200
      </varlistentry>
171
201
      
172
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>
173
226
        <term><option>fingerprint<literal> = </literal
174
227
        ><replaceable>HEXSTRING</replaceable></option></term>
175
228
        <listitem>
176
229
          <para>
 
230
            This option is <emphasis>required</emphasis>.
 
231
          </para>
 
232
          <para>
177
233
            This option sets the OpenPGP fingerprint that identifies
178
234
            the public key that clients authenticate themselves with
179
 
            through TLS.  The string needs to be in hexidecimal form,
 
235
            through TLS.  The string needs to be in hexadecimal form,
180
236
            but spaces or upper/lower case are not significant.
181
237
          </para>
182
238
        </listitem>
183
239
      </varlistentry>
184
240
      
185
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>
186
306
        <term><option>secret<literal> = </literal><replaceable
187
307
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
308
        <listitem>
189
309
          <para>
 
310
            If this option is not specified, the <option
 
311
            >secfile</option> option is <emphasis>required</emphasis>
 
312
            to be present.
 
313
          </para>
 
314
          <para>
190
315
            If present, this option must be set to a string of
191
316
            base64-encoded binary data.  It will be decoded and sent
192
317
            to the client matching the above
204
329
            lines is that a line beginning with white space adds to
205
330
            the value of the previous line, RFC 822-style.
206
331
          </para>
207
 
          <para>
208
 
            If this option is not specified, the <option
209
 
            >secfile</option> option is used instead, but one of them
210
 
            <emphasis>must</emphasis> be present.
211
 
          </para>
212
 
        </listitem>
213
 
      </varlistentry>
214
 
 
215
 
      <varlistentry>
216
 
        <term><option>secfile<literal> = </literal><replaceable
217
 
        >FILENAME</replaceable></option></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Similar to the <option>secret</option>, except the secret
221
 
            data is in an external file.  The contents of the file
222
 
            should <emphasis>not</emphasis> be base64-encoded, but
223
 
            will be sent to clients verbatim.
224
 
          </para>
225
 
          <para>
226
 
            This option is only used, and <emphasis>must</emphasis> be
227
 
            present, if <option>secret</option> is not specified.
228
 
          </para>
229
 
        </listitem>
230
 
      </varlistentry>
231
 
 
232
 
      <varlistentry>
233
 
        <term><option><literal>host = </literal><replaceable
234
 
        >STRING</replaceable></option></term>
235
 
        <listitem>
236
 
          <para>
237
 
            Host name for this client.  This is not used by the server
238
 
            directly, but can be, and is by default, used by the
239
 
            checker.  See the <option>checker</option> option.
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
 
335
      <varlistentry>
 
336
        <term><option>timeout<literal> = </literal><replaceable
 
337
        >TIME</replaceable></option></term>
 
338
        <listitem>
 
339
          <para>
 
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.
 
356
          </para>
 
357
        </listitem>
 
358
      </varlistentry>
 
359
      
 
360
      <varlistentry>
 
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>
 
366
        <listitem>
 
367
          <para>
 
368
            Whether this client should be enabled by default.  The
 
369
            default is <quote>true</quote>.
240
370
          </para>
241
371
        </listitem>
242
372
      </varlistentry>
279
409
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
410
        ></quote> will be replaced by the value of the attribute
281
411
        <varname>foo</varname> of the internal
282
 
        <quote><classname>Client</classname></quote> object.  See the
283
 
        source code for details, and let the authors know of any
284
 
        attributes that are useful so they may be preserved to any new
285
 
        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.
286
435
      </para>
287
436
      <para>
288
437
        Note that this means that, in order to include an actual
294
443
        mode is needed to expose an error of this kind.
295
444
      </para>
296
445
    </refsect2>
297
 
 
 
446
    
298
447
  </refsect1>
299
448
  
300
449
  <refsect1 id="files">
316
465
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
317
466
      obscure.
318
467
    </para>
 
468
    <xi:include href="bugs.xml"/>
319
469
  </refsect1>
320
470
  
321
471
  <refsect1 id="example">
323
473
    <informalexample>
324
474
      <programlisting>
325
475
[DEFAULT]
326
 
timeout = 1h
327
 
interval = 5m
328
 
checker = fping -q -- %(host)s
 
476
timeout = PT5M
 
477
interval = PT2M
 
478
checker = fping -q -- %%(host)s
329
479
 
330
480
# Client "foo"
331
481
[foo]
347
497
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
348
498
        QlnHIvPzEArRQLo=
349
499
host = foo.example.org
350
 
interval = 1m
 
500
interval = PT1M
351
501
 
352
502
# Client "bar"
353
503
[bar]
354
504
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
355
505
secfile = /etc/mandos/bar-secret
356
 
timeout = 15m
357
 
 
 
506
timeout = PT15M
 
507
approved_by_default = False
 
508
approval_delay = PT30S
358
509
      </programlisting>
359
510
    </informalexample>
360
511
  </refsect1>
362
513
  <refsect1 id="see_also">
363
514
    <title>SEE ALSO</title>
364
515
    <para>
 
516
      <citerefentry><refentrytitle>intro</refentrytitle>
 
517
      <manvolnum>8mandos</manvolnum></citerefentry>,
365
518
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
519
      <manvolnum>8</manvolnum></citerefentry>,
367
520
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
368
521
      <manvolnum>5</manvolnum></citerefentry>,
369
522
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
523
      <manvolnum>8</manvolnum></citerefentry>,
 
524
      <citerefentry><refentrytitle>fping</refentrytitle>
370
525
      <manvolnum>8</manvolnum></citerefentry>
371
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>
372
541
  </refsect1>
373
542
</refentry>
374
543
<!-- Local Variables: -->