cdsa/cdsa_pluginlib/cssmplugin.h

   1 /*
   2  * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * The contents of this file constitute Original Code as defined in and are
   5  * subject to the Apple Public Source License Version 1.2 (the 'License').
   6  * You may not use this file except in compliance with the License. Please obtain
   7  * a copy of the License at http://www.apple.com/publicsource and read it before
   8  * using this file.
   9  *
  10  * This Original Code and all software distributed under the License are
  11  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
  12  * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
  13  * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  14  * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
  15  * specific language governing rights and limitations under the License.
  16  */
  17
  18
  19 //
  20 // cssmplugin - common header for CSSM plugin modules
  21 //
  22 #ifndef _H_CSSMPLUGIN
  23 #define _H_CSSMPLUGIN
  24
  25 #include <Security/c++plugin.h>
  26 #include <Security/globalizer.h>
  27 #include <Security/callback.h>
  28 #include <hash_map>
  29 #include <set>
  30
  31 namespace Security
  32 {
  33
  34 //
  35 // Inherit from this (abstract) class to implement your plugin
  36 //
  37 class CssmPlugin {
  38     NOCOPY(CssmPlugin)
  39 public:
  40     CssmPlugin();
  41     virtual ~CssmPlugin();
  42
  43     void moduleLoad(const Guid &cssmGuid,
  44                     const Guid &moduleGuid,
  45                     const ModuleCallback &callback);
  46     void moduleUnload(const Guid &cssmGuid,
  47                       const Guid &moduleGuid,
  48                       const ModuleCallback &callback);
  49
  50     void moduleAttach(CSSM_MODULE_HANDLE theHandle,
  51                       const Guid &cssmGuid,
  52                       const Guid &moduleGuid,
  53                       const Guid &moduleManagerGuid,
  54                       const Guid &callerGuid,
  55                       const CSSM_VERSION &Version,
  56                       uint32 SubserviceID,
  57                       CSSM_SERVICE_TYPE SubServiceType,
  58                       CSSM_ATTACH_FLAGS AttachFlags,
  59                       CSSM_KEY_HIERARCHY KeyHierarchy,
  60                       const CSSM_UPCALLS &Upcalls,
  61                       CSSM_MODULE_FUNCS_PTR &FuncTbl);
  62     void moduleDetach(CSSM_MODULE_HANDLE handle);
  63
  64     const Guid &myGuid() const { return mMyGuid; }
  65
  66     void sendCallback(CSSM_MODULE_EVENT event,
  67                       uint32 subId,
  68                       CSSM_SERVICE_TYPE serviceType) const;
  69
  70     void sendInsertion(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
  71     { sendCallback(CSSM_NOTIFY_INSERT, subId, serviceType); }
  72
  73     void sendRemoval(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
  74     { sendCallback(CSSM_NOTIFY_REMOVE, subId, serviceType); }
  75
  76     void sendFault(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
  77     { sendCallback(CSSM_NOTIFY_FAULT, subId, serviceType); }
  78
  79 protected:
  80     // subclass-defined methods
  81     virtual void load();
  82     virtual void unload();
  83
  84     // make a session object for your plugin
  85     virtual PluginSession *makeSession(CSSM_MODULE_HANDLE handle,
  86                                        const CSSM_VERSION &version,
  87                                        uint32 subserviceId,
  88                                        CSSM_SERVICE_TYPE subserviceType,
  89                                        CSSM_ATTACH_FLAGS attachFlags,
  90                                        const CSSM_UPCALLS &upcalls) = 0;
  91
  92 private:
  93     // map of (CSSM) handles to attachment objects
  94     struct SessionMap :
  95             public hash_map<CSSM_MODULE_HANDLE, PluginSession *>,
  96             public Mutex { };
  97
  98     static ModuleNexus<SessionMap> sessionMap;
  99
 100     Guid mMyGuid;
 101
 102     // the registered callback. We currently allow only one
 103     ModuleCallback callback;
 104     bool haveCallback;
 105
 106 public:
 107     static PluginSession *find(CSSM_MODULE_HANDLE h)
 108     {
 109         StLock<Mutex> _(sessionMap());
 110         SessionMap::iterator it = sessionMap().find(h);
 111         if (it == sessionMap().end())
 112             CssmError::throwMe(CSSMERR_CSSM_INVALID_ADDIN_HANDLE);
 113         return it->second;
 114     }
 115 };
 116
 117 template <class SessionClass>
 118 inline SessionClass &findSession(CSSM_MODULE_HANDLE h)
 119 {
 120     SessionClass *session = dynamic_cast<SessionClass *>(CssmPlugin::find(h));
 121     if (session == NULL)
 122         CssmError::throwMe(CSSMERR_CSSM_INVALID_ADDIN_HANDLE);
 123     assert(session->handle() == h);
 124     return *session;
 125 }
 126
 127 } // end namespace Security
 128
 129 #endif //_H_CSSMPLUGIN