(file) Return to Executor.h CVS log (file) (dir) Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Executor.h between version 1.1.2.14 and 1.6

version 1.1.2.14, 2007/01/18 01:41:56 version 1.6, 2008/02/08 19:17:37
Line 38 
Line 38 
 #include <Pegasus/Common/MessageLoader.h> #include <Pegasus/Common/MessageLoader.h>
 #include <Pegasus/Common/AnonymousPipe.h> #include <Pegasus/Common/AnonymousPipe.h>
 #include <Pegasus/Common/Linkage.h> #include <Pegasus/Common/Linkage.h>
 #include <Pegasus/Common/SessionKey.h>  
 #include <Executor/Defines.h> #include <Executor/Defines.h>
 #include <cstdio> #include <cstdio>
  
Line 116 
Line 115 
     */     */
     static int ping();     static int ping();
  
     /** Open the given file with the given mode.      /** Open the given file with the given mode.  The file permissions are
           governed by Executor policy (if the Executor is called) or by the
           process umask setting.
         @param path the path of the file.         @param path the path of the file.
         @param mode 'r'=read, 'w'=write, and 'a'=append.         @param mode 'r'=read, 'w'=write, and 'a'=append.
         @return the file stream or NULL on failure.         @return the file stream or NULL on failure.
Line 144 
Line 145 
     /** Start a provider agent as the given user. The provider agent will     /** Start a provider agent as the given user. The provider agent will
         load the given provider module.         load the given provider module.
  
         @param sessionKey a valid session key.  
         @param module name of provider module to be loaded.         @param module name of provider module to be loaded.
         @param uid the UID to run the provider agent as.          @param pegasusHome the Pegasus home directory to use to find the
         @param gid the GID to run the provider agent as.              cimprovagt executable.
           @param userName the user name to run the provider agent as.
         @param pid the PID of the new process (to be eventually passed to         @param pid the PID of the new process (to be eventually passed to
             reapProviderAgent()).             reapProviderAgent()).
         @param providerAgentSessionKey a newly generated providerAgentSessionKey  
             (to be eventually passed to reapProviderAgent()).  
         @param readPipe pipe used to read data from provider agent.         @param readPipe pipe used to read data from provider agent.
         @param writePipe pipe used to write data from provider agent.         @param writePipe pipe used to write data from provider agent.
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int startProviderAgent(     static int startProviderAgent(
         const SessionKey& sessionKey,  
         const char* module,         const char* module,
         int uid,          const String& pegasusHome,
         int gid,          const String& userName,
         int& pid,         int& pid,
         SessionKey& providerAgentSessionKey,  
         AnonymousPipe*& readPipe,         AnonymousPipe*& readPipe,
         AnonymousPipe*& writePipe);         AnonymousPipe*& writePipe);
  
     /** Cause the executor to daemonize itself.      /** Cause the executor to complete its daemonization and the cimserver
           command to exit with success status.
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int daemonizeExecutor();     static int daemonizeExecutor();
  
     /** Wait for the provider agent to exit.     /** Wait for the provider agent to exit.
         @param sessionKey the sessionKey obtained with startProviderAgent().  
         @param pid the process id obtained with startProviderAgent().         @param pid the process id obtained with startProviderAgent().
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int reapProviderAgent(     static int reapProviderAgent(
         const SessionKey& sessionKey,  
         int pid);         int pid);
  
     /** Check whether the password is correct for the given user, using an     /** Check whether the password is correct for the given user, using an
Line 185 
Line 181 
         file).         file).
         @param username the name of a valid system user.         @param username the name of a valid system user.
         @param password the clear text password for the given user.         @param password the clear text password for the given user.
         @param sessionKey a new session key that may be passed to  
             startProviderAgent() and other methods.  
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int authenticatePassword(     static int authenticatePassword(
         const char* username,         const char* username,
         const char* password,          const char* password);
         SessionKey& sessionKey);  
  
     /** Check whether the given user is valid for the underlying authentcation     /** Check whether the given user is valid for the underlying authentcation
         mechanism.         mechanism.
Line 204 
Line 197 
  
     /** Begin authenticating the given *user* using the "local authentication"     /** Begin authenticating the given *user* using the "local authentication"
         algorithm. A file containing a secret token is created on the local         algorithm. A file containing a secret token is created on the local
         file system. The file is only reabable by the given user. The caller          file system. The file is only readable by the given user. The caller
         should pass the path of this file to the client, who will attempt to         should pass the path of this file to the client, who will attempt to
         read the secret token from the file and return it to the server. This         read the secret token from the file and return it to the server. This
         token and the session key generated by this function should then be          token and the file path generated by this function should then be
         passed to authenticateLocal().         passed to authenticateLocal().
         @param username name of user to be challenged.         @param username name of user to be challenged.
         @param challenged the challenge to be forwared by the caller to the          @param challenge The challenge file path to be forwared by the caller
             client (this is the path name of the secrets file mentioned above).              to the client.
         @param sessionKey a new session key that may be passed to the  
             startProviderAgent() and other methods.  
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int challengeLocal(     static int challengeLocal(
         const char* username,         const char* username,
         char challenge[EXECUTOR_BUFFER_SIZE],          char challengeFilePath[EXECUTOR_BUFFER_SIZE]);
         SessionKey& sessionKey);  
  
     /** Authenticate the given *user* using the "local authentication"     /** Authenticate the given *user* using the "local authentication"
         algorithm. The secret token is read from the file created by         algorithm. The secret token is read from the file created by
         challengeLocal(). If it matches the *challengeResponse* argument,          challengeLocal(). If it matches the *response* argument,
         then the authentication is successful (returns zero).         then the authentication is successful (returns zero).
         @param sessionKey a session key obtained from challengeLocal().          @param challengeFilePath The file path that was sent to the client
         @param challengeResponse the challenge response obtained from the              to challenge for the secret token, generated by challengeLocal().
           @param response The challenge response obtained from the
             authenticating user. This is the response to the challenge             authenticating user. This is the response to the challenge
             obtained from challengeLocal().             obtained from challengeLocal().
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int authenticateLocal(     static int authenticateLocal(
         const SessionKey& sessionKey,          const char* challengeFilePath,
         const char* challengeResponse);          const char* response);
  
     /** Generate a new sesion key for the given user. This method will be      /** Update the log level used by the Executor process.
         limited as soon as the SSL certificate authentication scheme is          @param logLevel the new log level to use in the Executor.
         moved into the executor (it will cease to generate session keys  
         upon the very first client connection).  
         @param username user for whom to create a session key.  
         @param sessionKey new session key that may be passed to  
             startProviderAgent() and other methods.  
         @return 0=success, -1=failure         @return 0=success, -1=failure
     */     */
     static int newSessionKey(      static int updateLogLevel(
         const char username[EXECUTOR_BUFFER_SIZE],          const char* logLevel);
         SessionKey& sessionKey);  
   
     /** Delete an existing session key.  
         @param sessionKey the session key that will be deleted.  
         @return 0=success, -1=failure  
     */  
     static int deleteSessionKey(  
         const SessionKey& sessionKey);  
  
 private: private:
     // Private to prevent instantiation.     // Private to prevent instantiation.

Legend:
Removed from v.1.1.2.14  
changed lines
  Added in v.1.6
No CVS admin address has been configured
 Powered by
ViewCVS 0.9.2