/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-22 12:48:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090922124807-i2cr0zv4vxjv38g4
* mandos-ctl: Made work again after D-Bus API changes.
  (datetime_to_milliseconds): Renamed to "timedelta_to_milliseconds".
                              All callers changed.
  (milliseconds_to_string): Use clearer mapping string format.
  (string_to_delta): Add some comments.

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-09-17">
 
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>
111
91
  <refsect1 id="options">
112
92
    <title>OPTIONS</title>
113
93
    <para>
114
 
      The possible options are:
115
 
    </para>
116
 
 
 
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
    
117
101
    <variablelist>
118
 
 
 
102
      
119
103
      <varlistentry>
120
 
        <term><literal><varname>timeout</varname></literal></term>
 
104
        <term><option>timeout<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
121
106
        <listitem>
122
 
          <synopsis><literal>timeout = </literal><replaceable
123
 
          >TIME</replaceable>
124
 
          </synopsis>
125
 
          <para>
126
 
            The timeout is how long the server will wait for a
127
 
            successful checker run until a client is considered
128
 
            invalid - that is, ineligible to get the data this server
129
 
            holds.  By default Mandos will use 1 hour.
 
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.
130
116
          </para>
131
117
          <para>
132
118
            The <replaceable>TIME</replaceable> is specified as a
143
129
          </para>
144
130
        </listitem>
145
131
      </varlistentry>
146
 
 
 
132
      
147
133
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
 
134
        <term><option>interval<literal> = </literal><replaceable
 
135
        >TIME</replaceable></option></term>
149
136
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
 
137
          <para>
 
138
            This option is <emphasis>optional</emphasis>.
 
139
          </para>
153
140
          <para>
154
141
            How often to run the checker to confirm that a client is
155
142
            still up.  <emphasis>Note:</emphasis> a new checker will
164
151
            as for <varname>timeout</varname> above.
165
152
          </para>
166
153
        </listitem>
167
 
      </varlistentry>      
168
 
 
 
154
      </varlistentry>
 
155
      
169
156
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
 
157
        <term><option>checker<literal> = </literal><replaceable
 
158
        >COMMAND</replaceable></option></term>
171
159
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
 
160
          <para>
 
161
            This option is <emphasis>optional</emphasis>.
 
162
          </para>
175
163
          <para>
176
164
            This option allows you to override the default shell
177
165
            command that the server will use to check if the client is
178
 
            still up.  The output of the command will be ignored, only
179
 
            the exit code is checked.  The command will be run using
180
 
            <quote><command><filename>/bin/sh</filename>
181
 
            <option>-c</option></command></quote>.  The default
182
 
            command is <quote><literal><command>fping</command>
183
 
            <option>-q</option> <option>--</option>
184
 
            %(host)s</literal></quote>.
 
166
            still up.  Any output of the command will be ignored, only
 
167
            the exit code is checked:  If the exit code of the command
 
168
            is zero, the client is considered up.  The command will be
 
169
            run using <quote><command><filename>/bin/sh</filename>
 
170
            <option>-c</option></command></quote>, so
 
171
            <varname>PATH</varname> will be searched.  The default
 
172
            value for the checker command is <quote><literal
 
173
            ><command>fping</command> <option>-q</option> <option
 
174
            >--</option> %%(host)s</literal></quote>.
185
175
          </para>
186
176
          <para>
187
177
            In addition to normal start time expansion, this option
192
182
      </varlistentry>
193
183
      
194
184
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
185
        <term><option>fingerprint<literal> = </literal
 
186
        ><replaceable>HEXSTRING</replaceable></option></term>
196
187
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
 
188
          <para>
 
189
            This option is <emphasis>required</emphasis>.
 
190
          </para>
200
191
          <para>
201
192
            This option sets the OpenPGP fingerprint that identifies
202
193
            the public key that clients authenticate themselves with
207
198
      </varlistentry>
208
199
      
209
200
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
 
201
        <term><option>secret<literal> = </literal><replaceable
 
202
        >BASE64_ENCODED_DATA</replaceable></option></term>
211
203
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
204
          <para>
 
205
            If this option is not specified, the <option
 
206
            >secfile</option> option is <emphasis>required</emphasis>
 
207
            to be present.
 
208
          </para>
215
209
          <para>
216
210
            If present, this option must be set to a string of
217
211
            base64-encoded binary data.  It will be decoded and sent
218
212
            to the client matching the above
219
213
            <option>fingerprint</option>.  This should, of course, be
220
214
            OpenPGP encrypted data, decryptable only by the client.
221
 
<!--        The program <citerefentry><refentrytitle><command -->
222
 
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
223
 
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
224
 
<!--        if desired. -->
225
 
          </para>
226
 
          <para>
227
 
            Note: this value of this option will probably run over
228
 
            many lines, and will then have to use the fact that a line
229
 
            beginning with white space adds to the value of the
230
 
            previous line, RFC 822-style.
231
 
          </para>
232
 
        </listitem>
233
 
      </varlistentry>
234
 
 
235
 
      <varlistentry>
236
 
        <term><literal>secfile</literal></term>
237
 
        <listitem>
238
 
          <para>
239
 
            Base 64 encoded OpenPGP encrypted password encrypted by
240
 
            the clients openpgp certificate as a binary file.
241
 
          </para>
242
 
        </listitem>
243
 
      </varlistentry>
244
 
 
245
 
      <varlistentry>
246
 
        <term><literal>host</literal></term>
247
 
        <listitem>
248
 
          <para>
249
 
            Host name that can be used in for checking that the client is up.
250
 
          </para>
251
 
        </listitem>
252
 
      </varlistentry>
253
 
 
254
 
      <varlistentry>
255
 
        <term><literal>checker</literal></term>
256
 
        <listitem>
257
 
          <para>
258
 
            Shell command that the server will use to check up if a
259
 
            client is still up.
260
 
          </para>
261
 
        </listitem>
262
 
      </varlistentry>      
263
 
 
264
 
      <varlistentry>
265
 
        <term><literal>timeout</literal></term>
266
 
        <listitem>
267
 
          <para>
268
 
            Duration that a client can be down whitout be removed from
269
 
            the client list.
270
 
          </para>
271
 
        </listitem>
272
 
      </varlistentry> 
 
215
            The program <citerefentry><refentrytitle><command
 
216
            >mandos-keygen</command></refentrytitle><manvolnum
 
217
            >8</manvolnum></citerefentry> can, using its
 
218
            <option>--password</option> option, be used to generate
 
219
            this, if desired.
 
220
          </para>
 
221
          <para>
 
222
            Note: this value of this option will probably be very
 
223
            long.  A useful feature to avoid having unreadably-long
 
224
            lines is that a line beginning with white space adds to
 
225
            the value of the previous line, RFC 822-style.
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
      
 
230
      <varlistentry>
 
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.
 
267
          </para>
 
268
        </listitem>
 
269
      </varlistentry>
273
270
      
274
271
    </variablelist>
275
 
  </refsect1>  
 
272
  </refsect1>
276
273
  
277
274
  <refsect1 id="expansion">
278
275
    <title>EXPANSION</title>
317
314
      <para>
318
315
        Note that this means that, in order to include an actual
319
316
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
317
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
318
        percent characters in a row (<quote>%%%%</quote>) must be
322
319
        entered.  Also, a bad format here will lead to an immediate
323
320
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
321
        mode is needed to expose an error of this kind.
325
322
      </para>
326
323
    </refsect2>
327
 
 
328
 
  </refsect1>  
 
324
    
 
325
  </refsect1>
329
326
  
330
327
  <refsect1 id="files">
331
328
    <title>FILES</title>
355
352
[DEFAULT]
356
353
timeout = 1h
357
354
interval = 5m
358
 
checker = fping -q -- %(host)s
 
355
checker = fping -q -- %%(host)s
359
356
 
360
357
# Client "foo"
361
358
[foo]
376
373
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
374
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
375
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
376
host = foo.example.org
381
 
interval = 5m
 
377
interval = 1m
382
378
 
383
379
# Client "bar"
384
380
[bar]
385
381
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
387
 
 
 
382
secfile = /etc/mandos/bar-secret
 
383
timeout = 15m
388
384
      </programlisting>
389
385
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
386
  </refsect1>
 
387
  
 
388
  <refsect1 id="see_also">
 
389
    <title>SEE ALSO</title>
 
390
    <para>
 
391
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
 
392
      <manvolnum>8</manvolnum></citerefentry>,
 
393
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
 
394
      <manvolnum>5</manvolnum></citerefentry>,
 
395
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
396
      <manvolnum>8</manvolnum></citerefentry>
 
397
    </para>
 
398
  </refsect1>
392
399
</refentry>
 
400
<!-- Local Variables: -->
 
401
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
402
<!-- time-stamp-end: "[\"']>" -->
 
403
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
404
<!-- End: -->