Security-57031.1.35.tar.gz

[apple/security.git] / Security / libsecurity_cdsa_plugin / lib / cssmplugin.h

diff --git a/Security/libsecurity_cdsa_plugin/lib/cssmplugin.h b/Security/libsecurity_cdsa_plugin/lib/cssmplugin.h
new file mode 100644 (file)
index 0000000..f8113c7
--- /dev/null
+++ b/Security/libsecurity_cdsa_plugin/lib/cssmplugin.h
@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) 2000-2001,2011,2014 Apple Inc. All Rights Reserved.
+ * 
+ * The contents of this file constitute Original Code as defined in and are
+ * subject to the Apple Public Source License Version 1.2 (the 'License').
+ * You may not use this file except in compliance with the License. Please obtain
+ * a copy of the License at http://www.apple.com/publicsource and read it before
+ * using this file.
+ * 
+ * This Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
+ * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
+ * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
+ * specific language governing rights and limitations under the License.
+ */
+
+
+//
+// cssmplugin - common header for CSSM plugin modules
+//
+#ifndef _H_CSSMPLUGIN
+#define _H_CSSMPLUGIN
+
+#include <security_cdsa_plugin/c++plugin.h>
+#include <security_utilities/globalizer.h>
+#include <security_cdsa_utilities/callback.h>
+#include <set>
+
+#include <ext/hash_map>
+using __gnu_cxx::hash_map;
+
+
+namespace Security {
+
+
+//
+// Inherit from this (abstract) class to implement your plugin
+//
+class CssmPlugin {
+    NOCOPY(CssmPlugin)
+public:
+    CssmPlugin();
+    virtual ~CssmPlugin();
+
+    void moduleLoad(const Guid &cssmGuid,
+                    const Guid &moduleGuid,
+                    const ModuleCallback &callback);
+    void moduleUnload(const Guid &cssmGuid,
+                      const Guid &moduleGuid,
+                      const ModuleCallback &callback);
+
+    void moduleAttach(CSSM_MODULE_HANDLE theHandle,
+                      const Guid &cssmGuid,
+                      const Guid &moduleGuid,
+                      const Guid &moduleManagerGuid,
+                      const Guid &callerGuid,
+                      const CSSM_VERSION &Version,
+                      uint32 SubserviceID,
+                      CSSM_SERVICE_TYPE SubServiceType,
+                      CSSM_ATTACH_FLAGS AttachFlags,
+                      CSSM_KEY_HIERARCHY KeyHierarchy,
+                      const CSSM_UPCALLS &Upcalls,
+                      CSSM_MODULE_FUNCS_PTR &FuncTbl);
+    void moduleDetach(CSSM_MODULE_HANDLE handle);
+    
+    const Guid &myGuid() const { return mMyGuid; }
+    
+    void sendCallback(CSSM_MODULE_EVENT event,
+                      uint32 ssid,
+                      CSSM_SERVICE_TYPE serviceType) const;
+                      
+    void sendInsertion(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
+    { sendCallback(CSSM_NOTIFY_INSERT, subId, serviceType); }
+                      
+    void sendRemoval(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
+    { sendCallback(CSSM_NOTIFY_REMOVE, subId, serviceType); }
+                      
+    void sendFault(uint32 subId, CSSM_SERVICE_TYPE serviceType) const
+    { sendCallback(CSSM_NOTIFY_FAULT, subId, serviceType); }
+
+protected:
+    // subclass-defined methods
+    virtual void load();
+    virtual void unload();
+
+    // make a session object for your plugin
+    virtual PluginSession *makeSession(CSSM_MODULE_HANDLE handle,
+                                       const CSSM_VERSION &version,
+                                       uint32 subserviceId,
+                                       CSSM_SERVICE_TYPE subserviceType,
+                                       CSSM_ATTACH_FLAGS attachFlags,
+                                       const CSSM_UPCALLS &upcalls) = 0;
+
+private:
+    // map of (CSSM) handles to attachment objects
+    struct SessionMap :
+            public hash_map<CSSM_MODULE_HANDLE, PluginSession *>,
+            public Mutex { };
+            
+    static ModuleNexus<SessionMap> sessionMap;
+    
+    Guid mMyGuid;
+
+    // the registered callback. Set during load processing, unset during unload
+    ModuleCallback mCallback;
+    bool mLoaded;
+
+public:
+    static PluginSession *find(CSSM_MODULE_HANDLE h)
+    {
+        StLock<Mutex> _(sessionMap());
+        SessionMap::iterator it = sessionMap().find(h);
+        if (it == sessionMap().end())
+            CssmError::throwMe(CSSMERR_CSSM_INVALID_ADDIN_HANDLE);
+        return it->second;
+    }
+};
+
+template <class SessionClass>
+inline SessionClass &findSession(CSSM_MODULE_HANDLE h)
+{
+    SessionClass *session = dynamic_cast<SessionClass *>(CssmPlugin::find(h));
+    if (session == NULL)
+        CssmError::throwMe(CSSMERR_CSSM_INVALID_ADDIN_HANDLE);
+    assert(session->handle() == h);
+    return *session;
+}
+
+} // end namespace Security
+
+#endif //_H_CSSMPLUGIN