libsecurity_cdsa_client/lib/cssmclient.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 // cssmclient - common client interface to CSSM and MDS
  21 //
  22 #ifndef _H_CDSA_CLIENT_CSSMCLIENT
  23 #define _H_CDSA_CLIENT_CSSMCLIENT  1
  24
  25 #include <security_utilities/threading.h>
  26 #include <security_utilities/globalizer.h>
  27 #include <security_utilities/refcount.h>
  28 #include <security_cdsa_utilities/cssmalloc.h>
  29 #include <security_cdsa_utilities/cssmpods.h>
  30 #include <map>
  31
  32 namespace Security {
  33 namespace CssmClient {
  34
  35
  36 //
  37 // Forward declarations
  38 //
  39 class Cssm;
  40 class Module;
  41 class Attachment;
  42
  43
  44 //
  45 // An mixin for objects that have (store) GUIDs.
  46 // The GUID value is meant to be set-once constant, and can be lock-handled accordingly.
  47 //
  48 class HasGuid {
  49 public:
  50         HasGuid(const Guid &guid) { mGuid = guid; }
  51         HasGuid() { }
  52
  53         const Guid &guid() const { return mGuid; }
  54
  55 protected:
  56         void setGuid(const Guid &guid) { mGuid = guid; }
  57
  58 private:
  59         Guid mGuid;
  60 };
  61
  62
  63 //
  64 // Exceptions are based on the CssmError utility class. We add our own class of client-side exceptions.
  65 //
  66 class Error : public CssmError {
  67 public:
  68         Error(CSSM_RETURN err) : CssmError(err) { }
  69         virtual const char *what () const throw();
  70
  71         enum {
  72                 objectBusy = -1,
  73         };
  74 };
  75
  76
  77 //
  78 // The CssmObject abstract class models features common to different Cssm objects.
  79 // It handles a tree hierarchy of objects (parent/children) safely.
  80 //
  81 class Object;
  82
  83 class ObjectImpl : virtual public RefCount
  84 {
  85 public:
  86         explicit ObjectImpl(); // Constructor for Impl objects without a parent.
  87         explicit ObjectImpl(const Object &parent);
  88         virtual ~ObjectImpl();
  89
  90         bool isActive() const { return mActive; }
  91
  92         virtual Allocator &allocator() const;
  93         virtual void allocator(Allocator &alloc);
  94
  95         // Pointer comparison by default.  Subclasses may override.
  96         virtual bool operator <(const ObjectImpl &other) const;
  97         virtual bool operator ==(const ObjectImpl &other) const;
  98
  99         static void check(CSSM_RETURN status);
 100
 101 protected:
 102         bool mActive;                                   // loaded, attached, etc.
 103         mutable Allocator *mAllocator; // allocator hierarchy (NULL => TBD)
 104
 105         template <class Obj> Obj parent() const
 106         { assert(mParent); return Obj(static_cast<typename Obj::Impl *>(&(*mParent))); }
 107
 108         void addChild();
 109         void removeChild();
 110         bool isIdle() const { return mChildCount == 0; }
 111
 112         // {de,}activate() assume you have locked *this
 113         virtual void activate() = 0;
 114         virtual void deactivate() = 0;
 115
 116 private:
 117         RefPointer<ObjectImpl> mParent;         // parent object
 118         AtomicCounter<uint32> mChildCount;
 119 };
 120
 121
 122 class Object
 123 {
 124         friend class ObjectImpl;
 125 public:
 126         typedef ObjectImpl Impl;
 127         explicit Object(Impl *impl) : mImpl(impl) {}
 128
 129 protected:
 130         // @@@ CSPDL subclass breaks if the is a static_cast
 131         template <class _Impl> _Impl &impl() const
 132         { return dynamic_cast<_Impl &>(*mImpl); }
 133
 134 public:
 135         Impl *operator ->() const { return &(*mImpl); }
 136         Impl &operator *() const { return *mImpl; }
 137
 138         // @@@ Why is this needed.  DbCursor which inheirits from Object wants to call this.
 139         template <class _Impl> _Impl &checkedImpl() const
 140         { return dynamic_cast<_Impl &>(*mImpl); }
 141
 142         bool operator !() const { return !mImpl; }
 143         operator bool() const { return mImpl; }
 144
 145     bool isActive() const                               { return mImpl && mImpl->isActive(); }
 146     Allocator &allocator() const        { return mImpl->allocator(); }
 147         void release()                                          { mImpl = NULL; }
 148
 149         bool operator <(const Object &other) const
 150         { return mImpl && other.mImpl ? *mImpl < *other.mImpl : mImpl < other.mImpl; }
 151         bool operator ==(const Object &other) const
 152         { return mImpl && other.mImpl ? *mImpl == *other.mImpl : mImpl == other.mImpl; }
 153
 154 private:
 155         RefPointer<Impl> mImpl;
 156 };
 157
 158
 159 //
 160 // Event callback mix-in class
 161 //
 162 class ModuleImpl;
 163
 164 class RawModuleEvents {
 165         friend class ModuleImpl;
 166 public:
 167         virtual ~RawModuleEvents();
 168
 169         virtual void notify(uint32 subService,
 170                 CSSM_SERVICE_TYPE type, CSSM_MODULE_EVENT event) = 0;
 171
 172 private:
 173         static CSSM_RETURN sendNotify(const CSSM_GUID *, void *context, uint32 subService,
 174                 CSSM_SERVICE_TYPE type, CSSM_MODULE_EVENT event);
 175 };
 176
 177 class ModuleEvents : public RawModuleEvents {
 178 public:
 179         virtual void insertion(uint32 subService, CSSM_SERVICE_TYPE type);
 180         virtual void removal(uint32 subService, CSSM_SERVICE_TYPE type);
 181         virtual void fault(uint32 subService, CSSM_SERVICE_TYPE type);
 182
 183 protected:
 184         void notify(uint32 subService, CSSM_SERVICE_TYPE type, CSSM_MODULE_EVENT event);
 185 };
 186
 187
 188 //
 189 // A CSSM loadable module.
 190 // You rarely directly interact with these objects, but if you need to,
 191 // here they are.
 192 //
 193 class ModuleImpl : public ObjectImpl, public HasGuid
 194 {
 195 public:
 196         ModuleImpl(const Guid &guid);
 197         ModuleImpl(const Guid &guid, const Cssm &session);
 198         virtual ~ModuleImpl();
 199
 200         void load() { activate(); }
 201         void unload() { deactivate(); }
 202         bool isLoaded() const { return isActive(); }
 203
 204         Cssm session() const;
 205
 206         void appNotifyCallback(CSSM_API_ModuleEventHandler appNotifyCallback, void *appNotifyCallbackCtx);
 207         void appNotifyCallback(RawModuleEvents *handler);
 208
 209 protected:
 210         void activate();
 211         void deactivate();
 212
 213         CSSM_API_ModuleEventHandler mAppNotifyCallback;
 214         void *mAppNotifyCallbackCtx;
 215 };
 216
 217 class Module : public Object
 218 {
 219 public:
 220         typedef ModuleImpl Impl;
 221         explicit Module(Impl *impl) : Object(impl) {}
 222         Module() : Object(NULL) {} // XXX This might break operator <
 223         Module(const Guid &guid) : Object(new Impl(guid)) {}
 224         Module(const Guid &guid, const Cssm &session) : Object(new Impl(guid, session)) {}
 225
 226         Impl *operator ->() const { return &impl<Impl>(); }
 227         Impl &operator *() const { return impl<Impl>(); }
 228 };
 229
 230
 231 //
 232 // An Attachment object. This is the base class of all typed attachment classes.
 233 //
 234 class AttachmentImpl : public ObjectImpl
 235 {
 236 public:
 237         AttachmentImpl(const Guid &guid, CSSM_SERVICE_TYPE subserviceType);
 238         AttachmentImpl(const Module &module, CSSM_SERVICE_TYPE subserviceType);
 239         //AttachmentImpl(... mds reference ...);
 240         virtual ~AttachmentImpl();
 241
 242         // Virtual so that subclasses can return there true mask.
 243         virtual CSSM_SERVICE_MASK subserviceMask() const;
 244
 245         CSSM_SERVICE_TYPE subserviceType() const { return mSubserviceType; }
 246         CSSM_VERSION version() const { return mVersion; }
 247         void version(const CSSM_VERSION &v) { mVersion = v; }
 248         uint32 subserviceId() const { return mSubserviceId; }
 249         virtual void subserviceId(uint32 id);
 250         CSSM_ATTACH_FLAGS flags() const { return mAttachFlags; }
 251         void flags(CSSM_ATTACH_FLAGS f) { mAttachFlags = f; }
 252
 253         void attach() { activate(); }
 254         void detach() { deactivate(); }
 255         bool attached() const { return isActive(); }
 256
 257         Module module() const;
 258         const Guid &guid() const { return module()->guid(); }
 259         CSSM_MODULE_HANDLE handle() { attach(); return mHandle; }
 260
 261         CssmSubserviceUid subserviceUid() const;
 262
 263 protected:
 264         void activate();
 265         void deactivate();
 266
 267 private:
 268         void make(CSSM_SERVICE_TYPE subserviceType);    // common constructor
 269
 270         CSSM_MODULE_HANDLE mHandle;
 271
 272         CSSM_SERVICE_TYPE mSubserviceType;                              // set by constructor
 273         CSSM_VERSION mVersion;
 274         uint32 mSubserviceId;
 275         CSSM_ATTACH_FLAGS mAttachFlags;
 276
 277         CssmAllocatorMemoryFunctions mMemoryFunctions;  // set on attach()
 278 };
 279
 280 class Attachment : public Object
 281 {
 282 public:
 283         typedef AttachmentImpl Impl;
 284         explicit Attachment(Impl *impl) : Object(impl) {}
 285         Attachment(const Guid &guid, CSSM_SERVICE_TYPE subserviceType)
 286         : Object(new Impl(guid, subserviceType)) {}
 287         Attachment(const Module &module, CSSM_SERVICE_TYPE subserviceType)
 288         : Object(new Impl(module, subserviceType)) {}
 289         //Attachment(... mds reference ...);
 290
 291         Impl *operator ->() const { return &impl<Impl>(); }
 292         Impl &operator *() const { return impl<Impl>(); }
 293 };
 294
 295
 296 //
 297 // A CSSM session object.
 298 // You usually only have one per program, or library, or what-not.
 299 //
 300 class Cssm;
 301
 302 class CssmImpl : public ObjectImpl {
 303     class StandardCssm; friend class StandardCssm;
 304 public:
 305         CssmImpl();
 306         virtual ~CssmImpl();
 307
 308         void init() { activate(); }
 309         void terminate() { deactivate(); }
 310
 311         CSSM_PRIVILEGE_SCOPE scope() const { return mScope; }
 312         void scope(CSSM_PRIVILEGE_SCOPE sc) { mScope = sc; }
 313         const Guid &callerGuid() const { return mCallerGuid; }
 314         void callerGuid(const CSSM_GUID &guid) { mCallerGuid = Guid::overlay(guid); }
 315
 316         Module autoModule(const Guid &guid);
 317
 318 protected:
 319         explicit CssmImpl(bool);                                // internal constructor
 320
 321         void setup();                                                   // constructor setup
 322
 323         void activate();
 324         void deactivate();
 325
 326 private:
 327         // CSSM global configuration -- picked up on each Init
 328         CSSM_VERSION mVersion;
 329         CSSM_PRIVILEGE_SCOPE mScope;
 330         Guid mCallerGuid;
 331
 332         // module repository: modules by guid (protected by self)
 333         typedef map<Guid, Module> ModuleMap;
 334         ModuleMap moduleMap;
 335         Mutex mapLock;
 336
 337 public:
 338         static Cssm standard();
 339         static void catchExit();
 340
 341 private:
 342         static void atExitHandler();
 343
 344     class StandardCssm : public Mutex {
 345     public:
 346         StandardCssm() : mCssm(NULL) { }
 347         ~StandardCssm();
 348         void setCssm(CssmImpl *cssm);
 349         void unsetCssm(CssmImpl *cssm);
 350         CssmImpl *get();
 351
 352     private:
 353         CssmImpl *mCssm;
 354     };
 355     static ModuleNexus<StandardCssm> mStandard;
 356 };
 357
 358 class Cssm : public Object
 359 {
 360 public:
 361         typedef CssmImpl Impl;
 362         explicit Cssm(Impl *impl) : Object(impl) {}
 363         explicit Cssm() : Object(new Impl()) {}
 364
 365         Impl *operator ->() const { return &impl<Impl>(); }
 366         Impl &operator *() const { return impl<Impl>(); }
 367
 368         static Cssm standard() { return CssmImpl::standard(); }
 369 };
 370
 371 } // end namespace CssmClient
 372
 373 } // end namespace Security
 374
 375 #endif // _H_CDSA_CLIENT_CSSMCLIENT