/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

Four new interrelated features:

1. Support using a different network interface via both initramfs.conf
   (the DEVICE setting) and the kernel command line (sixth field of
   the "ip=" option as in Linux' Documentation/nfsroot.txt).

2. Support connecting to a specified Mandos server directly using a
   kernel command line option ("mandos=connect:<ADDRESS>:<PORT>").

3. Support connecting directly to an IPv4 address (and port) using the
   "--connect" option of mandos-client.

4. Support an empty string to the --interface option to mandos-client.

* Makefile (WARN): Increase strictness by changing to
                   "-Wstrict-aliasing=1".

* debian/mandos-client.README.Debian (Use the Correct Network
  Interface): Changed to refer to initramfs.conf and nfsroot.txt.
  (Test the Server): Improve wording.
  (Non-local Connection): New section.
* initramfs-tools-script: Obey DEVICE environment variable and setting
                          from "/conf/initramfs.conf".  Also let any
                          "ip=" kernel command line option override
                          it.  Support new "mandos=connect" option.
                          Call "configure_networking" to set up IP
                          address on interface if necessary.
* plugin-runner.conf: Change example.
* plugins.d/mandos-client.c: Some whitespace and comment changes.
  (start_mandos_communication): Take an additional argument for
                                address family, all callers changed.
                                Connect to an IPv4 address if address
                                family is AF_INET.  Only set IPv6
                                scope_id for link-local addresses.
  (main): Accept empty interface name; this will not bring up any
         interface and leave the interface as unspecified.  Also do
         not restore kernel log level if lowering it failed.
* plugins.d/mandos-client.xml (OPTIONS): Document that the
                                         "--interface" option accepts
                                         an empty string.
  (EXAMPLE): Change example IPv6 address to a link-local address.

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>">
 
6
<!ENTITY TIMESTAMP "2009-01-08">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
7
9
]>
8
10
 
9
 
<refentry>
 
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
12
  <refentryinfo>
11
 
    <title>&CONFNAME;</title>
 
13
    <title>Mandos Manual</title>
12
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>&CONFNAME;</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&version;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
15
18
    <authorgroup>
16
19
      <author>
17
20
        <firstname>Björn</firstname>
30
33
    </authorgroup>
31
34
    <copyright>
32
35
      <year>2008</year>
 
36
      <year>2009</year>
33
37
      <holder>Teddy Hogeborn</holder>
34
38
      <holder>Björn Påhlsson</holder>
35
39
    </copyright>
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>
 
40
    <xi:include href="legalnotice.xml"/>
59
41
  </refentryinfo>
60
 
 
 
42
  
61
43
  <refmeta>
62
44
    <refentrytitle>&CONFNAME;</refentrytitle>
63
45
    <manvolnum>5</manvolnum>
69
51
      Configuration file for the Mandos server
70
52
    </refpurpose>
71
53
  </refnamediv>
72
 
 
 
54
  
73
55
  <refsynopsisdiv>
74
 
    <synopsis>
75
 
      &CONFPATH;
76
 
    </synopsis>
 
56
    <synopsis>&CONFPATH;</synopsis>
77
57
  </refsynopsisdiv>
78
 
 
 
58
  
79
59
  <refsect1 id="description">
80
60
    <title>DESCRIPTION</title>
81
61
    <para>
82
 
      The file &CONFPATH; is the configuration file for <citerefentry
 
62
      The file &CONFPATH; is a configuration file for <citerefentry
83
63
      ><refentrytitle>mandos</refentrytitle>
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
 
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
87
67
      if a client was declared invalid in a previous run of the
88
68
      server.
89
69
    </para>
111
91
  <refsect1 id="options">
112
92
    <title>OPTIONS</title>
113
93
    <para>
114
 
      The possible options are:
115
 
    </para>
116
 
 
 
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
    
117
101
    <variablelist>
118
 
 
 
102
      
119
103
      <varlistentry>
120
 
        <term><literal><varname>timeout</varname></literal></term>
 
104
        <term><option>timeout<literal> = </literal><replaceable
 
105
        >TIME</replaceable></option></term>
121
106
        <listitem>
122
 
          <synopsis><literal>timeout = </literal><replaceable
123
 
          >TIME</replaceable>
124
 
          </synopsis>
 
107
          <para>
 
108
            This option is <emphasis>optional</emphasis>.
 
109
          </para>
125
110
          <para>
126
111
            The timeout is how long the server will wait for a
127
112
            successful checker run until a client is considered
143
128
          </para>
144
129
        </listitem>
145
130
      </varlistentry>
146
 
 
 
131
      
147
132
      <varlistentry>
148
 
        <term><literal><varname>interval</varname></literal></term>
 
133
        <term><option>interval<literal> = </literal><replaceable
 
134
        >TIME</replaceable></option></term>
149
135
        <listitem>
150
 
          <synopsis><literal>interval = </literal><replaceable
151
 
          >TIME</replaceable>
152
 
          </synopsis>
 
136
          <para>
 
137
            This option is <emphasis>optional</emphasis>.
 
138
          </para>
153
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
164
150
            as for <varname>timeout</varname> above.
165
151
          </para>
166
152
        </listitem>
167
 
      </varlistentry>      
168
 
 
 
153
      </varlistentry>
 
154
      
169
155
      <varlistentry>
170
 
        <term><literal>checker</literal></term>
 
156
        <term><option>checker<literal> = </literal><replaceable
 
157
        >COMMAND</replaceable></option></term>
171
158
        <listitem>
172
 
          <synopsis><literal>checker = </literal><replaceable
173
 
          >COMMAND</replaceable>
174
 
          </synopsis>
 
159
          <para>
 
160
            This option is <emphasis>optional</emphasis>.
 
161
          </para>
175
162
          <para>
176
163
            This option allows you to override the default shell
177
164
            command that the server will use to check if the client is
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>.
 
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>.
185
174
          </para>
186
175
          <para>
187
176
            In addition to normal start time expansion, this option
192
181
      </varlistentry>
193
182
      
194
183
      <varlistentry>
195
 
        <term><literal>fingerprint</literal></term>
 
184
        <term><option>fingerprint<literal> = </literal
 
185
        ><replaceable>HEXSTRING</replaceable></option></term>
196
186
        <listitem>
197
 
          <synopsis><literal>fingerprint = </literal><replaceable
198
 
          >HEXSTRING</replaceable>
199
 
          </synopsis>
 
187
          <para>
 
188
            This option is <emphasis>required</emphasis>.
 
189
          </para>
200
190
          <para>
201
191
            This option sets the OpenPGP fingerprint that identifies
202
192
            the public key that clients authenticate themselves with
207
197
      </varlistentry>
208
198
      
209
199
      <varlistentry>
210
 
        <term><literal>secret</literal></term>
 
200
        <term><option>secret<literal> = </literal><replaceable
 
201
        >BASE64_ENCODED_DATA</replaceable></option></term>
211
202
        <listitem>
212
 
          <synopsis><literal>secret = </literal><replaceable
213
 
          >BASE64_ENCODED_DATA</replaceable>
214
 
          </synopsis>
 
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>
215
208
          <para>
216
209
            If present, this option must be set to a string of
217
210
            base64-encoded binary data.  It will be decoded and sent
218
211
            to the client matching the above
219
212
            <option>fingerprint</option>.  This should, of course, be
220
213
            OpenPGP encrypted data, decryptable only by the client.
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> 
 
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>
273
269
      
274
270
    </variablelist>
275
 
  </refsect1>  
 
271
  </refsect1>
276
272
  
277
273
  <refsect1 id="expansion">
278
274
    <title>EXPANSION</title>
317
313
      <para>
318
314
        Note that this means that, in order to include an actual
319
315
        percent character (<quote>%</quote>) in a
320
 
        <varname>checker</varname> options, <emphasis>four</emphasis>
 
316
        <varname>checker</varname> option, <emphasis>four</emphasis>
321
317
        percent characters in a row (<quote>%%%%</quote>) must be
322
318
        entered.  Also, a bad format here will lead to an immediate
323
319
        but <emphasis>silent</emphasis> run-time fatal exit; debug
324
 
        mode is needed to track down an error of this kind.
 
320
        mode is needed to expose an error of this kind.
325
321
      </para>
326
322
    </refsect2>
327
 
 
328
 
  </refsect1>  
 
323
    
 
324
  </refsect1>
329
325
  
330
326
  <refsect1 id="files">
331
327
    <title>FILES</title>
355
351
[DEFAULT]
356
352
timeout = 1h
357
353
interval = 5m
358
 
checker = fping -q -- %(host)s
 
354
checker = fping -q -- %%(host)s
359
355
 
360
356
# Client "foo"
361
357
[foo]
376
372
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
377
373
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
378
374
        QlnHIvPzEArRQLo=
379
 
        =iHhv
380
375
host = foo.example.org
381
 
interval = 5m
 
376
interval = 1m
382
377
 
383
378
# Client "bar"
384
379
[bar]
385
380
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
386
 
secfile = /etc/mandos/bar-secret.txt.asc
387
 
 
 
381
secfile = /etc/mandos/bar-secret
 
382
timeout = 15m
388
383
      </programlisting>
389
384
    </informalexample>
390
 
  </refsect1>  
391
 
 
 
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>
392
398
</refentry>
 
399
<!-- Local Variables: -->
 
400
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
401
<!-- time-stamp-end: "[\"']>" -->
 
402
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
403
<!-- End: -->