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
- browse files at revision 377
- compare with another revision
- download diff
- download tarball
- view history from revision 377
- Committer: Teddy Hogeborn
- Date: 2009-09-19 17:41:18 UTC
- Revision ID: teddy@fukt.bsnet.se-20090919174118-274yt9wptmtx0ykn
* plugins.d/password-prompt.c (main): Fix "-Wconversion" warning.
added
removed
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 "2010-09-26">
6
<!ENTITY TIMESTAMP "2009-09-17">
7
7
<!ENTITY % common SYSTEM "common.ent">
8
8
%common;
9
9
]>
34
34
<copyright>
35
35
<year>2008</year>
36
36
<year>2009</year>
37
<year>2010</year>
38
37
<holder>Teddy Hogeborn</holder>
39
38
<holder>Björn Påhlsson</holder>
40
39
</copyright>
64
63
><refentrytitle>mandos</refentrytitle>
65
64
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
66
65
The file needs to list all clients that should be able to use
67
the service. All clients listed will be regarded as enabled,
68
even if a client was disabled in a previous run of the server.
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
69
</para>
70
70
<para>
71
71
The format starts with a <literal>[<replaceable>section
101
101
<variablelist>
102
102
103
103
<varlistentry>
104
<term><option>approval_delay<literal> = </literal><replaceable
105
>TIME</replaceable></option></term>
106
<listitem>
107
<para>
108
This option is <emphasis>optional</emphasis>.
109
</para>
110
<para>
111
How long to wait for external approval before resorting to
112
use the <option>approved_by_default</option> value. The
113
default is <quote>0s</quote>, i.e. not to wait.
114
</para>
115
<para>
116
The format of <replaceable>TIME</replaceable> is the same
117
as for <varname>timeout</varname> below.
118
</para>
119
</listitem>
120
</varlistentry>
121
122
<varlistentry>
123
<term><option>approval_duration<literal> = </literal
124
><replaceable>TIME</replaceable></option></term>
125
<listitem>
126
<para>
127
This option is <emphasis>optional</emphasis>.
128
</para>
129
<para>
130
How long an external approval lasts. The default is 1
131
second.
132
</para>
133
<para>
134
The format of <replaceable>TIME</replaceable> is the same
135
as for <varname>timeout</varname> below.
136
</para>
137
</listitem>
138
</varlistentry>
139
140
<varlistentry>
141
<term><option>approved_by_default<literal> = </literal
142
>{ <literal >1</literal> | <literal>yes</literal> | <literal
143
>true</literal> | <literal>on</literal> | <literal
144
>0</literal> | <literal>no</literal> | <literal
145
>false</literal> | <literal>off</literal> }</option></term>
146
<listitem>
147
<para>
148
Whether to approve a client by default after
149
the <option>approval_delay</option>. The default
150
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.
151
152
</para>
152
153
</listitem>
153
154
</varlistentry>
197
198
</varlistentry>
198
199
199
200
<varlistentry>
200
<term><option><literal>host = </literal><replaceable
201
>STRING</replaceable></option></term>
202
<listitem>
203
<para>
204
This option is <emphasis>optional</emphasis>, but highly
205
<emphasis>recommended</emphasis> unless the
206
<option>checker</option> option is modified to a
207
non-standard value without <quote>%%(host)s</quote> in it.
208
</para>
209
<para>
210
Host name for this client. This is not used by the server
211
directly, but can be, and is by default, used by the
212
checker. See the <option>checker</option> option.
213
</para>
214
</listitem>
215
</varlistentry>
216
217
<varlistentry>
218
<term><option>interval<literal> = </literal><replaceable
219
>TIME</replaceable></option></term>
220
<listitem>
221
<para>
222
This option is <emphasis>optional</emphasis>.
223
</para>
224
<para>
225
How often to run the checker to confirm that a client is
226
still up. <emphasis>Note:</emphasis> a new checker will
227
not be started if an old one is still running. The server
228
will wait for a checker to complete until the below
229
<quote><varname>timeout</varname></quote> occurs, at which
230
time the client will be disabled, and any running checker
231
killed. The default interval is 5 minutes.
232
</para>
233
<para>
234
The format of <replaceable>TIME</replaceable> is the same
235
as for <varname>timeout</varname> below.
236
</para>
237
</listitem>
238
</varlistentry>
239
240
<varlistentry>
241
<term><option>secfile<literal> = </literal><replaceable
242
>FILENAME</replaceable></option></term>
243
<listitem>
244
<para>
245
This option is only used if <option>secret</option> is not
246
specified, in which case this option is
247
<emphasis>required</emphasis>.
248
</para>
249
<para>
250
Similar to the <option>secret</option>, except the secret
251
data is in an external file. The contents of the file
252
should <emphasis>not</emphasis> be base64-encoded, but
253
will be sent to clients verbatim.
254
</para>
255
<para>
256
File names of the form <filename>~user/foo/bar</filename>
257
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
258
are supported.
259
</para>
260
</listitem>
261
</varlistentry>
262
263
<varlistentry>
264
201
<term><option>secret<literal> = </literal><replaceable
265
202
>BASE64_ENCODED_DATA</replaceable></option></term>
266
203
<listitem>
291
228
</varlistentry>
292
229
293
230
<varlistentry>
294
<term><option>timeout<literal> = </literal><replaceable
295
>TIME</replaceable></option></term>
296
<listitem>
297
<para>
298
This option is <emphasis>optional</emphasis>.
299
</para>
300
<para>
301
The timeout is how long the server will wait (for either a
302
successful checker run or a client receiving its secret)
303
until a client is disabled and not allowed to get the data
304
this server holds. By default Mandos will use 1 hour.
305
</para>
306
<para>
307
The <replaceable>TIME</replaceable> is specified as a
308
space-separated number of values, each of which is a
309
number and a one-character suffix. The suffix must be one
310
of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
311
<quote>h</quote>, and <quote>w</quote> for days, seconds,
312
minutes, hours, and weeks, respectively. The values are
313
added together to give the total time value, so all of
314
<quote><literal>330s</literal></quote>,
315
<quote><literal>110s 110s 110s</literal></quote>, and
316
<quote><literal>5m 30s</literal></quote> will give a value
317
of five minutes and thirty seconds.
231
<term><option>secfile<literal> = </literal><replaceable
232
>FILENAME</replaceable></option></term>
233
<listitem>
234
<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.
249
</para>
250
</listitem>
251
</varlistentry>
252
253
<varlistentry>
254
<term><option><literal>host = </literal><replaceable
255
>STRING</replaceable></option></term>
256
<listitem>
257
<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.
318
267
</para>
319
268
</listitem>
320
269
</varlistentry>
432
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
433
382
secfile = /etc/mandos/bar-secret
434
383
timeout = 15m
435
approved_by_default = False
436
approval_delay = 30s
437
384
</programlisting>
438
385
</informalexample>
439
386
</refsect1>
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0