/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-31 14:00:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140036-5bruinjq267s5f8p
* mandos-clients.conf.xml: Changed all single quotes to double quotes
                           for consistency.
* mandos.conf.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-clients.conf.xml
1
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-01-08">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-31">
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>
95
115
      start time expansion, see <xref linkend="expansion"/>.
96
116
    </para>
97
117
    <para>
98
 
      Unknown options are ignored.  The used options are as follows:
 
118
      Uknown options are ignored.  The used options are as follows:
99
119
    </para>
100
 
    
 
120
 
101
121
    <variablelist>
102
 
      
 
122
 
103
123
      <varlistentry>
104
124
        <term><option>timeout<literal> = </literal><replaceable
105
125
        >TIME</replaceable></option></term>
106
126
        <listitem>
107
127
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
110
 
          <para>
111
128
            The timeout is how long the server will wait for a
112
129
            successful checker run until a client is considered
113
130
            invalid - that is, ineligible to get the data this server
128
145
          </para>
129
146
        </listitem>
130
147
      </varlistentry>
131
 
      
 
148
 
132
149
      <varlistentry>
133
150
        <term><option>interval<literal> = </literal><replaceable
134
151
        >TIME</replaceable></option></term>
135
152
        <listitem>
136
153
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
139
 
          <para>
140
154
            How often to run the checker to confirm that a client is
141
155
            still up.  <emphasis>Note:</emphasis> a new checker will
142
156
            not be started if an old one is still running.  The server
151
165
          </para>
152
166
        </listitem>
153
167
      </varlistentry>
154
 
      
 
168
 
155
169
      <varlistentry>
156
170
        <term><option>checker<literal> = </literal><replaceable
157
171
        >COMMAND</replaceable></option></term>
158
172
        <listitem>
159
173
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </para>
162
 
          <para>
163
174
            This option allows you to override the default shell
164
175
            command that the server will use to check if the client is
165
176
            still up.  Any output of the command will be ignored, only
170
181
            <varname>PATH</varname> will be searched.  The default
171
182
            value for the checker command is <quote><literal
172
183
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
184
            >--</option> %(host)s</literal></quote>.
174
185
          </para>
175
186
          <para>
176
187
            In addition to normal start time expansion, this option
185
196
        ><replaceable>HEXSTRING</replaceable></option></term>
186
197
        <listitem>
187
198
          <para>
188
 
            This option is <emphasis>required</emphasis>.
189
 
          </para>
190
 
          <para>
191
199
            This option sets the OpenPGP fingerprint that identifies
192
200
            the public key that clients authenticate themselves with
193
201
            through TLS.  The string needs to be in hexidecimal form,
201
209
        >BASE64_ENCODED_DATA</replaceable></option></term>
202
210
        <listitem>
203
211
          <para>
204
 
            If this option is not specified, the <option
205
 
            >secfile</option> option is <emphasis>required</emphasis>
206
 
            to be present.
207
 
          </para>
208
 
          <para>
209
212
            If present, this option must be set to a string of
210
213
            base64-encoded binary data.  It will be decoded and sent
211
214
            to the client matching the above
223
226
            lines is that a line beginning with white space adds to
224
227
            the value of the previous line, RFC 822-style.
225
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>
226
234
        </listitem>
227
235
      </varlistentry>
228
 
      
 
236
 
229
237
      <varlistentry>
230
238
        <term><option>secfile<literal> = </literal><replaceable
231
239
        >FILENAME</replaceable></option></term>
232
240
        <listitem>
233
241
          <para>
234
 
            This option is only used if <option>secret</option> is not
235
 
            specified, in which case this option is
236
 
            <emphasis>required</emphasis>.
237
 
          </para>
238
 
          <para>
239
242
            Similar to the <option>secret</option>, except the secret
240
243
            data is in an external file.  The contents of the file
241
244
            should <emphasis>not</emphasis> be base64-encoded, but
242
245
            will be sent to clients verbatim.
243
246
          </para>
244
247
          <para>
245
 
            File names of the form <filename>~user/foo/bar</filename>
246
 
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
247
 
            are supported.
 
248
            This option is only used, and <emphasis>must</emphasis> be
 
249
            present, if <option>secret</option> is not specified.
248
250
          </para>
249
251
        </listitem>
250
252
      </varlistentry>
251
 
      
 
253
 
252
254
      <varlistentry>
253
255
        <term><option><literal>host = </literal><replaceable
254
256
        >STRING</replaceable></option></term>
255
257
        <listitem>
256
258
          <para>
257
 
            This option is <emphasis>optional</emphasis>, but highly
258
 
            <emphasis>recommended</emphasis> unless the
259
 
            <option>checker</option> option is modified to a
260
 
            non-standard value without <quote>%(host)s</quote> in it.
261
 
          </para>
262
 
          <para>
263
259
            Host name for this client.  This is not used by the server
264
260
            directly, but can be, and is by default, used by the
265
261
            checker.  See the <option>checker</option> option.
320
316
        mode is needed to expose an error of this kind.
321
317
      </para>
322
318
    </refsect2>
323
 
    
 
319
 
324
320
  </refsect1>
325
321
  
326
322
  <refsect1 id="files">
351
347
[DEFAULT]
352
348
timeout = 1h
353
349
interval = 5m
354
 
checker = fping -q -- %%(host)s
 
350
checker = fping -q -- %(host)s
355
351
 
356
352
# Client "foo"
357
353
[foo]
380
376
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
377
secfile = /etc/mandos/bar-secret
382
378
timeout = 15m
 
379
 
383
380
      </programlisting>
384
381
    </informalexample>
385
382
  </refsect1>