/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.xml

Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
5
 
<!ENTITY TIMESTAMP "2009-02-24">
 
5
<!ENTITY TIMESTAMP "2009-09-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
86
86
      <sbr/>
87
87
      <arg><option>--debug</option></arg>
88
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
 
90
      <sbr/>
89
91
      <arg><option>--no-ipv6</option></arg>
90
92
    </cmdsynopsis>
91
93
    <cmdsynopsis>
233
235
      </varlistentry>
234
236
      
235
237
      <varlistentry>
 
238
        <term><option>--no-dbus</option></term>
 
239
        <listitem>
 
240
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
241
          <para>
 
242
            See also <xref linkend="dbus_interface"/>.
 
243
          </para>
 
244
        </listitem>
 
245
      </varlistentry>
 
246
      
 
247
      <varlistentry>
236
248
        <term><option>--no-ipv6</option></term>
237
249
        <listitem>
238
250
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
315
327
      The server will, by default, continually check that the clients
316
328
      are still up.  If a client has not been confirmed as being up
317
329
      for some time, the client is assumed to be compromised and is no
318
 
      longer eligible to receive the encrypted password.  The timeout,
 
330
      longer eligible to receive the encrypted password.  (Manual
 
331
      intervention is required to re-enable a client.)  The timeout,
319
332
      checker program, and interval between checks can be configured
320
333
      both globally and per client; see <citerefentry>
321
334
      <refentrytitle>mandos-clients.conf</refentrytitle>
322
 
      <manvolnum>5</manvolnum></citerefentry>.
 
335
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
336
      receiving its password will also be treated as a successful
 
337
      checker run.
323
338
    </para>
324
339
  </refsect1>
325
340
  
333
348
    </para>
334
349
  </refsect1>
335
350
  
 
351
  <refsect1 id="dbus_interface">
 
352
    <title>D-BUS INTERFACE</title>
 
353
    <para>
 
354
      The server will by default provide a D-Bus system bus interface.
 
355
      This interface will only be accessible by the root user or a
 
356
      Mandos-specific user, if such a user exists.
 
357
      <!-- XXX -->
 
358
    </para>
 
359
  </refsect1>
 
360
  
336
361
  <refsect1 id="exit_status">
337
362
    <title>EXIT STATUS</title>
338
363
    <para>