[BACK]Return to sudo_plugin.cat CVS log [TXT] [DIR] Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / sudo / doc

Diff for /embedaddon/sudo/doc/sudo_plugin.cat between versions 1.1.1.4 and 1.1.1.6

version 1.1.1.4, 2013/07/22 10:46:12 version 1.1.1.6, 2014/06/15 16:12:54
Line 5  NNAAMMEE Line 5  NNAAMMEE
   
 DDEESSCCRRIIPPTTIIOONN  DDEESSCCRRIIPPTTIIOONN
      Starting with version 1.8, ssuuddoo supports a plugin API for policy and       Starting with version 1.8, ssuuddoo supports a plugin API for policy and
     session logging.  By default, the ssuuddooeerrss policy plugin and an associated     session logging.  Plugins may be compiled as dynamic shared objects (the
     I/O logging plugin are used.  Via the plugin API, ssuuddoo can be configured     default on systems that support them) or compiled statically into the
     to use alternate policy and/or I/O logging plugins provided by third     ssuuddoo binary itself.  By default, the ssuuddooeerrss policy plugin and an
     parties.  The plugins to be used are specified in the sudo.conf(4) file.     associated I/O logging plugin are used.  Via the plugin API, ssuuddoo can be
      configured to use alternate policy and/or I/O logging plugins provided by
      third parties.  The plugins to be used are specified in the sudo.conf(4)
      file.
   
      The API is versioned with a major and minor number.  The minor version       The API is versioned with a major and minor number.  The minor version
      number is incremented when additions are made.  The major number is       number is incremented when additions are made.  The major number is
Line 193  DDEESSCCRRIIPPTTIIOONN Line 196  DDEESSCCRRIIPPTTIIOONN
                        The prompt to use when requesting a password, if                         The prompt to use when requesting a password, if
                        specified via the --pp flag.                         specified via the --pp flag.
   
                    remote_host=string
                          The name of the remote host to run the command on, if
                          specified via the --hh option.  Support for running the
                          command on a remote host is meant to be implemented via
                          a helper program that is executed in place of the user-
                          specified command.  The ssuuddoo front end is only capable
                          of executing commands on the local host.  Only
                          available starting with API version 1.4.
   
                  run_shell=bool                   run_shell=bool
                        Set to true if the user specified the --ss flag,                         Set to true if the user specified the --ss flag,
                        indicating that the user wishes to run a shell.                         indicating that the user wishes to run a shell.
   
                  runas_group=string                   runas_group=string
                       The group name or gid to to run the command as, if                       The group name or gid to run the command as, if
                        specified via the --gg flag.                         specified via the --gg flag.
   
                  runas_user=string                   runas_user=string
                       The user name or uid to to run the command as, if                       The user name or uid to run the command as, if
                        specified via the --uu flag.                         specified via the --uu flag.
   
                  selinux_role=string                   selinux_role=string
Line 271  DDEESSCCRRIIPPTTIIOONN Line 283  DDEESSCCRRIIPPTTIIOONN
                  pgid=int                   pgid=int
                        The ID of the process group that the running ssuuddoo                         The ID of the process group that the running ssuuddoo
                        process is a member of.  Only available starting with                         process is a member of.  Only available starting with
                       API version 1.2                       API version 1.2.
   
                  pid=int                   pid=int
                        The process ID of the running ssuuddoo process.  Only                         The process ID of the running ssuuddoo process.  Only
                       available starting with API version 1.2                       available starting with API version 1.2.
   
                  plugin_options                   plugin_options
                        Any (non-comment) strings immediately after the plugin                         Any (non-comment) strings immediately after the plugin
Line 293  DDEESSCCRRIIPPTTIIOONN Line 305  DDEESSCCRRIIPPTTIIOONN
   
                  ppid=int                   ppid=int
                        The parent process ID of the running ssuuddoo process.                         The parent process ID of the running ssuuddoo process.
                       Only available starting with API version 1.2                       Only available starting with API version 1.2.
   
                  sid=int                   sid=int
                        The session ID of the running ssuuddoo process or 0 if ssuuddoo                         The session ID of the running ssuuddoo process or 0 if ssuuddoo
                        is not part of a POSIX job control session.  Only                         is not part of a POSIX job control session.  Only
                       available starting with API version 1.2                       available starting with API version 1.2.
   
                  tcpgid=int                   tcpgid=int
                        The ID of the foreground process group associated with                         The ID of the foreground process group associated with
                        the terminal device associated with the ssuuddoo process or                         the terminal device associated with the ssuuddoo process or
                        -1 if there is no terminal present.  Only available                         -1 if there is no terminal present.  Only available
                       starting with API version 1.2                       starting with API version 1.2.
   
                  tty=string                   tty=string
                        The path to the user's terminal device.  If the user                         The path to the user's terminal device.  If the user
Line 536  DDEESSCCRRIIPPTTIIOONN Line 548  DDEESSCCRRIIPPTTIIOONN
                        If set, prevent the command from executing other                         If set, prevent the command from executing other
                        programs.                         programs.
   
                    preserve_fds=list
                          A comma-separated list of file descriptors that should
                          be preserved, regardless of the value of the _c_l_o_s_e_f_r_o_m
                          setting.  Only available starting with API version 1.5.
   
                  preserve_groups=bool                   preserve_groups=bool
                        If set, ssuuddoo will preserve the user's group vector                         If set, ssuuddoo will preserve the user's group vector
                        instead of initializing the group vector based on                         instead of initializing the group vector based on
Line 1196  DDEESSCCRRIIPPTTIIOONN Line 1213  DDEESSCCRRIIPPTTIIOONN
          *(vp) = (*(vp) & 0xffff0000) | (n); \           *(vp) = (*(vp) & 0xffff0000) | (n); \
      } while(0)       } while(0)
   
      RReemmoottee ccoommmmaanndd eexxeeccuuttiioonn
        The ssuuddoo front end does not have native support for running remote
        commands.  However, starting with ssuuddoo 1.8.8, the --hh option may be used
        to specify a remote host that is passed to the policy plugin.  A plugin
        may also accept a _r_u_n_a_s___u_s_e_r in the form of ``user@hostname'' which will
        work with older versions of ssuuddoo.  It is anticipated that remote commands
        will be supported by executing a ``helper'' program.  The policy plugin
        should setup the execution environment such that the ssuuddoo front end will
        run the helper which, in turn, will connect to the remote host and run
        the command.
   
        For example, the policy plugin could utilize sssshh to perform remote
        command execution.  The helper program would be responsible for running
        sssshh with the proper options to use a private key or certificate that the
        remote host will accept and run a program on the remote host that would
        setup the execution environment accordingly.
   
        Note that remote ssuuddooeeddiitt functionality must be handled by the policy
        plugin, not ssuuddoo itself as the front end has no knowledge that a remote
        command is being executed.  This may be addressed in a future revision of
        the plugin API.
   
    CCoonnvveerrssaattiioonn AAPPII     CCoonnvveerrssaattiioonn AAPPII
      If the plugin needs to interact with the user, it may do so via the       If the plugin needs to interact with the user, it may do so via the
      ccoonnvveerrssaattiioonn() function.  A plugin should not attempt to read directly       ccoonnvveerrssaattiioonn() function.  A plugin should not attempt to read directly
Line 1220  DDEESSCCRRIIPPTTIIOONN Line 1259  DDEESSCCRRIIPPTTIIOONN
          const char *msg;           const char *msg;
      };       };
   
        #define SUDO_CONV_REPL_MAX      255
   
      struct sudo_conv_reply {       struct sudo_conv_reply {
          char *reply;           char *reply;
      };       };
Line 1237  DDEESSCCRRIIPPTTIIOONN Line 1278  DDEESSCCRRIIPPTTIIOONN
      sudo_conv_message and sudo_conv_reply structures.  There must be a struct       sudo_conv_message and sudo_conv_reply structures.  There must be a struct
      sudo_conv_message and struct sudo_conv_reply for each message in the       sudo_conv_message and struct sudo_conv_reply for each message in the
      conversation.  The plugin is responsible for freeing the reply buffer       conversation.  The plugin is responsible for freeing the reply buffer
     filled in to the struct sudo_conv_reply, if any.     located in each struct sudo_conv_reply, if it is not NULL.
      SUDO_CONV_REPL_MAX represents the maximum length of the reply buffer (not
      including the trailing NUL character).  In practical terms, this is the
      longest password ssuuddoo will support.  It is also useful as a maximum value
      for the mmeemmsseett__ss() function when clearing passwords filled in by the
      conversation function.
   
      The pprriinnttff()-style function uses the same underlying mechanism as the       The pprriinnttff()-style function uses the same underlying mechanism as the
      ccoonnvveerrssaattiioonn() function but only supports SUDO_CONV_INFO_MSG,       ccoonnvveerrssaattiioonn() function but only supports SUDO_CONV_INFO_MSG,
Line 1393  PPLLUUGGIINN AAPPII CCHHAANNGGEELLOOG Line 1439  PPLLUUGGIINN AAPPII CCHHAANNGGEELLOOG
            The ssuuddoo front end now installs default signal handlers to trap             The ssuuddoo front end now installs default signal handlers to trap
            common signals while the plugin functions are run.             common signals while the plugin functions are run.
   
        Version 1.4 (sudo 1.8.8)
              The _r_e_m_o_t_e___h_o_s_t entry was added to the settings list.
   
        Version 1.5 (sudo 1.8.9)
              The entry was added to the command_info list.
   
 SSEEEE AALLSSOO  SSEEEE AALLSSOO
      sudo.conf(4), sudoers(4), sudo(1m)       sudo.conf(4), sudoers(4), sudo(1m)
   
Line 1412  DDIISSCCLLAAIIMMEERR Line 1464  DDIISSCCLLAAIIMMEERR
      file distributed with ssuuddoo or http://www.sudo.ws/sudo/license.html for       file distributed with ssuuddoo or http://www.sudo.ws/sudo/license.html for
      complete details.       complete details.
   
Sudo 1.8.7                       March 5, 2013                      Sudo 1.8.7Sudo 1.8.10                    December 20, 2013                   Sudo 1.8.10
Removed from v.1.1.1.4  
changed lines
  Added in v.1.1.1.6

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>