/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-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

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-01-08">
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>
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
 
        <term><option>timeout<literal> = </literal><replaceable
105
 
        >TIME</replaceable></option></term>
 
124
        <term><literal><varname>timeout</varname></literal></term>
106
125
        <listitem>
107
 
          <para>
108
 
            This option is <emphasis>optional</emphasis>.
109
 
          </para>
 
126
          <synopsis><literal>timeout = </literal><replaceable
 
127
          >TIME</replaceable>
 
128
          </synopsis>
110
129
          <para>
111
130
            The timeout is how long the server will wait for a
112
131
            successful checker run until a client is considered
128
147
          </para>
129
148
        </listitem>
130
149
      </varlistentry>
131
 
      
 
150
 
132
151
      <varlistentry>
133
 
        <term><option>interval<literal> = </literal><replaceable
134
 
        >TIME</replaceable></option></term>
 
152
        <term><literal><varname>interval</varname></literal></term>
135
153
        <listitem>
136
 
          <para>
137
 
            This option is <emphasis>optional</emphasis>.
138
 
          </para>
 
154
          <synopsis><literal>interval = </literal><replaceable
 
155
          >TIME</replaceable>
 
156
          </synopsis>
139
157
          <para>
140
158
            How often to run the checker to confirm that a client is
141
159
            still up.  <emphasis>Note:</emphasis> a new checker will
150
168
            as for <varname>timeout</varname> above.
151
169
          </para>
152
170
        </listitem>
153
 
      </varlistentry>
154
 
      
 
171
      </varlistentry>      
 
172
 
155
173
      <varlistentry>
156
 
        <term><option>checker<literal> = </literal><replaceable
157
 
        >COMMAND</replaceable></option></term>
 
174
        <term><literal>checker</literal></term>
158
175
        <listitem>
159
 
          <para>
160
 
            This option is <emphasis>optional</emphasis>.
161
 
          </para>
 
176
          <synopsis><literal>checker = </literal><replaceable
 
177
          >COMMAND</replaceable>
 
178
          </synopsis>
162
179
          <para>
163
180
            This option allows you to override the default shell
164
181
            command that the server will use to check if the client is
170
187
            <varname>PATH</varname> will be searched.  The default
171
188
            value for the checker command is <quote><literal
172
189
            ><command>fping</command> <option>-q</option> <option
173
 
            >--</option> %%(host)s</literal></quote>.
 
190
            >--</option> %(host)s</literal></quote>.
174
191
          </para>
175
192
          <para>
176
193
            In addition to normal start time expansion, this option
181
198
      </varlistentry>
182
199
      
183
200
      <varlistentry>
184
 
        <term><option>fingerprint<literal> = </literal
185
 
        ><replaceable>HEXSTRING</replaceable></option></term>
 
201
        <term><literal>fingerprint</literal></term>
186
202
        <listitem>
187
 
          <para>
188
 
            This option is <emphasis>required</emphasis>.
189
 
          </para>
 
203
          <synopsis><literal>fingerprint = </literal><replaceable
 
204
          >HEXSTRING</replaceable>
 
205
          </synopsis>
190
206
          <para>
191
207
            This option sets the OpenPGP fingerprint that identifies
192
208
            the public key that clients authenticate themselves with
197
213
      </varlistentry>
198
214
      
199
215
      <varlistentry>
200
 
        <term><option>secret<literal> = </literal><replaceable
201
 
        >BASE64_ENCODED_DATA</replaceable></option></term>
 
216
        <term><literal>secret</literal></term>
202
217
        <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>
 
218
          <synopsis><literal>secret = </literal><replaceable
 
219
          >BASE64_ENCODED_DATA</replaceable>
 
220
          </synopsis>
208
221
          <para>
209
222
            If present, this option must be set to a string of
210
223
            base64-encoded binary data.  It will be decoded and sent
223
236
            lines is that a line beginning with white space adds to
224
237
            the value of the previous line, RFC 822-style.
225
238
          </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>
 
239
          <para>
 
240
            If this option is not specified, the <option
 
241
            >secfile</option> option is used instead, but one of them
 
242
            <emphasis>must</emphasis> be present.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
 
 
247
      <varlistentry>
 
248
        <term><literal>secfile</literal></term>
 
249
        <listitem>
 
250
          <synopsis><literal>secfile = </literal><replaceable
 
251
          >FILENAME</replaceable>
 
252
          </synopsis>
 
253
          <para>
 
254
            The same as <option>secret</option>, but the secret data
 
255
            is in an external file.  The contents of the file should
 
256
            <emphasis>not</emphasis> be base64-encoded, but will be
 
257
            sent to clients verbatim.
 
258
          </para>
 
259
          <para>
 
260
            This option is only used, and <emphasis>must</emphasis> be
 
261
            present, if <option>secret</option> is not specified.
 
262
          </para>
 
263
        </listitem>
 
264
      </varlistentry>
 
265
 
 
266
      <varlistentry>
 
267
        <term><literal>host</literal></term>
 
268
        <listitem>
 
269
          <synopsis><literal>host = </literal><replaceable
 
270
          >STRING</replaceable>
 
271
          </synopsis>
262
272
          <para>
263
273
            Host name for this client.  This is not used by the server
264
274
            directly, but can be, and is by default, used by the
268
278
      </varlistentry>
269
279
      
270
280
    </variablelist>
271
 
  </refsect1>
 
281
  </refsect1>  
272
282
  
273
283
  <refsect1 id="expansion">
274
284
    <title>EXPANSION</title>
317
327
        percent characters in a row (<quote>%%%%</quote>) must be
318
328
        entered.  Also, a bad format here will lead to an immediate
319
329
        but <emphasis>silent</emphasis> run-time fatal exit; debug
320
 
        mode is needed to expose an error of this kind.
 
330
        mode is needed to track down an error of this kind.
321
331
      </para>
322
332
    </refsect2>
323
 
    
324
 
  </refsect1>
 
333
 
 
334
  </refsect1>  
325
335
  
326
336
  <refsect1 id="files">
327
337
    <title>FILES</title>
351
361
[DEFAULT]
352
362
timeout = 1h
353
363
interval = 5m
354
 
checker = fping -q -- %%(host)s
 
364
checker = fping -q -- %(host)s
355
365
 
356
366
# Client "foo"
357
367
[foo]
380
390
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
381
391
secfile = /etc/mandos/bar-secret
382
392
timeout = 15m
 
393
 
383
394
      </programlisting>
384
395
    </informalexample>
385
 
  </refsect1>
 
396
  </refsect1>  
386
397
  
387
398
  <refsect1 id="see_also">
388
399
    <title>SEE ALSO</title>
389
400
    <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>
 
401
      <citerefentry>
 
402
        <refentrytitle>mandos</refentrytitle>
 
403
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
404
        <refentrytitle>mandos-keygen</refentrytitle>
 
405
        <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
406
        <refentrytitle>mandos.conf</refentrytitle>
 
407
        <manvolnum>5</manvolnum></citerefentry>
396
408
    </para>
397
409
  </refsect1>
398
410
</refentry>
399
 
<!-- Local Variables: -->
400
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
401
 
<!-- time-stamp-end: "[\"']>" -->
402
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
403
 
<!-- End: -->