/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 plugins.d/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2009-01-08 03:54:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090108035406-01uqkv9xqgxlnw7c
Change the default value of the "checker" option command to make the
checker command be run-time dependent on the "host" client attribute
instead of reading it only once on startup:

* clients.conf (checker): Changed default commented-out value to
                          "fping -q -- %%(host)s".
* mandos (main): Changed default value for the "checker" config option
                 to "fping -q -- %%(host)s".
* mandos-clients.conf.xml (OPTIONS): Document changed default value.
  (EXAMPLE): Changed value of "checker".

* plugins.d/password-prompt.c: Whitespace changes only.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.xml
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
4
<!ENTITY COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
93
93
      </arg>
94
94
      <sbr/>
95
95
      <arg>
96
 
        <option>--delay <replaceable>SECONDS</replaceable></option>
97
 
      </arg>
98
 
      <sbr/>
99
 
      <arg>
100
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
101
 
      </arg>
102
 
      <sbr/>
103
 
      <arg>
104
96
        <option>--debug</option>
105
97
      </arg>
106
98
    </cmdsynopsis>
130
122
      <command>&COMMANDNAME;</command> is a client program that
131
123
      communicates with <citerefentry><refentrytitle
132
124
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
133
 
      to get a password.  In slightly more detail, this client program
134
 
      brings up a network interface, uses the interface’s IPv6
135
 
      link-local address to get network connectivity, uses Zeroconf to
136
 
      find servers on the local network, and communicates with servers
137
 
      using TLS with an OpenPGP key to ensure authenticity and
138
 
      confidentiality.  This client program keeps running, trying all
139
 
      servers on the network, until it receives a satisfactory reply
140
 
      or a TERM signal.  After all servers have been tried, all
141
 
      servers are periodically retried.  If no servers are found it
142
 
      will wait indefinitely for new servers to appear.
 
125
      to get a password.  It uses IPv6 link-local addresses to get
 
126
      network connectivity, Zeroconf to find servers, and TLS with an
 
127
      OpenPGP key to ensure authenticity and confidentiality.  It
 
128
      keeps running, trying all servers on the network, until it
 
129
      receives a satisfactory reply or a TERM signal is received.
143
130
    </para>
144
131
    <para>
145
132
      This program is not meant to be run directly; it is really meant
199
186
      </varlistentry>
200
187
      
201
188
      <varlistentry>
202
 
        <term><option>--interface=<replaceable
203
 
        >NAME</replaceable></option></term>
 
189
        <term><option>--interface=
 
190
        <replaceable>NAME</replaceable></option></term>
204
191
        <term><option>-i
205
192
        <replaceable>NAME</replaceable></option></term>
206
193
        <listitem>
207
194
          <para>
208
195
            Network interface that will be brought up and scanned for
209
 
            Mandos servers to connect to.  The default is the empty
210
 
            string, which will automatically choose an appropriate
211
 
            interface.
 
196
            Mandos servers to connect to.  The default it
 
197
            <quote><literal>eth0</literal></quote>.
212
198
          </para>
213
199
          <para>
214
200
            If the <option>--connect</option> option is used, this
215
201
            specifies the interface to use to connect to the address
216
202
            given.
217
203
          </para>
218
 
          <para>
219
 
            Note that since this program will normally run in the
220
 
            initial RAM disk environment, the interface must be an
221
 
            interface which exists at that stage.  Thus, the interface
222
 
            can not be a pseudo-interface such as <quote>br0</quote>
223
 
            or <quote>tun0</quote>; such interfaces will not exist
224
 
            until much later in the boot process, and can not be used
225
 
            by this program.
226
 
          </para>
227
 
          <para>
228
 
            <replaceable>NAME</replaceable> can be the string
229
 
            <quote><literal>none</literal></quote>; this will not use
230
 
            any specific interface, and will not bring up an interface
231
 
            on startup.  This is not recommended, and only meant for
232
 
            advanced users.
233
 
          </para>
234
204
        </listitem>
235
205
      </varlistentry>
236
206
      
281
251
          </para>
282
252
        </listitem>
283
253
      </varlistentry>
284
 
 
285
 
      <varlistentry>
286
 
        <term><option>--delay=<replaceable
287
 
        >SECONDS</replaceable></option></term>
288
 
        <listitem>
289
 
          <para>
290
 
            After bringing the network interface up, the program waits
291
 
            for the interface to arrive in a <quote>running</quote>
292
 
            state before proceeding.  During this time, the kernel log
293
 
            level will be lowered to reduce clutter on the system
294
 
            console, alleviating any other plugins which might be
295
 
            using the system console.  This option sets the upper
296
 
            limit of seconds to wait.  The default is 2.5 seconds.
297
 
          </para>
298
 
        </listitem>
299
 
      </varlistentry>
300
 
 
301
 
      <varlistentry>
302
 
        <term><option>--retry=<replaceable
303
 
        >SECONDS</replaceable></option></term>
304
 
        <listitem>
305
 
          <para>
306
 
            All Mandos servers are tried repeatedly until a password
307
 
            is received.  This value specifies, in seconds, how long
308
 
            between each successive try <emphasis>for the same
309
 
            server</emphasis>.  The default is 10 seconds.
310
 
          </para>
311
 
        </listitem>
312
 
      </varlistentry>
313
254
      
314
255
      <varlistentry>
315
256
        <term><option>--debug</option></term>
388
329
      server could be found and the password received from it could be
389
330
      successfully decrypted and output on standard output.  The
390
331
      program will exit with a non-zero exit status only if a critical
391
 
      error occurs.  Otherwise, it will forever connect to any
392
 
      discovered <application>Mandos</application> servers, trying to
393
 
      get a decryptable password and print it.
 
332
      error occurs.  Otherwise, it will forever connect to new
 
333
      <application>Mandos</application> servers as they appear, trying
 
334
      to get a decryptable password and print it.
394
335
    </para>
395
336
  </refsect1>
396
337
  
471
412
    <informalexample>
472
413
      <para>
473
414
        Run in debug mode, with a custom key, and do not use Zeroconf
474
 
        to locate a server; connect directly to the IPv6 link-local
475
 
        address <quote><systemitem class="ipaddress"
476
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
477
 
        using interface eth2:
 
415
        to locate a server; connect directly to the IPv6 address
 
416
        <quote><systemitem class="ipaddress"
 
417
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
418
        port 4711, using interface eth2:
478
419
      </para>
479
420
      <para>
480
421
 
481
422
<!-- do not wrap this line -->
482
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
423
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
483
424
 
484
425
      </para>
485
426
    </informalexample>