OSX/libsecurity_cssm/lib/module.h

   1 /*
   2  * Copyright (c) 2000-2004,2011-2012,2014 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24
  25 //
  26 // module - CSSM Module objects
  27 //
  28 #ifndef _H_MODULE
  29 #define _H_MODULE
  30
  31 #include "cssmint.h"
  32 #include "cssmmds.h"
  33 #include <security_cdsa_utilities/callback.h>
  34 #include "modloader.h"
  35 #include <set>
  36
  37 #include <unordered_map>
  38
  39
  40 //
  41 // This type represents a loaded plugin module of some kind. For each CssmManager
  42 // instance and each one plugin, there is only (at most) one Module object to
  43 // represent it.
  44 //
  45 class Module : public MdsComponent {
  46     NOCOPY(Module)
  47 public:
  48     Module(CssmManager *mgr, const MdsComponent &info, Plugin *plugin);
  49     virtual ~Module();
  50
  51     CssmManager &cssm;
  52
  53     bool unload(const ModuleCallback &callback);
  54
  55     CSSM_HANDLE attach(const CSSM_VERSION &version,
  56                        uint32 subserviceId,
  57                        CSSM_SERVICE_TYPE subserviceType,
  58                        const CSSM_API_MEMORY_FUNCS &memoryOps,
  59                        CSSM_ATTACH_FLAGS attachFlags,
  60                        CSSM_KEY_HIERARCHY keyHierarchy,
  61                        CSSM_FUNC_NAME_ADDR *functionTable,
  62                        uint32 functionTableSize);
  63     void detach(Attachment *attachment);
  64
  65     void add(const ModuleCallback &cb) { callbackSet.insert(cb); }
  66     void remove(const ModuleCallback &cb) { callbackSet.erase(cb); }
  67
  68     unsigned int callbackCount() const { return callbackSet.size(); }
  69     unsigned int attachmentCount() const { return (int)attachmentMap.size(); }
  70
  71         void safeLock()         { if (!isThreadSafe()) mLock.lock(); }
  72         void safeUnlock()       { if (!isThreadSafe()) mLock.unlock(); }
  73
  74 public:
  75     typedef std::unordered_map<CSSM_HANDLE, Attachment *> AttachmentMap;
  76
  77     Plugin *plugin;                                     // our loader module
  78
  79 private:
  80     void spiEvent(CSSM_MODULE_EVENT event,
  81                          const Guid &guid,
  82                          uint32 subserviceId,
  83                          CSSM_SERVICE_TYPE serviceType);
  84
  85     static CSSM_RETURN spiEventRelay(const CSSM_GUID *ModuleGuid,
  86                                      void *Context,
  87                                      uint32 SubserviceId,
  88                                      CSSM_SERVICE_TYPE ServiceType,
  89                                      CSSM_MODULE_EVENT EventType);
  90
  91 private:
  92     AttachmentMap attachmentMap;        // map of all outstanding attachment handles
  93     ModuleCallbackSet callbackSet;      // set of registered callbacks
  94
  95     Mutex mLock;
  96 };
  97
  98 #endif //_H_MODULE