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

* plugins.d/mandos-client.c (main): Use separate bool variable instead
                                    of clumsy NUL character in
                                    "tempdir".  Bug fix: Don't try to
                                    remove temp directory if it was
                                    never created.

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-24">
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>
137
129
      using TLS with an OpenPGP key to ensure authenticity and
138
130
      confidentiality.  This client program keeps running, trying all
139
131
      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.
 
132
      or a TERM signal is received.  If no servers are found, or after
 
133
      all servers have been tried, it waits indefinitely for new
 
134
      servers to appear.
143
135
    </para>
144
136
    <para>
145
137
      This program is not meant to be run directly; it is really meant
199
191
      </varlistentry>
200
192
      
201
193
      <varlistentry>
202
 
        <term><option>--interface=<replaceable
203
 
        >NAME</replaceable></option></term>
 
194
        <term><option>--interface=
 
195
        <replaceable>NAME</replaceable></option></term>
204
196
        <term><option>-i
205
197
        <replaceable>NAME</replaceable></option></term>
206
198
        <listitem>
207
199
          <para>
208
200
            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.
 
201
            Mandos servers to connect to.  The default it
 
202
            <quote><literal>eth0</literal></quote>.
212
203
          </para>
213
204
          <para>
214
205
            If the <option>--connect</option> option is used, this
224
215
            until much later in the boot process, and can not be used
225
216
            by this program.
226
217
          </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
218
        </listitem>
235
219
      </varlistentry>
236
220
      
281
265
          </para>
282
266
        </listitem>
283
267
      </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
268
      
314
269
      <varlistentry>
315
270
        <term><option>--debug</option></term>
388
343
      server could be found and the password received from it could be
389
344
      successfully decrypted and output on standard output.  The
390
345
      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.
 
346
      error occurs.  Otherwise, it will forever connect to new
 
347
      <application>Mandos</application> servers as they appear, trying
 
348
      to get a decryptable password and print it.
394
349
    </para>
395
350
  </refsect1>
396
351
  
471
426
    <informalexample>
472
427
      <para>
473
428
        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:
 
429
        to locate a server; connect directly to the IPv6 address
 
430
        <quote><systemitem class="ipaddress"
 
431
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
432
        port 4711, using interface eth2:
478
433
      </para>
479
434
      <para>
480
435
 
481
436
<!-- 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>
 
437
<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
438
 
484
439
      </para>
485
440
    </informalexample>