/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: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
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-29">
 
6
<!ENTITY TIMESTAMP "2019-02-09">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
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
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
49
    <xi:include href="legalnotice.xml"/>
61
50
  </refentryinfo>
62
 
 
 
51
  
63
52
  <refmeta>
64
53
    <refentrytitle>&CONFNAME;</refentrytitle>
65
54
    <manvolnum>5</manvolnum>
71
60
      Configuration file for the Mandos server
72
61
    </refpurpose>
73
62
  </refnamediv>
74
 
 
 
63
  
75
64
  <refsynopsisdiv>
76
 
    <synopsis>
77
 
      &CONFPATH;
78
 
    </synopsis>
 
65
    <synopsis>&CONFPATH;</synopsis>
79
66
  </refsynopsisdiv>
80
 
 
 
67
  
81
68
  <refsect1 id="description">
82
69
    <title>DESCRIPTION</title>
83
70
    <para>
85
72
      ><refentrytitle>mandos</refentrytitle>
86
73
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
87
74
      The file needs to list all clients that should be able to use
88
 
      the service.  All clients listed will be regarded as valid, even
89
 
      if a client was declared invalid in a previous run of the
90
 
      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.
91
82
    </para>
92
83
    <para>
93
84
      The format starts with a <literal>[<replaceable>section
117
108
      start time expansion, see <xref linkend="expansion"/>.
118
109
    </para>
119
110
    <para>
120
 
      Uknown options are ignored.  The used options are as follows:
 
111
      Unknown options are ignored.  The used options are as follows:
121
112
    </para>
122
 
 
 
113
    
123
114
    <variablelist>
124
 
 
125
 
      <varlistentry>
126
 
        <term><literal><varname>timeout</varname></literal></term>
127
 
        <listitem>
128
 
          <synopsis><literal>timeout = </literal><replaceable
129
 
          >TIME</replaceable>
130
 
          </synopsis>
131
 
          <para>
132
 
            The timeout is how long the server will wait for a
133
 
            successful checker run until a client is considered
134
 
            invalid - that is, ineligible to get the data this server
135
 
            holds.  By default Mandos will use 1 hour.
136
 
          </para>
137
 
          <para>
138
 
            The <replaceable>TIME</replaceable> is specified as a
139
 
            space-separated number of values, each of which is a
140
 
            number and a one-character suffix.  The suffix must be one
141
 
            of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
142
 
            <quote>h</quote>, and <quote>w</quote> for days, seconds,
143
 
            minutes, hours, and weeks, respectively.  The values are
144
 
            added together to give the total time value, so all of
145
 
            <quote><literal>330s</literal></quote>,
146
 
            <quote><literal>110s 110s 110s</literal></quote>, and
147
 
            <quote><literal>5m 30s</literal></quote> will give a value
148
 
            of five minutes and thirty seconds.
149
 
          </para>
150
 
        </listitem>
151
 
      </varlistentry>
152
 
 
153
 
      <varlistentry>
154
 
        <term><literal><varname>interval</varname></literal></term>
155
 
        <listitem>
156
 
          <synopsis><literal>interval = </literal><replaceable
157
 
          >TIME</replaceable>
158
 
          </synopsis>
159
 
          <para>
160
 
            How often to run the checker to confirm that a client is
161
 
            still up.  <emphasis>Note:</emphasis> a new checker will
162
 
            not be started if an old one is still running.  The server
163
 
            will wait for a checker to complete until the above
164
 
            <quote><varname>timeout</varname></quote> occurs, at which
165
 
            time the client will be marked invalid, and any running
166
 
            checker killed.  The default interval is 5 minutes.
167
 
          </para>
168
 
          <para>
169
 
            The format of <replaceable>TIME</replaceable> is the same
170
 
            as for <varname>timeout</varname> above.
171
 
          </para>
172
 
        </listitem>
173
 
      </varlistentry>      
174
 
 
175
 
      <varlistentry>
176
 
        <term><literal>checker</literal></term>
177
 
        <listitem>
178
 
          <synopsis><literal>checker = </literal><replaceable
179
 
          >COMMAND</replaceable>
180
 
          </synopsis>
181
 
          <para>
182
 
            This option allows you to override the default shell
183
 
            command that the server will use to check if the client is
184
 
            still up.  Any output of the command will be ignored, only
185
 
            the exit code is checked:  If the exit code of the command
186
 
            is zero, the client is considered up.  The command will be
187
 
            run using <quote><command><filename>/bin/sh</filename>
 
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
      
 
168
      <varlistentry>
 
169
        <term><option>checker<literal> = </literal><replaceable
 
170
        >COMMAND</replaceable></option></term>
 
171
        <listitem>
 
172
          <para>
 
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>
188
182
            <option>-c</option></command></quote>, so
189
183
            <varname>PATH</varname> will be searched.  The default
190
184
            value for the checker command is <quote><literal
191
185
            ><command>fping</command> <option>-q</option> <option
192
 
            >--</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.
193
193
          </para>
194
194
          <para>
195
195
            In addition to normal start time expansion, this option
200
200
      </varlistentry>
201
201
      
202
202
      <varlistentry>
203
 
        <term><literal>fingerprint</literal></term>
204
 
        <listitem>
205
 
          <synopsis><literal>fingerprint = </literal><replaceable
206
 
          >HEXSTRING</replaceable>
207
 
          </synopsis>
 
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>
 
226
        <term><option>fingerprint<literal> = </literal
 
227
        ><replaceable>HEXSTRING</replaceable></option></term>
 
228
        <listitem>
 
229
          <para>
 
230
            This option is <emphasis>required</emphasis>.
 
231
          </para>
208
232
          <para>
209
233
            This option sets the OpenPGP fingerprint that identifies
210
234
            the public key that clients authenticate themselves with
211
 
            through TLS.  The string needs to be in hexidecimal form,
212
 
            but spaces or upper/lower case are not significant.
213
 
          </para>
214
 
        </listitem>
215
 
      </varlistentry>
216
 
      
217
 
      <varlistentry>
218
 
        <term><literal>secret</literal></term>
219
 
        <listitem>
220
 
          <synopsis><literal>secret = </literal><replaceable
221
 
          >BASE64_ENCODED_DATA</replaceable>
222
 
          </synopsis>
 
235
            through TLS.  The string needs to be in hexadecimal form,
 
236
            but spaces or upper/lower case are not significant.
 
237
          </para>
 
238
        </listitem>
 
239
      </varlistentry>
 
240
      
 
241
      <varlistentry>
 
242
        <term><option>key_id<literal> = </literal
 
243
        ><replaceable>HEXSTRING</replaceable></option></term>
 
244
        <listitem>
 
245
          <para>
 
246
            This option is <emphasis>optional</emphasis>.
 
247
          </para>
 
248
          <para>
 
249
            This option sets the certificate key ID that identifies
 
250
            the public key that clients authenticate themselves with
 
251
            through TLS.  The string needs to be in hexadecimal form,
 
252
            but spaces or upper/lower case are not significant.
 
253
          </para>
 
254
        </listitem>
 
255
      </varlistentry>
 
256
      
 
257
      <varlistentry>
 
258
        <term><option><literal>host = </literal><replaceable
 
259
        >STRING</replaceable></option></term>
 
260
        <listitem>
 
261
          <para>
 
262
            This option is <emphasis>optional</emphasis>, but highly
 
263
            <emphasis>recommended</emphasis> unless the
 
264
            <option>checker</option> option is modified to a
 
265
            non-standard value without <quote>%%(host)s</quote> in it.
 
266
          </para>
 
267
          <para>
 
268
            Host name for this client.  This is not used by the server
 
269
            directly, but can be, and is by default, used by the
 
270
            checker.  See the <option>checker</option> option.
 
271
          </para>
 
272
        </listitem>
 
273
      </varlistentry>
 
274
      
 
275
      <varlistentry>
 
276
        <term><option>interval<literal> = </literal><replaceable
 
277
        >TIME</replaceable></option></term>
 
278
        <listitem>
 
279
          <para>
 
280
            This option is <emphasis>optional</emphasis>.
 
281
          </para>
 
282
          <para>
 
283
            How often to run the checker to confirm that a client is
 
284
            still up.  <emphasis>Note:</emphasis> a new checker will
 
285
            not be started if an old one is still running.  The server
 
286
            will wait for a checker to complete until the below
 
287
            <quote><varname>timeout</varname></quote> occurs, at which
 
288
            time the client will be disabled, and any running checker
 
289
            killed.  The default interval is 2 minutes.
 
290
          </para>
 
291
          <para>
 
292
            The format of <replaceable>TIME</replaceable> is the same
 
293
            as for <varname>timeout</varname> below.
 
294
          </para>
 
295
        </listitem>
 
296
      </varlistentry>
 
297
      
 
298
      <varlistentry>
 
299
        <term><option>secfile<literal> = </literal><replaceable
 
300
        >FILENAME</replaceable></option></term>
 
301
        <listitem>
 
302
          <para>
 
303
            This option is only used if <option>secret</option> is not
 
304
            specified, in which case this option is
 
305
            <emphasis>required</emphasis>.
 
306
          </para>
 
307
          <para>
 
308
            Similar to the <option>secret</option>, except the secret
 
309
            data is in an external file.  The contents of the file
 
310
            should <emphasis>not</emphasis> be base64-encoded, but
 
311
            will be sent to clients verbatim.
 
312
          </para>
 
313
          <para>
 
314
            File names of the form <filename>~user/foo/bar</filename>
 
315
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
316
            are supported.
 
317
          </para>
 
318
        </listitem>
 
319
      </varlistentry>
 
320
      
 
321
      <varlistentry>
 
322
        <term><option>secret<literal> = </literal><replaceable
 
323
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
324
        <listitem>
 
325
          <para>
 
326
            If this option is not specified, the <option
 
327
            >secfile</option> option is <emphasis>required</emphasis>
 
328
            to be present.
 
329
          </para>
223
330
          <para>
224
331
            If present, this option must be set to a string of
225
332
            base64-encoded binary data.  It will be decoded and sent
226
 
            to the client matching the above
227
 
            <option>fingerprint</option>.  This should, of course, be
228
 
            OpenPGP encrypted data, decryptable only by the client.
 
333
            to the client matching the above <option>key_id</option>
 
334
            or <option>fingerprint</option>.  This should, of course,
 
335
            be OpenPGP encrypted data, decryptable only by the client.
229
336
            The program <citerefentry><refentrytitle><command
230
337
            >mandos-keygen</command></refentrytitle><manvolnum
231
338
            >8</manvolnum></citerefentry> can, using its
238
345
            lines is that a line beginning with white space adds to
239
346
            the value of the previous line, RFC 822-style.
240
347
          </para>
241
 
          <para>
242
 
            If this option is not specified, the <option
243
 
            >secfile</option> option is used instead, but one of them
244
 
            <emphasis>must</emphasis> be present.
245
 
          </para>
246
 
        </listitem>
247
 
      </varlistentry>
248
 
 
249
 
      <varlistentry>
250
 
        <term><literal>secfile</literal></term>
251
 
        <listitem>
252
 
          <synopsis><literal>secfile = </literal><replaceable
253
 
          >FILENAME</replaceable>
254
 
          </synopsis>
255
 
          <para>
256
 
            The same as <option>secret</option>, but the secret data
257
 
            is in an external file.  The contents of the file should
258
 
            <emphasis>not</emphasis> be base64-encoded, but will be
259
 
            sent to clients verbatim.
260
 
          </para>
261
 
          <para>
262
 
            This option is only used, and <emphasis>must</emphasis> be
263
 
            present, if <option>secret</option> is not specified.
264
 
          </para>
265
 
        </listitem>
266
 
      </varlistentry>
267
 
 
268
 
      <varlistentry>
269
 
        <term><literal>host</literal></term>
270
 
        <listitem>
271
 
          <synopsis><literal>host = </literal><replaceable
272
 
          >STRING</replaceable>
273
 
          </synopsis>
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.
 
348
        </listitem>
 
349
      </varlistentry>
 
350
      
 
351
      <varlistentry>
 
352
        <term><option>timeout<literal> = </literal><replaceable
 
353
        >TIME</replaceable></option></term>
 
354
        <listitem>
 
355
          <para>
 
356
            This option is <emphasis>optional</emphasis>.
 
357
          </para>
 
358
          <para>
 
359
            The timeout is how long the server will wait, after a
 
360
            successful checker run, until a client is disabled and not
 
361
            allowed to get the data this server holds.  By default
 
362
            Mandos will use 5 minutes.  See also the
 
363
            <option>extended_timeout</option> option.
 
364
          </para>
 
365
          <para>
 
366
            The <replaceable>TIME</replaceable> is specified as an RFC
 
367
            3339 duration; for example
 
368
            <quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
 
369
            one year, two months, three days, four hours, five
 
370
            minutes, and six seconds.  Some values can be omitted, see
 
371
            RFC 3339 Appendix A for details.
 
372
          </para>
 
373
        </listitem>
 
374
      </varlistentry>
 
375
      
 
376
      <varlistentry>
 
377
        <term><option>enabled<literal> = </literal>{ <literal
 
378
        >1</literal> | <literal>yes</literal> | <literal>true</literal
 
379
        > | <literal >on</literal> | <literal>0</literal> | <literal
 
380
        >no</literal> | <literal>false</literal> | <literal
 
381
        >off</literal> }</option></term>
 
382
        <listitem>
 
383
          <para>
 
384
            Whether this client should be enabled by default.  The
 
385
            default is <quote>true</quote>.
278
386
          </para>
279
387
        </listitem>
280
388
      </varlistentry>
281
389
      
282
390
    </variablelist>
283
 
  </refsect1>  
 
391
  </refsect1>
284
392
  
285
393
  <refsect1 id="expansion">
286
394
    <title>EXPANSION</title>
317
425
        <quote><literal>%%(<replaceable>foo</replaceable>)s</literal
318
426
        ></quote> will be replaced by the value of the attribute
319
427
        <varname>foo</varname> of the internal
320
 
        <quote><classname>Client</classname></quote> object.  See the
321
 
        source code for details, and let the authors know of any
322
 
        attributes that are useful so they may be preserved to any new
323
 
        versions of this software.
 
428
        <quote><classname>Client</classname></quote> object in the
 
429
        Mandos server.  The currently allowed values for
 
430
        <replaceable>foo</replaceable> are:
 
431
        <quote><literal>approval_delay</literal></quote>,
 
432
        <quote><literal>approval_duration</literal></quote>,
 
433
        <quote><literal>created</literal></quote>,
 
434
        <quote><literal>enabled</literal></quote>,
 
435
        <quote><literal>expires</literal></quote>,
 
436
        <quote><literal>key_id</literal></quote>,
 
437
        <quote><literal>fingerprint</literal></quote>,
 
438
        <quote><literal>host</literal></quote>,
 
439
        <quote><literal>interval</literal></quote>,
 
440
        <quote><literal>last_approval_request</literal></quote>,
 
441
        <quote><literal>last_checked_ok</literal></quote>,
 
442
        <quote><literal>last_enabled</literal></quote>,
 
443
        <quote><literal>name</literal></quote>,
 
444
        <quote><literal>timeout</literal></quote>, and, if using
 
445
        D-Bus, <quote><literal>dbus_object_path</literal></quote>.
 
446
        See the source code for details.  <emphasis role="strong"
 
447
        >Currently, <emphasis>none</emphasis> of these attributes
 
448
        except <quote><literal>host</literal></quote> are guaranteed
 
449
        to be valid in future versions.</emphasis> Therefore, please
 
450
        let the authors know of any attributes that are useful so they
 
451
        may be preserved to any new versions of this software.
324
452
      </para>
325
453
      <para>
326
454
        Note that this means that, in order to include an actual
329
457
        percent characters in a row (<quote>%%%%</quote>) must be
330
458
        entered.  Also, a bad format here will lead to an immediate
331
459
        but <emphasis>silent</emphasis> run-time fatal exit; debug
332
 
        mode is needed to track down an error of this kind.
 
460
        mode is needed to expose an error of this kind.
333
461
      </para>
334
462
    </refsect2>
335
 
 
336
 
  </refsect1>  
 
463
    
 
464
  </refsect1>
337
465
  
338
466
  <refsect1 id="files">
339
467
    <title>FILES</title>
354
482
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
355
483
      obscure.
356
484
    </para>
 
485
    <xi:include href="bugs.xml"/>
357
486
  </refsect1>
358
487
  
359
488
  <refsect1 id="example">
361
490
    <informalexample>
362
491
      <programlisting>
363
492
[DEFAULT]
364
 
timeout = 1h
365
 
interval = 5m
366
 
checker = fping -q -- %(host)s
 
493
timeout = PT5M
 
494
interval = PT2M
 
495
checker = fping -q -- %%(host)s
367
496
 
368
497
# Client "foo"
369
498
[foo]
 
499
key_id = 788cd77115cd0bb7b2d5e0ae8496f6b48149d5e712c652076b1fd2d957ef7c1f
370
500
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
371
501
secret =
372
502
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
385
515
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
386
516
        QlnHIvPzEArRQLo=
387
517
host = foo.example.org
388
 
interval = 1m
 
518
interval = PT1M
389
519
 
390
520
# Client "bar"
391
521
[bar]
 
522
key_id = F90C7A81D72D1EA69A51031A91FF8885F36C8B46D155C8C58709A4C99AE9E361
392
523
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
393
524
secfile = /etc/mandos/bar-secret
394
 
timeout = 15m
395
 
 
 
525
timeout = PT15M
 
526
approved_by_default = False
 
527
approval_delay = PT30S
396
528
      </programlisting>
397
529
    </informalexample>
398
 
  </refsect1>  
 
530
  </refsect1>
399
531
  
400
532
  <refsect1 id="see_also">
401
533
    <title>SEE ALSO</title>
402
534
    <para>
 
535
      <citerefentry><refentrytitle>intro</refentrytitle>
 
536
      <manvolnum>8mandos</manvolnum></citerefentry>,
403
537
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
404
538
      <manvolnum>8</manvolnum></citerefentry>,
405
539
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
406
540
      <manvolnum>5</manvolnum></citerefentry>,
407
541
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
542
      <manvolnum>8</manvolnum></citerefentry>,
 
543
      <citerefentry><refentrytitle>fping</refentrytitle>
408
544
      <manvolnum>8</manvolnum></citerefentry>
409
545
    </para>
 
546
    <variablelist>
 
547
      <varlistentry>
 
548
        <term>
 
549
          RFC 3339: <citetitle>Date and Time on the Internet:
 
550
          Timestamps</citetitle>
 
551
        </term>
 
552
      <listitem>
 
553
        <para>
 
554
          The time intervals are in the "duration" format, as
 
555
          specified in ABNF in Appendix A of RFC 3339.
 
556
        </para>
 
557
      </listitem>
 
558
      </varlistentry>
 
559
    </variablelist>
410
560
  </refsect1>
411
561
</refentry>
412
562
<!-- Local Variables: -->