/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 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

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>
62
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
63
83
      ><refentrytitle>mandos</refentrytitle>
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 enabled,
67
 
      even if a client was disabled in a previous run of the server.
 
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
 
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
90
111
  <refsect1 id="options">
91
112
    <title>OPTIONS</title>
92
113
    <para>
93
 
      <emphasis>Note:</emphasis> all option values are subject to
94
 
      start time expansion, see <xref linkend="expansion"/>.
95
 
    </para>
96
 
    <para>
97
 
      Unknown options are ignored.  The used options are as follows:
98
 
    </para>
99
 
    
 
114
      The possible options are:
 
115
    </para>
 
116
 
100
117
    <variablelist>
101
 
      
 
118
 
102
119
      <varlistentry>
103
 
        <term><option>timeout<literal> = </literal><replaceable
104
 
        >TIME</replaceable></option></term>
 
120
        <term><literal><varname>timeout</varname></literal></term>
105
121
        <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.
 
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.
114
130
          </para>
115
131
          <para>
116
132
            The <replaceable>TIME</replaceable> is specified as a
127
143
          </para>
128
144
        </listitem>
129
145
      </varlistentry>
130
 
      
 
146
 
131
147
      <varlistentry>
132
 
        <term><option>interval<literal> = </literal><replaceable
133
 
        >TIME</replaceable></option></term>
 
148
        <term><literal><varname>interval</varname></literal></term>
134
149
        <listitem>
135
 
          <para>
136
 
            This option is <emphasis>optional</emphasis>.
137
 
          </para>
 
150
          <synopsis><literal>interval = </literal><replaceable
 
151
          >TIME</replaceable>
 
152
          </synopsis>
138
153
          <para>
139
154
            How often to run the checker to confirm that a client is
140
155
            still up.  <emphasis>Note:</emphasis> a new checker will
141
156
            not be started if an old one is still running.  The server
142
157
            will wait for a checker to complete until the above
143
158
            <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.
 
159
            time the client will be marked invalid, and any running
 
160
            checker killed.  The default interval is 5 minutes.
146
161
          </para>
147
162
          <para>
148
163
            The format of <replaceable>TIME</replaceable> is the same
149
164
            as for <varname>timeout</varname> above.
150
165
          </para>
151
166
        </listitem>
152
 
      </varlistentry>
153
 
      
 
167
      </varlistentry>      
 
168
 
154
169
      <varlistentry>
155
 
        <term><option>checker<literal> = </literal><replaceable
156
 
        >COMMAND</replaceable></option></term>
 
170
        <term><literal>checker</literal></term>
157
171
        <listitem>
158
 
          <para>
159
 
            This option is <emphasis>optional</emphasis>.
160
 
          </para>
 
172
          <synopsis><literal>checker = </literal><replaceable
 
173
          >COMMAND</replaceable>
 
174
          </synopsis>
161
175
          <para>
162
176
            This option allows you to override the default shell
163
177
            command that the server will use to check if the client is
164
 
            still up.  Any output of the command will be ignored, only
165
 
            the exit code is checked:  If the exit code of the command
166
 
            is zero, the client is considered up.  The command will be
167
 
            run using <quote><command><filename>/bin/sh</filename>
168
 
            <option>-c</option></command></quote>, so
169
 
            <varname>PATH</varname> will be searched.  The default
170
 
            value for the checker command is <quote><literal
171
 
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
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>.
173
185
          </para>
174
186
          <para>
175
187
            In addition to normal start time expansion, this option
180
192
      </varlistentry>
181
193
      
182
194
      <varlistentry>
183
 
        <term><option>fingerprint<literal> = </literal
184
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
195
        <term><literal>fingerprint</literal></term>
185
196
        <listitem>
186
 
          <para>
187
 
            This option is <emphasis>required</emphasis>.
188
 
          </para>
 
197
          <synopsis><literal>fingerprint = </literal><replaceable
 
198
          >HEXSTRING</replaceable>
 
199
          </synopsis>
189
200
          <para>
190
201
            This option sets the OpenPGP fingerprint that identifies
191
202
            the public key that clients authenticate themselves with
196
207
      </varlistentry>
197
208
      
198
209
      <varlistentry>
199
 
        <term><option>secret<literal> = </literal><replaceable
200
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
210
        <term><literal>secret</literal></term>
201
211
        <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>
 
212
          <synopsis><literal>secret = </literal><replaceable
 
213
          >BASE64_ENCODED_DATA</replaceable>
 
214
          </synopsis>
207
215
          <para>
208
216
            If present, this option must be set to a string of
209
217
            base64-encoded binary data.  It will be decoded and sent
210
218
            to the client matching the above
211
219
            <option>fingerprint</option>.  This should, of course, be
212
220
            OpenPGP encrypted data, decryptable only by the client.
213
 
            The program <citerefentry><refentrytitle><command
214
 
            >mandos-keygen</command></refentrytitle><manvolnum
215
 
            >8</manvolnum></citerefentry> can, using its
216
 
            <option>--password</option> option, be used to generate
217
 
            this, if desired.
218
 
          </para>
219
 
          <para>
220
 
            Note: this value of this option will probably be very
221
 
            long.  A useful feature to avoid having unreadably-long
222
 
            lines is that a line beginning with white space adds to
223
 
            the value of the previous line, RFC 822-style.
224
 
          </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>
261
 
          <para>
262
 
            Host name for this client.  This is not used by the server
263
 
            directly, but can be, and is by default, used by the
264
 
            checker.  See the <option>checker</option> option.
265
 
          </para>
266
 
        </listitem>
267
 
      </varlistentry>
 
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> 
268
273
      
269
274
    </variablelist>
270
 
  </refsect1>
 
275
  </refsect1>  
271
276
  
272
277
  <refsect1 id="expansion">
273
278
    <title>EXPANSION</title>
312
317
      <para>
313
318
        Note that this means that, in order to include an actual
314
319
        percent character (<quote>%</quote>) in a
315
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
320
        <varname>checker</varname> options, <emphasis>four</emphasis>
316
321
        percent characters in a row (<quote>%%%%</quote>) must be
317
322
        entered.  Also, a bad format here will lead to an immediate
318
323
        but <emphasis>silent</emphasis> run-time fatal exit; debug
319
 
        mode is needed to expose an error of this kind.
 
324
        mode is needed to track down an error of this kind.
320
325
      </para>
321
326
    </refsect2>
322
 
    
323
 
  </refsect1>
 
327
 
 
328
  </refsect1>  
324
329
  
325
330
  <refsect1 id="files">
326
331
    <title>FILES</title>
350
355
[DEFAULT]
351
356
timeout = 1h
352
357
interval = 5m
353
 
checker = fping -q -- %%(host)s
 
358
checker = fping -q -- %(host)s
354
359
 
355
360
# Client "foo"
356
361
[foo]
371
376
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
372
377
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
373
378
        QlnHIvPzEArRQLo=
 
379
        =iHhv
374
380
host = foo.example.org
375
 
interval = 1m
 
381
interval = 5m
376
382
 
377
383
# Client "bar"
378
384
[bar]
379
385
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
 
secfile = /etc/mandos/bar-secret
381
 
timeout = 15m
 
386
secfile = /etc/mandos/bar-secret.txt.asc
 
387
 
382
388
      </programlisting>
383
389
    </informalexample>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="see_also">
387
 
    <title>SEE ALSO</title>
388
 
    <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>
395
 
    </para>
396
 
  </refsect1>
 
390
  </refsect1>  
 
391
 
397
392
</refentry>
398
 
<!-- Local Variables: -->
399
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
400
 
<!-- time-stamp-end: "[\"']>" -->
401
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
402
 
<!-- End: -->