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

Diff for /pegasus/src/Pegasus/Common/SSLContextRep.h between version 1.16 and 1.33

version 1.16, 2004/06/09 20:49:35 version 1.33, 2008/05/29 17:17:02
Line 1 
Line 1 
 //%2003////////////////////////////////////////////////////////////////////////  //%2006////////////////////////////////////////////////////////////////////////
 // //
 // Copyright (c) 2000, 2001, 2002  BMC Software, Hewlett-Packard Development  // Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development
 // Company, L. P., IBM Corp., The Open Group, Tivoli Systems.  // Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems.
 // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.; // Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L. P.;
 // IBM Corp.; EMC Corporation, The Open Group. // IBM Corp.; EMC Corporation, The Open Group.
   // Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.;
   // IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group.
   // Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.;
   // EMC Corporation; VERITAS Software Corporation; The Open Group.
   // Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.;
   // EMC Corporation; Symantec Corporation; The Open Group.
 // //
 // Permission is hereby granted, free of charge, to any person obtaining a copy // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to // of this software and associated documentation files (the "Software"), to
Line 23 
Line 29 
 // //
 //============================================================================== //==============================================================================
 // //
 // Author: Nag Boranna, Hewlett-Packard Company ( nagaraja_boranna@hp.com )  
 //  
 // Modified By: Sushma Fernandes, Hewlett-Packard Company (sushma_fernandes@hp.com)  
 //              Heather Sterling, IBM (hsterl@us.ibm.com)  
 //  
 //%///////////////////////////////////////////////////////////////////////////// //%/////////////////////////////////////////////////////////////////////////////
  
   #ifndef Pegasus_SSLContextRep_h
   #define Pegasus_SSLContextRep_h
   
 #ifdef PEGASUS_HAS_SSL #ifdef PEGASUS_HAS_SSL
 #define OPENSSL_NO_KRB5 1 #define OPENSSL_NO_KRB5 1
 #include <openssl/err.h> #include <openssl/err.h>
Line 38 
Line 42 
 #else #else
 #define SSL_CTX void #define SSL_CTX void
 #endif #endif
 #include <Pegasus/Common/SSLContext.h>  
 #include <Pegasus/Common/Linkage.h>  
 #include <Pegasus/Common/IPC.h>  
  
 #ifndef Pegasus_SSLContextRep_h  #include <Pegasus/Common/SSLContext.h>
 #define Pegasus_SSLContextRep_h  #include <Pegasus/Common/Mutex.h>
   #include <Pegasus/Common/Threads.h>
   #include <Pegasus/Common/Tracer.h>
   #include <Pegasus/Common/AutoPtr.h>
   #include <Pegasus/Common/SharedPtr.h>
  
   //
   // Typedef's for OpenSSL callback functions.
   //
   extern "C"
   {
       typedef void (* CRYPTO_SET_LOCKING_CALLBACK)(int, int, const char *, int);
       typedef unsigned long (* CRYPTO_SET_ID_CALLBACK)(void);
   };
  
 PEGASUS_NAMESPACE_BEGIN PEGASUS_NAMESPACE_BEGIN
  
   struct FreeX509STOREPtr
   {
       void operator()(X509_STORE* ptr)
       {
   #ifdef PEGASUS_HAS_SSL
           X509_STORE_free(ptr);
   #endif
       }
   };
   
   #ifdef PEGASUS_HAS_SSL
   
   class SSLEnvironmentInitializer
   {
   public:
   
       SSLEnvironmentInitializer()
       {
           AutoMutex autoMut(_instanceCountMutex);
   
           PEG_TRACE((TRC_SSL, Tracer::LEVEL4,
               "In SSLEnvironmentInitializer(), _instanceCount is %d",
               _instanceCount));
  
 class PEGASUS_COMMON_LINKAGE SSLContextRep          if (_instanceCount == 0)
 { {
               _initializeCallbacks();
               SSL_load_error_strings();
               SSL_library_init();
           }
   
           _instanceCount++;
       }
   
       ~SSLEnvironmentInitializer()
       {
           AutoMutex autoMut(_instanceCountMutex);
           _instanceCount--;
   
           PEG_TRACE((TRC_SSL, Tracer::LEVEL4,
               "In ~SSLEnvironmentInitializer(), _instanceCount is %d",
               _instanceCount));
   
           if (_instanceCount == 0)
           {
               ERR_free_strings();
               _uninitializeCallbacks();
           }
       }
   
   private:
   
       SSLEnvironmentInitializer(const SSLEnvironmentInitializer&);
       SSLEnvironmentInitializer& operator=(const SSLEnvironmentInitializer&);
   
     /*     /*
     SSL locking callback function. It is needed to perform locking on          Initialize the SSL locking and ID callbacks.
     shared data structures.      */
       static void _initializeCallbacks()
       {
           PEG_TRACE_CSTRING(TRC_SSL, Tracer::LEVEL4,
               "Initializing SSL callbacks.");
   
           // Allocate Memory for _sslLocks. SSL locks needs to be able to handle
           // up to CRYPTO_num_locks() different mutex locks.
  
     This function needs access to variable ssl_locks.          _sslLocks.reset(new Mutex[CRYPTO_num_locks()]);
     Declare it as a friend of class SSLContextRep.  
  
     @param mode         Specifies whether to lock/unlock.  # if defined(PEGASUS_HAVE_PTHREADS) && !defined(PEGASUS_OS_VMS)
     @param type Type of lock.          // Set the ID callback. The ID callback returns a thread ID.
     @param file      File name of the function setting the lock.          CRYPTO_set_id_callback((CRYPTO_SET_ID_CALLBACK) pthread_self);
     @param line      Line number of the function setting the lock.  # endif
   
           // Set the locking callback.
   
           CRYPTO_set_locking_callback(
               (CRYPTO_SET_LOCKING_CALLBACK) _lockingCallback);
       }
   
       /*
           Reset the SSL locking and ID callbacks.
     */     */
     friend void pegasus_locking_callback(      static void _uninitializeCallbacks()
       {
           PEG_TRACE_CSTRING(TRC_SSL, Tracer::LEVEL4, "Resetting SSL callbacks.");
           CRYPTO_set_locking_callback(NULL);
           CRYPTO_set_id_callback(NULL);
           _sslLocks.reset();
       }
   
       static void _lockingCallback(
                       int       mode,                       int       mode,
                       int       type,                       int       type,
                       const     char* file,                       const     char* file,
                       int       line);          int line)
       {
           if (mode & CRYPTO_LOCK)
           {
               _sslLocks.get()[type].lock();
           }
           else
           {
               _sslLocks.get()[type].unlock();
           }
       }
  
 public:      /**
           Locks to be used by SSL.
       */
       static AutoArrayPtr<Mutex> _sslLocks;
  
     /** Constructor for a SSLContextRep object.      /**
     @param trustStore  trust store file path          Count of the instances of this class.  The SSL environment must be
     @param certPath  server certificate file path          initialized when the first SSLEnvironmentInitializer is constructed.
     @param keyPath  server key file path          It must be uninitialized when the last SSLEnvironmentInitializer is
     @param verifyCert  function pointer to a certificate verification          destructed.
     call back function.      */
     @param randomFile  file path of a random file that is used as a seed      static int _instanceCount;
     for random number generation by OpenSSL.  
  
     @exception SSLException  exception indicating failure to create a context.      /**
           Mutex for controlling access to _instanceCount.
     */     */
     SSLContextRep(      static Mutex _instanceCountMutex;
         const String& trustStore,  };
         const String& certPath = String::EMPTY,  
         const String& keyPath = String::EMPTY,  
         SSLCertificateVerifyFunction* verifyCert = NULL,  
         const String& randomFile = String::EMPTY);  
  
 #ifdef PEGASUS_USE_SSL_CLIENT_VERIFICATION  #endif
     //ATTN: We may need to make this more robust to cover the different variations of SSLContexts  
   class SSLCallbackInfoRep
   {
   public:
       SSLCertificateVerifyFunction* verifyCertificateCallback;
       Array<SSLCertificateInfo*> peerCertificate;
       X509_STORE* crlStore;
   
       String ipAddress;
   
       friend class SSLCallback;
   
       friend class SSLCallbackInfo;
   };
   
   class SSLContextRep
   {
   public:
  
         /** Constructor for a SSLContextRep object.         /** Constructor for a SSLContextRep object.
     @param trustStore  trust store file path     @param trustStore  trust store file path
Line 107 
Line 221 
         const String& trustStore,         const String& trustStore,
         const String& certPath = String::EMPTY,         const String& certPath = String::EMPTY,
         const String& keyPath = String::EMPTY,         const String& keyPath = String::EMPTY,
           const String& crlPath = String::EMPTY,
         SSLCertificateVerifyFunction* verifyCert = NULL,         SSLCertificateVerifyFunction* verifyCert = NULL,
         Boolean trustStoreAutoUpdate = false,  
                 String trustStoreUserName = String::EMPTY,  
         const String& randomFile = String::EMPTY);         const String& randomFile = String::EMPTY);
 #endif  
  
     SSLContextRep(const SSLContextRep& sslContextRep);     SSLContextRep(const SSLContextRep& sslContextRep);
  
Line 125 
Line 237 
  
     String getKeyPath() const;     String getKeyPath() const;
  
     Boolean isPeerVerificationEnabled() const;  #ifdef PEGASUS_USE_DEPRECATED_INTERFACES
       String getTrustStoreUserName() const;
   #endif
  
     Boolean isTrustStoreAutoUpdateEnabled() const;      String getCRLPath() const;
  
         String getTrustStoreUserName() const;      SharedPtr<X509_STORE, FreeX509STOREPtr> getCRLStore() const;
  
     SSLCertificateVerifyFunction* getSSLCertificateVerifyFunction() const;      void setCRLStore(X509_STORE* store);
  
     /*      Boolean isPeerVerificationEnabled() const;
     Initialize the SSL locking environment.  
  
     This function sets the locking callback functions.      SSLCertificateVerifyFunction* getSSLCertificateVerifyFunction() const;
     */  
     static void init_ssl();  
  
     /*      /**
     Cleanup the SSL locking environment.          Checks if the certificate associated with this SSL context has expired
           or is not yet valid.
           @exception SSLException if the certificate is determined to be invalid.
     */     */
     static void free_ssl();      void validateCertificate();
  
 private: private:
  
   #ifdef PEGASUS_HAS_SSL
       /**
           Ensures that the SSL environment remains initialized for the lifetime
           of the SSLContextRep object.
       */
       SSLEnvironmentInitializer _env;
   #endif
   
     SSL_CTX * _makeSSLContext();     SSL_CTX * _makeSSLContext();
     void _randomInit(const String& randomFile);     void _randomInit(const String& randomFile);
     Boolean _verifyPrivateKey(SSL_CTX *ctx, const String& keyPath);     Boolean _verifyPrivateKey(SSL_CTX *ctx, const String& keyPath);
Line 154 
Line 275 
     String _trustStore;     String _trustStore;
     String _certPath;     String _certPath;
     String _keyPath;     String _keyPath;
       String _crlPath;
     String _randomFile;     String _randomFile;
     SSL_CTX * _sslContext;     SSL_CTX * _sslContext;
  
     Boolean _verifyPeer;     Boolean _verifyPeer;
     Boolean _trustStoreAutoUpdate;  
         String _trustStoreUserName;  
  
     SSLCertificateVerifyFunction* _certificateVerifyFunction;     SSLCertificateVerifyFunction* _certificateVerifyFunction;
  
     /*      SharedPtr<X509_STORE, FreeX509STOREPtr> _crlStore;
        Mutex containing the SSL locks.  
     */  
     static Mutex* _sslLocks;  
   
     /*  
        Count for instances of this class. This is used to initialize and free  
        SSL locking objects.  
     */  
     static int _countRep;  
   
     /*  
        Mutex for countRep.  
     */  
     static Mutex _countRepMutex;  
 }; };
  
 PEGASUS_NAMESPACE_END PEGASUS_NAMESPACE_END
  
 #endif /* Pegasus_SSLContextRep_h */ #endif /* Pegasus_SSLContextRep_h */
   

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