/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-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

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-09-12">
 
7
<!ENTITY TIMESTAMP "2008-08-31">
8
8
]>
9
9
 
10
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
37
37
    </copyright>
38
38
    <xi:include href="legalnotice.xml"/>
39
39
  </refentryinfo>
40
 
  
 
40
 
41
41
  <refmeta>
42
42
    <refentrytitle>&CONFNAME;</refentrytitle>
43
43
    <manvolnum>5</manvolnum>
49
49
      Configuration file for the Mandos server
50
50
    </refpurpose>
51
51
  </refnamediv>
52
 
  
 
52
 
53
53
  <refsynopsisdiv>
54
54
    <synopsis>&CONFPATH;</synopsis>
55
55
  </refsynopsisdiv>
56
 
  
 
56
 
57
57
  <refsect1 id="description">
58
58
    <title>DESCRIPTION</title>
59
59
    <para>
93
93
      start time expansion, see <xref linkend="expansion"/>.
94
94
    </para>
95
95
    <para>
96
 
      Unknown options are ignored.  The used options are as follows:
 
96
      Uknown options are ignored.  The used options are as follows:
97
97
    </para>
98
 
    
 
98
 
99
99
    <variablelist>
100
 
      
 
100
 
101
101
      <varlistentry>
102
102
        <term><option>timeout<literal> = </literal><replaceable
103
103
        >TIME</replaceable></option></term>
104
104
        <listitem>
105
105
          <para>
106
 
            This option is <emphasis>optional</emphasis>.
107
 
          </para>
108
 
          <para>
109
106
            The timeout is how long the server will wait for a
110
107
            successful checker run until a client is considered
111
108
            invalid - that is, ineligible to get the data this server
126
123
          </para>
127
124
        </listitem>
128
125
      </varlistentry>
129
 
      
 
126
 
130
127
      <varlistentry>
131
128
        <term><option>interval<literal> = </literal><replaceable
132
129
        >TIME</replaceable></option></term>
133
130
        <listitem>
134
131
          <para>
135
 
            This option is <emphasis>optional</emphasis>.
136
 
          </para>
137
 
          <para>
138
132
            How often to run the checker to confirm that a client is
139
133
            still up.  <emphasis>Note:</emphasis> a new checker will
140
134
            not be started if an old one is still running.  The server
149
143
          </para>
150
144
        </listitem>
151
145
      </varlistentry>
152
 
      
 
146
 
153
147
      <varlistentry>
154
148
        <term><option>checker<literal> = </literal><replaceable
155
149
        >COMMAND</replaceable></option></term>
156
150
        <listitem>
157
151
          <para>
158
 
            This option is <emphasis>optional</emphasis>.
159
 
          </para>
160
 
          <para>
161
152
            This option allows you to override the default shell
162
153
            command that the server will use to check if the client is
163
154
            still up.  Any output of the command will be ignored, only
183
174
        ><replaceable>HEXSTRING</replaceable></option></term>
184
175
        <listitem>
185
176
          <para>
186
 
            This option is <emphasis>required</emphasis>.
187
 
          </para>
188
 
          <para>
189
177
            This option sets the OpenPGP fingerprint that identifies
190
178
            the public key that clients authenticate themselves with
191
179
            through TLS.  The string needs to be in hexidecimal form,
199
187
        >BASE64_ENCODED_DATA</replaceable></option></term>
200
188
        <listitem>
201
189
          <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
190
            If present, this option must be set to a string of
208
191
            base64-encoded binary data.  It will be decoded and sent
209
192
            to the client matching the above
221
204
            lines is that a line beginning with white space adds to
222
205
            the value of the previous line, RFC 822-style.
223
206
          </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>
224
212
        </listitem>
225
213
      </varlistentry>
226
 
      
 
214
 
227
215
      <varlistentry>
228
216
        <term><option>secfile<literal> = </literal><replaceable
229
217
        >FILENAME</replaceable></option></term>
230
218
        <listitem>
231
219
          <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
220
            Similar to the <option>secret</option>, except the secret
238
221
            data is in an external file.  The contents of the file
239
222
            should <emphasis>not</emphasis> be base64-encoded, but
240
223
            will be sent to clients verbatim.
241
224
          </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>
242
229
        </listitem>
243
230
      </varlistentry>
244
 
      
 
231
 
245
232
      <varlistentry>
246
233
        <term><option><literal>host = </literal><replaceable
247
234
        >STRING</replaceable></option></term>
248
235
        <listitem>
249
236
          <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
237
            Host name for this client.  This is not used by the server
257
238
            directly, but can be, and is by default, used by the
258
239
            checker.  See the <option>checker</option> option.
313
294
        mode is needed to expose an error of this kind.
314
295
      </para>
315
296
    </refsect2>
316
 
    
 
297
 
317
298
  </refsect1>
318
299
  
319
300
  <refsect1 id="files">
373
354
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
374
355
secfile = /etc/mandos/bar-secret
375
356
timeout = 15m
 
357
 
376
358
      </programlisting>
377
359
    </informalexample>
378
360
  </refsect1>