/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: 2008-08-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> 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;
 
7
<!ENTITY TIMESTAMP "2008-08-30">
9
8
]>
10
9
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
12
11
  <refentryinfo>
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
41
61
  </refentryinfo>
42
 
  
 
62
 
43
63
  <refmeta>
44
64
    <refentrytitle>&CONFNAME;</refentrytitle>
45
65
    <manvolnum>5</manvolnum>
51
71
      Configuration file for the Mandos server
52
72
    </refpurpose>
53
73
  </refnamediv>
54
 
  
 
74
 
55
75
  <refsynopsisdiv>
56
76
    <synopsis>&CONFPATH;</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
124
        <term><option>timeout<literal> = </literal><replaceable
104
125
        >TIME</replaceable></option></term>
105
126
        <listitem>
106
127
          <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.
 
128
            The timeout is how long the server will wait for a
 
129
            successful checker run until a client is considered
 
130
            invalid - that is, ineligible to get the data this server
 
131
            holds.  By default Mandos will use 1 hour.
114
132
          </para>
115
133
          <para>
116
134
            The <replaceable>TIME</replaceable> is specified as a
127
145
          </para>
128
146
        </listitem>
129
147
      </varlistentry>
130
 
      
 
148
 
131
149
      <varlistentry>
132
150
        <term><option>interval<literal> = </literal><replaceable
133
151
        >TIME</replaceable></option></term>
134
152
        <listitem>
135
153
          <para>
136
 
            This option is <emphasis>optional</emphasis>.
137
 
          </para>
138
 
          <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
150
165
          </para>
151
166
        </listitem>
152
167
      </varlistentry>
153
 
      
 
168
 
154
169
      <varlistentry>
155
170
        <term><option>checker<literal> = </literal><replaceable
156
171
        >COMMAND</replaceable></option></term>
157
172
        <listitem>
158
173
          <para>
159
 
            This option is <emphasis>optional</emphasis>.
160
 
          </para>
161
 
          <para>
162
174
            This option allows you to override the default shell
163
175
            command that the server will use to check if the client is
164
176
            still up.  Any output of the command will be ignored, only
169
181
            <varname>PATH</varname> will be searched.  The default
170
182
            value for the checker command is <quote><literal
171
183
            ><command>fping</command> <option>-q</option> <option
172
 
            >--</option> %%(host)s</literal></quote>.
 
184
            >--</option> %(host)s</literal></quote>.
173
185
          </para>
174
186
          <para>
175
187
            In addition to normal start time expansion, this option
184
196
        ><replaceable>HEXSTRING</replaceable></option></term>
185
197
        <listitem>
186
198
          <para>
187
 
            This option is <emphasis>required</emphasis>.
188
 
          </para>
189
 
          <para>
190
199
            This option sets the OpenPGP fingerprint that identifies
191
200
            the public key that clients authenticate themselves with
192
201
            through TLS.  The string needs to be in hexidecimal form,
200
209
        >BASE64_ENCODED_DATA</replaceable></option></term>
201
210
        <listitem>
202
211
          <para>
203
 
            If this option is not specified, the <option
204
 
            >secfile</option> option is <emphasis>required</emphasis>
205
 
            to be present.
206
 
          </para>
207
 
          <para>
208
212
            If present, this option must be set to a string of
209
213
            base64-encoded binary data.  It will be decoded and sent
210
214
            to the client matching the above
222
226
            lines is that a line beginning with white space adds to
223
227
            the value of the previous line, RFC 822-style.
224
228
          </para>
 
229
          <para>
 
230
            If this option is not specified, the <option
 
231
            >secfile</option> option is used instead, but one of them
 
232
            <emphasis>must</emphasis> be present.
 
233
          </para>
225
234
        </listitem>
226
235
      </varlistentry>
227
 
      
 
236
 
228
237
      <varlistentry>
229
238
        <term><option>secfile<literal> = </literal><replaceable
230
239
        >FILENAME</replaceable></option></term>
231
240
        <listitem>
232
241
          <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
242
            Similar to the <option>secret</option>, except the secret
239
243
            data is in an external file.  The contents of the file
240
244
            should <emphasis>not</emphasis> be base64-encoded, but
241
245
            will be sent to clients verbatim.
242
246
          </para>
243
247
          <para>
244
 
            File names of the form <filename>~user/foo/bar</filename>
245
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
246
 
            are supported.
 
248
            This option is only used, and <emphasis>must</emphasis> be
 
249
            present, if <option>secret</option> is not specified.
247
250
          </para>
248
251
        </listitem>
249
252
      </varlistentry>
250
 
      
 
253
 
251
254
      <varlistentry>
252
255
        <term><option><literal>host = </literal><replaceable
253
256
        >STRING</replaceable></option></term>
254
257
        <listitem>
255
258
          <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
259
            Host name for this client.  This is not used by the server
263
260
            directly, but can be, and is by default, used by the
264
261
            checker.  See the <option>checker</option> option.
319
316
        mode is needed to expose an error of this kind.
320
317
      </para>
321
318
    </refsect2>
322
 
    
 
319
 
323
320
  </refsect1>
324
321
  
325
322
  <refsect1 id="files">
350
347
[DEFAULT]
351
348
timeout = 1h
352
349
interval = 5m
353
 
checker = fping -q -- %%(host)s
 
350
checker = fping -q -- %(host)s
354
351
 
355
352
# Client "foo"
356
353
[foo]
379
376
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
380
377
secfile = /etc/mandos/bar-secret
381
378
timeout = 15m
 
379
 
382
380
      </programlisting>
383
381
    </informalexample>
384
382
  </refsect1>