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>
19
20
<firstname>Björn</firstname>
20
21
<surname>Påhlsson</surname>
22
<email>belorn@fukt.bsnet.se</email>
23
<email>belorn@recompile.se</email>
26
27
<firstname>Teddy</firstname>
27
28
<surname>Hogeborn</surname>
29
<email>teddy@fukt.bsnet.se</email>
30
<email>teddy@recompile.se</email>
35
47
<holder>Teddy Hogeborn</holder>
36
48
<holder>Björn Påhlsson</holder>
38
50
<xi:include href="legalnotice.xml"/>
42
54
<refentrytitle>&CONFNAME;</refentrytitle>
43
55
<manvolnum>5</manvolnum>
61
73
><refentrytitle>mandos</refentrytitle>
62
74
<manvolnum>8</manvolnum></citerefentry>, read by it at startup.
63
75
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
76
the service. The settings in this file can be overridden by
77
runtime changes to the server, which it saves across restarts.
78
(See the section called <quote>PERSISTENT STATE</quote> in
79
<citerefentry><refentrytitle>mandos</refentrytitle><manvolnum
80
>8</manvolnum></citerefentry>.) However, any <emphasis
81
>changes</emphasis> to this file (including adding and removing
82
clients) will, at startup, override changes done during runtime.
69
85
The format starts with a <literal>[<replaceable>section
93
109
start time expansion, see <xref linkend="expansion"/>.
96
Uknown options are ignored. The used options are as follows:
112
Unknown options are ignored. The used options are as follows:
102
<term><option>timeout<literal> = </literal><replaceable
103
>TIME</replaceable></option></term>
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.
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.
128
<term><option>interval<literal> = </literal><replaceable
129
>TIME</replaceable></option></term>
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.
141
The format of <replaceable>TIME</replaceable> is the same
142
as for <varname>timeout</varname> above.
118
<term><option>approval_delay<literal> = </literal><replaceable
119
>TIME</replaceable></option></term>
122
This option is <emphasis>optional</emphasis>.
125
How long to wait for external approval before resorting to
126
use the <option>approved_by_default</option> value. The
127
default is <quote>PT0S</quote>, i.e. not to wait.
130
The format of <replaceable>TIME</replaceable> is the same
131
as for <varname>timeout</varname> below.
137
<term><option>approval_duration<literal> = </literal
138
><replaceable>TIME</replaceable></option></term>
141
This option is <emphasis>optional</emphasis>.
144
How long an external approval lasts. The default is 1
148
The format of <replaceable>TIME</replaceable> is the same
149
as for <varname>timeout</varname> below.
155
<term><option>approved_by_default<literal> = </literal
156
>{ <literal >1</literal> | <literal>yes</literal> | <literal
157
>true</literal> | <literal>on</literal> | <literal
158
>0</literal> | <literal>no</literal> | <literal
159
>false</literal> | <literal>off</literal> }</option></term>
162
Whether to approve a client by default after
163
the <option>approval_delay</option>. The default
164
is <quote>True</quote>.
148
170
<term><option>checker<literal> = </literal><replaceable
149
171
>COMMAND</replaceable></option></term>
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>
174
This option is <emphasis>optional</emphasis>.
177
This option overrides the default shell command that the
178
server will use to check if the client is still up. Any
179
output of the command will be ignored, only the exit code
180
is checked: If the exit code of the command is zero, the
181
client is considered up. The command will be run using
182
<quote><command><filename>/bin/sh</filename>
158
183
<option>-c</option></command></quote>, so
159
184
<varname>PATH</varname> will be searched. The default
160
185
value for the checker command is <quote><literal
161
186
><command>fping</command> <option>-q</option> <option
162
>--</option> %(host)s</literal></quote>.
187
>--</option> %%(host)s</literal></quote>. Note that
188
<command>mandos-keygen</command>, when generating output
189
to be inserted into this file, normally looks for an SSH
190
server on the Mandos client, and, if it finds one, outputs
191
a <option>checker</option> option to check for the
192
client’s SSH key fingerprint – this is more secure against
165
196
In addition to normal start time expansion, this option
204
<term><option>extended_timeout<literal> = </literal><replaceable
205
>TIME</replaceable></option></term>
208
This option is <emphasis>optional</emphasis>.
211
Extended timeout is an added timeout that is given once
212
after a password has been sent successfully to a client.
213
The timeout is by default longer than the normal timeout,
214
and is used for handling the extra long downtime while a
215
machine is booting up. Time to take into consideration
216
when changing this value is file system checks and quota
217
checks. The default value is 15 minutes.
220
The format of <replaceable>TIME</replaceable> is the same
221
as for <varname>timeout</varname> below.
173
227
<term><option>fingerprint<literal> = </literal
174
228
><replaceable>HEXSTRING</replaceable></option></term>
177
This option sets the OpenPGP fingerprint that identifies
178
the public key that clients authenticate themselves with
179
through TLS. The string needs to be in hexidecimal form,
180
but spaces or upper/lower case are not significant.
231
This option is <emphasis>required</emphasis> if the
232
<option>key_id</option> is not set, and
233
<emphasis>optional</emphasis> otherwise.
236
This option sets the OpenPGP fingerprint that (before
237
GnuTLS 3.6.0) identified the public key that clients
238
authenticate themselves with through TLS. The string
239
needs to be in hexadecimal form, but spaces or upper/lower
240
case are not significant.
246
<term><option>key_id<literal> = </literal
247
><replaceable>HEXSTRING</replaceable></option></term>
250
This option is <emphasis>required</emphasis> if the
251
<option>fingerprint</option> is not set, and
252
<emphasis>optional</emphasis> otherwise.
255
This option sets the certificate key ID that (with GnuTLS
256
3.6.6 or later) identifies the public key that clients
257
authenticate themselves with through TLS. The string
258
needs to be in hexadecimal form, but spaces or upper/lower
259
case are not significant.
265
<term><option><literal>host = </literal><replaceable
266
>STRING</replaceable></option></term>
269
This option is <emphasis>optional</emphasis>, but highly
270
<emphasis>recommended</emphasis> unless the
271
<option>checker</option> option is modified to a
272
non-standard value without <quote>%%(host)s</quote> in it.
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.
283
<term><option>interval<literal> = </literal><replaceable
284
>TIME</replaceable></option></term>
287
This option is <emphasis>optional</emphasis>.
290
How often to run the checker to confirm that a client is
291
still up. <emphasis>Note:</emphasis> a new checker will
292
not be started if an old one is still running. The server
293
will wait for a checker to complete until the below
294
<quote><varname>timeout</varname></quote> occurs, at which
295
time the client will be disabled, and any running checker
296
killed. The default interval is 2 minutes.
299
The format of <replaceable>TIME</replaceable> is the same
300
as for <varname>timeout</varname> below.
306
<term><option>secfile<literal> = </literal><replaceable
307
>FILENAME</replaceable></option></term>
310
This option is only used if <option>secret</option> is not
311
specified, in which case this option is
312
<emphasis>required</emphasis>.
315
Similar to the <option>secret</option>, except the secret
316
data is in an external file. The contents of the file
317
should <emphasis>not</emphasis> be base64-encoded, but
318
will be sent to clients verbatim.
321
File names of the form <filename>~user/foo/bar</filename>
322
and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
187
330
>BASE64_ENCODED_DATA</replaceable></option></term>
333
If this option is not specified, the <option
334
>secfile</option> option is <emphasis>required</emphasis>
190
338
If present, this option must be set to a string of
191
339
base64-encoded binary data. It will be decoded and sent
192
to the client matching the above
193
<option>fingerprint</option>. This should, of course, be
194
OpenPGP encrypted data, decryptable only by the client.
340
to the client matching the above <option>key_id</option>
341
or <option>fingerprint</option>. This should, of course,
342
be OpenPGP encrypted data, decryptable only by the client.
195
343
The program <citerefentry><refentrytitle><command
196
344
>mandos-keygen</command></refentrytitle><manvolnum
197
345
>8</manvolnum></citerefentry> can, using its
204
352
lines is that a line beginning with white space adds to
205
353
the value of the previous line, RFC 822-style.
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.
216
<term><option>secfile<literal> = </literal><replaceable
217
>FILENAME</replaceable></option></term>
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.
226
This option is only used, and <emphasis>must</emphasis> be
227
present, if <option>secret</option> is not specified.
233
<term><option><literal>host = </literal><replaceable
234
>STRING</replaceable></option></term>
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.
359
<term><option>timeout<literal> = </literal><replaceable
360
>TIME</replaceable></option></term>
363
This option is <emphasis>optional</emphasis>.
366
The timeout is how long the server will wait, after a
367
successful checker run, until a client is disabled and not
368
allowed to get the data this server holds. By default
369
Mandos will use 5 minutes. See also the
370
<option>extended_timeout</option> option.
373
The <replaceable>TIME</replaceable> is specified as an RFC
374
3339 duration; for example
375
<quote><literal>P1Y2M3DT4H5M6S</literal></quote> meaning
376
one year, two months, three days, four hours, five
377
minutes, and six seconds. Some values can be omitted, see
378
RFC 3339 Appendix A for details.
384
<term><option>enabled<literal> = </literal>{ <literal
385
>1</literal> | <literal>yes</literal> | <literal>true</literal
386
> | <literal >on</literal> | <literal>0</literal> | <literal
387
>no</literal> | <literal>false</literal> | <literal
388
>off</literal> }</option></term>
391
Whether this client should be enabled by default. The
392
default is <quote>true</quote>.
279
432
<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
280
433
></quote> will be replaced by the value of the attribute
281
434
<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.
435
<quote><classname>Client</classname></quote> object in the
436
Mandos server. The currently allowed values for
437
<replaceable>foo</replaceable> are:
438
<quote><literal>approval_delay</literal></quote>,
439
<quote><literal>approval_duration</literal></quote>,
440
<quote><literal>created</literal></quote>,
441
<quote><literal>enabled</literal></quote>,
442
<quote><literal>expires</literal></quote>,
443
<quote><literal>key_id</literal></quote>,
444
<quote><literal>fingerprint</literal></quote>,
445
<quote><literal>host</literal></quote>,
446
<quote><literal>interval</literal></quote>,
447
<quote><literal>last_approval_request</literal></quote>,
448
<quote><literal>last_checked_ok</literal></quote>,
449
<quote><literal>last_enabled</literal></quote>,
450
<quote><literal>name</literal></quote>,
451
<quote><literal>timeout</literal></quote>, and, if using
452
D-Bus, <quote><literal>dbus_object_path</literal></quote>.
453
See the source code for details. <emphasis role="strong"
454
>Currently, <emphasis>none</emphasis> of these attributes
455
except <quote><literal>host</literal></quote> are guaranteed
456
to be valid in future versions.</emphasis> Therefore, please
457
let the authors know of any attributes that are useful so they
458
may be preserved to any new versions of this software.
288
461
Note that this means that, in order to include an actual
362
539
<refsect1 id="see_also">
363
540
<title>SEE ALSO</title>
542
<citerefentry><refentrytitle>intro</refentrytitle>
543
<manvolnum>8mandos</manvolnum></citerefentry>,
365
544
<citerefentry><refentrytitle>mandos-keygen</refentrytitle>
366
545
<manvolnum>8</manvolnum></citerefentry>,
367
546
<citerefentry><refentrytitle>mandos.conf</refentrytitle>
368
547
<manvolnum>5</manvolnum></citerefentry>,
369
548
<citerefentry><refentrytitle>mandos</refentrytitle>
549
<manvolnum>8</manvolnum></citerefentry>,
550
<citerefentry><refentrytitle>fping</refentrytitle>
370
551
<manvolnum>8</manvolnum></citerefentry>
556
RFC 3339: <citetitle>Date and Time on the Internet:
557
Timestamps</citetitle>
561
The time intervals are in the "duration" format, as
562
specified in ABNF in Appendix A of RFC 3339.
374
569
<!-- Local Variables: -->