/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 10:41:16 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825104116-cjd54qqs535kpdxq
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
                                syntax by name.

* mandos.conf.xml (SEE ALSO): Also refer to gnutls_priority_init(3),
                              RFC 4291, and Zeroconf.

* mandos.xml (SEE ALSO): Also refer to sections 2.2 and 2.5.5.2 of RFC
                         4291.  Stop using <citation> tags.

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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-12-09">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
33
      <holder>Teddy Hogeborn</holder>
38
34
      <holder>Björn Påhlsson</holder>
39
35
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
41
59
  </refentryinfo>
42
 
  
 
60
 
43
61
  <refmeta>
44
62
    <refentrytitle>&CONFNAME;</refentrytitle>
45
63
    <manvolnum>5</manvolnum>
51
69
      Configuration file for the Mandos server
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
57
77
  </refsynopsisdiv>
58
 
  
 
78
 
59
79
  <refsect1 id="description">
60
80
    <title>DESCRIPTION</title>
61
81
    <para>
63
83
      ><refentrytitle>mandos</refentrytitle>
64
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
85
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
86
      the service.  All clients listed will be regarded as valid, even
 
87
      if a client was declared invalid in a previous run of the
 
88
      server.
68
89
    </para>
69
90
    <para>
70
91
      The format starts with a <literal>[<replaceable>section
94
115
      start time expansion, see <xref linkend="expansion"/>.
95
116
    </para>
96
117
    <para>
97
 
      Unknown options are ignored.  The used options are as follows:
 
118
      Uknown options are ignored.  The used options are as follows:
98
119
    </para>
99
 
    
 
120
 
100
121
    <variablelist>
101
 
      
 
122
 
102
123
      <varlistentry>
103
 
        <term><option>timeout<literal> = </literal><replaceable
104
 
        >TIME</replaceable></option></term>
 
124
        <term><literal><varname>timeout</varname></literal></term>
105
125
        <listitem>
106
 
          <para>
107
 
            This option is <emphasis>optional</emphasis>.
108
 
          </para>
109
 
          <para>
110
 
            The timeout is how long the server will wait (for either a
111
 
            successful checker run or a client receiving its secret)
112
 
            until a client is disabled and not allowed to get the data
113
 
            this server holds.  By default Mandos will use 1 hour.
 
126
          <synopsis><literal>timeout = </literal><replaceable
 
127
          >TIME</replaceable>
 
128
          </synopsis>
 
129
          <para>
 
130
            The timeout is how long the server will wait for a
 
131
            successful checker run until a client is considered
 
132
            invalid - that is, ineligible to get the data this server
 
133
            holds.  By default Mandos will use 1 hour.
114
134
          </para>
115
135
          <para>
116
136
            The <replaceable>TIME</replaceable> is specified as a
127
147
          </para>
128
148
        </listitem>
129
149
      </varlistentry>
130
 
      
 
150
 
131
151
      <varlistentry>
132
 
        <term><option>interval<literal> = </literal><replaceable
133
 
        >TIME</replaceable></option></term>
 
152
        <term><literal><varname>interval</varname></literal></term>
134
153
        <listitem>
135
 
          <para>
136
 
            This option is <emphasis>optional</emphasis>.
137
 
          </para>
 
154
          <synopsis><literal>interval = </literal><replaceable
 
155
          >TIME</replaceable>
 
156
          </synopsis>
138
157
          <para>
139
158
            How often to run the checker to confirm that a client is
140
159
            still up.  <emphasis>Note:</emphasis> a new checker will
141
160
            not be started if an old one is still running.  The server
142
161
            will wait for a checker to complete until the above
143
162
            <quote><varname>timeout</varname></quote> occurs, at which
144
 
            time the client will be disabled, and any running checker
145
 
            killed.  The default interval is 5 minutes.
 
163
            time the client will be marked invalid, and any running
 
164
            checker killed.  The default interval is 5 minutes.
146
165
          </para>
147
166
          <para>
148
167
            The format of <replaceable>TIME</replaceable> is the same
149
168
            as for <varname>timeout</varname> above.
150
169
          </para>
151
170
        </listitem>
152
 
      </varlistentry>
153
 
      
 
171
      </varlistentry>      
 
172
 
154
173
      <varlistentry>
155
 
        <term><option>checker<literal> = </literal><replaceable
156
 
        >COMMAND</replaceable></option></term>
 
174
        <term><literal>checker</literal></term>
157
175
        <listitem>
158
 
          <para>
159
 
            This option is <emphasis>optional</emphasis>.
160
 
          </para>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
161
179
          <para>
162
180
            This option allows you to override the default shell
163
181
            command that the server will use to check if the client is
169
187
            <varname>PATH</varname> will be searched.  The default
170
188
            value for the checker command is <quote><literal
171
189
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
190
            >--</option> %(host)s</literal></quote>.
173
191
          </para>
174
192
          <para>
175
193
            In addition to normal start time expansion, this option
180
198
      </varlistentry>
181
199
      
182
200
      <varlistentry>
183
 
        <term><option>fingerprint<literal> = </literal
184
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
201
        <term><literal>fingerprint</literal></term>
185
202
        <listitem>
186
 
          <para>
187
 
            This option is <emphasis>required</emphasis>.
188
 
          </para>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
189
206
          <para>
190
207
            This option sets the OpenPGP fingerprint that identifies
191
208
            the public key that clients authenticate themselves with
196
213
      </varlistentry>
197
214
      
198
215
      <varlistentry>
199
 
        <term><option>secret<literal> = </literal><replaceable
200
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
216
        <term><literal>secret</literal></term>
201
217
        <listitem>
202
 
          <para>
203
 
            If this option is not specified, the <option
204
 
            >secfile</option> option is <emphasis>required</emphasis>
205
 
            to be present.
206
 
          </para>
 
218
          <synopsis><literal>secret = </literal><replaceable
 
219
          >BASE64_ENCODED_DATA</replaceable>
 
220
          </synopsis>
207
221
          <para>
208
222
            If present, this option must be set to a string of
209
223
            base64-encoded binary data.  It will be decoded and sent
222
236
            lines is that a line beginning with white space adds to
223
237
            the value of the previous line, RFC 822-style.
224
238
          </para>
225
 
        </listitem>
226
 
      </varlistentry>
227
 
      
228
 
      <varlistentry>
229
 
        <term><option>secfile<literal> = </literal><replaceable
230
 
        >FILENAME</replaceable></option></term>
231
 
        <listitem>
232
 
          <para>
233
 
            This option is only used if <option>secret</option> is not
234
 
            specified, in which case this option is
235
 
            <emphasis>required</emphasis>.
236
 
          </para>
237
 
          <para>
238
 
            Similar to the <option>secret</option>, except the secret
239
 
            data is in an external file.  The contents of the file
240
 
            should <emphasis>not</emphasis> be base64-encoded, but
241
 
            will be sent to clients verbatim.
242
 
          </para>
243
 
          <para>
244
 
            File names of the form <filename>~user/foo/bar</filename>
245
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
246
 
            are supported.
247
 
          </para>
248
 
        </listitem>
249
 
      </varlistentry>
250
 
      
251
 
      <varlistentry>
252
 
        <term><option><literal>host = </literal><replaceable
253
 
        >STRING</replaceable></option></term>
254
 
        <listitem>
255
 
          <para>
256
 
            This option is <emphasis>optional</emphasis>, but highly
257
 
            <emphasis>recommended</emphasis> unless the
258
 
            <option>checker</option> option is modified to a
259
 
            non-standard value without <quote>%%(host)s</quote> in it.
260
 
          </para>
 
239
          <para>
 
240
            If this option is not specified, the <option
 
241
            >secfile</option> option is used instead, but one of them
 
242
            <emphasis>must</emphasis> be present.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
 
 
247
      <varlistentry>
 
248
        <term><literal>secfile</literal></term>
 
249
        <listitem>
 
250
          <synopsis><literal>secfile = </literal><replaceable
 
251
          >FILENAME</replaceable>
 
252
          </synopsis>
 
253
          <para>
 
254
            The same as <option>secret</option>, but the secret data
 
255
            is in an external file.  The contents of the file should
 
256
            <emphasis>not</emphasis> be base64-encoded, but will be
 
257
            sent to clients verbatim.
 
258
          </para>
 
259
          <para>
 
260
            This option is only used, and <emphasis>must</emphasis> be
 
261
            present, if <option>secret</option> is not specified.
 
262
          </para>
 
263
        </listitem>
 
264
      </varlistentry>
 
265
 
 
266
      <varlistentry>
 
267
        <term><literal>host</literal></term>
 
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
261
272
          <para>
262
273
            Host name for this client.  This is not used by the server
263
274
            directly, but can be, and is by default, used by the
267
278
      </varlistentry>
268
279
      
269
280
    </variablelist>
270
 
  </refsect1>
 
281
  </refsect1>  
271
282
  
272
283
  <refsect1 id="expansion">
273
284
    <title>EXPANSION</title>
316
327
        percent characters in a row (<quote>%%%%</quote>) must be
317
328
        entered.  Also, a bad format here will lead to an immediate
318
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
319
 
        mode is needed to expose an error of this kind.
 
330
        mode is needed to track down an error of this kind.
320
331
      </para>
321
332
    </refsect2>
322
 
    
323
 
  </refsect1>
 
333
 
 
334
  </refsect1>  
324
335
  
325
336
  <refsect1 id="files">
326
337
    <title>FILES</title>
350
361
[DEFAULT]
351
362
timeout = 1h
352
363
interval = 5m
353
 
checker = fping -q -- %%(host)s
 
364
checker = fping -q -- %(host)s
354
365
 
355
366
# Client "foo"
356
367
[foo]
379
390
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
391
secfile = /etc/mandos/bar-secret
381
392
timeout = 15m
 
393
 
382
394
      </programlisting>
383
395
    </informalexample>
384
 
  </refsect1>
 
396
  </refsect1>  
385
397
  
386
398
  <refsect1 id="see_also">
387
399
    <title>SEE ALSO</title>
388
400
    <para>
389
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
390
 
      <manvolnum>8</manvolnum></citerefentry>,
391
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
392
 
      <manvolnum>5</manvolnum></citerefentry>,
393
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
394
 
      <manvolnum>8</manvolnum></citerefentry>
 
401
      <citerefentry>
 
402
        <refentrytitle>mandos</refentrytitle>
 
403
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
404
        <refentrytitle>mandos-keygen</refentrytitle>
 
405
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
406
        <refentrytitle>mandos.conf</refentrytitle>
 
407
        <manvolnum>5</manvolnum></citerefentry>
395
408
    </para>
396
409
  </refsect1>
397
410
</refentry>
398
 
<!-- Local Variables: -->
399
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
400
 
<!-- time-stamp-end: "[\"']>" -->
401
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
402
 
<!-- End: -->