/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-clients.conf.xml

* plugin-runner.c: Minor stylistic changes.

* plugins.d/askpass-fifo.c: Changed contact information and did minor
                            stylistic changes.

* plugins.d/mandos-client.c: Minor stylistic changes.

* plugins.d/password-prompt.c: Changed contact information.

* plugins.d/splashy.c: Changed contact information.
  (main): Changed error handling design.  Bug fix: Will now be much
          more tolerant against signals.  Bug fix: Will now re-raise
          signal received.

* plugins.d/usplash.c: Changed contact information and did minor
                       stylistic changes.

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">
5
4
<!ENTITY CONFNAME "mandos-clients.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-30">
 
6
<!ENTITY TIMESTAMP "2009-02-15">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
  <refentryinfo>
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
35
37
      <holder>Teddy Hogeborn</holder>
36
38
      <holder>Björn Påhlsson</holder>
37
39
    </copyright>
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>
 
40
    <xi:include href="legalnotice.xml"/>
61
41
  </refentryinfo>
62
 
 
 
42
  
63
43
  <refmeta>
64
44
    <refentrytitle>&CONFNAME;</refentrytitle>
65
45
    <manvolnum>5</manvolnum>
71
51
      Configuration file for the Mandos server
72
52
    </refpurpose>
73
53
  </refnamediv>
74
 
 
 
54
  
75
55
  <refsynopsisdiv>
76
56
    <synopsis>&CONFPATH;</synopsis>
77
57
  </refsynopsisdiv>
78
 
 
 
58
  
79
59
  <refsect1 id="description">
80
60
    <title>DESCRIPTION</title>
81
61
    <para>
115
95
      start time expansion, see <xref linkend="expansion"/>.
116
96
    </para>
117
97
    <para>
118
 
      Uknown options are ignored.  The used options are as follows:
 
98
      Unknown options are ignored.  The used options are as follows:
119
99
    </para>
120
 
 
 
100
    
121
101
    <variablelist>
122
 
 
 
102
      
123
103
      <varlistentry>
124
104
        <term><option>timeout<literal> = </literal><replaceable
125
105
        >TIME</replaceable></option></term>
126
106
        <listitem>
127
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
 
110
          <para>
128
111
            The timeout is how long the server will wait for a
129
112
            successful checker run until a client is considered
130
113
            invalid - that is, ineligible to get the data this server
145
128
          </para>
146
129
        </listitem>
147
130
      </varlistentry>
148
 
 
 
131
      
149
132
      <varlistentry>
150
133
        <term><option>interval<literal> = </literal><replaceable
151
134
        >TIME</replaceable></option></term>
152
135
        <listitem>
153
136
          <para>
 
137
            This option is <emphasis>optional</emphasis>.
 
138
          </para>
 
139
          <para>
154
140
            How often to run the checker to confirm that a client is
155
141
            still up.  <emphasis>Note:</emphasis> a new checker will
156
142
            not be started if an old one is still running.  The server
165
151
          </para>
166
152
        </listitem>
167
153
      </varlistentry>
168
 
 
 
154
      
169
155
      <varlistentry>
170
156
        <term><option>checker<literal> = </literal><replaceable
171
157
        >COMMAND</replaceable></option></term>
172
158
        <listitem>
173
159
          <para>
 
160
            This option is <emphasis>optional</emphasis>.
 
161
          </para>
 
162
          <para>
174
163
            This option allows you to override the default shell
175
164
            command that the server will use to check if the client is
176
165
            still up.  Any output of the command will be ignored, only
181
170
            <varname>PATH</varname> will be searched.  The default
182
171
            value for the checker command is <quote><literal
183
172
            ><command>fping</command> <option>-q</option> <option
184
 
            >--</option> %(host)s</literal></quote>.
 
173
            >--</option> %%(host)s</literal></quote>.
185
174
          </para>
186
175
          <para>
187
176
            In addition to normal start time expansion, this option
196
185
        ><replaceable>HEXSTRING</replaceable></option></term>
197
186
        <listitem>
198
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
 
190
          <para>
199
191
            This option sets the OpenPGP fingerprint that identifies
200
192
            the public key that clients authenticate themselves with
201
193
            through TLS.  The string needs to be in hexidecimal form,
209
201
        >BASE64_ENCODED_DATA</replaceable></option></term>
210
202
        <listitem>
211
203
          <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>
212
209
            If present, this option must be set to a string of
213
210
            base64-encoded binary data.  It will be decoded and sent
214
211
            to the client matching the above
226
223
            lines is that a line beginning with white space adds to
227
224
            the value of the previous line, RFC 822-style.
228
225
          </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>
234
226
        </listitem>
235
227
      </varlistentry>
236
 
 
 
228
      
237
229
      <varlistentry>
238
230
        <term><option>secfile<literal> = </literal><replaceable
239
231
        >FILENAME</replaceable></option></term>
240
232
        <listitem>
241
233
          <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>
242
239
            Similar to the <option>secret</option>, except the secret
243
240
            data is in an external file.  The contents of the file
244
241
            should <emphasis>not</emphasis> be base64-encoded, but
245
242
            will be sent to clients verbatim.
246
243
          </para>
247
244
          <para>
248
 
            This option is only used, and <emphasis>must</emphasis> be
249
 
            present, if <option>secret</option> is not specified.
 
245
            File names of the form <filename>~user/foo/bar</filename>
 
246
            and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
 
247
            are supported.
250
248
          </para>
251
249
        </listitem>
252
250
      </varlistentry>
253
 
 
 
251
      
254
252
      <varlistentry>
255
253
        <term><option><literal>host = </literal><replaceable
256
254
        >STRING</replaceable></option></term>
257
255
        <listitem>
258
256
          <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>
259
263
            Host name for this client.  This is not used by the server
260
264
            directly, but can be, and is by default, used by the
261
265
            checker.  See the <option>checker</option> option.
316
320
        mode is needed to expose an error of this kind.
317
321
      </para>
318
322
    </refsect2>
319
 
 
 
323
    
320
324
  </refsect1>
321
325
  
322
326
  <refsect1 id="files">
347
351
[DEFAULT]
348
352
timeout = 1h
349
353
interval = 5m
350
 
checker = fping -q -- %(host)s
 
354
checker = fping -q -- %%(host)s
351
355
 
352
356
# Client "foo"
353
357
[foo]
376
380
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
377
381
secfile = /etc/mandos/bar-secret
378
382
timeout = 15m
379
 
 
380
383
      </programlisting>
381
384
    </informalexample>
382
385
  </refsect1>