/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-09-21 04:22:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080921042250-r0qqjsbz2ulfo5le
* Makefile: Bug fix: fix syntax error.

* debian/control: Depend on "po-debconf".
  (mandos, mandos-client): Add "${misc:Depends}", used by
                           dh_installdebconf.

* debian/mandos-client.config: New; show note.
* debian/mandos-client.template: New.

* debian/mandos.README.Debian: New.

* debian/mandos.config: New; show note.
* debian/mandos.prerm: New; stop daemon.
* debian/mandos.template: New.

* debian/po/POTFILES.in: New.
* debian/po/sv.po: New.

* debian/rules (clean): Added "debconf-updatepo" as suggested by
                        po-debconf(7).
  (binary-common): Added "dh_installdebconf" to use "debian/*.config"
                   and "debian/*.template" files.

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