/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-09-04 14:12:10 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904141210-ig3or8uiz3cpxatj
* plugins.d/password-request.xml (EXAMPLE): Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
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-08-31">
 
7
<!ENTITY TIMESTAMP "2008-09-04">
8
8
]>
9
9
 
10
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
93
93
      start time expansion, see <xref linkend="expansion"/>.
94
94
    </para>
95
95
    <para>
96
 
      Uknown options are ignored.  The used options are as follows:
 
96
      Unknown options are ignored.  The used options are as follows:
97
97
    </para>
98
98
 
99
99
    <variablelist>
103
103
        >TIME</replaceable></option></term>
104
104
        <listitem>
105
105
          <para>
 
106
            This option is <emphasis>optional</emphasis>.
 
107
          </para>
 
108
          <para>
106
109
            The timeout is how long the server will wait for a
107
110
            successful checker run until a client is considered
108
111
            invalid - that is, ineligible to get the data this server
129
132
        >TIME</replaceable></option></term>
130
133
        <listitem>
131
134
          <para>
 
135
            This option is <emphasis>optional</emphasis>.
 
136
          </para>
 
137
          <para>
132
138
            How often to run the checker to confirm that a client is
133
139
            still up.  <emphasis>Note:</emphasis> a new checker will
134
140
            not be started if an old one is still running.  The server
149
155
        >COMMAND</replaceable></option></term>
150
156
        <listitem>
151
157
          <para>
 
158
            This option is <emphasis>optional</emphasis>.
 
159
          </para>
 
160
          <para>
152
161
            This option allows you to override the default shell
153
162
            command that the server will use to check if the client is
154
163
            still up.  Any output of the command will be ignored, only
174
183
        ><replaceable>HEXSTRING</replaceable></option></term>
175
184
        <listitem>
176
185
          <para>
 
186
            This option is <emphasis>required</emphasis>.
 
187
          </para>
 
188
          <para>
177
189
            This option sets the OpenPGP fingerprint that identifies
178
190
            the public key that clients authenticate themselves with
179
191
            through TLS.  The string needs to be in hexidecimal form,
187
199
        >BASE64_ENCODED_DATA</replaceable></option></term>
188
200
        <listitem>
189
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>
190
207
            If present, this option must be set to a string of
191
208
            base64-encoded binary data.  It will be decoded and sent
192
209
            to the client matching the above
204
221
            lines is that a line beginning with white space adds to
205
222
            the value of the previous line, RFC 822-style.
206
223
          </para>
207
 
          <para>
208
 
            If this option is not specified, the <option
209
 
            >secfile</option> option is used instead, but one of them
210
 
            <emphasis>must</emphasis> be present.
211
 
          </para>
212
224
        </listitem>
213
225
      </varlistentry>
214
226
 
217
229
        >FILENAME</replaceable></option></term>
218
230
        <listitem>
219
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>
220
237
            Similar to the <option>secret</option>, except the secret
221
238
            data is in an external file.  The contents of the file
222
239
            should <emphasis>not</emphasis> be base64-encoded, but
223
240
            will be sent to clients verbatim.
224
241
          </para>
225
 
          <para>
226
 
            This option is only used, and <emphasis>must</emphasis> be
227
 
            present, if <option>secret</option> is not specified.
228
 
          </para>
229
242
        </listitem>
230
243
      </varlistentry>
231
244
 
234
247
        >STRING</replaceable></option></term>
235
248
        <listitem>
236
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>
237
256
            Host name for this client.  This is not used by the server
238
257
            directly, but can be, and is by default, used by the
239
258
            checker.  See the <option>checker</option> option.