1 mike  1.1.2.1 //%2006////////////////////////////////////////////////////////////////////////
  2               //
  3               // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
  4               // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
  5               // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.;
  6               // IBM Corp.; EMC Corporation, The Open Group.
  7               // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
  8               // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
  9               // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 10               // EMC Corporation; VERITAS Software Corporation; The Open Group.
 11               // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
 12               // EMC Corporation; Symantec Corporation; The Open Group.
 13               //
 14               // Permission is hereby granted, free of charge, to any person obtaining a copy
 15               // of this software and associated documentation files (the "Software"), to
 16               // deal in the Software without restriction, including without limitation the
 17               // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 18               // sell copies of the Software, and to permit persons to whom the Software is
 19               // furnished to do so, subject to the following conditions:
 20               // 
 21               // THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN
 22 mike  1.1.2.1 // ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED
 23               // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
 24               // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 25               // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 26               // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 27               // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 28               // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 29               //
 30               //==============================================================================
 31               //
 32               //%/////////////////////////////////////////////////////////////////////////////
 33               
 34               #ifndef _Pegasus_Common_Executor_h
 35               #define _Pegasus_Common_Executor_h
 36               
 37               #include <Pegasus/Common/Config.h>
 38               #include <Pegasus/Common/MessageLoader.h>
 39               #include <Pegasus/Common/AnonymousPipe.h>
 40               #include <Pegasus/Common/Linkage.h>

 41 mike  1.1.2.5 #include <Pegasus/Common/SessionKey.h>

 42 mike  1.1.2.3 #include <Executor/Defines.h>

 43 mike  1.1.2.1 #include <cstdio>
 44               
 45               PEGASUS_NAMESPACE_BEGIN
 46               
 47               class PEGASUS_COMMON_LINKAGE Executor
 48               {
 49               public:
 50               

 51 mike  1.1.2.2     static void setSock(int sock);

 52 mike  1.1.2.1 

 53 mike  1.1.2.3     /** Return zero if the executor is present.
 54                   */
 55                   static int detectExecutor();
 56               

 57 mike  1.1.2.1     static int ping();
 58               
 59                   static FILE* openFile(
 60                       const char* path,
 61                       int mode);
 62               
 63                   static int renameFile(
 64                       const char* oldPath,
 65                       const char* newPath);
 66               
 67                   static int removeFile(
 68                       const char* path);
 69               
 70                   static int startProviderAgent(

 71 mike  1.1.2.7         const SessionKey& sessionKey,

 72 mike  1.1.2.1         const char* module, 
 73                       int uid,
 74                       int gid, 
 75                       int& pid,

 76 mike  1.1.2.9         SessionKey& providerAgentSessionKey,

 77 mike  1.1.2.1         AnonymousPipe*& readPipe,
 78                       AnonymousPipe*& writePipe);
 79               
 80                   static int daemonizeExecutor();
 81               

 82 mike  1.1.2.10     static int reapProviderAgent(
 83                        const SessionKey& sessionKey,

 84 mike  1.1.2.1          int pid);
 85                

 86 mike  1.1.2.7      static int authenticatePassword(

 87 mike  1.1.2.1          const char* username,

 88 mike  1.1.2.6          const char* password,
 89                        SessionKey& sessionKey);

 90 mike  1.1.2.1  

 91 mike  1.1.2.7      static int validateUser(

 92 mike  1.1.2.1          const char* username);
 93                

 94 mike  1.1.2.4      /** Start authenticating the given *user* using the "local authentication"
 95                        algorithm. A file containing a secret token is created on the local 
 96                        file system. The file is only reabable by the given user. The caller 
 97                        should pass the *path* of this file to the client, who will attempt to 
 98                        read the secret token from the file and return it to the server. This 
 99                        token and the session key generated by this function should then be 

100 mike  1.1.2.7          passed to authenticateLocal().

101 mike  1.1.2.4      */

102 mike  1.1.2.7      static int challengeLocal(

103 mike  1.1.2.3          const char* user,

104 mike  1.1.2.7          char challenge[EXECUTOR_BUFFER_SIZE],

105 mike  1.1.2.6          SessionKey& sessionKey);

106 mike  1.1.2.3  

107 mike  1.1.2.7      /** Authenticating the given *user* using the "local authentication"

108 mike  1.1.2.4          algorithm. The secret token is read from the file created by 

109 mike  1.1.2.7          challengeLocal(). If it matches the *token* argument, then the

110 mike  1.1.2.4          authentication is successful (returns zero).
111                    */

112 mike  1.1.2.7      static int authenticateLocal(

113 mike  1.1.2.6          const SessionKey& sessionKey,

114 mike  1.1.2.7          const char* challengeResponse);

115 mike  1.1.2.3  

116 mike  1.1.2.8      /** Generate a new sesion key for the given user. This method will be
117                        eliminated as soon as the SSL certificate authentication scheme is
118                        moved into the executor.
119                    */
120                    static int newSessionKey(
121                        const char username[EXECUTOR_BUFFER_SIZE],
122                        SessionKey& sessionKey);
123                

124 mike  1.1.2.9      /** Delete an existing session key.
125                    */
126                    static int deleteSessionKey(
127                        const SessionKey& sessionKey);
128                

129 mike  1.1.2.1  private:
130                    // Private to prevent instantiation.
131                    Executor();
132                };
133                
134                PEGASUS_NAMESPACE_END
135                
136                #endif /* _Pegasus_Common_Executor_h */