/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-25 01:16:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825011638-zgqej2cafhne05ay
* mandos-keygen: Strip 24-bit checksum of Radix-64 from output to make
                 output strictly base64.

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">
4
5
<!ENTITY CONFNAME "mandos-clients.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-02-15">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
9
7
]>
10
8
 
11
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
12
10
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
11
    <title>&CONFNAME;</title>
14
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
13
    <productname>&CONFNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
18
15
    <authorgroup>
19
16
      <author>
20
17
        <firstname>Björn</firstname>
33
30
    </authorgroup>
34
31
    <copyright>
35
32
      <year>2008</year>
36
 
      <year>2009</year>
37
33
      <holder>Teddy Hogeborn</holder>
38
34
      <holder>Björn Påhlsson</holder>
39
35
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
41
59
  </refentryinfo>
42
 
  
 
60
 
43
61
  <refmeta>
44
62
    <refentrytitle>&CONFNAME;</refentrytitle>
45
63
    <manvolnum>5</manvolnum>
51
69
      Configuration file for the Mandos server
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
74
    <synopsis>
 
75
      &CONFPATH;
 
76
    </synopsis>
57
77
  </refsynopsisdiv>
58
 
  
 
78
 
59
79
  <refsect1 id="description">
60
80
    <title>DESCRIPTION</title>
61
81
    <para>
62
 
      The file &CONFPATH; is a configuration file for <citerefentry
 
82
      The file &CONFPATH; is the configuration file for <citerefentry
63
83
      ><refentrytitle>mandos</refentrytitle>
64
 
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
65
 
      The file needs to list all clients that should be able to use
66
 
      the service.  All clients listed will be regarded as valid, even
 
84
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup,
 
85
      where each client that will be able to use the service needs to
 
86
      be listed.  All clients listed will be regarded as valid, even
67
87
      if a client was declared invalid in a previous run of the
68
88
      server.
69
89
    </para>
91
111
  <refsect1 id="options">
92
112
    <title>OPTIONS</title>
93
113
    <para>
94
 
      <emphasis>Note:</emphasis> all option values are subject to
95
 
      start time expansion, see <xref linkend="expansion"/>.
96
 
    </para>
97
 
    <para>
98
 
      Unknown options are ignored.  The used options are as follows:
99
 
    </para>
100
 
    
 
114
      The possible options are:
 
115
    </para>
 
116
 
101
117
    <variablelist>
102
 
      
 
118
 
103
119
      <varlistentry>
104
 
        <term><option>timeout<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
 
120
        <term><literal><varname>timeout</varname></literal></term>
106
121
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
 
122
          <synopsis><literal>timeout = </literal><replaceable
 
123
          >TIME</replaceable>
 
124
          </synopsis>
110
125
          <para>
111
126
            The timeout is how long the server will wait for a
112
127
            successful checker run until a client is considered
128
143
          </para>
129
144
        </listitem>
130
145
      </varlistentry>
131
 
      
 
146
 
132
147
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
 
148
        <term><literal><varname>interval</varname></literal></term>
135
149
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
 
150
          <synopsis><literal>interval = </literal><replaceable
 
151
          >TIME</replaceable>
 
152
          </synopsis>
139
153
          <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
150
164
            as for <varname>timeout</varname> above.
151
165
          </para>
152
166
        </listitem>
153
 
      </varlistentry>
154
 
      
 
167
      </varlistentry>      
 
168
 
155
169
      <varlistentry>
156
 
        <term><option>checker<literal> = </literal><replaceable
157
 
        >COMMAND</replaceable></option></term>
 
170
        <term><literal>checker</literal></term>
158
171
        <listitem>
159
 
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </para>
 
172
          <synopsis><literal>checker = </literal><replaceable
 
173
          >COMMAND</replaceable>
 
174
          </synopsis>
162
175
          <para>
163
176
            This option allows you to override the default shell
164
177
            command that the server will use to check if the client is
165
 
            still up.  Any output of the command will be ignored, only
166
 
            the exit code is checked:  If the exit code of the command
167
 
            is zero, the client is considered up.  The command will be
168
 
            run using <quote><command><filename>/bin/sh</filename>
169
 
            <option>-c</option></command></quote>, so
170
 
            <varname>PATH</varname> will be searched.  The default
171
 
            value for the checker command is <quote><literal
172
 
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
178
            still up.  The output of the command will be ignored, only
 
179
            the exit code is checked.  The command will be run using
 
180
            <quote><command><filename>/bin/sh</filename>
 
181
            <option>-c</option></command></quote>.  The default
 
182
            command is <quote><literal><command>fping</command>
 
183
            <option>-q</option> <option>--</option>
 
184
            %(host)s</literal></quote>.
174
185
          </para>
175
186
          <para>
176
187
            In addition to normal start time expansion, this option
181
192
      </varlistentry>
182
193
      
183
194
      <varlistentry>
184
 
        <term><option>fingerprint<literal> = </literal
185
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
195
        <term><literal>fingerprint</literal></term>
186
196
        <listitem>
187
 
          <para>
188
 
            This option is <emphasis>required</emphasis>.
189
 
          </para>
 
197
          <synopsis><literal>fingerprint = </literal><replaceable
 
198
          >HEXSTRING</replaceable>
 
199
          </synopsis>
190
200
          <para>
191
201
            This option sets the OpenPGP fingerprint that identifies
192
202
            the public key that clients authenticate themselves with
197
207
      </varlistentry>
198
208
      
199
209
      <varlistentry>
200
 
        <term><option>secret<literal> = </literal><replaceable
201
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
210
        <term><literal>secret</literal></term>
202
211
        <listitem>
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>
 
212
          <synopsis><literal>secret = </literal><replaceable
 
213
          >BASE64_ENCODED_DATA</replaceable>
 
214
          </synopsis>
208
215
          <para>
209
216
            If present, this option must be set to a string of
210
217
            base64-encoded binary data.  It will be decoded and sent
211
218
            to the client matching the above
212
219
            <option>fingerprint</option>.  This should, of course, be
213
220
            OpenPGP encrypted data, decryptable only by the client.
214
 
            The program <citerefentry><refentrytitle><command
215
 
            >mandos-keygen</command></refentrytitle><manvolnum
216
 
            >8</manvolnum></citerefentry> can, using its
217
 
            <option>--password</option> option, be used to generate
218
 
            this, if desired.
219
 
          </para>
220
 
          <para>
221
 
            Note: this value of this option will probably be very
222
 
            long.  A useful feature to avoid having unreadably-long
223
 
            lines is that a line beginning with white space adds to
224
 
            the value of the previous line, RFC 822-style.
225
 
          </para>
226
 
        </listitem>
227
 
      </varlistentry>
228
 
      
229
 
      <varlistentry>
230
 
        <term><option>secfile<literal> = </literal><replaceable
231
 
        >FILENAME</replaceable></option></term>
232
 
        <listitem>
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>
239
 
            Similar to the <option>secret</option>, except the secret
240
 
            data is in an external file.  The contents of the file
241
 
            should <emphasis>not</emphasis> be base64-encoded, but
242
 
            will be sent to clients verbatim.
243
 
          </para>
244
 
          <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
 
          </para>
249
 
        </listitem>
250
 
      </varlistentry>
251
 
      
252
 
      <varlistentry>
253
 
        <term><option><literal>host = </literal><replaceable
254
 
        >STRING</replaceable></option></term>
255
 
        <listitem>
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>
263
 
            Host name for this client.  This is not used by the server
264
 
            directly, but can be, and is by default, used by the
265
 
            checker.  See the <option>checker</option> option.
266
 
          </para>
267
 
        </listitem>
268
 
      </varlistentry>
 
221
<!--        The program <citerefentry><refentrytitle><command -->
 
222
<!--        >mandos-keygen</command></refentrytitle><manvolnum -->
 
223
<!--        >8</manvolnum></citerefentry> can be used to generate it, -->
 
224
<!--        if desired. -->
 
225
          </para>
 
226
          <para>
 
227
            Note: this value of this option will probably run over
 
228
            many lines, and will then have to use the fact that a line
 
229
            beginning with white space adds to the value of the
 
230
            previous line, RFC 822-style.
 
231
          </para>
 
232
        </listitem>
 
233
      </varlistentry>
 
234
 
 
235
      <varlistentry>
 
236
        <term><literal>secfile</literal></term>
 
237
        <listitem>
 
238
          <para>
 
239
            Base 64 encoded OpenPGP encrypted password encrypted by
 
240
            the clients openpgp certificate as a binary file.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
 
244
 
 
245
      <varlistentry>
 
246
        <term><literal>host</literal></term>
 
247
        <listitem>
 
248
          <para>
 
249
            Host name that can be used in for checking that the client is up.
 
250
          </para>
 
251
        </listitem>
 
252
      </varlistentry>
 
253
 
 
254
      <varlistentry>
 
255
        <term><literal>checker</literal></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Shell command that the server will use to check up if a
 
259
            client is still up.
 
260
          </para>
 
261
        </listitem>
 
262
      </varlistentry>      
 
263
 
 
264
      <varlistentry>
 
265
        <term><literal>timeout</literal></term>
 
266
        <listitem>
 
267
          <para>
 
268
            Duration that a client can be down whitout be removed from
 
269
            the client list.
 
270
          </para>
 
271
        </listitem>
 
272
      </varlistentry> 
269
273
      
270
274
    </variablelist>
271
 
  </refsect1>
 
275
  </refsect1>  
272
276
  
273
277
  <refsect1 id="expansion">
274
278
    <title>EXPANSION</title>
313
317
      <para>
314
318
        Note that this means that, in order to include an actual
315
319
        percent character (<quote>%</quote>) in a
316
 
        <varname>checker</varname> option, <emphasis>four</emphasis>
 
320
        <varname>checker</varname> options, <emphasis>four</emphasis>
317
321
        percent characters in a row (<quote>%%%%</quote>) must be
318
322
        entered.  Also, a bad format here will lead to an immediate
319
323
        but <emphasis>silent</emphasis> run-time fatal exit; debug
320
 
        mode is needed to expose an error of this kind.
 
324
        mode is needed to track down an error of this kind.
321
325
      </para>
322
326
    </refsect2>
323
 
    
324
 
  </refsect1>
 
327
 
 
328
  </refsect1>  
325
329
  
326
330
  <refsect1 id="files">
327
331
    <title>FILES</title>
351
355
[DEFAULT]
352
356
timeout = 1h
353
357
interval = 5m
354
 
checker = fping -q -- %%(host)s
 
358
checker = fping -q -- %(host)s
355
359
 
356
360
# Client "foo"
357
361
[foo]
372
376
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
373
377
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
374
378
        QlnHIvPzEArRQLo=
 
379
        =iHhv
375
380
host = foo.example.org
376
 
interval = 1m
 
381
interval = 5m
377
382
 
378
383
# Client "bar"
379
384
[bar]
380
385
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
 
secfile = /etc/mandos/bar-secret
382
 
timeout = 15m
 
386
secfile = /etc/mandos/bar-secret.txt.asc
 
387
 
383
388
      </programlisting>
384
389
    </informalexample>
385
 
  </refsect1>
386
 
  
387
 
  <refsect1 id="see_also">
388
 
    <title>SEE ALSO</title>
389
 
    <para>
390
 
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
391
 
      <manvolnum>8</manvolnum></citerefentry>,
392
 
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
393
 
      <manvolnum>5</manvolnum></citerefentry>,
394
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
395
 
      <manvolnum>8</manvolnum></citerefentry>
396
 
    </para>
397
 
  </refsect1>
 
390
  </refsect1>  
 
391
 
398
392
</refentry>
399
 
<!-- Local Variables: -->
400
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
401
 
<!-- time-stamp-end: "[\"']>" -->
402
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
403
 
<!-- End: -->