/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: 2009-09-05 01:46:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090905014642-36108sqop1ci0z0m
* plugins.d/mandos-client.c (start_mandos_communication): Check
                                                         "quit_now"
                                                         throughout.
                                                         Always close
                                                         socket and
                                                         deinit GnuTLS
                                                         properly.
  (browse_callback): Return immediately if "quit_now" is set.

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>">
 
6
<!ENTITY TIMESTAMP "2009-02-15">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
33
37
      <holder>Teddy Hogeborn</holder>
34
38
      <holder>Björn Påhlsson</holder>
35
39
    </copyright>
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>
 
40
    <xi:include href="legalnotice.xml"/>
59
41
  </refentryinfo>
60
 
 
 
42
  
61
43
  <refmeta>
62
44
    <refentrytitle>&CONFNAME;</refentrytitle>
63
45
    <manvolnum>5</manvolnum>
69
51
      Configuration file for the Mandos server
70
52
    </refpurpose>
71
53
  </refnamediv>
72
 
 
 
54
  
73
55
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
77
57
  </refsynopsisdiv>
78
 
 
 
58
  
79
59
  <refsect1 id="description">
80
60
    <title>DESCRIPTION</title>
81
61
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
62
      The file &CONFPATH; is a configuration file for <citerefentry
83
63
      ><refentrytitle>mandos</refentrytitle>
84
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
85
 
      where each client that will be able to use the service needs to
86
 
      be listed.  All clients listed will be regarded as valid, even
 
64
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
 
65
      The file needs to list all clients that should be able to use
 
66
      the service.  All clients listed will be regarded as valid, even
87
67
      if a client was declared invalid in a previous run of the
88
68
      server.
89
69
    </para>
90
70
    <para>
91
 
      The format starts with a section under [] which is either
 
71
      The format starts with a <literal>[<replaceable>section
 
72
      header</replaceable>]</literal> which is either
92
73
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
93
 
      name</replaceable>]</literal>.  Following the section is any
94
 
      number of <quote><varname><replaceable>option</replaceable
 
74
      name</replaceable>]</literal>.  The <replaceable>client
 
75
      name</replaceable> can be anything, and is not tied to a host
 
76
      name.  Following the section header is any number of
 
77
      <quote><varname><replaceable>option</replaceable
95
78
      ></varname>=<replaceable>value</replaceable></quote> entries,
96
79
      with continuations in the style of RFC 822.  <quote><varname
97
80
      ><replaceable>option</replaceable></varname>: <replaceable
98
81
      >value</replaceable></quote> is also accepted.  Note that
99
82
      leading whitespace is removed from values.  Values can contain
100
83
      format strings which refer to other values in the same section,
101
 
      or values in the <quote>DEFAULT</quote> section.  Lines
102
 
      beginning with <quote>#</quote> or <quote>;</quote> are ignored
103
 
      and may be used to provide comments.
 
84
      or values in the <quote>DEFAULT</quote> section (see <xref
 
85
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
 
86
      or <quote>;</quote> are ignored and may be used to provide
 
87
      comments.
104
88
    </para>
105
89
  </refsect1>
106
90
  
107
91
  <refsect1 id="options">
108
92
    <title>OPTIONS</title>
109
93
    <para>
110
 
      The possible options are:
111
 
    </para>
112
 
 
 
94
      <emphasis>Note:</emphasis> all option values are subject to
 
95
      start time expansion, see <xref linkend="expansion"/>.
 
96
    </para>
 
97
    <para>
 
98
      Unknown options are ignored.  The used options are as follows:
 
99
    </para>
 
100
    
113
101
    <variablelist>
114
 
 
 
102
      
115
103
      <varlistentry>
116
 
        <term><literal><varname>timeout</varname></literal></term>
 
104
        <term><option>timeout<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
117
106
        <listitem>
118
 
          <synopsis><literal>timeout = </literal><replaceable
119
 
          >TIME</replaceable>
120
 
          </synopsis>
 
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
121
110
          <para>
122
111
            The timeout is how long the server will wait for a
123
112
            successful checker run until a client is considered
139
128
          </para>
140
129
        </listitem>
141
130
      </varlistentry>
142
 
 
 
131
      
143
132
      <varlistentry>
144
 
        <term><literal><varname>interval</varname></literal></term>
 
133
        <term><option>interval<literal> = </literal><replaceable
 
134
        >TIME</replaceable></option></term>
145
135
        <listitem>
146
 
          <synopsis><literal>interval = </literal><replaceable
147
 
          >TIME</replaceable>
148
 
          </synopsis>
 
136
          <para>
 
137
            This option is <emphasis>optional</emphasis>.
 
138
          </para>
149
139
          <para>
150
140
            How often to run the checker to confirm that a client is
151
141
            still up.  <emphasis>Note:</emphasis> a new checker will
160
150
            as for <varname>timeout</varname> above.
161
151
          </para>
162
152
        </listitem>
163
 
      </varlistentry>      
164
 
 
 
153
      </varlistentry>
 
154
      
165
155
      <varlistentry>
166
 
        <term><literal>checker</literal></term>
 
156
        <term><option>checker<literal> = </literal><replaceable
 
157
        >COMMAND</replaceable></option></term>
167
158
        <listitem>
168
159
          <para>
 
160
            This option is <emphasis>optional</emphasis>.
 
161
          </para>
 
162
          <para>
169
163
            This option allows you to override the default shell
170
 
            command that the server will use to check up if the client
171
 
            is still up. By default mandos will "fping -q -- %%(host)s"
172
 
          </para>
173
 
        </listitem>
174
 
      </varlistentry>
175
 
      
176
 
      <varlistentry>
177
 
        <term><literal>fingerprint</literal></term>
178
 
        <listitem>
179
 
          <para>
180
 
            This option sets the openpgp fingerprint that identifies
181
 
            the public certificate that clients authenticates themself
182
 
            through gnutls. The string need to be in hex-decimal form.
183
 
          </para>
184
 
        </listitem>
185
 
      </varlistentry>
186
 
      
187
 
      <varlistentry>
188
 
        <term><literal>secret</literal></term>
189
 
        <listitem>
190
 
          <para>
191
 
            Base 64 encoded OpenPGP encrypted password encrypted by
192
 
            the clients openpgp certificate.
193
 
          </para>
194
 
        </listitem>
195
 
      </varlistentry>
196
 
 
197
 
      <varlistentry>
198
 
        <term><literal>secfile</literal></term>
199
 
        <listitem>
200
 
          <para>
201
 
            Base 64 encoded OpenPGP encrypted password encrypted by
202
 
            the clients openpgp certificate as a binary file.
203
 
          </para>
204
 
        </listitem>
205
 
      </varlistentry>
206
 
 
207
 
      <varlistentry>
208
 
        <term><literal>host</literal></term>
209
 
        <listitem>
210
 
          <para>
211
 
            Host name that can be used in for checking that the client is up.
212
 
          </para>
213
 
        </listitem>
214
 
      </varlistentry>
215
 
 
216
 
      <varlistentry>
217
 
        <term><literal>checker</literal></term>
218
 
        <listitem>
219
 
          <para>
220
 
            Shell command that the server will use to check up if a
221
 
            client is still up.
222
 
          </para>
223
 
        </listitem>
224
 
      </varlistentry>      
225
 
 
226
 
      <varlistentry>
227
 
        <term><literal>timeout</literal></term>
228
 
        <listitem>
229
 
          <para>
230
 
            Duration that a client can be down whitout be removed from
231
 
            the client list.
232
 
          </para>
233
 
        </listitem>
234
 
      </varlistentry> 
 
164
            command that the server will use to check if the client is
 
165
            still up.  Any output of the command will be ignored, only
 
166
            the exit code is checked:  If the exit code of the command
 
167
            is zero, the client is considered up.  The command will be
 
168
            run using <quote><command><filename>/bin/sh</filename>
 
169
            <option>-c</option></command></quote>, so
 
170
            <varname>PATH</varname> will be searched.  The default
 
171
            value for the checker command is <quote><literal
 
172
            ><command>fping</command> <option>-q</option> <option
 
173
            >--</option> %%(host)s</literal></quote>.
 
174
          </para>
 
175
          <para>
 
176
            In addition to normal start time expansion, this option
 
177
            will also be subject to runtime expansion; see <xref
 
178
            linkend="expansion"/>.
 
179
          </para>
 
180
        </listitem>
 
181
      </varlistentry>
 
182
      
 
183
      <varlistentry>
 
184
        <term><option>fingerprint<literal> = </literal
 
185
        ><replaceable>HEXSTRING</replaceable></option></term>
 
186
        <listitem>
 
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
 
190
          <para>
 
191
            This option sets the OpenPGP fingerprint that identifies
 
192
            the public key that clients authenticate themselves with
 
193
            through TLS.  The string needs to be in hexidecimal form,
 
194
            but spaces or upper/lower case are not significant.
 
195
          </para>
 
196
        </listitem>
 
197
      </varlistentry>
 
198
      
 
199
      <varlistentry>
 
200
        <term><option>secret<literal> = </literal><replaceable
 
201
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
202
        <listitem>
 
203
          <para>
 
204
            If this option is not specified, the <option
 
205
            >secfile</option> option is <emphasis>required</emphasis>
 
206
            to be present.
 
207
          </para>
 
208
          <para>
 
209
            If present, this option must be set to a string of
 
210
            base64-encoded binary data.  It will be decoded and sent
 
211
            to the client matching the above
 
212
            <option>fingerprint</option>.  This should, of course, be
 
213
            OpenPGP encrypted data, decryptable only by the client.
 
214
            The program <citerefentry><refentrytitle><command
 
215
            >mandos-keygen</command></refentrytitle><manvolnum
 
216
            >8</manvolnum></citerefentry> can, using its
 
217
            <option>--password</option> option, be used to generate
 
218
            this, if desired.
 
219
          </para>
 
220
          <para>
 
221
            Note: this value of this option will probably be very
 
222
            long.  A useful feature to avoid having unreadably-long
 
223
            lines is that a line beginning with white space adds to
 
224
            the value of the previous line, RFC 822-style.
 
225
          </para>
 
226
        </listitem>
 
227
      </varlistentry>
 
228
      
 
229
      <varlistentry>
 
230
        <term><option>secfile<literal> = </literal><replaceable
 
231
        >FILENAME</replaceable></option></term>
 
232
        <listitem>
 
233
          <para>
 
234
            This option is only used if <option>secret</option> is not
 
235
            specified, in which case this option is
 
236
            <emphasis>required</emphasis>.
 
237
          </para>
 
238
          <para>
 
239
            Similar to the <option>secret</option>, except the secret
 
240
            data is in an external file.  The contents of the file
 
241
            should <emphasis>not</emphasis> be base64-encoded, but
 
242
            will be sent to clients verbatim.
 
243
          </para>
 
244
          <para>
 
245
            File names of the form <filename>~user/foo/bar</filename>
 
246
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
247
            are supported.
 
248
          </para>
 
249
        </listitem>
 
250
      </varlistentry>
 
251
      
 
252
      <varlistentry>
 
253
        <term><option><literal>host = </literal><replaceable
 
254
        >STRING</replaceable></option></term>
 
255
        <listitem>
 
256
          <para>
 
257
            This option is <emphasis>optional</emphasis>, but highly
 
258
            <emphasis>recommended</emphasis> unless the
 
259
            <option>checker</option> option is modified to a
 
260
            non-standard value without <quote>%%(host)s</quote> in it.
 
261
          </para>
 
262
          <para>
 
263
            Host name for this client.  This is not used by the server
 
264
            directly, but can be, and is by default, used by the
 
265
            checker.  See the <option>checker</option> option.
 
266
          </para>
 
267
        </listitem>
 
268
      </varlistentry>
235
269
      
236
270
    </variablelist>
237
 
  </refsect1>  
 
271
  </refsect1>
238
272
  
239
273
  <refsect1 id="expansion">
240
274
    <title>EXPANSION</title>
242
276
      There are two forms of expansion: Start time expansion and
243
277
      runtime expansion.
244
278
    </para>
245
 
    <refsect2>
 
279
    <refsect2 id="start_time_expansion">
246
280
      <title>START TIME EXPANSION</title>
247
281
      <para>
248
282
        Any string in an option value of the form
260
294
        entered.
261
295
      </para>
262
296
    </refsect2>
263
 
    <refsect2>
 
297
    <refsect2 id="runtime_expansion">
264
298
      <title>RUNTIME EXPANSION</title>
265
299
      <para>
266
300
        This is currently only done for the <varname>checker</varname>
279
313
      <para>
280
314
        Note that this means that, in order to include an actual
281
315
        percent character (<quote>%</quote>) in a
282
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
316
        <varname>checker</varname> option, <emphasis>four</emphasis>
283
317
        percent characters in a row (<quote>%%%%</quote>) must be
284
318
        entered.  Also, a bad format here will lead to an immediate
285
319
        but <emphasis>silent</emphasis> run-time fatal exit; debug
286
 
        mode is needed to track down an error of this kind.
 
320
        mode is needed to expose an error of this kind.
287
321
      </para>
288
322
    </refsect2>
289
 
 
290
 
  </refsect1>  
 
323
    
 
324
  </refsect1>
291
325
  
292
326
  <refsect1 id="files">
293
327
    <title>FILES</title>
338
372
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
339
373
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
340
374
        QlnHIvPzEArRQLo=
341
 
        =iHhv
342
375
host = foo.example.org
343
 
interval = 5m
 
376
interval = 1m
344
377
 
345
378
# Client "bar"
346
379
[bar]
347
380
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
348
 
secfile = /etc/mandos/bar-secret.txt.asc
349
 
 
 
381
secfile = /etc/mandos/bar-secret
 
382
timeout = 15m
350
383
      </programlisting>
351
384
    </informalexample>
352
 
  </refsect1>  
353
 
 
 
385
  </refsect1>
 
386
  
 
387
  <refsect1 id="see_also">
 
388
    <title>SEE ALSO</title>
 
389
    <para>
 
390
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
391
      <manvolnum>8</manvolnum></citerefentry>,
 
392
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
393
      <manvolnum>5</manvolnum></citerefentry>,
 
394
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
395
      <manvolnum>8</manvolnum></citerefentry>
 
396
    </para>
 
397
  </refsect1>
354
398
</refentry>
 
399
<!-- Local Variables: -->
 
400
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
401
<!-- time-stamp-end: "[\"']>" -->
 
402
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
403
<!-- End: -->