/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 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

Show diffs side-by-side

added added

removed removed

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